Telefones

Este é um serviço para consulta de pessoas brasileiras. Este recurso consulta os números de telefone relacionados ao CPF informado e retorna os dados recebidos na mesma solicitação.

Há outras duas possíveis respostas para o código de status 200: Dentro serviceData, ele pode conter apenas o message 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 Phones for person

post

/

The PF Phones service returns the list of phone numbers related to the provided CPF.
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 Phones needs to be "pf_phones"

Example: pf_phones

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

{
  "service": "pf_phones",
  "parameters": {
    "cpf": "text",
    "birthDate": "14/02/2010"
  },
  "metadata": {}
}

{
  "requestId": "text",
  "message": "text",
  "data": {
    "service": "pf_phones",
    "serviceData": {
      "phones": [
        {
          "number": "999999999",
          "areaCode": "11",
          "countryCode": "55",
          "type": "MOBILE",
          "lastPassageDate": "2000-01-01T00:00:00Z",
          "portabilityHistory": [
            {
              "OriginalCarrier": "text",
              "NewCarrier": "text",
              "PortabilityDate": "text"
            }
          ],
          "hasOptIn": false
        }
      ]
    },
    "metadata": {}
  }
}