OTPsApi
| Method | HTTP request | Description |
|---|---|---|
| ContactVerificationAuthenticateUsingPOST | POST /api/web/v1/contact/verification/authenticate | Authenticate Contact Verification Challenge |
| ContactVerificationChallengeUsingPOST | POST /api/web/v1/contact/verification/challenge | Get Contact Verification Challenge |
| CreateOTPUsingPOST | POST /api/web/v1/otps | Creates and returns an OTP |
ContactVerificationAuthenticateUsingPOST
OTPVerificationAuthenticateResponse ContactVerificationAuthenticateUsingPOST (OTPVerificationAuthenticateValue oTPVerificationAuthenticateValue)
Authenticate Contact Verification Challenge
Authenticate the contact verification challenge. Caller requires the CONTACTVERIFICATION:ADD permission.
Using the ContactVerificationAuthenticateUsingPOSTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| oTPVerificationAuthenticateValue | 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 | - |
ContactVerificationChallengeUsingPOST
OTPVerificationChallengeResponse ContactVerificationChallengeUsingPOST (OTPVerificationChallengeValue oTPVerificationChallengeValue)
Get Contact Verification Challenge
Get a contact verification challenge for the specified contact. Caller requires the CONTACTVERIFICATION:ADD permission.
Example
Using the ContactVerificationChallengeUsingPOSTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| oTPVerificationChallengeValue | 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 | - |
CreateOTPUsingPOST
OTP CreateOTPUsingPOST (OTPCreateParms oTPCreateParms)
Creates and returns an OTP
Create and return an OTP. Caller requires the OTPS:ADD permission.
Example
Using the CreateOTPUsingPOSTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| oTPCreateParms | 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 | - |