v7

latestOpenAPI 3.0.0raw.githubusercontent.com2026-06-121372601.5 MB
Standard API

Returns up to 3 verified address suggestions for a given input address.

Useful as a fallback when POST /verifications returns a failed status — suggestions represent the closest matches found and may help the user identify the correct address.

Accepts the same freeform or structured input formats as POST /verifications.

  • Uses 1 lookup per call (plus 1 more if geocoding).
post/v1/addver/suggestions

Query parameters

includeDetailsboolean
properCaseboolean
geocodeboolean

Request body

OR

Response

The request has succeeded.

status'success' | 'error' required
messagestring required