Register eUICC.
Register an external eUICC in the specified CMP. This eventually results in an IoT subscription being provisioned with the specified eUICC.
- application/json
Request Body required
If domainId is not specified, the eUICC will be registered in the requesting user's own domain.
- eid string required
Possible values: Value must match regular expression
^[0-9]{32}$
Uniquely identifies an eUICC (eSIM).
- cmp string required
Possible values: [
IOTA_EU
,ARQIA_BR
,THINGSPACE_US
]The profile's Connectivity Management Platform (CMP) determines which underlying connectivity platform the profile belongs to and determines what kind of data is available for the profile and its connectivity subscription.
- domainId string
Possible values: Value must match regular expression
^([A-Za-z0-9]{8}-){0,6}[A-Za-z0-9]{8}$
Domain the resource belongs to. Used to determine which users have access to the resource.
- euiccAgreementId string required
Uniquely identifies an agreement for an organization.
- localeId string required
IoTA locale ID.
- 202
- 400
- 401
- 403
- 429
- 500
An EID has been registered for an eUICC connected to an agreement and a domain.
- application/json
- Schema
- Example (from schema)
Schema
- imsi string
Possible values: Value must match regular expression
^[0-9]{6,15}$
International Mobile Subscriber Identity. Uniquely identifies a subscriber in the mobile network.
- iccid string
Possible values: Value must match regular expression
^89[0-9]{16,18}$
Integrated Circuit Card ID. Uniquely identifies a UICC (SIM card) or an eUICC profile.
- msisdn string
Possible values: Value must match regular expression
^[0-9]{5,15}$
Mobile Station International Subscriber Directory Number. This is equivalent to the phone number, including the country code.
{
"imsi": "230000000000001",
"iccid": "89000000000000000001",
"msisdn": "46000000001"
}
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 stringerrorCode stringpath stringOptional 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 stringerrorCode stringpath stringOptional 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 stringerrorCode stringpath stringOptional 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 stringerrorCode stringpath stringOptional 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 stringerrorCode stringpath stringOptional path, usually used to describe which incoming parameters are not valid.
{
"name": "string",
"message": "string",
"errors": [
{
"message": "string",
"errorCode": "string",
"path": "string"
}
]
}