Download OpenAPI specification:Download
Contains functionality around OTP (one time password) services.
For endpoints that support localization the language can be passed either as a query string parameter (using the name 'language') or in the 'accept-language' header.
If no language is passed to such endpoints then the default configured language will be used.
Checks validity of a one-time verification code sent to the contact under the context of a specific session.
| contactId required | integer <int32> Contact id |
| sessionId required | string Session id |
| key required | string Key |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "keyStatus": "Valid",
- "attemptsLeft": 0
}Verifies a one-time verification code sent to the contact under the context of a specific session.
| contactId required | integer <int32> Contact id |
| sessionId required | string Session id |
| key required | string Key |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "keyStatus": "Valid",
- "attemptsLeft": 0
}Sends a one-time verification code to the contact in a specific channel. If a sessionId is not specified, a generated sessionId would be returned (to be used when verifying the key).
| contactId required | integer <int32> Contact ID. |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
Send verification key request.
| sessionId | string Nullable |
| channel | string (VerificationChannelKey) Enum: "Sms" "Email" |
| templateMetadataKey | string Nullable |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "sessionId": "string",
- "channel": "Sms",
- "templateMetadataKey": "string"
}{- "generatedSessionId": "string"
}