---
title: "Create a hosted KYC link — estimate"
method: POST
path: "/v1/messaging/phone-numbers/kyc/share/estimate"
tags: ["Phone Numbers"]
---

# Create a hosted KYC link — estimate

`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

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

## Request body

- object
  - `country` string, required: ISO 3166-1 alpha-2 country code (must be a regulated/KYC country).
  - `areaCode` string: 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).
  - `branding` object: Optional white-label of the hosted page the end customer sees.
    - `logoUrl` string, uri: Logo shown above the form.
    - `brandColor` string: Hex color (e.g. #1a73e8) used as a brand accent on the page.
    - `companyName` string: Your company name, shown on the hosted page.
  - `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_url` string, 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 `200`

Estimate

- Estimate
  - `operation` string
  - `estimated_credits` number
  - `credits_to_reserve` number
  - `estimated_usage` object
  - `note` string, nullable
  - `balance` object
    - `available` number
  - `sufficient` boolean

---

[API](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai.md) · [All operations](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/llms.txt) · [OpenAPI document](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/revisions/a8caa42835ce?raw)