Country porting 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.
API key authentication - use your Zernio API key as a Bearer token
In: header
Query Parameters
ISO country of the numbers being ported (a supported port-in country).
2 <= length <= 2The portability check's phoneNumberType — requirements differ by type.
"local""local" | "mobile" | "national" | "toll_free"Response Body
application/json
application/json
application/json
import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.phonenumbers.getPhoneNumberPortInRequirements({ query: { country: 'string', },});console.log(data);{
"country": "string",
"numberType": "string",
"supported": true,
"fields": [
{
"requirementId": "string",
"label": "string",
"kind": "text",
"description": "string",
"example": "string",
"acceptableValues": [
"string"
]
}
]
}{
"error": "string",
"type": "invalid_request_error",
"code": "string",
"param": "string",
"platform": "string",
"platformError": {},
"details": {}
}{
"error": "Unauthorized"
}A port-in order's pending requirements GET
The live requirements on an EXISTING porting order: which are filled, which are still pending, and which bounced on review (`requirement-info-exception`). Use it to fix and resubmit a rejected international port. Same field shape as the country-level requirements endpoint, plus per-requirement status.
Get declined requirements GET
For a number in `regulatory_declined`, returns ONLY the requirements the reviewer flagged declined, as a form spec (same shape as the KYC form GET). The customer fixes just those — Telnyx supports correcting a declined requirement group and re-submitting it (no new number/group). Falls back to the full spec if the provider exposes no per-requirement flags.