---
title: "Validate Address and Return Suggestions"
method: POST
path: "/programs/{programCode}/AddressVerification"
tags: ["ContactVerification"]
---

# Validate Address and Return Suggestions

`POST /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 parameters

- `programCode` string, required

## Headers

- `X-GD-RequestId` string, required

## Request body

- AddressVerificationRequest — Represents a request to verify an address. Contains address details such as address lines, city, state, and zip code. Inherits standard request metadata from Gd.Bos.DataTransfer.Request.RequestBase.
  - `addressLine1` string, nullable — Required. The first line of the address (e.g., street address).
  - `addressLine2` string, nullable — Optional. The second line of the address (e.g., apartment, suite, unit, building, floor, etc.).
  - `city` string, nullable — Required. The city associated with the address.
  - `state` string, nullable — Required. The state or province associated with the address.
  - `zipCode` string, nullable — Required. The postal or zip code for the address.

## Response `200`

OK

- AddressVerificationResponse — Represents the response for address verification, including a list of possible addresses, validity status, and the match level.
  - `addresses` GenericAddress[], nullable — Gets or sets the list of possible addresses returned from the verification process.
    - `addressLine1` string, nullable — Gets or sets the first line of the address.
    - `addressLine2` string, nullable — Gets or sets the second line of the address.
    - `city` string, nullable — Gets or sets the city of the address.
    - `state` string, nullable — Gets or sets the state or province of the address.
    - `zipCode` string, nullable — Gets or sets the ZIP or postal code of the address.
    - `countryCode` string, nullable — Gets or sets the country code of the address.
    - `type` string, nullable — Gets or sets the type of the address (e.g., home, work).
  - `isValidAddress` boolean — Gets or sets a value indicating whether the provided address is valid.
  - `matchLevel` string, nullable — Gets or sets the level of match for the address verification (e.g., "Exact", "Partial").
  - `responseDetails` ResponseDetail[], nullable — Required: A list of response details providing status codes, descriptions, and additional information about the result of the operation.
    - `code` integer — The primary status or error code for the response (e.g., 200 for success, 400 for validation error).
    - `subCode` integer, nullable — An optional subcode providing more granular detail about the response or error.
    - `description` string, nullable — A human-readable description of the response, error, or status.
    - `url` string, nullable — A URL linking to documentation or a web page with more information about the response code.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error
- `503` — Service Unavailable

---

[API](https://skmtc.net/greendot/apis/baas-apis.md) · [All operations](https://skmtc.net/greendot/apis/baas-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/greendot/baas-apis/revisions/666553766b78/schema)