Products
FGTS (V1)
1min
Example responses
JSON
{
"code": 200,
"msg": "OK",
"report_time": "2023-02-05 12:12:34",
"data": {
"enquiry_cpf": "12345678901",
"report_version": "V1",
"connection_key": "1786a4508v3443ea86f5e16bc0cd3eeb",
"connection_id": "LzW7vfYsanVsjdv1ELKlCPBoCZFGFsUy",
"report_id": "d1fd2ba2-f9a7-4326-95f4-f922985901d1",
"user_consent": "Yes",
"allow_autoupdate": "Yes",
"institution_id": "",
"report_type": "FGTS",
"FGTS_info": {
"personalInfo": {
"cpf_verified": "12345678901",
"holder_name": "John Doe",
"address": "",
"city": "",
"state": "",
"country": "",
"post_code": "",
"latest_withdrawal_type": "",
"has_birthday_withdrawal": 0,
"latest_birthday_withdrawal_date": "",
"e-mail": "[email protected]",
"withdrawalDetail": [
{
"withdrawal_date": "2019-10-25",
"withdrawal_description": "SAQUE JAM - COD 50",
"withdrawal_amount": -61.49
},
{
"withdrawal_date": "2019-10-25",
"withdrawal_description": "SAQUE DEP - COD 50",
"withdrawal_amount": -438.51
},
{
"withdrawal_date": "2020-07-06",
"withdrawal_description": "SAQUE DEP - COD 19E",
"withdrawal_amount": -1006.75
},
{
"withdrawal_date": "2020-07-06",
"withdrawal_description": "SAQUE JAM - COD 19E",
"withdrawal_amount": -38.25
}
]
},
"bankAccount": {
"bank_name": "NU PAGAMENTOS S.A.",
"agency_number": "0001",
"account_number": "123456789",
"account_type": "Conta Pagamento"
},
"accountInfo": [
{
"pis_pasep": "123.45678.36-3",
"company_name": "TECNOLOGIA PARA FINANCAS PE",
"company_cnpj": "12345678000101",
"work_permit": "1234567-8808",
"account_type": "OPTANTE",
"category": "01",
"fgts_account": "1234567890123/1173-BH",
"admission_date": "05/10/2022",
"movement_code": "",
"operation_date": "05/10/2022",
"interest_rate": 0.03,
"amount_for_termination": 573.17,
"balance": 573.17,
"blocked_balance": "1",
"blocked_balance_amount": 726.95,
"transactionDetail": [
{
"trans_date": "2023-02-10",
"trans_description": "CREDITO DE JAM 0,004552",
"trans_amount": 2.59,
"trans_balance": 573.16
},
{
"trans_date": "2023-01-10",
"trans_description": "CREDITO DE JAM 0,004543",
"trans_amount": 2.58,
"trans_balance": 570.58
},
{
"trans_date": "2022-12-10",
"trans_description": "CREDITO DE JAM 0,003976",
"trans_amount": 4.5,
"trans_balance": 253.26
},
{
"trans_date": "2022-12-07",
"trans_description": "115-DEPOSITO NOVEMBRO 2022",
"trans_amount": 3.15,
"trans_balance": 568.79
},
{
"trans_date": "2022-11-07",
"trans_description": "115-DEPOSITO OUTUBRO 2022",
"trans_amount": 252.21,
"trans_balance": 252.35
}
]
}
],
"exceptionalWithdrawal": {
"available_for_exc_withdrawal": 1000,
"excpected_payment_date": ""
},
"exceptionalWithdrawalBank": {
"bank_name": "",
"agency_number": "",
"account_number": "",
"account_type": ""
}
}
},
"query_param": {}
}