OTPsApi
| Method | HTTP request | Description |
|---|---|---|
| contact_verification_authenticate_using_post | POST /api/web/v1/contact/verification/authenticate | Authenticate Contact Verification Challenge |
| contact_verification_challenge_using_post | POST /api/web/v1/contact/verification/challenge | Get Contact Verification Challenge |
| create_otp_using_post | POST /api/web/v1/otps | Creates and returns an OTP |
contact_verification_authenticate_using_post
OTPVerificationAuthenticateResponse contact_verification_authenticate_using_post(otp_verification_authenticate_value)
Authenticate Contact Verification Challenge
Authenticate the contact verification challenge. Caller requires the CONTACTVERIFICATION:ADD permission.
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| otp_verification_authenticate_value | OTPVerificationAuthenticateValue |
Return type
OTPVerificationAuthenticateResponse
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 400 | Bad request | - |
| 401 | Authorization information is missing or invalid | - |
| 429 | Too many requests | - |
contact_verification_challenge_using_post
OTPVerificationChallengeResponse contact_verification_challenge_using_post(otp_verification_challenge_value)
Get Contact Verification Challenge
Get a contact verification challenge for the specified contact. Caller requires the CONTACTVERIFICATION:ADD permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| otp_verification_challenge_value | OTPVerificationChallengeValue |
Return type
OTPVerificationChallengeResponse
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 400 | Bad request | - |
| 401 | Authorization information is missing or invalid | - |
| 429 | Too many requests | - |
create_otp_using_post
OTP create_otp_using_post(otp_create_parms)
Creates and returns an OTP
Create and return an OTP. Caller requires the OTPS:ADD permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| otp_create_parms | OTPCreateParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |