ScaOtp
A one-time-password challenge by SMS, voice or WhatsApp, for strong customer authentication.
Operations
Every route this entity exposes. Each route links to its own reference on this page.
| Method | Route | SDK operation | Returns |
|---|---|---|---|
POST |
/one-time-token/sms/trigger |
create |
Trigger result with obfuscated phone number |
POST |
/one-time-token/voice/trigger |
create |
Trigger result with obfuscated phone number |
POST |
/one-time-token/whatsapp/trigger |
create |
Trigger result with obfuscated phone number |
DELETE |
/application/users/{userId}/phone-numbers/{phoneNumberId} |
remove |
No Content |
Examples
One example per SDK, generated from the API model. The argument names are the parameters and fields of this entity, and the values are placeholders. The examples are not compiled or executed.
Golang
Construct client as shown in the Golang setup, then call the operations:
removed, err := client.ScaOtp(nil).Remove(map[string]any{"phone_number_id": 1, "user_id": 1}, nil)
if err != nil {
panic(err)
}
fmt.Println(removed)
Lua
Construct client as shown in the Lua setup, then call the operations:
local removed, err = client:ScaOtp():remove({ phone_number_id = 1, user_id = 1 })
PHP
Construct client as shown in the PHP setup, then call the operations:
$client->ScaOtp()->remove(["phone_number_id" => 1, "user_id" => 1]);
Python
Construct client as shown in the Python setup, then call the operations:
client.ScaOtp().remove({"phone_number_id": 1, "user_id": 1})
Ruby
Construct client as shown in the Ruby setup, then call the operations:
client.ScaOtp.remove({ "phone_number_id" => 1, "user_id" => 1 })
TypeScript
Construct client as shown in the TypeScript setup, then call the operations:
await client.ScaOtp().remove({ phone_number_id: 1, user_id: 1 })
Fields
| Field | Type | Required | Description |
|---|
create
POST /one-time-token/sms/trigger
Operation ID: ottSmsTrigger.
Authentication: bearer token (UserToken).
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
One-Time-Token |
header |
string |
Yes | Text value of a OTT. |
X-External-Correlation-Id |
header |
string (uuid) |
No | Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more. |
Responses
200: Trigger result with obfuscated phone number
application/json
| Property | Type | Required | Description |
|---|---|---|---|
obfuscatedPhoneNo |
string |
No | Obfuscated phone number that can be used as a hint for the end customer regarding which phone number the SMS was sent to. |
429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header
application/json
The response is object.
POST /one-time-token/voice/trigger
Operation ID: ottVoiceTrigger.
Authentication: bearer token (UserToken).
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
One-Time-Token |
header |
string |
Yes | Text value of a OTT. |
X-External-Correlation-Id |
header |
string (uuid) |
No | Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more. |
Responses
200: Trigger result with obfuscated phone number
application/json
| Property | Type | Required | Description |
|---|---|---|---|
obfuscatedPhoneNo |
string |
No | Obfuscated phone number that can be used as a hint for the end customer regarding which phone number the voice message was sent to. |
429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header
application/json
The response is object.
POST /one-time-token/whatsapp/trigger
Operation ID: ottWhatsappTrigger.
Authentication: bearer token (UserToken).
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
One-Time-Token |
header |
string |
Yes | Text value of a OTT. |
X-External-Correlation-Id |
header |
string (uuid) |
No | Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more. |
Responses
200: Trigger result with obfuscated phone number
application/json
| Property | Type | Required | Description |
|---|---|---|---|
obfuscatedPhoneNo |
string |
No | Obfuscated phone number that can be used as a hint for the end customer regarding which phone number the WhatsApp message was sent to. |
429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header
application/json
The response is object.
remove
DELETE /application/users/{userId}/phone-numbers/{phoneNumberId}
Operation ID: userSecurityPhoneNumberDelete.
Authentication: bearer token (ClientCredentialsToken).
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
userId |
path |
integer (int64) |
Yes | User ID. |
phoneNumberId |
path |
integer (int64) |
Yes | ID of a phone number. |
X-External-Correlation-Id |
header |
string (uuid) |
No | Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more. |
Responses
204: No Content
429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header
application/json
The response is object.