Sign inGet Started
Get started
Guides
API Reference
SDKs
CLI
Knowledge Base
Changelog

Send install credentials to the traveler

POST
/v1/esim/sims/{esim_id}/credentials/deliver
bird esim credentials deliver <esim-id> \
  --channel sms \
  --locale nl \
  --to +31612345678
Response202
{
  "id": "edv_01krdgeqcxet5s7t44vh8rt9mg",
  "channel": "email",
  "to": "traveler@example.com",
  "status": "pending",
  "failure_code": "invalid_recipient",
  "install_link": {
    "id": "eil_01krdgeqcxet5s7t44vh8rt9mg"
  }
}

Sends a hosted installation link by email or SMS. The eSIM must be installable. Email includes the link expiry time; SMS includes the link. The recipient opens the page to view the QR code and manual installation details. Links expire after seven days; resending leaves earlier links valid until expiry or explicit revocation.

A 202 response confirms acceptance for sending. Check List credential deliveries for the delivery outcome and any failure code. Reuse the same Idempotency-Key to recover an accepted send while its response is retained.

Returns 409 with E26012 when the selected channel is unavailable; choose another configured channel. New deliveries return 501 while hosted links are unavailable. A retained successful response can still be replayed during that time.

Parameters

esim_idstring

eSIM ID.

Request Payload

to
string
required

Recipient address. An email address for the email channel, an E.164 phone number for the sms channel.

channel
string
required

Channel the install credentials are delivered over.

Possible values: email, sms

locale
string

Language for the message. Falls back to the closest available language, then English.

Response Payload

id
string
required
channel
string
required
to
string
required

Recipient address the message goes to.

status
string
required
failure_code
nullable string
required

Why the delivery failed. Null unless status is failed. Open enum: treat unrecognized values as future failure kinds.

Possible values (may grow over time): invalid_recipient, suppressed, blocked, bounced, channel_unavailable, send_failed

created_at
string
required

When the delivery was accepted.

settled_at
nullable string
required

When the outcome became known. Null while pending.

install_link
nullable object
required

Link metadata for explicit revocation. Null for deliveries created before hosted links were enabled.

Show child attributes

Related resources

Continue with the documentation, guides and examples for this topic.

Get an implementation brief