create_esim_order
Start an eSIM purchase for a person. Phone-number plans need name, accept_aup: true and a real (not temporary) email, and are limited to 3 numbers per person. Any number past 3 needs customer_phone and id_document and waits for an ID check (status pending_payment with no payment_url yet, nothing charged) before payment_url is given. This does not charge anyone: it returns payment_url (card, bank transfer or crypto) for the person to pay, in US dollars outside Nigeria and in naira in Nigeria. After a verified payment the eSIM is delivered by email. Poll get_order_status with reference and status_token. The buyer can ask for a full refund before delivery. Use plan_code and location from search_esim_plans, or phone_plan_code from search_phone_plans.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"email": "<email>",
"accept_terms": "<accept_terms>"
},
"name": "create_esim_order"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | With phone_plan_code: the person's full name (first and last). | |
| Yes | Required: the person's email, for their receipt and order details (the eSIM). | ||
| country | No | Optional: the payer's two-letter country. Outside Nigeria (NG) they pay in US dollars. Defaults to where the request comes from. | |
| currency | No | Optional: USD or NGN. By default prices are in US dollars outside Nigeria and in naira inside Nigeria, from where the request comes from. | |
| location | No | Destination code from search_esim_plans, for example US. Not needed with phone_plan_code. | |
| plan_code | No | plan_code from search_esim_plans. | |
| accept_aup | No | Required true with phone_plan_code: your user agreed to the Acceptable Use Policy (/acceptable-use): no spam, scams, impersonation, bulk SMS or robocalls; a violation cancels the number with no refund. | |
| id_document | No | Only when asked (VERIFICATION_REQUIRED): data URL (data:image/jpeg;base64,... or application/pdf) of a passport, driving licence or national ID, under 3 MB. Kept private. | |
| accept_terms | Yes | Set true only if your user agreed to the Terms of Use and Privacy Policy on this website. | |
| customer_phone | No | Only when asked (VERIFICATION_REQUIRED): the person's own phone number. | |
| phone_plan_code | No | plan_code from search_phone_plans, for an eSIM with a phone number. | |
| email_verification_token | No | verification_token from verify_email_code for this email (required while email checks are on). |