v2

latestOpenAPI 3.1.02026-08-075421692.0 MB

Phone Numbers

Pre-validate KYC address

Optional early check for the address step of a Tier 4 (end-user identity) registration: validates a postal address for deliverability BEFORE the full KYC submit, so it can be corrected before any documents are uploaded. The full submit (POST /v1/phone-numbers/kyc) re-validates the address, so this call is purely a fast feedback path and skipping it is safe. Only the postal address is sent (no documents, no gov-ID fields). A region (administrative_area) is required by the validator; when it is omitted the pre-check is skipped and { ok: true, skipped: true } is returned (the final submit still validates).

post/v1/phone-numbers/kyc/validate-address

Request body

countrystring required

ISO 3166-1 alpha-2 country code.

street_addressstring required

localitystring required

City / town.

administrative_areastring

State / province / region. When omitted, the pre-check is skipped (the final submit still validates).

postal_codestring required

Response

Address is deliverable, or the pre-check was skipped (no region supplied).

okboolean

skippedboolean

true when no administrative_area was supplied, so no pre-check ran.

Example response

{
  "ok": true
}