See below for sample requests and responses for each supported code type.
Global Match Code
Request Example:
{
"codeType": "GlobalMatchCode",
"items": [
{ "id": "1", "code": "V4-P4S4A0T4R6Z4C4-5" }
],
"responseOptions": { "includeOfficialDescription": true }
}Response Example:
{
"results": [
{
"id": "1",
"status": 200,
"data": {
"codeType": "GlobalMatchCode",
"input": "V4-P4S4A0T4R6Z4C4-5",
"officialDescription": { ... },
"customerInsightSummary": "Address verified at the premise level with high confidence. Region was appended from reference data.",
"links": { "documentation": "https://docs.precisely.com/.../address_verification_global_match_code.html" },
"version": "1.0.0",
"generatedAt": "2025-11-24T00:00:00Z"
}
}
]
}Global Location Code
Request Example:
{
"codeType": "GlobalLocationCode",
"items": [ { "id": "1", "code": "662" } ],
"responseOptions": { "includeOfficialDescription": true, "includeExplanationList": true }
}Response Example:
{
"results": [
{
"id": "1",
"status": 200,
"data": {
"codeType": "GlobalLocationCode",
"input": "662",
"officialDescription": { ... },
"customerInsightSummary": "This geocode pinpoints an address inside the building footprint (building-level accuracy).",
"explanationList": [ ... ],
"links": { "documentation": "https://docs.precisely.com/.../global_location_codes_glc.html" },
"version": "1.0.0",
"generatedAt": "2025-11-06T00:00:00Z"
}
}
]
}Global Delivery Indicator
Request Example:
{
"codeType": "GlobalDeliveryIndicator",
"items": [ { "id": "1", "code": "4" } ],
"responseOptions": { "includeOfficialDescription": true, "includeExplanationList": true }
}Response Example:
{
"results": [
{
"id": "1",
"status": 200,
"data": {
"codeType": "GlobalDeliveryIndicator",
"input": "4",
"officialDescription": { ... },
"customerInsightSummary": "Mail can be delivered, but it does not map to a physical location (e.g., PO Box).",
"explanationList": [ ... ],
"links": { "documentation": "https://docs.precisely.com/.../global_delivery_indicator.html" },
"version": "1.0.0",
"generatedAt": "2025-11-07T00:00:00Z"
}
}
]
}Forward Result Code
Request Example:
{
"codeType": "ForwardResultCode",
"codes": [
{
"id": "1",
"code": "S8HPNTSCZA"
}
],
"responseOptions": {
"includeOfficialDescription": true
}
}Response Example:
{
"responses": [
{
"id": "1",
"status": "OK",
"result": {
"codeType": "ForwardResultCode",
"customerInsightSummary": "Precise address-point (rooftop) match with full component agreement across house number, street, city, and postal code.",
"officialDescription": {
"code": "S8HPNTSCZA",
"matchType": "Street",
"accuracy": {
"level": "8",
"label": "Exact address point",
"customerInsight": "Precise address-point (rooftop) match."
},
"components": [
{ "flag": "H", "description": "House number match", "matched": true },
{ "flag": "P", "description": "Street prefix match", "matched": true },
{ "flag": "N", "description": "Street name match", "matched": true },
{ "flag": "T", "description": "Street type match", "matched": true },
{ "flag": "S", "description": "Street suffix match", "matched": true },
{ "flag": "C", "description": "City/Town match", "matched": true },
{ "flag": "Z", "description": "Postal code match", "matched": true },
{ "flag": "A", "description": "Address Dictionary match", "matched": true }
]
}
}
}
],
"documentationLink": "https://help.precisely.com/r/t/1029715567/2025-08-06/Geo-Addressing-SDK/pub/5.0/en-US/Geo-Addressing-SDK-Developer-Guide/Forward-Geocoding-Result-Codes?tocId=ahMbr7cMxq9AO2zWRlL4zw",
"generatedAt": "2026-03-18T10:15:30.000000000Z"
}Reverse Result Code
Request Example:
{
"codeType": "ReverseResultCode",
"codes": [
{
"id": "1",
"code": "RS8A"
}
],
"responseOptions": {
"includeOfficialDescription": true
}
}Response Example:
{
"responses": [
{
"id": "1",
"status": "OK",
"result": {
"codeType": "ReverseResultCode",
"customerInsightSummary": "High confidence match to building or parcel centroid with accurate reference data.",
"officialDescription": {
"code": "RS8A",
"matchType": "Street",
"precision": {
"level": "8",
"label": "Building/Parcel",
"customerInsight": "Match to building or parcel centroid",
"accuracyRange": "10-25 meters"
},
"quality": {
"grade": "A",
"label": "High Quality",
"customerInsight": "High confidence match with accurate reference data",
"confidence": "95-100%"
}
}
}
}
],
"documentationLink": "https://help.precisely.com/r/t/1029715570/2025-08-06/Geo-Addressing-SDK/pub/5.0/en-US/Geo-Addressing-SDK-Developer-Guide/Reverse-Geocoding-R-Result-Codes?tocId=s2w5tVdrP~n_qrw3OFMWrQ",
"generatedAt": "2026-03-18T10:20:00.000000000Z"
}