Transfer numbers in
Starts moving numbers from another carrier. US numbers need the account details exactly as on the bill and an uploaded bill (document_sids); the authorised person then signs by email. Other countries are handled by our team (assisted: true). Progress arrives as the number.port_in.updated webhook.
Scopes: number:write
Authorizations
An API key from Settings → API keys, sent as Authorization: Bearer kb_live_…. A workspace key starts kb_; a personal key starts kbp_ and acts as its owner.
Headers
A unique key (a UUID works) for this request. Retrying with the same key returns the first answer instead of running twice.
255The API version to answer as, a date (YYYY-MM-DD). Leave it out for the current version (2026-11-07). An unknown version is refused with 400 unsupported_api_version.
2026-11-07 "2026-11-07"
Body
The numbers' country, ISO 3166 alpha-2.
^[A-Z]{2}$The numbers to move in.
1 - 50 elementsThe carrier they leave.
1 - 120The date you'd like them moved (not guaranteed).
US numbers: the account exactly as it appears on the bill.
US numbers: the uploaded bill (document_sid).
5Anything our team should know.
1000Response
Successful Response
The transfer id.
Where the transfer stands.
Our team runs it with your carrier (outside the US).
The carrier receiving the numbers.
The numbers and their status.
ISO 8601.
ISO 8601.
The carrier's reference.
The carrier the numbers leave.
The date asked for (YYYY-MM-DD).
The status in plain words.
Why it failed.
When the numbers arrived.