Authorizations
An API key that grants access to the Connect API. You can create and manage API keys in the portal.
Headers
A unique key to ensure idempotency of requests. If a request with the same key has already been processed, the same result will be returned. The key must be unique for each distinct operation. Keys are expired after 24 hours, but we recommend using a new key for each request.
Modified requests with the same idempotency keys are rejected with a 409 Conflict status code.
256Body
Address to validate.
Request to validate an address.
Response
Address validation completed.
Result of address validation with optional suggestions.
Depending on setup, address validation is either shape based (e.g. this looks like an address), or verified against an address registry.
Whether the provided address is valid.
false
If provided, a suggestion for a corrected address by the underlying address validation service.
Do note that this may be returned for seemingly valid addresses, where the network has a more precise or standardized version of the address. A typical example of this is the address is found in the networks' registry but under a different name because it contains aliases or minor formatting issues, mistyped zip codes, etc.
Additional validation details.
{
"issues": [
{
"message": "Missing city",
"property": "city"
},
{
"message": "Invalid zip format",
"property": "zip"
}
]
}