Developer Portal · v1.9

Port phone numbers, everywhere.

Port, manage and track phone numbers across countries and providers — one API. Let your users keep their number when they switch — webhooks, a numbers registry, and a full audit trail behind one clean, provider-agnostic API.

Get started API Reference

Guides

01 Getting started Port your first number in five steps. Everything on this platform is API-first: anything you can do, you can do with an HTTP call and your API key. Read guide 02 Authentication Every request must carry an API key Read guide 03 Port-in orders A port-in order transfers numbers from their current carrier onto the platform. Orders are asynchronous: after submission, progress depends on the losing… Read guide 04 Porting walkthrough (full example) A complete, real port from start to finish — every request you send and every response you get back, porting the UK mobile number +447912345678. All… Read guide 05 Webhooks We push an event to your registered URLs whenever anything meaningful happens. Webhooks are the fast path; the events API is the queryable history behind… Read guide 06 Port-outs A port-out happens when another carrier — on behalf of the end user — requests one of your numbers. Regulations require these to be honored unless there is a… Read guide 07 Numbers registry The registry is the authoritative list of your numbers on the platform — think of it as your HLR: for every number, who owns it, which provider it lives on… Read guide 08 Events Every meaningful change is recorded as an immutable event — the same events that are pushed to your webhooks are queryable here forever. Use the events API… Read guide 09 Errors & idempotency Errors return a JSON body with a detail field — either a string or a structured object Read guide 10 Countries & requirements Porting rules are national. The platform routes each order to the right provider per country and attaches that country's legal requirements automatically… Read guide 11 Porting endpoint reference Every endpoint you need to port a number, in the order you will use them. Nothing else — account, API-key and admin management are covered by the… Read guide 12 Webhook event examples Every example on this page is a real delivery captured from a live run of the platform — a full port-in (including a review rejection and fix), a draft… Read guide 13 Sending SMS Once a port completes, the number is yours to use — starting with SMS. Send from any active or active_unconfigured number in your registry, receive inbound… Read guide 14 Call forwarding Once a number is active on the platform you can control where its calls go. Two independent rules per number Read guide