---
title: "Country porting requirements"
method: GET
path: "/v1/messaging/phone-numbers/port-in/requirements"
tags: ["Phone Numbers"]
---

# Country porting requirements

`GET /v1/messaging/phone-numbers/port-in/requirements`

## Request

- Base URL: `https://apihub.co.il`
- URL: `https://apihub.co.il/v1/messaging/phone-numbers/port-in/requirements`
- Auth: HTTP bearer

The country-specific information a port-in needs BEYOND the LOA,
invoice, and account/address details, such as an ID copy, proof of
address, a tax id, or a porting code. Call it after the portability
check (which returns each number's `countryCode` and
`phoneNumberType`), render the fields, and pass the collected values as
the create request's `requirements`. US/CA return an empty list.


**Billing:** Read (free unless it says otherwise) · **Rate limit:** 120/min

## Query parameters

- `country` string, required: ISO country of the numbers being ported (a supported port-in country).
- `numberType` 'local' | 'mobile' | 'national' | 'toll_free': The portability check's phoneNumberType. Requirements differ by type.

## Headers

- `Idempotency-Key` string
- `X-Tag` string

## Response `200`

Completed

- object
  - `id` string: Execution id — stable across internal retries; use it with GET /v1/executions/{id}
  - `status` 'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
  - `operation` string
  - `tag` string, nullable: Your X-Tag, if sent
  - `created_at` string, date-time
  - `completed_at` string, date-time, nullable
  - `output` object: Operation result (see each operation). While a Studio render is processing: `stage` (queued · transcribing · downloading · preparing · cleaning_voice · mixing_audio · rendering · finishing), `phase` (the engine's: download · prepare · voice · audio · encode · qa · upload, or null), `progress` (a percent, 0–100) and `progress_fraction` (0–1), `eta_seconds` (seconds left, never below 0) and `estimate_seconds`
    - `fields` object[]
      - `kind` 'text' | 'date' | 'address' | 'file' | 'action': text/date take a string value; file takes a documentId from the documents endpoint; address is satisfied automatically from the end-user service address.
      - `label` string
      - `description` string
      - `requirementId` string: Pass back as requirements[].requirementTypeId.
      - `acceptableValues` string[]: When present, the value must be one of these.
    - `country` string
    - `supported` boolean: false when the combination includes a step that can't be completed through the API (e.g. an in-person identity verification). Porting it needs support.
    - `numberType` string
  - `error` string, nullable
  - `usage` object
    - `credits_charged` number, nullable
    - `credits_reserved` number
    - `estimated_credits` number
    - `cost_source` 'provider_reported' | 'calculated' | 'estimated' | 'null', nullable
    - `provider_usage` object, nullable: Normalised consumption, e.g. { VIDEO_SECOND: 22.4 }
  - `balance` object
    - `available` number
    - `reserved` number

## Other responses

- `400`: Invalid input
- `402`: Insufficient credits / project budget
- `404`: Resource not found (or not yours)
- `429`: Rate limited
- `503`: Service temporarily paused

---

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