SMS
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.
postPhoneMatch5.0.SMS (initial request)
{"output": {"outofband": {}},"meta": {"confirmation": 57984073,"reference": "12345","service": "PhoneMatch5.0.SMS","timestamp": "2019-01-07 12:35:09","company": "Company ABC, Inc.","user": "[email protected]"},"result": {"action": "PENDING","detail": "MORE INFORMATION IS REQUIRED","issues": []},"continuations": {"outofband": {"url": "/process/continue","template": {"token": "o76m3nvz94jvaatfsmespzgx3qkzjjl1","codematch": {"key": null}},"instructions": "A code has been delivered to the provided number. Please resubmit the code to complete the transaction."}}}
{"user": "[email protected]","pass": "PASSWORD","service": "PhoneMatch5.0.SMS","reference": "12345","options": {"outofband": {"message": "Hello {fn}, your one-time password is {pin}","do_not_send_to_types": ["voip", "mobile", "landline"]}},"target": {"fn": "John","ln": "Smith","phone": "2015106000"}}
The following are all values that will be returned in the result object of the response.
Action | Detail | Description |
FAIL | SUPPRESSED SENDING CODE | The phone line type was detected as one of the line types passed in the options object in the |
FAIL | FAILED TO SEND TO NUMBER | An issue occurred during password delivery and it never reached the user |
FAIL | DATA CHECK FAILED | The phone number is invalid and the code could not be sent |
PENDING | TRANSACTION REQUIRES FURTHER ATTENTION | The line type is not in the |
postPhoneMatch5.0.SMS (OTP validation request)
{"final": {"template": {"token": "1x6mvu6b4kuwonduqw8b1nsj7jpxgaza"},"url": "\/process\/status"},"meta": {"company": "Veratad Technologies, LLC","confirmation": 96197373,"reference": null,"service": "PhoneMatch5.0.SMS","timestamp": "2020-07-10 10:46:08","user": "[email protected]"},"output": {"codematch": {"key_matched": true}},"result": {"action": "PASS","detail": "ALL CHECKS PASSED","issues": []}}
{"token": "o76m3nvz94jvaatfsmespzgx3qkzjjl1","codematch": {"key": "12345"}}
Action | Detail | Description |
FAIL | FAILED OUT-OF-BAND CHECK | The number is valid, the line type was not found in the |
PASS | ALL CHECKS PASSED | The number is valid, the line type was not found in the |
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_typesarrayThe 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_typesarrayThe 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_typesarrayThe OTP was not sent successfully
The user OTP entry did not match the OTP sent
