Sign in
latestOpenAPI 3.0.12026-08-102423137.1 KB

80dd46738839

Activation challenges

Create a delivery event for an activation challenge

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

post/v1/mfa/challenges/activation/{id}/delivery_events

Path parameters

idstring required

Activation challenge id.

Request body

type'DISPATCHED' | 'IN_TRANSIT' | 'DELIVERED' | 'UNDELIVERED' | 'LOST' | 'RETURNED' | 'SENT' | 'BOUNCED' required

Current status of the delivery process.

provider'DEUTSCHE POST' | 'DHL' | 'TWILIO'

Name of the provider used to deliver the activation code.

additional_detailsstring

Additional details about the event.

timestampstring required

UTC timestamp of the event in RFC 3339 format.

Example request

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

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
}