Issue a one-time password that can be used to verify a list of resources

Request

Starts the verification process for a list of resources in which a one-time password is sent to a device belonging to the logged-in user that was previously enrolled through the /authentication_factors/otp/{channel} endpoint.

This endpoint can be used to challenge Outgoing Wire Transfers, Sends, and Linked Account Declarations.

You should only start this process if the operation state is PENDING_CHALLENGE.

Note that on the Sandbox Environment, text messages are not sent and the one-time-password is always "123456".

Security

auth_token and api-key

Path

channelstring(SCAOtpChannel)required

The unique identifier for the channel.

Value:"SMS"

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

resourceTypestring(MultipleSCAResourceType)required

The resource type that the subsequent Ids pertain to. Note that the linked_account_declaration can only be performed by a logged in Root User.

Enum:"outgoing_wire_transfers""sends""linked_account_declaration""correspondent_bank_transfers"

resourceIdsArray of stringsrequired

Can be used with a single or a list of resource Ids. A resource Id is the unique identifier of the resource type that was provided in the response when the resource (such as a transaction) was created.

curl -i -X POST \
  'https://sandbox.weavr.io/multi/challenges/otp/{channel}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -H 'idempotency-ref: string' \
  -d '{
    "resourceType": "outgoing_wire_transfers",
    "resourceIds": [
      "string"
    ]
  }'

Responses

Success

Headers

request-refstringrequired

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

Bodyapplication/json

scaChallengeIdstring(Id)^[0-9]+$

Response

{
  "scaChallengeId": "string"
}