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

post

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

Query parameters
originstringOptional

If necessary, the source may also return the mother's name. To retrieve this information, the parameter origin=2 must be included in the query URL

Example: https://api.sa.prd.combateafraude.com/services?origin=2
Header parameters
AuthorizationstringRequired

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

Body
servicestringRequired

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

Default: cpf_syncExample: cpf_sync
metadataobjectOptional

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

Responses
200

Success

application/json
post
POST /services HTTP/1.1
Host: api.sa.prd.combateafraude.com
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 64

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

Last updated