The Explain Address Code API returns a batch‑structured response. Each item in the
request corresponds to one entry in the results array, preserving order
and allowing item‑level status reporting.
Response Body
{
"responses": [
{
"id": "string",
"status": <STATUS_CODE>,
"result": {
response
}
}
]
}Field Details
| Field | Type | Description |
| codeType | String | Type of address code (e.g.,
GlobalMatchCode). |
| input | String | The original code submitted in the request. |
| officialDescription | Object | Detailed breakdown of verification, component match status, and confidence. (Structure omitted in your snippet but included in the actual API.) |
| customerInsightSummary | String | Human‑readable summary describing the verification outcome. |
| links | Object | Contains URLs related to documentation or additional resources. |
| version | String | API or response schema version. |
| generatedAt | String (ISO timestamp) | Timestamp when the response was generated. |