Skip to content
/Activation challenges

Device management (1.0)

Download OpenAPI description
device-management.json
device-management.yaml
Languages
Servers
Mock Server
https://docs.solarisgroup.com/_mock/api-reference/onboarding/device-management

Device binding

Operations

Device signing challenges

Operations

SMS challenges

Operations

Change requests

Operations

Activation challenges

Operations

Create an Activation challenge

Request

Generate a new activation code that can be delivered to endcustomer by the partner.

Query
invalidate_existing_codeboolean

When invalidate_existing_code=true, automatically invalidate existing code and return new code. Return 409 Conflict status, if an activation code for the given person already exists except when invalidate_existing_code=true

Bodyapplication/jsonrequired
person_idstring

ID of the person for whom the Activation challenge should be created.

Example: "ec3d16cbc106f481b72d881d90c89cc5cper"
originstring

A string to distinguish the origin of the request. The request can originate from MOBILE_APP or WEB or WEBUI and the values can be set as accordingly. It can be used to filter the list of codes while using the index endpoint.

Example: "MOBILE_APP"
string

A string to distinguish the origin of the request. The request can originate from MOBILE_APP or WEB or WEBUI and the values can be set as accordingly. It can be used to filter the list of codes while using the index endpoint.

purposestring

Purpose of the activation code to be created. The generated activation code can be used only for the desired purpose. More purposes may be supported in future.

Example: "DEVICE_BINDING"
string

Purpose of the activation code to be created. The generated activation code can be used only for the desired purpose. More purposes may be supported in future.

delivery_methodstring

Method of delivering activation code to the endcustomer. SNAILMAIL is the only supported delivery_method as of now. More delivery_methods may be supported in the future.

Example: "SNAILMAIL"
string

Method of delivering activation code to the endcustomer. SNAILMAIL is the only supported delivery_method as of now. More delivery_methods may be supported in the future.

invalidate_existing_codeboolean

When invalidate_existing_code=true, automatically invalidate existing code and return new code. Return 409 Conflict status, if an activation code for the given person already exists except when invalidate_existing_code=true

Example: true
application/json
{
  "person_id": "ec3d16cbc106f481b72d881d90c89cc5cper",
  "origin": "MOBILE_APP",
  "purpose": "DEVICE_BINDING",
  "delivery_method": "SNAILMAIL",
  "invalidate_existing_code": true
}

Responses

Created

Headers
Locationstring
Bodyapplication/json
idstring

The ID of the challenge.

Example: "6642d15e-8f6b-4d28-9186-cdd61d80032a"
person_idstring

The ID of the person for whom the activation code is created

Example: "55e47118b78741dbb81cdd3d372bc448cpar"
codestring

activation code

Example: "code123456abcd"
created_atstring

The date and time when the code was created.

Example: "2022-03-18T14:50:04Z"
expires_atstring

The date and time when the code will expire.

Example: "2022-03-18T14:55:04Z"
originstring

Origin of the request. Origin specifed while creating a new activation code is returned here. "SOLARISBANK" is a reserved origin value which will be used by solarisbank for internally generated requests.

Example: "MOBILE_APP"
purposestring

Purpose of the activation_code. The generated activation_code can be used only for the desired purpose. Currently the only supported purpose is DEVICE_BINDING. More purposes may be supported in future.

Example: "DEVICE_BINDING"
delivery_methodstring

Partner's method of delivering activation code to the endcustomer.

Example: "SNAILMAIL"
usage_countinteger

The number of times the activation code has been used.

Example: 1
max_usage_countinteger

The maximum number of times the activation code can be used.

Example: 5
Response
application/json
{
  "id": "6642d15e-8f6b-4d28-9186-cdd61d80032a",
  "person_id": "55e47118b78741dbb81cdd3d372bc448cpar",
  "code": "code123456abcd",
  "created_at": "2022-03-18T14:50:04Z",
  "expires_at": "2022-03-18T14:55:04Z",
  "origin": "MOBILE_APP",
  "purpose": "DEVICE_BINDING",
  "delivery_method": "SNAILMAIL",
  "usage_count": 1,
  "max_usage_count": 5
}

List Activation Challenges for a person

Request

Returns a list of activation challenges based on the filter criterias.

Query
page[size]integer

