---
title: "Explain Address Codes"
method: POST
path: "/v1/explain-addresscode"
tags: ["ExplainAddressCode"]
---

# Explain Address Codes

`POST /v1/explain-addresscode`

## Request

- Base URL: `https://api.cloud.precisely.com`
- URL: `https://api.cloud.precisely.com/v1/explain-addresscode`
- Auth: one of:
  - HTTP bearer
  - API key in header `Authorization`

Precisely ExplainAddressCode is an API that decodes proprietary Precisely address intelligence codes into structured, human-readable descriptions.

**Supported code systems:**
- Global Match Code (GMC)
- Global Location Code (GLC)
- Global Delivery Indicator (GDI)
- Forward Result Code (FRC)
- Reverse Result Code (RRC)

**The API generates:**
- Machine-readable structured fields
- Human-friendly descriptions
- Customizable insight summaries
- Official Explain Codes
- Supporting metadata

## Headers

- `X-Request-Id` string

## Request body

- ExplainAddressCodeRequest: Request to explain one or more address codes
  - `codeType` string, required: Type of address code (e.g., GlobalMatchCode)
  - `codes` ExplainAddressCodeItemRequest[], required: List of address codes to explain
    - `id` string, nullable: Optional identifier for mapping responses to requests
    - `code` string, required: The address code to explain
  - `responseOptions` ResponseOptions: Options for controlling response details
    - `includeOfficialDescription` boolean: Whether to include official description in output

## Response `200`

All address codes explained successfully

- ExplainAddressCodeResponse: Response containing explained address codes with insights and metadata
  - `responses` ExplainAddressCodeResponseItem[]: List of responses corresponding to each code in the request
    - `id` string, nullable: Optional client-provided identifier for correlation
    - `status` 'OK' | 'ERROR' | 'INVALID_REQUEST', required: Decode operation status
    - `result` ExplainResult: Decoded address code result
      - `codeType` string: Type of address code
      - `customerInsightSummary` string: Customer insight summary
      - `officialDescription` object, nullable: Official technical description (when requested)
    - `errorMessage` string, nullable: Error message if decoding failed
  - `documentationLink` string: URL to API documentation for interpreting the response and understanding code types
  - `generatedAt` string: Response creation timestamp in ISO-8601 format

## Other responses

- `206`: Address codes explained partially (some failed)
- `400`: Invalid request - bad codeType, batch size exceeded, or all codes failed validation
- `401`: Unauthorized: Invalid token
- `403`: Forbidden
- `413`: Request entity too large
- `429`: Too many requests
- `500`: Internal server error
- `503`: Service unavailable

---

[API](https://skmtc.dev/precisely/apis/geo-addressing-api.md) · [All operations](https://skmtc.dev/precisely/apis/geo-addressing-api/llms.txt) · [OpenAPI document](https://skmtc.dev/precisely/apis/geo-addressing-api/revisions/d985d4737abe?raw)