API
Ott
A one-time token: verify its SMS, voice or WhatsApp challenge, or get its status.
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/verify |
create |
One time token status |
POST |
/one-time-token/voice/verify |
create |
One time token status |
POST |
/one-time-token/whatsapp/verify |
create |
One time token status |
GET |
/one-time-token/status |
load |
One time token status |
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:
ott, err := client.Ott(nil).Load(nil, nil)
if err != nil {
panic(err)
}
fmt.Println(ott)
Lua
Construct client as shown in the Lua setup, then call the operations:
local ott, err = client:Ott():load()
PHP
Construct client as shown in the PHP setup, then call the operations:
$ott = $client->Ott()->load();
Python
Construct client as shown in the Python setup, then call the operations:
ott = client.Ott().load()
Ruby
Construct client as shown in the Ruby setup, then call the operations:
ott = client.Ott.load()
TypeScript
Construct client as shown in the TypeScript setup, then call the operations:
const ott = await client.Ott().load()
Fields
| Field | Type | Required | Description |
|---|---|---|---|
actionType |
string |
No | The action bound to the one time token. |
challenges |
array |
No | Array of challenge objects. |
oneTimeToken |
string |
No | Unique identifier of a one time token. |
userId |
integer |
No | Creator of this one time token. |
validity |
integer |
No | Seconds until the one time token becomes expired. |
create
POST /one-time-token/sms/verify
Operation ID: ottSmsVerify.
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. |
Request body
application/json
| Property | Type | Required | Description |
|---|---|---|---|
otpCode |
string |
No | 6 digit OTP code in text format. |
Responses
200: One time token status
application/json
| Property | Type | Required | Description |
|---|---|---|---|
oneTimeTokenProperties |
object |
No | Properties of the one time token. |
oneTimeTokenProperties.actionType |
string |
No | The action bound to the one time token. For example, BALANCE__GET_STATEMENT when we want to retrieve a balance account statement. |
oneTimeTokenProperties.challenges |
array of object |
No | Array of challenge objects. |
oneTimeTokenProperties.challenges[].alternatives |
array of object |
No | Alternative challenges that user can do instead. |
oneTimeTokenProperties.challenges[].passed |
boolean |
No | Status of this challenge. |
oneTimeTokenProperties.challenges[].primaryChallenge |
object |
No | Type of challenge user can do. |
oneTimeTokenProperties.challenges[].primaryChallenge.type |
string |
No | Type of the challenge (PIN, FACE_MAP, SMS, WHATSAPP, VOICE, PARTNER_DEVICE_FINGERPRINT). |
oneTimeTokenProperties.challenges[].primaryChallenge.viewData |
object |
No | An object that provides data required to present a challenge window. It can be messages, IDs, or other attributes. |
oneTimeTokenProperties.challenges[].required |
boolean |
No | Required (or not) to pass the OTT. |
oneTimeTokenProperties.oneTimeToken |
string |
No | Unique identifier of a one time token. |
oneTimeTokenProperties.userId |
integer (int64) |
No | Creator of this one time token. |
oneTimeTokenProperties.validity |
integer (int64) |
No | Seconds until the one time token becomes expired. |
Example response:
{
"oneTimeTokenProperties": {
"challenges": [],
"oneTimeToken": "9f5f5812-2609-4e48-8418-b64437c0c7cd",
"validity": 3600
}
}
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/verify
Operation ID: ottVoiceVerify.
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. |
Request body
application/json
| Property | Type | Required | Description |
|---|---|---|---|
otpCode |
string |
No | 6 digit OTP code in text format. |
Responses
200: One time token status
application/json
| Property | Type | Required | Description |
|---|---|---|---|
oneTimeTokenProperties |
object |
No | Properties of the one time token. |
oneTimeTokenProperties.actionType |
string |
No | The action bound to the one time token. For example, BALANCE__GET_STATEMENT when we want to retrieve a balance account statement. |
oneTimeTokenProperties.challenges |
array of object |
No | Array of challenge objects. |
oneTimeTokenProperties.challenges[].alternatives |
array of object |
No | Alternative challenges that user can do instead. |
oneTimeTokenProperties.challenges[].passed |
boolean |
No | Status of this challenge. |
oneTimeTokenProperties.challenges[].primaryChallenge |
object |
No | Type of challenge user can do. |
oneTimeTokenProperties.challenges[].primaryChallenge.type |
string |
No | Type of the challenge (PIN, FACE_MAP, SMS, WHATSAPP, VOICE, PARTNER_DEVICE_FINGERPRINT). |
oneTimeTokenProperties.challenges[].primaryChallenge.viewData |
object |
No | An object that provides data required to present a challenge window. It can be messages, IDs, or other attributes. |
oneTimeTokenProperties.challenges[].required |
boolean |
No | Required (or not) to pass the OTT. |
oneTimeTokenProperties.oneTimeToken |
string |
No | Unique identifier of a one time token. |
oneTimeTokenProperties.userId |
integer (int64) |
No | Creator of this one time token. |
oneTimeTokenProperties.validity |
integer (int64) |
No | Seconds until the one time token becomes expired. |
Example response:
{
"oneTimeTokenProperties": {
"challenges": [],
"oneTimeToken": "9f5f5812-2609-4e48-8418-b64437c0c7cd",
"validity": 3600
}
}
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/verify
Operation ID: ottWhatsappVerify.
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. |
Request body
application/json
| Property | Type | Required | Description |
|---|---|---|---|
otpCode |
string |
No | 6 digit OTP code in text format. |
Responses
200: One time token status
application/json
| Property | Type | Required | Description |
|---|---|---|---|
oneTimeTokenProperties |
object |
No | Properties of the one time token. |
oneTimeTokenProperties.actionType |
string |
No | The action bound to the one time token. For example, BALANCE__GET_STATEMENT when we want to retrieve a balance account statement. |
oneTimeTokenProperties.challenges |
array of object |
No | Array of challenge objects. |
oneTimeTokenProperties.challenges[].alternatives |
array of object |
No | Alternative challenges that user can do instead. |
oneTimeTokenProperties.challenges[].passed |
boolean |
No | Status of this challenge. |
oneTimeTokenProperties.challenges[].primaryChallenge |
object |
No | Type of challenge user can do. |
oneTimeTokenProperties.challenges[].primaryChallenge.type |
string |
No | Type of the challenge (PIN, FACE_MAP, SMS, WHATSAPP, VOICE, PARTNER_DEVICE_FINGERPRINT). |
oneTimeTokenProperties.challenges[].primaryChallenge.viewData |
object |
No | An object that provides data required to present a challenge window. It can be messages, IDs, or other attributes. |
oneTimeTokenProperties.challenges[].required |
boolean |
No | Required (or not) to pass the OTT. |
oneTimeTokenProperties.oneTimeToken |
string |
No | Unique identifier of a one time token. |
oneTimeTokenProperties.userId |
integer (int64) |
No | Creator of this one time token. |
oneTimeTokenProperties.validity |
integer (int64) |
No | Seconds until the one time token becomes expired. |
Example response:
{
"oneTimeTokenProperties": {
"challenges": [],
"oneTimeToken": "9f5f5812-2609-4e48-8418-b64437c0c7cd",
"validity": 3600
}
}
429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header
application/json
The response is object.
load
GET /one-time-token/status
Operation ID: ottStatusGet.
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: One time token status
application/json
| Property | Type | Required | Description |
|---|---|---|---|
oneTimeTokenProperties |
object |
No | Properties of the one time token. |
oneTimeTokenProperties.actionType |
string |
No | The action bound to the one time token. For example, BALANCE__GET_STATEMENT when we want to retrieve a balance account statement. |
oneTimeTokenProperties.challenges |
array of object |
No | Array of challenge objects. |
oneTimeTokenProperties.challenges[].alternatives |
array of object |
No | Alternative challenges that user can do instead. |
oneTimeTokenProperties.challenges[].passed |
boolean |
No | Status of this challenge. |
oneTimeTokenProperties.challenges[].primaryChallenge |
object |
No | Type of challenge user can do. |
oneTimeTokenProperties.challenges[].primaryChallenge.type |
string |
No | Type of the challenge (PIN, FACE_MAP, SMS, WHATSAPP, VOICE, PARTNER_DEVICE_FINGERPRINT). |
oneTimeTokenProperties.challenges[].primaryChallenge.viewData |
object |
No | An object that provides data required to present a challenge window. It can be messages, IDs, or other attributes. |
oneTimeTokenProperties.challenges[].required |
boolean |
No | Required (or not) to pass the OTT. |
oneTimeTokenProperties.oneTimeToken |
string |
No | Unique identifier of a one time token. |
oneTimeTokenProperties.userId |
integer (int64) |
No | Creator of this one time token. |
oneTimeTokenProperties.validity |
integer (int64) |
No | Seconds until the one time token becomes expired. |
Example response:
{
"oneTimeTokenProperties": {
"actionType": "BALANCE__GET_STATEMENT",
"challenges": [
{
"alternatives": [],
"passed": false,
"primaryChallenge": {
"type": "PIN",
"viewData": {
"attributes": {
"userId": 6146956
}
}
},
"required": true
}
],
"oneTimeToken": "9f5f5812-2609-4e48-8418-b64437c0c7cd",
"userId": 6146956,
"validity": 3600
}
}
429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header
application/json
The response is object.