v1

latestOpenAPI 3.0.12026-07-243407211.3 MB

ContactVerification

Validate Address and Return Suggestions

Validates the provided address for a given program and returns a list of suggested addresses and address validity indicators. This endpoint may be called to mitigate returned mail issues.

post/programs/{programCode}/AddressVerification

Path parameters

programCodestring required

The code of the program for which address verification is performed.

Headers

X-GD-RequestIdstring required

The unique request identifier from the request header.

Request body

addressLine1string nullable

Required. The first line of the address (e.g., street address).

addressLine2string nullable

Optional. The second line of the address (e.g., apartment, suite, unit, building, floor, etc.).

citystring nullable

Required. The city associated with the address.

statestring nullable

Required. The state or province associated with the address.

zipCodestring nullable

Required. The postal or zip code for the address.

Response

isValidAddressboolean

Gets or sets a value indicating whether the provided address is valid.

matchLevelstring nullable

Gets or sets the level of match for the address verification (e.g., "Exact", "Partial").