Explain Address Code Request - Precisely Data Integrity Suite

Data Integrity Suite APIs

Product

Data_Integrity

Spatial_Analytics

Data_Enrichment

geo_addressing_1

Services

Spatial Analytics

Data Enrichment

Geo Addressing

ft:title

Data Integrity Suite APIs

ft:locale

en-US

PublicationType

pt_developer

copyrightfirst

2023

copyrightlast

2026

This section provides an overview of how the Email Address Code API functions and how you can integrate it into your workflow. If you would like to explore its capabilities, consider signing up for a Free Trial.

This method will consume credits.

HTTP Request
- URL Composition
  - Base URL: https://api.cloud.precisely.com
  - Email Address Code: /v1/explain-addresscode
- Supported Methods: POST
- Batch Limit: Maximum 25 items per request
- Rate Limit (Transactions per second): 700

Request Body

{
  "codeType": "<codeType>", 
  "codes": [
    {
      "id": "optional string",
      "code": "string"
    }
  ],
  "responseOptions": {
    "includeOfficialDescription": <true/false>
 
  }
}

Field Details

Table 1.
Field	Description	Rules	Validation
codeType	Determines which Precisely decoder is used.	Required. Must be one of: `GlobalMatchCode`, `GlobalLocationCode`, `GlobalDeliveryIndicator`, `ForwardResultCode`, `ReverseResultCode`	Error returned if unsupported value is provided.
codes[]	Array of code objects to decode.	Required. Must contain 1–25 items	Batch size cannot exceed 25.
codes[].code	The code to decode.	Required. Must contain a single code only (no comma‑ or pipe‑separated lists)	Validated based on expected length/format for the selected `codeType`.
codes[].id	Optional identifier for tracking.	Optional. If omitted, an incremental ID is auto‑generated	Auto‑assigned values: `1`, `2`, `3`, ..
includeCustomerInsightSummary	the official description of codetype	Optional	Can be `true` or `false`

Note:

codeType determines which decoding logic is applied.
codes[] is always required.
Each item in codes[] must contain exactly one code.
id is optional and used only for client‑side correlation.
Maximum batch size is 25 items.