Call
Validate a user's number and send a one time password via call to their phone to verify they have possession.
This service is asynchronous
The PhoneMatch OTP delivery services are asynchronous which means you will make an initial call to send the OTP and receive a response and a second call to validate the user's OTP entry against what was sent.
Initial Request - Send the phone number with other options via the Initial Request Instructions below and when successful you will receive a response with a template that includes a token value.
OTP Validation Request - Send the template returned in the initial request including the token and the user's OTP entry back to the system for final match result.
As part of this process you are also validating the number the user provided since the service will not send to invalid phone lines.
PhoneMatch5.0.Call (initial request)
POST
https://production.idresponse.com/process/comprehensive/gateway
Initial request details
Request Body
Sample Initial Request Body
Action and Detail Responses Initial Request
The following are all values that will be returned in the result object of the response.
PhoneMatch5.0.Call (OTP validation request)
POST
https://production.idresponse.com/process/continue
OTP validation request details
Request Body
Sample OTP Validation Request Body
Action and Detail Response OTP Validation Request
Rules
PhoneMatch+SMS will process with the default base ruleset:
The base ruleset will return a PASS when:
The phone number is valid
The phone line type is not found in the
do_not_send_to_types
arrayThe OTP was sent successfully
The user OTP entry matched the OTP sent
The base ruleset will return a PENDING when:
The phone number is valid
The phone line type is not found in the
do_not_send_to_types
arrayThe OTP was sent successfully
The transaction is waiting for submission of the user's OTP entry
The base ruleset will return a FAIL when:
The phone number is not valid
The phone line type is found in the
do_not_send_to_types
arrayThe OTP was not sent successfully
The user OTP entry did not match the OTP sent
Last updated