Skip to content

Create mobile biometrics challenge

Request

Creates a challenge for the user to sign for the mobile biometrics flow.

Security
ClientAccessToken
Bodyapplication/jsonrequired
One of:
device_idstring, <= 80 characters

Identifier of the device from which the authentication request originates

approval_dataobject

Flat object that contains the data that your customer should approve for a transaction signing or custom approval flow. It can contain up to 10 keys, and only alphanumeric characters, underscores, hyphens, and periods. It will be returned as a claim in the ID token upon successful authentication.

Example:
{ "transaction_id": "eFII2y40uB9hQ98nXt3tc1IHkRt8GrRZiqZuRn_59wT", "sum": "200" }
timeoutnumber
Default:600
identifierstringrequired

User identifier, which may correspond to the user's email, phone number, username, or user ID. The type of identifier should be specified as the identifier_type.

identifier_typestringrequired

Type of user identifier used for login

curl -i -X POST \
  https://api.sbx.transmitsecurity.io/cis/v1/auth/mobile-biometrics/start \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "device_id": "string",
    "approval_data": {
      "transaction_id": "eFII2y40uB9hQ98nXt3tc1IHkRt8GrRZiqZuRn_59wT",
      "sum": "200"
    },
    "timeout": 600,
    "identifier": "string",
    "identifier_type": "string"
  }'

Responses

Backend auth initialized successfully.

Bodyapplication/json
challengestringrequired
Response
{ "challenge": "string" }