Sincronização de CPF (Pessoa física)

Requisitos de autenticação:

• Endpoints regulares usam OAuth2 autenticação com URL base: https://api.us.prd.caf.io
• Para maior segurança, alguns endpoints também podem oferecer suporte a mTLS autenticação com URL base: https://mtls.us.prd.caf.io
• Para obter informações sobre como implementar mTLS, acesse Usando mTLS

Este é um serviço exclusivo para consultar pessoas brasileiras. Este recurso consulta informações pessoais básicas usando o CPF e a data de nascimento informados e retorna os dados recebidos na mesma requisição.

Ambos cpf e birthDate são obrigatórios. O birthDate parâmetro aceita os formatos DD/MM/AAAA ou AAAA-MM-DD.

Há outras duas possíveis respostas para o código de status 200: Dentro de serviceData, ele pode conter apenas o mensagem atributo com os valores: "O CPF não existe na base de dados da Receita Federal." ou "Este CPF pertence a um menor de idade. A solicitação não pode ser processada por motivos legais."

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: Create Services

Parâmetros de consulta

originstringOpcional

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.us.prd.caf.io/v1/services?origin=2

Parâmetros de cabeçalho

AuthorizationstringObrigatório

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

Corpo

servicestringObrigatório

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

Default: cpf_syncExample: cpf_sync

metadataobjectOpcional

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

Respostas

200

Success

application/json

requestIdstringOpcional

messagestringOpcional

400

Invalid provided body

application/json

401

Invalid token

application/json

403

The token does not have permission to access this resource

application/json

500

Internal server error

application/json

post/

POST /v1/services/ HTTP/1.1
Host: api.us.prd.caf.io
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "service": "cpf_sync",
  "parameters": {
    "cpf": "text",
    "birthDate": "14/02/1990"
  },
  "metadata": {}
}

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