CEQUENS API
Developer HubCEQUENS Console
HomeAPI ReferenceSDKsContext Plugin
M F A

Send IVR Verification

POST
/mfa/v2/verification/ivr

Make a call to the recipient’s phone number to verify his identity, and that the given phone number is valid. Verify will send result to your Callback URL configured into your account. Supported channel for IVR is ONLY Voice

Authorization

bearerAuth
AuthorizationBearer <token>

JWT access token returned by Signing In (POST /auth/v1/tokens/).

In: header

Request Body

application/json

channel*string

Channel name which correspond to supported channels ; "Voice"

method*string

method used on verification. supported values : "IVR"

recipientIdentifier*string

Recipient mobile number

templateCode?string

Template code to use when make the call. If not provided , API uses the value defined in account configuration

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/mfa/v2/verification/ivr" \  -H "Content-Type: application/json" \  -d '{    "channel": "voice",    "method": "IVR",    "recipientIdentifier": "+xxxxxxxxxxxx",    "templateCode": "code"  }'
"{ \n \"status\":201,\n \"replyMessage\": \"[Request handled successfully]\",\n \"requestId\": \"32a6d7340-405e-11ea-9ffd-47489e6dbc08\",\n \"requestTime\": \"2020-01-26T19:06:30.912\",\n \"data\": {\n    \"checkCode\": \"NUAGYJBQMAYDSXAD\"\n  }\n}"

Check OTP Verification PUT

Validates the received OTP from your user with the check code returned from the Send OTP code API. If the codes match, then the OTP is validated, and the recipient’s phone number or email address is successfully verified.

Send push authentication POST

Send push authentication notification to the recipient’s phone on mobile application to verify his identity. Verify will send result to your Callback URL configured into your account.