Get activation QR code for an eSIM

GET 
/sim_cards/:sim_card_id/activation_code

It returns the contents for the activation QR code for an eSIM.

This API is only available for eSIMs. If the given SIM is a physical SIM card, or has already been installed, an error will be returned.

Request

Path Parameters

sim_card_id uuidrequired

Identifies a SIM card.

Responses

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

data

object

record_type string

activation_code string

Contents of the eSIM activation QR code.

{
  "data": {
    "record_type": "sim_card_activation_code",
    "activation_code": "LPA:1$...."
  }
}

default: Unexpected error

application/json

• Schema
• Example (from schema)

Schema

errors

Error[]

Array [

code intrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta object

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/sim_cards/:sim_card_id/activation_code' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• default

---

{
  "data": {
    "record_type": "sim_card_activation_code",
    "activation_code": "LPA:1$...."
  }
}

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}