Receita federal people

Description

Receita Federal is responsible for issuing and managing the Natural Persons Register. This query obtains public data from the Natural Persons Register (CPF).

HTTP method GET

Endpoint

https://8ehec73psb.execute-api.us-west-2.amazonaws.com/uat/identity/api/idv-govcheck/v1/br-identity/{documentNumber}/check-receita-federal

info

Before proceeding, make sure you have your jwt token, if you don't, check the login documentation.

Request header parameter

NAME	REQUIRED	TYPE	DESCRIPTION
Authorization	✅	string	bearer jwt token

URI request parameter

NAME	REQUIRED	TYPE	DESCRIPTION
documentNumber	✅	string	Brazil identity document number.

Status code responses

Code	Description
200	OK
400	Bad request
401	Unauthorized
404	Not found
500	Internal server error.

The full documentation error codes can be found here.

Response 200 status code

{
    "traceId": "b2345cfc7bee621e",
    "timestamp": "2023-05-15 11:59:35",
    "data": {
        "cpf number": "xxx.xxx.xxx-xx",
        "name": "string",
        "date_of_birth": "DD/MM/YYYY",
        " legal_situation": "REGULAR",
        " date_of_inscription ": "DD/MM/YYYY",
        " date_of_passing_ away ": " DD/MM/YYYY ",
    }
}

Response 400 status code

{
    "traceId": "542fc743fffda052",
    "timestamp": "2023-05-05 11:20:46",
    "code": "IDV-4005",
    "message": "-",
    "data": null
}

Response 401 status code

{
    "timestamp": "YYYY-MM-DDTHH:mm:ss.sssZ",
    "status": 401,
    "error": "Unauthorized",
    "path": "/api/idv-govcheck/v1/br-identity/{documentNumber}/check-receita-federal"
}

Response 500 status code

{
    "traceId": "43a20f33d4e8730d",
    "timestamp": "yyyy-mm-dd HH:MM:SS",
    "code": "IDV-1001",
    "message": "A generic error has occurred.",
    "data": null
}