Basic Data Sync (Individual)

This is an exclusive service for consulting Brazilian people. This feature queries basic personal information using the CPF provided and returns the data received in the same request.

There are two other possible responses for status code 200: Within serviceData, it may contain only the message attribute with the values: "The CPF does not exist in the Receita Federal database." or "This CPF belongs to a minor. The request can't be processed for legal reasons."

Run synchronous Basic Data for Individual

The cpf sync service returns whether the provided CPF is valid, as well some basic information about the holder.
Permission required: Services query

POSThttps://api.sa.prd.combateafraude.com/services

Header parameters

Body

application/json

service*string

The name of the requested service, for Basic Data Sync (Individual) need be "cpf_sync"

Example: "cpf_sync"

parameters*object

The data expected by the service Basic Data Sync (Individual)

metadataobject

All fields passed to the metadata will be returned in the response, this field is useful to bring an internal identifier of the request for example

Response

200400401403500

Success

Body

application/json

requestIdstring

messagestring

dataobject

Data returned with document information inside.

Request

JavaScriptCurlPython

const response = await fetch('https://api.sa.prd.combateafraude.com/services', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "service": "cpf_sync",
      "parameters": {
        "cpf": "text"
      }
    }),
});
const data = await response.json();

Response

200400401403500

{
  "requestId": "text",
  "message": "text",
  "data": {
    "service": "cpf_sync",
    "serviceData": {
      "taxIdNumber": "44443333333",
      "name": "Holder name",
      "taxIdStatus": "REGULAR",
      "birthDate": "2021-01-11",
      "fallback": false
    }
  }
}