Firsty

Search...

Search...

Porting

List port-in requests

Experimental. This endpoint is still settling — its request and response shape may change without a deprecation cycle.

Lists all port-in requests for the eSIM, newest first. Corrected requests after a rejection/failure are separate entries — the list is the request history.

get/profiles/{profileReference}/esims/{esimReference}/port-ins

Authorization

Authorization: Bearer {token} — an OAuth2 access token from the client-credentials flow. How authentication works

Path parameters

profileReferencestringrequired

The eSIM's profile reference (16-digit numeric string)

esimReferencestringrequired

eSIM reference identifier (18-digit opaque token)

Responses

200Port-in requests for the eSIMapplication/json
Show response body
dataarray of PortIn

Port-in requests, newest first

Show properties
portInRequestReferencestringrequired

Public opaque port-in request reference (8-char uppercase base36)

profileReferencestringrequired
esimReferencestringrequired

The eSIM this port-in belongs to

msisdnstringrequired

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

detailsobject

Provider-specific donor details. The exact fields and validation depend on the eSIM variant. Fields that are accepted, required, or mutually exclusive are resolved from the selected eSIM's number-porting provider. Unknown fields are rejected.

Show properties
donorContractTypestringrequired

Contract type of the number at the donor operator

Optionsprepaidpostpaid
donorIccidstring

Donor SIM ICCID at the donor operator. Exact format is validated per eSIM variant.

donorAccountNumberstring

Account/customer number at the donor operator

statusstringrequired
  • requested: Accepted by Firsty; provider submission in progress
  • approved: Donor/provider accepted the port
  • scheduled: Port scheduled for a future date (reserved for future markets)
  • cancelling: Cancellation requested, awaiting provider confirmation
  • completed: Number ported — the eSIM activates with the ported number
  • rejected: Donor rejected the request (see reason)
  • failed: Port failed (see reason)
  • cancelled: Cancellation confirmed
Optionsrequestedapprovedscheduledcancellingcompletedrejectedfailedcancelled
reasonobject | null

Failure/rejection detail, present when status is rejected or failed

Show properties
codestringrequired

Normalized failure/rejection code

messagestring | null

Human-readable detail when available

scheduledDatestring | null · date

Planned porting date when known (reserved for future markets)

submittedAtstring | null · date-time

When the port-in was submitted to the provider; null while submission is still pending

completedAtstring | null · date-time

When the port completed

abandonedboolean

Whether porting was abandoned in favour of the temporary number (irreversible; no corrected request possible)

createdAtstring · date-timerequired
updatedAtstring · date-timerequired
401Unauthorized - missing or invalid API key403Forbidden - client does not have access to this resource404Resource not found429Rate limit exceeded500Internal server error