> ## Documentation Index > Fetch the complete documentation index at: https://help.withallo.com/llms.txt > Use this file to discover all available pages before exploring further. # Get eSIM activation code > Returns the activation code of a ready eSIM: the LPA string, the SM-DP+ address, the matching id and a QR code. Before the eSIM is ready, the request fails with `ESIM_NOT_READY`. Requires the `PARTNER` scope. **Required scope:** `PARTNER` Returns what your client needs to install a ready eSIM on their phone: the full activation code (`lpa`), its two parts (`smdp_address` and `matching_id`) and a QR code. Before the eSIM is ready, the request fails with `409 ESIM_NOT_READY`. Wait for the [`partner.esim.ready`](/en/v2/api-reference/webhooks/event-catalog#partneresimready) webhook, or for `status: ACTIVE` on [Get eSIM](/en/v2/api-reference/partner/get-esim). The activation code is never sent in a webhook. Fetch it when you deliver the eSIM to your client. Anyone who installs the eSIM with this code takes over the line. Send it only to your client. ## Response fields | Field | Description | | - | - | | `lpa` | The full activation code, in the form `LPA:1$$` | | `smdp_address` | The SM-DP+ address, for manual entry | | `matching_id` | The activation code, for manual entry | | `qr_code` | A PNG data URI of a QR code that encodes `lpa`. Use it as the `src` of an `` tag. | ## How to deliver the eSIM to your client Give your client one of these, depending on their phone: * **QR code**: show `qr_code`. Your client scans it from their phone's eSIM settings. * **Android, manual entry**: give `smdp_address` and `matching_id`. Your client types them in their phone's eSIM settings. * **iPhone (iOS 17.4 and later), one-tap link**: build a link from `lpa`. Your client opens it on the iPhone and the eSIM installs from there. The iPhone link is `https://esimsetup.apple.com/esim_qrcode_provisioning?carddata=` followed by the URL-encoded `lpa`. The `$` and `:` characters must be encoded. ```javascript theme={null} const { lpa } = activationCode; const link = "https://esimsetup.apple.com/esim_qrcode_provisioning?carddata=" + encodeURIComponent(lpa); ``` ```python theme={null} from urllib.parse import quote lpa = activation_code["lpa"] link = "https://esimsetup.apple.com/esim_qrcode_provisioning?carddata=" + quote(lpa, safe="") ``` Your client must be in France when they activate the eSIM. See [eSIM (France)](/en/phone-numbers/esim) for the install steps on each phone. Allo does not detect when the eSIM is installed on the phone. The line already rings the eSIM from the moment it is ready. ## Errors | Code | What it means | | - | - | | `ESIM_NOT_READY` | The eSIM is not ready to install yet. Always `retryable: true`. | | `PARTNER_ESIM_NOT_FOUND` | No eSIM with this id was ordered on an account your API key created. | | `ESIM_UNAVAILABLE` | The activation code cannot be read right now. Retry later. | ## OpenAPI ````yaml GET /v2/api/partner/esims/{id}/activation_code openapi: 3.0.3 info: title: Allo API description: >- Allo API provides programmatic access to your Allo account, allowing you to manage webhooks, retrieve calls and contacts, and send SMS messages. All requests to `/v1/api/**` endpoints automatically go through quota checking and scope validation. version: 1.0.0 contact: name: Allo Support servers: - url: https://api.withallo.com description: Production server security: [] tags: - name: Summary Templates description: >- Manage call summary templates that control how AI-generated call summaries are structured for your team. - name: Webhooks description: >- Manage webhook endpoints to receive real-time notifications about events in your Allo account. Each endpoint subscribes to one or more event topics and is verified with a signing secret. - name: Calls description: >- Retrieve and search call records with filtering and pagination. Filter calls by your Allo phone number. - name: Contacts description: >- Search and retrieve contact information with sorting and pagination. Includes engagement level tracking. - name: SMS description: Send SMS messages to phone numbers using your Allo numbers. - name: Phone Numbers description: Retrieve information about your Allo phone numbers. - name: Analytics description: Pre-computed call metrics, team performance, and outbound dial funnel - name: CRM description: Manage people, companies, and deals in your CRM. - name: Notes description: >- Internal team notes on conversations and CRM people, with @mention support. Notes are never visible to the contact. - name: Threads description: >- Team discussion threads attached to a conversation item (call, SMS, or conversation note). One thread per item. - name: AI Receptionist description: >- Read and write the AI receptionist configuration of a phone line: business details, voice, prompt, capabilities, business hours, transfer rules, scheduling calendars and knowledge sources. paths: /v2/api/partner/esims/{id}/activation_code: get: tags: - Partner summary: Get eSIM activation code description: >- Returns the activation code of a ready eSIM: the LPA string, the SM-DP+ address, the matching id and a QR code. Before the eSIM is ready, the request fails with `ESIM_NOT_READY`. Requires the `PARTNER` scope. operationId: getPartnerEsimActivationCode parameters: - name: id in: path required: true schema: type: string description: The eSIM id returned by Order eSIM (`eso-*`). responses: '200': description: Activation code content: application/json: schema: type: object properties: data: type: object properties: lpa: type: string description: >- Full activation code, `LPA:1$$`. example: LPA:1$smdp.example.com$ABCD-1234-EFGH-5678 smdp_address: type: string description: SM-DP+ address, for manual entry on Android. example: smdp.example.com matching_id: type: string description: >- Matching id (activation code), for manual entry on Android. example: ABCD-1234-EFGH-5678 qr_code: type: string description: PNG data URI of a QR code that encodes `lpa`. example: data:image/png;base64,iVBORw0KGgo... example: data: lpa: LPA:1$smdp.example.com$ABCD-1234-EFGH-5678 smdp_address: smdp.example.com matching_id: ABCD-1234-EFGH-5678 qr_code: data:image/png;base64,iVBORw0KGgo... '401': $ref: '#/components/responses/ApiUnauthorized' '403': description: The API key lacks the PARTNER scope. content: application/json: schema: type: object properties: error: type: object '404': description: >- No eSIM with this id was ordered on an account your API key provisioned (PARTNER_ESIM_NOT_FOUND). content: application/json: schema: type: object properties: error: type: object '409': description: >- The eSIM is not ready to install yet (ESIM_NOT_READY). Wait for the `partner.esim.ready` webhook. content: application/json: schema: type: object properties: error: type: object '429': $ref: '#/components/responses/ApiRateLimited' '500': description: The activation code cannot be read right now (ESIM_UNAVAILABLE). content: application/json: schema: type: object properties: error: type: object security: - ApiKeyAuth: [] components: responses: ApiUnauthorized: description: Invalid or missing API key content: application/json: schema: $ref: '#/components/schemas/ApiError' ApiRateLimited: description: Rate limit exceeded content: application/json: schema: $ref: '#/components/schemas/ApiError' schemas: ApiError: type: object properties: error: type: object properties: type: type: string code: type: string message: type: string retryable: type: boolean request_id: type: string retry_after_seconds: type: integer nullable: true securitySchemes: ApiKeyAuth: type: apiKey in: header name: Authorization ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.