Use this filter to specify the size of each page of results.

page[number]integer

Use this filter to return only the devices on a certain page of the response.

filter[person_id]string

Use this filter to return only challenges that belong to a specific person.

filter[include_expired]string

Boolean value that determines whether or not the API should also return expired challenges. Default value is false.

filter[origin]string

Use this filter to return only challenges that belong to a specific orign

filter[purpose]string

Use this filter to return only challenges that belong to a specific purpose

filter[delivery_method]string

Use this filter to return only challenges that belong to a specific delivery method

No request payload

Responses

OK

Bodyapplication/jsonArray [
idstring

The ID of the challenge.

Example: "6642d15e-8f6b-4d28-9186-cdd61d80032a"
person_idstring

The ID of the person for whom the activation code is created

Example: "55e47118b78741dbb81cdd3d372bc448cpar"
codestring

activation code

Example: "code123456abcd"
created_atstring

The date and time when the code was created.

Example: "2022-03-18T14:50:04Z"
expires_atstring

The date and time when the code will expire.

Example: "2022-03-18T14:55:04Z"
originstring

Origin of the request. Origin specifed while creating a new activation code is returned here. "SOLARISBANK" is a reserved origin value which will be used by solarisbank for internally generated requests.

Example: "MOBILE_APP"
purposestring

Purpose of the activation_code. The generated activation_code can be used only for the desired purpose. Currently the only supported purpose is DEVICE_BINDING. More purposes may be supported in future.

Example: "DEVICE_BINDING"
delivery_methodstring

Partner's method of delivering activation code to the endcustomer.

Example: "SNAILMAIL"
usage_countinteger

The number of times the activation code has been used.

Example: 1
max_usage_countinteger

The maximum number of times the activation code can be used.

Example: 5
]
Response
application/json
[
  {
    "id": "6642d15e-8f6b-4d28-9186-cdd61d80032a",
    "person_id": "55e47118b78741dbb81cdd3d372bc448cpar",
    "code": "code123456abcd",
    "created_at": "2022-03-18T14:50:04Z",
    "expires_at": "2022-03-18T14:55:04Z",
    "origin": "MOBILE_APP",
    "purpose": "DEVICE_BINDING",
    "delivery_method": "SNAILMAIL",
    "usage_count": 1,
    "max_usage_count": 5
  }
]

Retrieve an Activation challenge

Request

Returns a previously created activation challenge.

Path
idstringrequired

Activation challenge id.

No request payload

Responses

OK

Bodyapplication/json
idstring

The ID of the challenge.

Example: "6642d15e-8f6b-4d28-9186-cdd61d80032a"
person_idstring

The ID of the person for whom the activation code is created

Example: "55e47118b78741dbb81cdd3d372bc448cpar"
codestring

activation code

Example: "code123456abcd"
created_atstring

The date and time when the code was created.

Example: "2022-03-18T14:50:04Z"
expires_atstring

The date and time when the code will expire.

Example: "2022-03-18T14:55:04Z"
originstring

Origin of the request. Origin specifed while creating a new activation code is returned here. "SOLARISBANK" is a reserved origin value which will be used by solarisbank for internally generated requests.

Example: "MOBILE_APP"
purposestring

Purpose of the activation_code. The generated activation_code can be used only for the desired purpose. Currently the only supported purpose is DEVICE_BINDING. More purposes may be supported in future.

Example: "DEVICE_BINDING"
delivery_methodstring

Partner's method of delivering activation code to the endcustomer.

Example: "SNAILMAIL"
usage_countinteger

The number of times the activation code has been used.

Example: 1
max_usage_countinteger

The maximum number of times the activation code can be used.

Example: 5
Response
application/json
{
  "id": "6642d15e-8f6b-4d28-9186-cdd61d80032a",
  "person_id": "55e47118b78741dbb81cdd3d372bc448cpar",
  "code": "code123456abcd",
  "created_at": "2022-03-18T14:50:04Z",
  "expires_at": "2022-03-18T14:55:04Z",
  "origin": "MOBILE_APP",
  "purpose": "DEVICE_BINDING",
  "delivery_method": "SNAILMAIL",
  "usage_count": 1,
  "max_usage_count": 5
}

Delete an Activation challenge

Request

Marks an activation challenge as expired so that it cannot be used anymore.

