V-PIN Stand Alone
VPINMatch5.0
POST https://production.idresponse.com/process/comprehensive/gateway
Make an HTTPS POST request with the following body parameters to find out if the target has provided valid identity attributes. You will receive a synchronous response in 2-3 seconds with a result object that includes an action, detail and issues object.
Request Body
user*
string
Your account's API username
pass*
string
Your account's API password
service*
string
The service name (VPINMatch5.0)
reference
string
A unique identifier for your customer
target*
object
The individual being sent for verification
fn*
string
The target's first name
ln*
object
The target's last name
addr*
string
The target's street address (line 1 and line 2)
city
string
the target's city
state
string
The target's state
zip*
string
The target's zip
dob*
string
The target's Date of Birth (YYYYMMDD format)
ssn
string
The target's SSN (either 4 or 9)
phone
string
The target's phone number
string
The target's email address
age
string
The age to check (must be sent like "age+" i.e. "18+", "21+" etc.)
test_key
string
The test key value that you are using to test
Use the test_key attribute to test the service. When the test_key is provided the system will use the dummy data provider and return a VPIN value.
Sample Request Body
Action and Detail Responses
The following are all values that will be returned in the result object of the response.
INFO
NOT A VERIFICATION
The trasnaction haas returned with INFO
FAIL
NO MATCH
There is no person matching the entered details.
FAIL
MULTIPLE VPIN MATCHES FOUND
We are finding an ambiguous result.
Last updated