CPF object
This is the content of `data` in lookups and of `data` in each `found` item of a batch.
- cpfstring
- Sanitized CPF, 11 digits.
- namestring
- Holder’s name, in uppercase.
- birthdatestring
- Date of birth as
DD/MM/YYYY. - day / month / yearnumber
- The numeric parts of the date of birth.
- situationstring | null
- Registration status as text, for example
REGULARorSUSPENSA.nullwhen the source does not say. - social_namestring | null
- Social name of the holder, in uppercase.
nullwhen there is none. - registration_datestring | null
- CPF registration date, formatted
DD/MM/YYYY.nullwhen the source does not say.
Response envelope
- successboolean
- Always
trueon 200 responses. - dataobject
- The CPF object.
- credits_remainingnumber
- Balance after this lookup (cycle allowance plus add-on credits). Can be hidden in the dashboard settings.
200 OK
1{2 "success": true,3 "data": {4 "cpf": "52998224725",5 "name": "MARIA SOUZA LIMA",6 "birthdate": "26/11/1982",7 "day": 26,8 "month": 11,9 "year": 1982,10 "situation": "REGULAR",11 "social_name": null,12 "registration_date": "12/03/2004"13 },14 "credits_remaining": 1915}