Addresses

This is a service for consulting Brazilian people. This feature queries the addresses related to 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 Addresses for person

post

/

The PF Addresses service returns the list of addresses related to the provided CPF.
Permission required: Create Services

Header parameters

AuthorizationstringRequired

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

Body

servicestringRequired

The name of the requested service, for PF Addresses needs to be "pf_addresses"

Example: pf_addresses

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

requestIdstringOptional

messagestringOptional

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": {}
  }
}