Path
idstringrequired

Activation challenge id.

No request payload

Responses

No Content

Response
No content

Create a delivery event for an activation challenge

Request

Registers a new delivery event that updates the delivery status of an activation challenge.

Bodyapplication/jsonrequired
typestringrequired

Current status of the delivery process.

Example: "DISPATCHED"
string

Current status of the delivery process.

timestampstringrequired

UTC timestamp of the event in RFC 3339 format.

Example: "2018-06-18T13:06:54.000Z"
providerstring

Name of the provider used to deliver the activation code.

Example: "DEUTSCHE POST"
string

Name of the provider used to deliver the activation code.

additional_detailsstring

Additional details about the event.

Example: "Booking id is 123E"
application/json
{
  "type": "DISPATCHED",
  "provider": "DEUTSCHE POST",
  "additional_details": "Booking id is 123E",
  "timestamp": "2018-06-18T13:06:54.000Z"
}

Responses

Created

Headers
Locationstring
Bodyapplication/json
idstring

The ID of the challenge.

Example: "6642d15e-8f6b-4d28-9186-cdd61d80032a"
person_idstring

The ID of the person for whom the activation code is created

Example: "55e47118b78741dbb81cdd3d372bc448cpar"
codestring

activation code

Example: "code123456abcd"
created_atstring

The date and time when the code was created.

Example: "2022-03-18T14:50:04Z"
expires_atstring

The date and time when the code will expire.

Example: "2022-03-18T14:55:04Z"
originstring

Origin of the request. Origin specifed while creating a new activation code is returned here. "SOLARISBANK" is a reserved origin value which will be used by solarisbank for internally generated requests.

Example: "MOBILE_APP"
purposestring

Purpose of the activation_code. The generated activation_code can be used only for the desired purpose. Currently the only supported purpose is DEVICE_BINDING. More purposes may be supported in future.

Example: "DEVICE_BINDING"
delivery_methodstring

Partner's method of delivering activation code to the endcustomer.

Example: "SNAILMAIL"
usage_countinteger

The number of times the activation code has been used.

Example: 1
max_usage_countinteger

The maximum number of times the activation code can be used.

Example: 5
Response
application/json
{
  "id": "6642d15e-8f6b-4d28-9186-cdd61d80032a",
  "person_id": "55e47118b78741dbb81cdd3d372bc448cpar",
  "code": "code123456abcd",
  "created_at": "2022-03-18T14:50:04Z",
  "expires_at": "2022-03-18T14:55:04Z",
  "origin": "MOBILE_APP",
  "purpose": "DEVICE_BINDING",
  "delivery_method": "SNAILMAIL",
  "usage_count": 1,
  "max_usage_count": 5
}

List delivery events for an activation challenge.

Request

Returns a list delivery events for a given activation challenge (sorted descending by timestamp).

Path
idstringrequired

Activation challenge id.

No request payload

Responses

OK

Bodyapplication/jsonArray [
idstring

The ID of the delivery event.

Example: "xxx12345devt"
typestring

The type of delivery event.

Example: "DISPATCHED"
providerstring

Provider used to deliver the activation code.

Example: "DEUTSCHE POST"
timestampstring

The timestamp of the delivery event.

Example: "2022-03-18T14:50:04Z"
]
Response
application/json
[
  {
    "id": "xxx12345devt",
    "type": "DISPATCHED",
    "provider": "DEUTSCHE POST",
    "timestamp": "2022-03-18T14:50:04Z"
  }
]

Retrieve a delivery event.

Request

Returns an activation challenge delivery event.

Path
activation_challenge_idstringrequired

Activation challenge id.

idstringrequired

Delivery event id.

No request payload

Responses

OK

Bodyapplication/json
idstring

The ID of the delivery event.

Example: "xxx12345devt"
typestring

The type of delivery event.

Example: "DISPATCHED"
providerstring

Provider used to deliver the activation code.

Example: "DEUTSCHE POST"
timestampstring

The timestamp of the delivery event.

Example: "2022-03-18T14:50:04Z"
Response
application/json
{
  "id": "xxx12345devt",
  "type": "DISPATCHED",
  "provider": "DEUTSCHE POST",
  "timestamp": "2022-03-18T14:50:04Z"
}