Query person status

POST

https://api.heimdall.watch/kyc/v1/persons/status

CPF consultation at the Federal Revenue

Description
The CPF query in the Federal Revenue database returns information about the status of the CPF, including status, query protocol, death information (if available) and other details.

Source of Information

The information returned in this query is taken from the public CPF status query on the Federal Revenue website. The link to access this consultation can be seen here.

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Header Params

Body Params application/json

Example

{
    "filters": {
        "personId": "stringstrin",
        "days": 0
    },
    "webhook": "http://example.com"
}

Responses

🟢200OK

application/json

Body

Example

{
    "queryResult": {
        "personId": "string",
        "fullName": "string",
        "dateOfBirth": "string",
        "dateOfDeath": "string",
        "motherFullName": "string",
        "registredAt": "string",
        "error": "string",
        "status": "string",
        "verifiyngDigit": "string",
        "protocolCode": "string",
        "verifiedAt": "string"
    },
    "queryData": {
        "id": "nkhxb6t5a49nzh3vipyx8hlw",
        "createdAt": "2023-08-24T14:15:22Z",
        "url": "api.example.com/v1/bet/persons/11122233344/cache-verification"
    }
}

Modified at 2023-12-28 18:11:15

Get access token

Query person status simple

Query person status

CPF consultation at the Federal Revenue#

Request

Responses

CPF consultation at the Federal Revenue