Firsty

Search...

Search...

PortingExperimental

Get port-out details

Retrieves a single port-out, with its answer once given.

get/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

profileReferencestringrequired

Profile reference

esimReferencestringrequired

eSIM reference

portOutRequestReferencestringrequired

Port-out request reference

Responses

200Port-out detailsapplication/json
Show response body
dataobjectoptional
Show properties
portOutRequestReferencestring

Port-out request reference

profileReferencestring
esimReferencestring
msisdnstring

The number leaving, in international format (E.164 without a leading +)

statusstring

Extensible enum.

  • requested: The recipient asked for the number; no answer yet
  • approved: The port-out was approved; the number leaves at the agreed moment. It can still be rejected
  • rejected: The port-out was rejected (see answer.reason); the number stays
  • cancelled: The recipient cancelled; the number stays
  • completed: The number left for the recipient. The only final status: a rejected, cancelled or failed port-out completes when the number left after all
  • failed: The port-out could not be carried out; the number stays
Examplesrequestedapprovedrejectedcancelledcompletedfailed
answerone of approved | rejected | null

The answer to the port-out; null until it has one

Show properties
approvedobjectoptional
Show properties
decisionstring
answeredBystring

Extensible enum. Who answered: client, firsty (Firsty, when you did not answer), or provider (the network answers by itself).

Examplesclientfirstyprovider
answeredAtstring · date-time
rejectedobjectoptional
Show properties
decisionstring
reasonobject

Why the port-out was rejected

Show properties
codestring

Extensible enum. The cause of the rejection, the same for every market.

Examplesnot_portablecustomer_number_mismatchcustomer_number_unverifiedcontract_commitmentsim_number_mismatchother
messagestring

The cause in a sentence, for a person; free-form, not intended to be parsed

answeredBystring

Extensible enum. Who answered: client, firsty (Firsty, when you did not answer), or provider (the network answers by itself).

Examplesclientfirstyprovider
answeredAtstring · date-time
detailsone of BE | NL

Extensible by country: the market's own fields. Ignore a country you do not know.

Show properties
BEobjectoptional

A Belgian port-out. The network answers it and carries it out by itself.

Show properties
countrystring
NLobjectoptional

A 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 properties
countrystring
customerIdstring | null

The 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

contractActionstring

Extensible 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.

Examplesterminate_at_expiryterminate_earlykeep_with_new_number
notestring | null

The recipient's note; null when it sent none

answerBeforestring · date-time

When the answer is due

firstPossibleAtstring | null · date-time

The earliest moment the number can leave, once answered; null until then

createdAtstring · date-time
updatedAtstring · date-time
completedAtstring | null · date-time

When the number left; null until it has

cancelledAtstring | null · date-time

When 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