Skip to main content

Create an H5 link

POST 
/v1/esim/h5_links

Creates a link to the hosted eSIM page for one cardholder.

Requires the esim:write scope.

cardholder_id names who the page is for, and must be a cardholder in your organization. One outside it is refused with 404, exactly as if it did not exist.

The link lasts 15 minutes. expires_at is always created_at plus 15 minutes, and the lifetime is not configurable. Until then the link opens as many times as you like; after it, the page refuses it and you create a new one. A link cannot be retrieved, listed, or revoked once created.

Create it from your backend when the cardholder asks for the page, and redirect them straight to url. A link sent by email, SMS, or push has usually expired by the time it is opened — send a link to your own endpoint instead, and have that endpoint create a fresh H5 link when it is followed.

Treat url as a credential. Anyone holding it acts as that cardholder until it expires. Keep it out of logs, analytics, and storage.

A retry with the same Idempotency-Key returns the original link, expires_at included — even after it has expired, since keys are kept for 24 hours. Use a fresh key for every new link.

Request​

Responses​

The link.