Skip to content

Verify enrolment of a user device for authentication using one-time passwords

Request

The second step in enrolling the logged-in user (root or authorised user) to use one-time-passwords to enable verification of transactions. The challenge expires after 5 minutes and the number of incorrect OTP attempts is limited to reduce the risk of fraud, in that case challenge has to be issued again.

Note that on the Sandbox Environment, text messages are not sent and the verificationCode is always set to "123456".

Security
api-key and auth_token
Path
channelstring(SCAOtpChannel)required

The unique identifier for the channel.

Value:"SMS"
Headers
idempotency-refstring

A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.

Bodyapplication/jsonrequired
verificationCodestring(Nonce)^[0-9]{6}$required

The code received by the user on the device.

curl -i -X POST \
  'https://sandbox.weavr.io/multi/authentication_factors/otp/{channel}/verify' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -H 'idempotency-ref: string' \
  -d '{
    "verificationCode": "string"
  }'

Responses

Success - No Content.

Headers
request-refstringrequired

A request identifier. Providing this reference when contacting our support team will help us investigate your query.

Response
No content