Sign in
latestOpenAPI 3.0.12026-08-102423137.1 KB

80dd46738839

Activation challenges

List Activation Challenges for a person

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

get/v1/mfa/challenges/activation

Query parameters

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

Response

OK

idstring

The ID of the challenge.

person_idstring

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

codestring

activation code

created_atstring

The date and time when the code was created.

expires_atstring

The date and time when the code will expire.

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 Solaris SE for internally generated requests.

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.

delivery_methodstring

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

usage_countinteger

The number of times the activation code has been used.

max_usage_countinteger

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

Example response

[
  {
    "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
  }
]