Sign in
latestOpenAPI 3.0.12026-08-102423137.1 KB

80dd46738839

Activation challenges

Create an Activation challenge

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

post/v1/mfa/challenges/activation

Query parameters

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

Request body

person_idstring

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

origin'MOBILE_APP' | 'WEB' | 'WEBUI'

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.

purpose'DEVICE_BINDING'

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_method'SNAILMAIL'

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 request

{
  "person_id": "ec3d16cbc106f481b72d881d90c89cc5cper",
  "origin": "MOBILE_APP",
  "purpose": "DEVICE_BINDING",
  "delivery_method": "SNAILMAIL",
  "invalidate_existing_code": true
}

Response

Created

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
}