PortingExperimental
Get port-out details
Retrieves a single port-out, with its answer once given.
/profiles/{profileReference}/esims/{esimReference}/port-outs/{portOutRequestReference}Authorization
Authorization: Bearer {token} — an OAuth2 access token from the client-credentials flow. How authentication works
Path parameters
profileReferencestringrequiredProfile reference
esimReferencestringrequiredeSIM reference
portOutRequestReferencestringrequiredPort-out request reference
Responses
200Port-out detailsapplication/jsonShow response bodyHide response body
dataobjectoptionalShow propertiesHide properties
portOutRequestReferencestringPort-out request reference
profileReferencestringesimReferencestringmsisdnstringThe number leaving, in international format (E.164 without a leading +)
statusstringrequested: The recipient asked for the number; no answer yetapproved: The port-out was approved; the number leaves at the agreed moment. It can still be rejectedrejected: The port-out was rejected (seeanswer.reason); the number stayscancelled: The recipient cancelled; the number stayscompleted: The number left for the recipient. The only final status: a rejected, cancelled or failed port-out completes when the number left after allfailed: The port-out could not be carried out; the number stays
requestedapprovedrejectedcancelledcompletedfailedanswerone of approved | rejected | nullThe answer to the port-out; null until it has one
Show propertiesHide properties
approvedobjectoptionalShow propertiesHide properties
decisionstringansweredBystringExtensible enum. Who answered: client,
firsty (Firsty, when you did not answer), or provider (the network answers by itself).
clientfirstyprovideransweredAtstring · date-timerejectedobjectoptionalShow propertiesHide properties
decisionstringreasonobjectWhy the port-out was rejected
Show propertiesHide properties
codestringExtensible enum. The cause of the rejection, the same for every market.
not_portablecustomer_number_mismatchcustomer_number_unverifiedcontract_commitmentsim_number_mismatchothermessagestringThe cause in a sentence, for a person; free-form, not intended to be parsed
answeredBystringExtensible enum. Who answered: client,
firsty (Firsty, when you did not answer), or provider (the network answers by itself).
clientfirstyprovideransweredAtstring · date-timedetailsone of BE | NLExtensible by country: the market's own fields. Ignore a country you do not know.
Show propertiesHide properties
BEobjectoptionalA Belgian port-out. The network answers it and carries it out by itself.
Show propertiesHide properties
countrystringNLobjectoptionalA Dutch port-out. Answer it with POST .../port-outs/{portOutRequestReference}/answer before answerBefore; a port-out still unanswered shortly before gets a default answer from Firsty.
Show propertiesHide properties
countrystringcustomerIdstring | nullThe customer number the recipient sent, to check against the customer's; null when it sent none and the customer confirmed the request by SMS instead
contractActionstringExtensible enum. What the recipient asked
for the customer's contract here: terminate_at_expiry ends it where it can end, terminate_early ends it
even during a commitment, keep_with_new_number keeps it running on a new number.
terminate_at_expiryterminate_earlykeep_with_new_numbernotestring | nullThe recipient's note; null when it sent none
answerBeforestring · date-timeWhen the answer is due
firstPossibleAtstring | null · date-timeThe earliest moment the number can leave, once answered; null until then
createdAtstring · date-timeupdatedAtstring · date-timecompletedAtstring | null · date-timeWhen the number left; null until it has
cancelledAtstring | null · date-timeWhen the recipient cancelled; null unless it did
401Unauthorized - missing or invalid API key403Forbidden - client does not have access to this resource404Resource not found429Rate limit exceeded. A `429` can also arrive without these headers or this body; handle it by its status code.500Internal server error