Phone Numbers

Create a hosted KYC link — estimate

Price the request without executing it. Same body as POST /v1/messaging/phone-numbers/kyc/share.

post/v1/messaging/phone-numbers/kyc/share/estimate

Request

  • Base URL: https://apihub.co.il
  • URL: https://apihub.co.il/v1/messaging/phone-numbers/kyc/share/estimate
  • Auth: HTTP bearer

Request body

countrystring required

ISO 3166-1 alpha-2 country code (must be a regulated/KYC country).

areaCodestring

Area code (NDC) the eventual number must be in. Hard constraint carried by the link; the end customer filling the form makes no area choice. Options come from GET /v1/phone-numbers/availability (areaOptions).

language'en' | 'es' | 'pt-BR'

Language of the hosted page: its copy, the carrier requirement texts (translated once per country and cached), the pre-submit review notes and the status emails to the end customer. Omitted: the browser language of the end customer, falling back to English. The end customer can also switch with ?lang= on the page.

redirect_urlstring uri

Where to send the end customer's browser after a successful submit. On completion Zernio appends kyc=submitted and country=<ISO-2> as query params. When omitted, the hosted page shows a built-in confirmation screen instead.

Response

Estimate

operationstring
estimated_creditsnumber
credits_to_reservenumber
estimated_usageobject
notestring nullable
sufficientboolean

Changes

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