Trusted payees

Verify a payee batch using a one-time password

Completes verification of a payee batch by submitting the one-time password sent to the user.

Pass the operationBatchId as id and the code the user received as verificationCode. On success the batch is applied (payees are added to or removed from the trusted list) and the batch moves to CHALLENGE_COMPLETED and then COMPLETED. On failure it moves to CHALLENGE_FAILED and the payees are left unchanged.

This returns 204 as soon as the code is accepted, but the batch is applied asynchronously. Read the outcome with Get a batch of payees.

:::note On sandbox, no text message is sent and verificationCode is always 123456. :::

post/beneficiaries/batch/{id}/challenges/otp/{channel}/verify

Request

  • Base URL: https://sandbox.weavr.io/multi
  • URL: https://sandbox.weavr.io/multi/beneficiaries/batch/{id}/challenges/otp/{channel}/verify
  • Auth: HTTP bearer and API key in header api-key

Path parameters

idstring required
Example:123456789

The unique identifier of the payee batch.

channel'SMS' required
  • SMS: The one-time-password is sent as a text message

The unique identifier for the channel.

Request body

verificationCodestring required

A randomly generated one-time use code.

Example request

{
  "verificationCode": "654321"
}

Response

Success - No Content.

Changes

No recorded changes to this operation across all 1 revision of this API.