Endereços

Este é um serviço para consultar pessoas brasileiras. Este recurso consulta os endereços relacionados ao CPF fornecido e retorna os dados recebidos na mesma solicitação.

Existem duas outras possíveis respostas para o código de status 200: Dentro de 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 razões legais."

Run synchronous Addresses for person

post

/

The PF Addresses service returns the list of addresses 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 Addresses needs to be "pf_addresses"

Example: pf_addresses

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

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

{
  "requestId": "text",
  "message": "text",
  "data": {
    "service": "pf_addresses",
    "serviceData": {
      "addresses": [
        {
          "typology": "R",
          "title": "",
          "addressMain": "STREET NAME",
          "number": "1000",
          "complement": "FLOOR 5",
          "neighborhood": "NEIGHBORHOOD NAME",
          "zipCode": "00000000",
          "city": "CITY NAME",
          "state": "RS",
          "country": "BRASIL",
          "type": "HOME",
          "complementType": "FLOOR",
          "householdCode": "0000000000000000000000000000000000000000000000000000000000000000",
          "buildingCode": "0000000000000000000000000000000000000000000000000000000000000000",
          "householdTotalPassages": "",
          "householdBadPassages": "",
          "householdCrawlingPassages": "",
          "householdValidationPassages": "",
          "householdQueryPassages": "",
          "householdMonthAveragePassages": "",
          "householdNumberOfEntities": "",
          "buildingTotalPassages": "",
          "buildingBadPassages": "",
          "buildingCrawlingPassages": "",
          "buildingValidationPassages": "",
          "buildingQueryPassages": "",
          "buildingMonthAveragePassages": "",
          "buildingNumberOfHouseholds": "",
          "last3MonthsPassages": "",
          "last6MonthsPassages": "",
          "last12MonthsPassages": "",
          "last18MonthsPassages": "",
          "priority": 1,
          "isMain": true,
          "isRecent": false,
          "isActive": false,
          "isRatified": false,
          "firstPassageDate": "2018-01-01T00:00:00Z",
          "lastPassageDate": "2025-01-01T00:00:00Z",
          "creationDate": "2018-01-01T00:00:00Z",
          "lastUpdateDate": "2025-01-01T00:00:00Z",
          "hasOptIn": false,
          "ibgeCode": "0000000",
          "latitude": -23.5505,
          "longitude": -46.6333
        }
      ]
    },
    "metadata": {}
  }
}