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

# Country porting requirements

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

The country-specific information a port-in needs BEYOND the LOA,
invoice, and account/address details — e.g. 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.

## Query parameters

- `country` string, required
- `numberType` 'local' | 'mobile' | 'national' | 'toll_free'

## Response `200`

Requirement fields for the country/type combination.

- object
  - `country` string
  - `numberType` 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.
  - `fields` object[]
    - `requirementId` string — Pass back as requirements[].requirementTypeId.
    - `label` string
    - `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.
    - `description` string
    - `example` string
    - `acceptableValues` string[] — When present, the value must be one of these.

## Other responses

- `400` — Invalid request
- `401` — Unauthorized
- `422` — Country not supported for port-in

---

[API](https://skmtc.net/zernio/apis/zernio-api.md) · [All operations](https://skmtc.net/zernio/apis/zernio-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zernio/zernio-api/revisions/15e893e69e8c/schema)