Products
FGTS (V1)
1min
Example responses
JSON
1{
2 "code": 200,
3 "msg": "OK",
4 "report_time": "2023-02-05 12:12:34",
5 "data": {
6 "enquiry_cpf": "12345678901",
7 "report_version": "V1",
8 "connection_key": "1786a4508v3443ea86f5e16bc0cd3eeb",
9 "connection_id": "LzW7vfYsanVsjdv1ELKlCPBoCZFGFsUy",
10 "report_id": "d1fd2ba2-f9a7-4326-95f4-f922985901d1",
11 "user_consent": "Yes",
12 "allow_autoupdate": "Yes",
13 "institution_id": "",
14 "report_type": "FGTS",
15 "FGTS_info": {
16 "personalInfo": {
17 "cpf_verified": "12345678901",
18 "holder_name": "John Doe",
19 "address": "",
20 "city": "",
21 "state": "",
22 "country": "",
23 "post_code": "",
24 "latest_withdrawal_type": "",
25 "has_birthday_withdrawal": 0,
26 "latest_birthday_withdrawal_date": "",
27 "e-mail": "[email protected]",
28 "withdrawalDetail": [
29 {
30 "withdrawal_date": "2019-10-25",
31 "withdrawal_description": "SAQUE JAM - COD 50",
32 "withdrawal_amount": -61.49
33 },
34 {
35 "withdrawal_date": "2019-10-25",
36 "withdrawal_description": "SAQUE DEP - COD 50",
37 "withdrawal_amount": -438.51
38 },
39 {
40 "withdrawal_date": "2020-07-06",
41 "withdrawal_description": "SAQUE DEP - COD 19E",
42 "withdrawal_amount": -1006.75
43 },
44 {
45 "withdrawal_date": "2020-07-06",
46 "withdrawal_description": "SAQUE JAM - COD 19E",
47 "withdrawal_amount": -38.25
48 }
49 ]
50 },
51 "bankAccount": {
52 "bank_name": "NU PAGAMENTOS S.A.",
53 "agency_number": "0001",
54 "account_number": "123456789",
55 "account_type": "Conta Pagamento"
56 },
57 "accountInfo": [
58 {
59 "pis_pasep": "123.45678.36-3",
60 "company_name": "TECNOLOGIA PARA FINANCAS PE",
61 "company_cnpj": "12345678000101",
62 "work_permit": "1234567-8808",
63 "account_type": "OPTANTE",
64 "category": "01",
65 "fgts_account": "1234567890123/1173-BH",
66 "admission_date": "05/10/2022",
67 "movement_code": "",
68 "operation_date": "05/10/2022",
69 "interest_rate": 0.03,
70 "amount_for_termination": 573.17,
71 "balance": 573.17,
72 "blocked_balance": "1",
73 "blocked_balance_amount": 726.95,
74 "transactionDetail": [
75 {
76 "trans_date": "2023-02-10",
77 "trans_description": "CREDITO DE JAM 0,004552",
78 "trans_amount": 2.59,
79 "trans_balance": 573.16
80 },
81 {
82 "trans_date": "2023-01-10",
83 "trans_description": "CREDITO DE JAM 0,004543",
84 "trans_amount": 2.58,
85 "trans_balance": 570.58
86 },
87 {
88 "trans_date": "2022-12-10",
89 "trans_description": "CREDITO DE JAM 0,003976",
90 "trans_amount": 4.5,
91 "trans_balance": 253.26
92 },
93 {
94 "trans_date": "2022-12-07",
95 "trans_description": "115-DEPOSITO NOVEMBRO 2022",
96 "trans_amount": 3.15,
97 "trans_balance": 568.79
98 },
99 {
100 "trans_date": "2022-11-07",
101 "trans_description": "115-DEPOSITO OUTUBRO 2022",
102 "trans_amount": 252.21,
103 "trans_balance": 252.35
104 }
105 ]
106 }
107 ],
108 "exceptionalWithdrawal": {
109 "available_for_exc_withdrawal": 1000,
110 "excpected_payment_date": ""
111 },
112 "exceptionalWithdrawalBank": {
113 "bank_name": "",
114 "agency_number": "",
115 "account_number": "",
116 "account_type": ""
117 }
118 }
119 },
120 "query_param": {}
121}