POST web_api/securelink/confirmation_questions/ivr

Send a new SecureLink Confirmation Question request via IVR phone call.

Request Information

URI Parameters

None.

Body Parameters

The customized question that you want to ask the user to confirm and the phone number to send the request to will be included in the body formatted as a SecureLinkConfirmationRequest object.

SecureLinkConfirmationRequest

Name	Description	Type	Additional information
PhoneNumber	The phone number to send the Confirmation Request question to	string	Required Matching regular expression pattern: \d{7,15}
ConfirmationQuestion	The Confirmation Request question to ask the user. This must be a Yes/No question, where an answer of "Yes" results in a positive confirmation	string	Required Max length: 200

Name

Description

Type

Additional information

PhoneNumber

The phone number to send the Confirmation Request question to

string

Required

Matching regular expression pattern: \d{7,15}

ConfirmationQuestion

The Confirmation Request question to ask the user. This must be a Yes/No question, where an answer of "Yes" results in a positive confirmation

string

Required

Max length: 200

Request Formats

application/json, text/json

Sample:

{
  "PhoneNumber": "sample string 1",
  "ConfirmationQuestion": "sample string 2"
}

application/xml, text/xml

Sample:

<SecureLinkConfirmationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VerificationServicesApi.CustomClasses">
  <ConfirmationQuestion>sample string 2</ConfirmationQuestion>
  <PhoneNumber>sample string 1</PhoneNumber>
</SecureLinkConfirmationRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The response body will include a SecureLink Request Result which includes the RequestId value that is needed to check on the result of the request using the GET action

SecureLinkRequestResult

Name	Description	Type	Additional information
SecureLinkRequestId	The SecureLink RequestId value that you will use to retrieve the result of the user response	integer	None.
ErrorMessage	Only populated if there is an error processing the request	string	None.

Response Formats

application/json, text/json

Sample:

{
  "SecureLinkRequestId": 1,
  "ErrorMessage": "sample string 1"
}

application/xml, text/xml

Sample:

<SecureLinkRequestResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.giact.com/verificationservices/v5">
  <ErrorMessage>sample string 1</ErrorMessage>
  <SecureLinkRequestId>1</SecureLinkRequestId>
</SecureLinkRequestResult>