ExplainAddressCode

Explain Address Codes

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
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

Headers

X-Request-Idstring

The X-Request-Id header is optional but incredibly useful for developers. It serves as a unique identifier for requests within our system. When you encounter any problems with your requests, providing us with the X-Request-Id will enable us to pinpoint the specific request in question without the need for extensive manual searching. This means faster and more efficient troubleshooting. The maximum allowed length is 38 characters.

Request body

codeTypestring required

Type of address code (e.g., GlobalMatchCode)

Example request

{
  "codeType": "GlobalMatchCode",
  "codes": [
    {
      "id": "1",
      "code": "V4-D4M0B0U0F0G0P4S4Q0X0A0T4E0R4W0Z4Y6C4-5"
    }
  ],
  "responseOptions": {
    "includeOfficialDescription": true
  }
}

Response

All address codes explained successfully

documentationLinkstring

URL to API documentation for interpreting the response and understanding code types

generatedAtstring

Response creation timestamp in ISO-8601 format

Example response

{
  "responses": [
    {
      "id": "1",
      "status": "OK",
      "result": {
        "codeType": "GlobalMatchCode",
        "customerInsightSummary": "Address premise verified with high confidence.",
        "officialDescription": {
          "addressMatchStatus": {
            "symbol": "V4",
            "status": "Verified",
            "verificationLevel": 4,
            "verificationLevelLabel": "Premise verified"
          },
          "componentMatchStatus": {
            "P": {
              "label": "Premise/House Number",
              "value": 4,
              "meaning": "Verified without changes"
            },
            "S": {
              "label": "Street",
              "value": 4,
              "meaning": "Verified without changes"
            },
            "Z": {
              "label": "Postcode/Zip Code",
              "value": 4,
              "meaning": "Verified without changes"
            },
            "C": {
              "label": "Country",
              "value": 4,
              "meaning": "Verified without changes"
            }
          },
          "matchConfidence": {
            "value": 5,
            "label": "High Confidence"
          }
        }
      },
      "errorMessage": "Invalid code format for GlobalMatchCode in the request (DIS-LI-1040): verification level must be 1-4"
    }
  ],
  "documentationLink": "https://help.cloud.precisely.com/r/t/1737727574924/2025-11-18/Precisely-Data-Integrity-Suite/disapi/Latest/en-US/Data-Integrity-Suite-APIs/Global-Match-Code",
  "generatedAt": "2025-12-18T13:48:29.842427575Z"
}

Changes

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