Basic Data Sync (Individual)

This service performs the consult on personal basic information using provided cpf and returns the received data in the same request.

Run synchronous Basic Data for Individual

post

Send the individual's CPF number to consult the service synchronously.

Header parameters

AuthorizationstringRequired

Customer access token. See more in the 'Authentication' topic of this section.

Example: Bearer your_token_here

Body

servicestringRequired

The service to consult. Should be "pf_basic_data".

Example: pf_basic_data

Responses

200

Success

application/json

400

Bad Request

application/json

500

Internal Server Error

application/json

post

HTTPcURLJavaScriptPython

POST /v1/services HTTP/1.1
Host: api.combateafraude.com
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "service": "pf_basic_data",
  "attributes": {
    "cpf": "text",
    "birthDate": "text"
  }
}

{
  "requestId": "6cb8093c-14ef-4fd1-810b-ee9fa5f9aae9",
  "id": "6021a21b3811c35ecb8dea20",
  "data": {
    "taxIdNumber": "00011122233",
    "taxIdCountry": "BRAZIL",
    "taxIdStatus": "REGULAR",
    "name": "JOHNNY DOE",
    "socialName": "JANE DOE",
    "gender": "F",
    "birthDate": "2023-02-02T00:00:00Z",
    "birthCountry": "BRASILEIRA",
    "motherName": "MARIA LURDES DOE",
    "fatherName": "JOHN DOE"
  }
}

Beta Testing Data

Below are presented the test data for the API and their respective behaviors.

CPF	DOCUMENT STATUS	DESCRIPTION	STATUS CODE
64913872591	CANCELADA	CANCELED	200
52389071686	CANCELADA	CANCELED	200
07691852312	PENDENTE DE REGULARIZACAO	PENDING	200
10975384600	PENDENTE DE REGULARIZACAO	PENDING	200
40532176871	SUSPENSA	SUSPENDED	200
47123586964	SUSPENSA	SUSPENDED	200
18025346790	NULA	NULL	200
00000000191	-	INVALID DOCUMENT	200
05137518743	TITULAR FALECIDO	DECEASED	200
08849979878	TITULAR FALECIDO	DECEASED	200
19321675019	CPF não encontrado na base de dados da Receita Federal.	OUT OF DATABASE	200
40442820135	REGULAR	REGULAR	200
63017285995	REGULAR	REGULAR	200
91708635203	REGULAR	REGULAR	200
58136053391	REGULAR	REGULAR	200
59872132070	O CPF pertence a um menor de idade com 12 anos ou menos. Por razões legais não é possível realizar a consulta.	UNDER 12 YEARS	400
23993556011	O CPF pertence a um menor de idade. É necessária a Data de Nascimento para realizar a consulta.	UNDER 18 YEARS	400
30302463020	Data de nascimento informada está divergente da constante na base de dados da Secretaria da Receita Federal do Brasil	DIVERGENT BIRTH DATE	400
98302514705	Não foi possível encontrar o CPF no tempo necessário	TIMEOUT	408

Return messages

Some error messages that may be returned according to what is sent in the body.

Message	Description
CPF não informado	CPF not entered
CPF deve ser uma string	CPF must be a string
CPF deve possuir 11 dígitos. Somente números	CPF must have 11 digits. Numbers only
birthDate deve ser uma string	birthDate must be a string