Create a transfer request

post

https://api.emaktalk.com/api/v1/numbers/transfers

Starts a request to transfer numbers in from your current carrier, created with status requested. Porting is a multi-day process agreed with the losing carrier: nothing changes on the numbers now, they keep working on your existing service until the transfer completes, and the details you send must match the losing carrier's records exactly or the port is rejected later. Submitting also emails our operations team and your notification addresses. The bill upload, the request and its numbers are written in separate steps, so a failure partway can leave a partial request behind — list your transfer requests before retrying. Requires an API key with the Admin role.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

carrier_name

string

required

Name of the carrier the numbers are transferring away from. Required and non-empty.

account_number

string

required

Your account number with that carrier, exactly as it appears on the bill.

account_holder_name

string

required

Account holder name as the losing carrier has it on file.

authorized_signature

string

required

Typed signature of the person authorizing the transfer.

street_number

string

required

Street number of the service address on file with the losing carrier.

street_name

string

required

Street name of that service address.

city

string

required

City of that service address.

province_state

string

required

Province or state of that service address.

postal_zip_code

string

required

Postal or ZIP code of that service address.

floor

string

Floor of the service address. Trimmed, and an empty value is stored as none.

suite_apt

string

Suite or apartment of the service address. Trimmed, and an empty value is stored as none.

preferred_date

string | null

The date you would like the transfer to complete. A preference, not a commitment, and the format is not validated.

preferred_time

string

The time of day you would prefer. Trimmed, and labeled as Eastern time in the notification.

bill_invoice_date

string

Invoice date of the bill you are supplying. An empty value is stored as none.

bill_confidence

string

enum

How current you believe the bill details are: high, medium or low. Not checked against that list at runtime.

Allowed:

notification_emails

array of strings

Addresses to notify about this request. Defaults to the identity your key authenticated as.

notification_emails

numbers

array of objects

required

The numbers this request covers. Must be non-empty and include at least one entry with action set to transfer. Each entry needs a non-empty did (no format checking), an action of transfer, disconnect or keep, and may carry optional portable, ocn, losing_carrier, rate_center, tier and monthly_fee metadata that defaults to none.

numbers*

bill_file_base64

string

Your most recent bill from the losing carrier, base64-encoded. It is uploaded only when bill_file_mime_type is sent as well.

bill_file_mime_type

string

MIME type of the uploaded bill. Required for the upload to happen at all.

bill_file_name

string

Accepted but not used.

Responses

401

Missing or invalid API key.

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The transfer request and its number rows were created with status requested.

400A required field was missing, or the numbers list was empty or had no transfer action.

403Requires an API key with the Admin role.

500The body could not be parsed, the bill upload failed, or the request could not be saved.