Address Parser

Parse Address

Parses a single-line address into its components.

post/v1/address/parse

Request

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

Headers

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

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

Request body

idstring nullable

An optional ID to map the request payload to the response payload, helpful for batch processing.

addressstring required

A single-line address string to parse into structured components.

Example request

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

Response

Address successfully parsed.

Example response

{
  "response": {
    "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.