Webhooks
Porting events
Signed POST requests to your webhook endpoint for port-in and port-out events. See the Webhooks overview for signature verification.
Triggered when a port-in has been submitted to the network. A port-in can be submitted more than once under the same portInRequestReference; each submission replaces the previous one and triggers this event again.
Payload
typestringportin.submittedtimestampstring · date-timeWhen the event was recorded. This can be later than the change it reports: usage reported by the network can describe consumption that happened earlier.
dataobjectShow propertiesHide properties
portInRequestReferencestringPort-in request reference
profileReferencestringesimReferencestringmsisdnstringThe number being ported, in international format (E.164 without a leading +)
statusstringrequested: Accepted by Firsty; submission to the network in progressapproved: The donor accepted the port;scheduledAtis the earliest moment the number can move, once known, which can be days ahead. When that moment has already passed, the number moves right after the approval. The port finishes atcompletedcancelling: Cancellation requested, awaiting the network's confirmationcompleted: The donor released the number and it is assigned to this SIMrejected: Donor rejected the request (seereason); submit a corrected request or abandon (see the Porting workflow). A rejection the customer can still correct may keep the requestrequesteduntil it is finalfailed: Port failed (seereason); submit a corrected request or abandon (see the Porting workflow)cancelled: Cancellation confirmed; submit a corrected request or abandon (see the Porting workflow)
requestedapprovedcancellingcompletedrejectedfailedcancelledTriggered when the donor operator approved the port-in.
Payload
typestringportin.approvedtimestampstring · date-timeWhen the event was recorded. This can be later than the change it reports: usage reported by the network can describe consumption that happened earlier.
dataobjectShow propertiesHide properties
portInRequestReferencestringPort-in request reference
profileReferencestringesimReferencestringmsisdnstringThe number being ported, in international format (E.164 without a leading +)
statusstringrequested: Accepted by Firsty; submission to the network in progressapproved: The donor accepted the port;scheduledAtis the earliest moment the number can move, once known, which can be days ahead. When that moment has already passed, the number moves right after the approval. The port finishes atcompletedcancelling: Cancellation requested, awaiting the network's confirmationcompleted: The donor released the number and it is assigned to this SIMrejected: Donor rejected the request (seereason); submit a corrected request or abandon (see the Porting workflow). A rejection the customer can still correct may keep the requestrequesteduntil it is finalfailed: Port failed (seereason); submit a corrected request or abandon (see the Porting workflow)cancelled: Cancellation confirmed; submit a corrected request or abandon (see the Porting workflow)
requestedapprovedcancellingcompletedrejectedfailedcancelledscheduledAtstring | null · date-timeWhen the number moves to this SIM, as the donor agreed or, on portin.rescheduled, as you moved it; null when the network gives no date. It may move until the port completes
Triggered when an approved port-in is moved to a new porting moment; scheduledAt carries the new moment.
Payload
typestringportin.rescheduledtimestampstring · date-timeWhen the event was recorded. This can be later than the change it reports: usage reported by the network can describe consumption that happened earlier.
dataobjectShow propertiesHide properties
portInRequestReferencestringPort-in request reference
profileReferencestringesimReferencestringmsisdnstringThe number being ported, in international format (E.164 without a leading +)
statusstringrequested: Accepted by Firsty; submission to the network in progressapproved: The donor accepted the port;scheduledAtis the earliest moment the number can move, once known, which can be days ahead. When that moment has already passed, the number moves right after the approval. The port finishes atcompletedcancelling: Cancellation requested, awaiting the network's confirmationcompleted: The donor released the number and it is assigned to this SIMrejected: Donor rejected the request (seereason); submit a corrected request or abandon (see the Porting workflow). A rejection the customer can still correct may keep the requestrequesteduntil it is finalfailed: Port failed (seereason); submit a corrected request or abandon (see the Porting workflow)cancelled: Cancellation confirmed; submit a corrected request or abandon (see the Porting workflow)
requestedapprovedcancellingcompletedrejectedfailedcancelledscheduledAtstring | null · date-timeWhen the number moves to this SIM, as the donor agreed or, on portin.rescheduled, as you moved it; null when the network gives no date. It may move until the port completes
Triggered when the donor operator rejected the port-in. Submit a corrected request or abandon (see the Porting workflow).
Payload
typestringportin.rejectedtimestampstring · date-timeWhen the event was recorded. This can be later than the change it reports: usage reported by the network can describe consumption that happened earlier.
dataobjectShow propertiesHide properties
portInRequestReferencestringPort-in request reference
profileReferencestringesimReferencestringmsisdnstringThe number being ported, in international format (E.164 without a leading +)
statusstringrequested: Accepted by Firsty; submission to the network in progressapproved: The donor accepted the port;scheduledAtis the earliest moment the number can move, once known, which can be days ahead. When that moment has already passed, the number moves right after the approval. The port finishes atcompletedcancelling: Cancellation requested, awaiting the network's confirmationcompleted: The donor released the number and it is assigned to this SIMrejected: Donor rejected the request (seereason); submit a corrected request or abandon (see the Porting workflow). A rejection the customer can still correct may keep the requestrequesteduntil it is finalfailed: Port failed (seereason); submit a corrected request or abandon (see the Porting workflow)cancelled: Cancellation confirmed; submit a corrected request or abandon (see the Porting workflow)
requestedapprovedcancellingcompletedrejectedfailedcancelledreasonobjectWhy the port-in was rejected or failed. Present when status is rejected or failed, and on a requested port-in the donor has rejected for a reason the customer can still correct
Show propertiesHide properties
codestringNormalized cause of the rejection or failure, the same in every country. provider_failure covers every cause without a more specific code. The list of values is open-ended; new values may be added
msisdn_sim_mismatchmsisdn_account_mismatchdonor_contract_type_mismatchnumber_not_activenumber_not_portablenumber_porting_in_progressporting_window_unavailableprovider_failuremessagestring | nullHuman-readable detail of the cause for support; free-form, not intended to be parsed. Null when there is none
Triggered when the port completed: the donor released the number and it is assigned to the SIM.
Payload
typestringportin.completedtimestampstring · date-timeWhen the event was recorded. This can be later than the change it reports: usage reported by the network can describe consumption that happened earlier.
dataobjectShow propertiesHide properties
portInRequestReferencestringPort-in request reference
profileReferencestringesimReferencestringmsisdnstringThe number being ported, in international format (E.164 without a leading +)
statusstringrequested: Accepted by Firsty; submission to the network in progressapproved: The donor accepted the port;scheduledAtis the earliest moment the number can move, once known, which can be days ahead. When that moment has already passed, the number moves right after the approval. The port finishes atcompletedcancelling: Cancellation requested, awaiting the network's confirmationcompleted: The donor released the number and it is assigned to this SIMrejected: Donor rejected the request (seereason); submit a corrected request or abandon (see the Porting workflow). A rejection the customer can still correct may keep the requestrequesteduntil it is finalfailed: Port failed (seereason); submit a corrected request or abandon (see the Porting workflow)cancelled: Cancellation confirmed; submit a corrected request or abandon (see the Porting workflow)
requestedapprovedcancellingcompletedrejectedfailedcancelledTriggered when the port-in failed. Submit a corrected request or abandon (see the Porting workflow).
Payload
typestringportin.failedtimestampstring · date-timeWhen the event was recorded. This can be later than the change it reports: usage reported by the network can describe consumption that happened earlier.
dataobjectShow propertiesHide properties
portInRequestReferencestringPort-in request reference
profileReferencestringesimReferencestringmsisdnstringThe number being ported, in international format (E.164 without a leading +)
statusstringrequested: Accepted by Firsty; submission to the network in progressapproved: The donor accepted the port;scheduledAtis the earliest moment the number can move, once known, which can be days ahead. When that moment has already passed, the number moves right after the approval. The port finishes atcompletedcancelling: Cancellation requested, awaiting the network's confirmationcompleted: The donor released the number and it is assigned to this SIMrejected: Donor rejected the request (seereason); submit a corrected request or abandon (see the Porting workflow). A rejection the customer can still correct may keep the requestrequesteduntil it is finalfailed: Port failed (seereason); submit a corrected request or abandon (see the Porting workflow)cancelled: Cancellation confirmed; submit a corrected request or abandon (see the Porting workflow)
requestedapprovedcancellingcompletedrejectedfailedcancelledreasonobjectWhy the port-in was rejected or failed. Present when status is rejected or failed, and on a requested port-in the donor has rejected for a reason the customer can still correct
Show propertiesHide properties
codestringNormalized cause of the rejection or failure, the same in every country. provider_failure covers every cause without a more specific code. The list of values is open-ended; new values may be added
msisdn_sim_mismatchmsisdn_account_mismatchdonor_contract_type_mismatchnumber_not_activenumber_not_portablenumber_porting_in_progressporting_window_unavailableprovider_failuremessagestring | nullHuman-readable detail of the cause for support; free-form, not intended to be parsed. Null when there is none
Triggered when a requested cancellation was confirmed by the network.
Payload
typestringportin.cancelledtimestampstring · date-timeWhen the event was recorded. This can be later than the change it reports: usage reported by the network can describe consumption that happened earlier.
dataobjectShow propertiesHide properties
portInRequestReferencestringPort-in request reference
profileReferencestringesimReferencestringmsisdnstringThe number being ported, in international format (E.164 without a leading +)
statusstringrequested: Accepted by Firsty; submission to the network in progressapproved: The donor accepted the port;scheduledAtis the earliest moment the number can move, once known, which can be days ahead. When that moment has already passed, the number moves right after the approval. The port finishes atcompletedcancelling: Cancellation requested, awaiting the network's confirmationcompleted: The donor released the number and it is assigned to this SIMrejected: Donor rejected the request (seereason); submit a corrected request or abandon (see the Porting workflow). A rejection the customer can still correct may keep the requestrequesteduntil it is finalfailed: Port failed (seereason); submit a corrected request or abandon (see the Porting workflow)cancelled: Cancellation confirmed; submit a corrected request or abandon (see the Porting workflow)
requestedapprovedcancellingcompletedrejectedfailedcancelledTriggered when the recipient asks for one of your numbers. A port-out that carries details.answerBefore must be answered before that moment (see Answer a port-out); one without it needs no answer.
Payload
typestringportout.requestedtimestampstring · date-timeWhen the event was recorded. This can be later than the change it reports: usage reported by the network can describe consumption that happened earlier.
dataobjectShow 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
Triggered when the port-out was approved; the number leaves at the agreed moment.
Payload
typestringportout.approvedtimestampstring · date-timeWhen the event was recorded. This can be later than the change it reports: usage reported by the network can describe consumption that happened earlier.
dataobjectShow 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
Triggered when the port-out was rejected; the number stays.
Payload
typestringportout.rejectedtimestampstring · date-timeWhen the event was recorded. This can be later than the change it reports: usage reported by the network can describe consumption that happened earlier.
dataobjectShow 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
Triggered when the recipient cancelled the port-out; the number stays.
Payload
typestringportout.cancelledtimestampstring · date-timeWhen the event was recorded. This can be later than the change it reports: usage reported by the network can describe consumption that happened earlier.
dataobjectShow 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
Triggered when the number left for the recipient. The SIM is terminated with it, and esim.lifecycle.terminated follows. It can follow portout.rejected or portout.cancelled when the number left after all.
Payload
typestringportout.completedtimestampstring · date-timeWhen the event was recorded. This can be later than the change it reports: usage reported by the network can describe consumption that happened earlier.
dataobjectShow 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
Triggered when the network reports that the port-out could not be carried out; the number stays.
Payload
typestringportout.failedtimestampstring · date-timeWhen the event was recorded. This can be later than the change it reports: usage reported by the network can describe consumption that happened earlier.
dataobjectShow 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