CEcequens

Send IVR Verification

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

post/v2/verification/ivr

Request

  • Base URL
    https://apis.cequens.com/mfa
  • URL
    https://apis.cequens.com/mfa/v2/verification/ivr
  • Auth
    API key in header Authorization

Request body

channelstring required

Channel name which correspond to supported channels ; "Voice"

methodstring required

method used on verification. supported values : "IVR"

recipientIdentifierstring required

Recipient mobile number

templateCodestring

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

Response

200

statusinteger
replyMessagestring
requestIdstring
requestTimestring

Example response

{
  "status": 201,
  "replyMessage": "[Request handled successfully]",
  "requestId": "32a6d7340-405e-11ea-9ffd-47489e6dbc08",
  "requestTime": "2020-01-26T19:06:30.912",
  "data": {
    "checkCode": "NUAGYJBQMAYDSXAD"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.