Sincronização básica de dados (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 suportar mTLS autenticação com URL base: https://mtls.us.prd.caf.io
• Para informações sobre a implementação de mTLS, acesse Usando mTLS

Este é um serviço para consultar pessoas brasileiras. Este recurso consulta informações pessoais básicas usando o CPF informado e retorna os dados recebidos na mesma solicitação.

Existem outras duas possíveis respostas para o código de status 200: Dentro 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. A solicitação não pode ser processada por razões legais."

Run synchronous Basic Data for Individual

post

/

The PF Basic Data service returns whether the provided CPF is valid, as well some basic information about the holder.
Permission required: Create Services

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 PF Basic Data Sync (Individual) needs to be "pf_basic_data"

Example: pf_basic_data

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: 69

{
  "service": "pf_basic_data",
  "parameters": {
    "cpf": "text"
  },
  "metadata": {}
}

{
  "requestId": "text",
  "message": "text",
  "data": {
    "service": "pf_basic_data",
    "serviceData": {
      "taxIdNumber": "12345678910",
      "taxIdCountry": "BRAZIL",
      "alternativeIdNumbers": {},
      "name": "HOLDER NAME",
      "socialName": "HOLDER SOCIAL NAME",
      "gender": "M",
      "birthDate": "2000-01-01T00:00:00Z",
      "age": 25,
      "birthCountry": "BRASILEIRA",
      "motherName": "HOLDER MOTHER NAME",
      "fatherName": "HOLDER FATHER NAME",
      "taxIdStatus": "REGULAR",
      "taxIdOrigin": "RECEITA FEDERAL",
      "hasObitIndication": false,
      "obitIndicationOrigin": "",
      "obitIndicationYear": "",
      "taxIdStatusDate": "2010-01-01T00:00:00Z",
      "creationDate": "2010-01-01T00:00:00Z",
      "lastUpdateDate": "2025-01-01T00:00:00Z"
    },
    "metadata": {}
  }
}