Strong Authentication

Onboard a mobile as second factor

Onboard an end user device as a second factor to enable Strong Customer Authentication (SCA).

This operation can be retried as long as no factor has not yet been validated.

SecurityLinkcy-Auth
Request
Request Body schema: application/json
endpointId
required
string

The identifier of the SCA endpoint (device) you want to enroll. It is defined in the SCA SDK as endpointID.

factor
string
Default: "BIOMETRY"

Choose a factor to enroll, you will be able to enroll an other one later.

Enum: "BIOMETRY" "PIN"
strategy
string (Strategy)
Default: "PUSH_NOTIFICATION"

Whether you want to receive a PUSH_NOTIFICATION on the device or get a JOIN_CODE to join the interaction through your own channel.

Enum: "PUSH_NOTIFICATION" "JOIN_CODE"
endUserId
string <uuid>

The end-user id if requesting as a partner, else ignored.

Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

409
500

Internal Server Error

post/api/partner/sca
Request samples
application/json
{
  • "endpointId": "string",
  • "factor": "BIOMETRY",
  • "strategy": "PUSH_NOTIFICATION",
  • "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5"
}
Response samples
application/json
{
  • "endpointId": "string",
  • "joinCode": "0907af4a-d224-4ddb-a7ab-11c52f9fed47"
}

Add an authentication Factor

On an already onboarded device. You can choose to update or add a factor (Biometry/PIN).

At least one factor must be already enrolled. You can use this endpoint to change an user PIN

SecurityLinkcy-Auth
Request
Request Body schema: application/json
factor
required
string

Choose a factor to enroll, you will be able to enroll an other one later.

Enum: "BIOMETRY" "PIN"
strategy
string (Strategy)
Default: "PUSH_NOTIFICATION"

Whether you want to receive a PUSH_NOTIFICATION on the device or get a JOIN_CODE to join the interaction through your own channel.

Enum: "PUSH_NOTIFICATION" "JOIN_CODE"
endUserId
string <uuid>

The end-user id if requesting as a partner, else ignored.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

409
500

Internal Server Error

patch/api/partner/sca
Request samples
application/json
{
  • "factor": "BIOMETRY",
  • "strategy": "PUSH_NOTIFICATION",
  • "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5"
}
Response samples
application/json
{
  • "endpointId": "string",
  • "joinCode": "0907af4a-d224-4ddb-a7ab-11c52f9fed47"
}