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

x-access-token

string

required

Body Params application/json

object | null

optional

filters

object | null

optional

Request filters.

personId

string

required

>= 11 characters<= 11 characters

days

integer | null

optional

Max past days to filter verification.

webhook

string <uri> | null

optional

Webhook to return the result if request fail.

Example

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

Responses

🟢200OK

application/json

Body

queryResult

object (Person Verification)

required

personId

string

required

fullName

string

required

dateOfBirth

string

required

dateOfDeath

string | null

optional

motherFullName

string | null

optional

registredAt

string | null

optional

error

string | null

optional

status

string | null

optional

verifiyngDigit

string | null

optional

protocolCode

string | null

optional

verifiedAt

string | null

optional

queryData

object (Query Result)

optional

Example:

{"id":"nkhxb6t5a49nzh3vipyx8hlw","createdAt":"2023-08-24T14:15:22Z","url":"api.example.com/v1/bet/players"}

string

required

Request ID

createdAt

string <date-time>

required

Created date of request.

webhook

string <uri> | null

required

status

string

required

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"
    }
}

Query person status

CPF consultation at the Federal Revenue#

Request

Responses

CPF consultation at the Federal Revenue