Starts or resumes localization process for an eUICC to the specified country.

Starts or resumes the process of localizing the eUICC to the specified country. If a previous localization for an eUICC failed it is safe to perform a retry using this endpoint since the process will pick up from where it failed.

The end result of a successful localization will be that a new profile is downloaded and enabled on the eUICC. This means that the eUICC will use a SIM that is local to the specified country rather than use roaming as is the default behavior.

Path Parameters

• eid string required

  Possible values: Value must match regular expression ^[0-9]{32}$

  EID to perform request on.

application/json

Request Body required

Specifies where the eUICC is to be localized. The content of the request body depends on the localization target, make sure to view the schema for the localization target you will be using.

anyOf

• MOD1
• MOD2
• MOD3

---

localizationTarget string required

Possible values: [BR_DATORA, BR_DATORA_MULTI]

Localization target for Brazil Datora.

localizationTarget string required

Possible values: [US_VERIZON_CAT_1]

imei string required

Possible values: Value must match regular expression ^[0-9]{14,16}$

The IMEI of the device that is being localized.

deviceType string

Possible values: [OMA_DM, LWM2M]

The device type of the device that is being localized. If null, then the default device type will be picked (if configured).

5g boolean required

Set to true if the localized profile should be a 5G profile. If false, 5G will not be usable.

localizationTarget string required

Possible values: [US_VERIZON_CAT_M]

imei string required

Possible values: Value must match regular expression ^[0-9]{14,16}$

The IMEI of the device that is being localized.

deviceType string

Possible values: [LWM2M]

The device type of the device that is being localized. If null, then the default device type will be picked (if configured). Note that for US_VERIZON_CAT_M, the only supported deviceType value is LWM2M.

Responses

• 202
• 400
• 401
• 403
• 404
• 429
• 500

---

eUICC localization started or resumed.

BadRequest

Response Headers

• Access-Control-Allow-Origin string
• Access-Control-Allow-Methods string
• Access-Control-Allow-Headers string

application/json

• Schema
• Example (from schema)

---

Schema

• name string
• message string
• errors object[]

  message string

  errorCode string

  path string

  Optional path, usually used to describe which incoming parameters are not valid.

{
  "name": "string",
  "message": "string",
  "errors": [
    {
      "message": "string",
      "errorCode": "string",
      "path": "string"
    }
  ]
}

Unauthorized. Your token is not valid.

Response Headers

• Access-Control-Allow-Origin string
• Access-Control-Allow-Methods string
• Access-Control-Allow-Headers string

application/json

• Schema
• Example (from schema)

---

Schema

• name string
• message string
• errors object[]

  message string

  errorCode string

  path string

  Optional path, usually used to describe which incoming parameters are not valid.

{
  "name": "string",
  "message": "string",
  "errors": [
    {
      "message": "string",
      "errorCode": "string",
      "path": "string"
    }
  ]
}

Forbidden. You are not allowed to access the requested resource.

Response Headers

• Access-Control-Allow-Origin string
• Access-Control-Allow-Methods string
• Access-Control-Allow-Headers string

application/json

• Schema
• Example (from schema)

---

Schema

• name string
• message string
• errors object[]

  message string

  errorCode string

  path string

  Optional path, usually used to describe which incoming parameters are not valid.

{
  "name": "string",
  "message": "string",
  "errors": [
    {
      "message": "string",
      "errorCode": "string",
      "path": "string"
    }
  ]
}

The specified resource was not found

Response Headers

• Access-Control-Allow-Origin string
• Access-Control-Allow-Methods string
• Access-Control-Allow-Headers string

application/json

• Schema
• Example (from schema)

---

Schema

• name string
• message string
• errors object[]

  message string

  errorCode string

  path string

  Optional path, usually used to describe which incoming parameters are not valid.

{
  "name": "string",
  "message": "string",
  "errors": [
    {
      "message": "string",
      "errorCode": "string",
      "path": "string"
    }
  ]
}

RateLimitError. Too Many Requests.

Response Headers

• Access-Control-Allow-Origin string
• Access-Control-Allow-Methods string
• Access-Control-Allow-Headers string

application/json

• Schema
• Example (from schema)

---

Schema

• name string
• message string
• errors object[]

  message string

  errorCode string

  path string

  Optional path, usually used to describe which incoming parameters are not valid.

{
  "name": "string",
  "message": "string",
  "errors": [
    {
      "message": "string",
      "errorCode": "string",
      "path": "string"
    }
  ]
}

Internal Server Error

Response Headers

• Access-Control-Allow-Origin string
• Access-Control-Allow-Methods string
• Access-Control-Allow-Headers string

application/json

• Schema
• Example (from schema)

---

Schema

• name string
• message string
• errors object[]

  message string

  errorCode string

  path string

  Optional path, usually used to describe which incoming parameters are not valid.

{
  "name": "string",
  "message": "string",
  "errors": [
    {
      "message": "string",
      "errorCode": "string",
      "path": "string"
    }
  ]
}

Loading...