Confirmation Challenges

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

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.

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".

Securityauth_token and api_key
Request
path Parameters
channel
required
string (SCAOtpChannel)

The unique identifier for the channel.

Value: "SMS"
header Parameters
idempotency-ref
string

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.

Request Body schema: application/json
required
resourceType
required
string (MultipleSCAResourceType)

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"
resourceIds
required
Array of strings

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.

Responses
200

Success

400

Bad Request Error - Your request is invalid.

401

Unauthorized - Your credentials or access token are invalid.

403

Forbidden - Access to the requested resource or action is forbidden.

405

Method Not Allowed - The request was received but has been rejected for the requested resource.

409

Conflict

429

Too many requests.

500

Internal Server Error - There is a problem with the server. Please try again later.

503

Service Unavailable - We're temporarily offline for maintenance. Please try again later.

default

Error

post/challenges/otp/{channel}
Request samples
application/json
{
  • "resourceType": "outgoing_wire_transfers",
  • "resourceIds": [
    ]
}
Response samples
application/json
{
  • "scaChallengeId": "string"
}

Verify a list of resources using a one-time password

Completes the verification process for a list of resources.

This endpoint can be used to challenge Outgoing Wire Transfers & Sends.

If the outcome of the verification is successful, the resource is executed.

If not verified challenge expires after 5 minutes and the number of incorrect OTP attempts is limited to reduce the risk of fraud.

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

Securityauth_token and api_key
Request
path Parameters
scaChallengeId
required
string^[0-9]+$

The unique identifier of the SCA challenge.

channel
required
string (SCAOtpChannel)

The unique identifier for the channel.

Value: "SMS"
header Parameters
idempotency-ref
string

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.

Request Body schema: application/json
required
verificationCode
required
string (Nonce) ^[0-9]{6}$

The code received by the user on the device.

resourceType
required
string (MultipleSCAResourceType)

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"
Responses
204

Success - No Content.

400

Bad Request Error - Your request is invalid.

401

Unauthorized - Your credentials or access token are invalid.

403

Forbidden - Access to the requested resource or action is forbidden.

409

Conflict

429

Too many requests.

500

Internal Server Error - There is a problem with the server. Please try again later.

503

Service Unavailable - We're temporarily offline for maintenance. Please try again later.

default

Error

post/challenges/{scaChallengeId}/otp/{channel}/verify
Request samples
application/json
{
  • "verificationCode": "string",
  • "resourceType": "outgoing_wire_transfers"
}
Response samples
application/json
{
  • "message": "string",
  • "syntaxErrors": {
    }
}

Issue a push notification that can be used to verify a list of resources

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

This endpoint can be used to challenge Outgoing Wire Transfers & Sends.

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

Securityauth_token and api_key
Request
path Parameters
channel
required
string (SCAPushChannel)
  • "AUTHY": The push notification is sent on the user's device using Twilio Authy
  • "BIOMETRIC": The push notification is sent to the user's device
Enum: "AUTHY" "BIOMETRIC"
header Parameters
idempotency-ref
string

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.

Request Body schema: application/json
required
resourceType
required
string (MultipleSCAResourceType)

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"
resourceIds
required
Array of strings

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.

Responses
200

Success

400

Bad Request Error - Your request is invalid.

401

Unauthorized - Your credentials or access token are invalid.

403

Forbidden - Access to the requested resource or action is forbidden.

405

Method Not Allowed - The request was received but has been rejected for the requested resource.

409

Conflict

429

Too many requests.

500

Internal Server Error - There is a problem with the server. Please try again later.

503

Service Unavailable - We're temporarily offline for maintenance. Please try again later.

default

Error

post/challenges/push/{channel}
Request samples
application/json
{
  • "resourceType": "outgoing_wire_transfers",
  • "resourceIds": [
    ]
}
Response samples
application/json
{
  • "scaChallengeId": "string"
}