Products
INSS (V1)
1min
Example responses
JSON
1{
2 "code": 200,
3 "msg": "OK",
4 "report_time": "2023-11-08 06:10:13",
5 "data":
6 {
7 "enquiryCpf": "12345678909",
8 "reportVersion": "V1",
9 "connectionKey": "1a0b354048c78aa5b4e051ee19fd72d4",
10 "connectionId": "Y9wLKiiopSHrNqtrkprtcsaAWIEWue0j",
11 "reportId": "f488f098-e15f-45bb-9334-f81rtef60875",
12 "userConsent": "Yes",
13 "allowAutoupdate": "Yes",
14 "institutionId": "",
15 "reportType": "INSS",
16 "inssInfo":
17 {
18 "personalInformation":
19 {
20 "cpfVerified": "12345678909",
21 "name": "John Doe",
22 "motherName": "Jane",
23 "fatherName": "John",
24 "gender": "Masculino",
25 "maritalStatus": "Solteiro(a)",
26 "scholarity": "Ens. Medio Completo",
27 "birthday": "1950-01-01",
28 "deathDate": "",
29 "nationality": "Estrangeira",
30 "birthCountry": "Mexico",
31 "arrivalDate": "1994-11-10",
32 "birthCity": "",
33 "birthState": ""
34 },
35 "beneficiaryBankInfo":
36 {
37 "institution": "BANCO DO BRASIL S A",
38 "accountType": "Conta Corrente",
39 "agencyNumber": "1234",
40 "accountNumber": "0000123456",
41 "benefitNumber": "7045123456",
42 "pdfList":
43 [
44 {
45 "hisconPdf": "https://partnerpdfdata.s3.sa-east-1.amazonaws.com/INSS/7045123456/20231108_historico-creditos.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA3KF3UU6UCG6W7BRG%2F20231108%2Fsa-east-1%2Fs3%2Faws4_request&X-Amz-Date=20231108T091013Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=dda81234b0ab2ee5f4f2b7ca4a0d2d2de123419e6a9c9db51841c384d02f5d76"
46 }
47 ]
48 },
49 "benefitInfo":
50 [
51 {
52 "benefitName": "BENEFÍCIO DE PRESTAÇÃO CONTINUADA A PESSOA IDOSA",
53 "benefitStatus": "ATIVO",
54 "benefitNumber": "7045123456",
55 "benefitChecking":
56 {
57 "DIB": "2019-07-25",
58 "DCB": "",
59 "MR": 1320,
60 "APS": "21001234",
61 "benefitCheckingDetail":
62 [
63 {
64 "referenceMonth": "11/2023",
65 "transDate": "2023-12-05",
66 "transAmount": 1320,
67 "paymentStatus": 1,
68 "expectedPaymentDate": "2023-12-05",
69 "paymentOccurrence": "Pagamento efetivado",
70 "beneficiaryAccountType": "CCF - CONTA-CORRENTE",
71 "NIT": "11955027123",
72 "rubricInfo":
73 [
74 {
75 "rubricAmount": 1320.00,
76 "rubricDescription": "VALOR TOTAL DE MR DO PERIODO",
77 "rubricId": "101"
78 }
79 ]
80 },
81 {
82 "referenceMonth": "10/2023",
83 "transDate": "2023-11-06",
84 "transAmount": 1320,
85 "paymentStatus": 1,
86 "expectedPaymentDate": "2023-11-06",
87 "paymentOccurrence": "Pagamento efetivado",
88 "beneficiaryAccountType": "CCF - CONTA-CORRENTE",
89 "NIT": "11955027123",
90 "rubricInfo":
91 [
92 {
93 "rubricAmount": 1320.00,
94 "rubricDescription": "VALOR TOTAL DE MR DO PERIODO",
95 "rubricId": "101"
96 }
97 ]
98 }
99 ]
100 }
101 }
102 ]
103 }
104 },
105 "query_param":
106 {
107 "email": "[email protected]"
108 }
109}
Updated 14 Dec 2023
Did this page help you?