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).

Billing: Request; paid actions are priced in credits (see GET /v1/messaging/prices) · Rate limit: 60/min

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

Request

Base URL: https://apihub.co.il
URL: https://apihub.co.il/v1/messaging/phone-numbers/kyc/validate-address
Auth: HTTP bearer

Headers

Idempotency-Keystring

Replay-safe: the same execution is returned instead of charging twice

X-Tagstring

Group calls into one job (e.g. one video) — see GET /v1/usage?tag=…

Request body

countrystring required

ISO 3166-1 alpha-2 country code.

localitystring required

City / town.

postal_codestring required

street_addressstring required

extended_addressstring

Address complement: apartment, suite, unit, or the quadra/lote used in some countries. Optional. Does not substitute for a building number on street_address.

administrative_areastring

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

Response

Completed

idstring

Execution id — stable across internal retries; use it with GET /v1/executions/{id}

operationstring

tagstring nullable

Your X-Tag, if sent

created_atstring date-time

completed_atstring date-time nullable

errorstring nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.