Address Parser

Parse Address Batch

Parses a batch of up to 10 single-line addresses into components.

post/v1/address/parse/batch

Request

  • Base URL: https://api.cloud.precisely.com
  • URL: https://api.cloud.precisely.com/v1/address/parse/batch
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Headers

X-Request-Idstring
Example:3cf82271-385d-40c3-b425-7550144eb1e5

The X-Request-Id header is optional but helpful for tracking batch requests. Acts as a unique identifier for troubleshooting and debugging. Maximum length: 38 characters.

Request body

Example request

{
  "addresses": [
    {
      "id": "1",
      "address": "1700 district ave #300 burlington, ma"
    }
  ]
}

Response

Batch addresses parsed successfully.

Example response

{
  "responses": [
    {
      "id": "1",
      "status": "OK",
      "code": "DIS-AP-1001",
      "detail": "Request is not valid",
      "address": {
        "addressNumber": "1700",
        "street": "district ave",
        "admin1": "ma",
        "city": "burlington",
        "suburb": "north suburb",
        "postalCode": "01803",
        "placeName": "Corporate Plaza",
        "floor": "3rd Floor",
        "unit": "#300"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.