Validate Address and Return Suggestions

post

https://example.com/programs/{programCode}/AddressVerification

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.

Path Params

programCode

string

required

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

Body Params

The request payload containing address details to be verified.

addressLine1

string | null

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

addressLine2

string | null

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

city

string | null

Required. The city associated with the address.

state

string | null

Required. The state or province associated with the address.

zipCode

string | null

Required. The postal or zip code for the address.

Headers

X-GD-RequestId

string

required

The unique request identifier from the request header.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

text/json

200OK

403Forbidden

500Internal Server Error

503Service Unavailable