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

Name	Type	Description
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
email	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

200 Transaction processed and result returned

{
    "meta": {
        "confirmation": 160393597,
        "timestamp": "2023-11-08 11:26:55",
        "reference": "",
        "user": "[e-mail]",
        "company": "Veratad Technologies, LLC",
        "service": "IDMatch5.0.VPIN"
    },
    "output": {
        "vpin": {
            "uuid": "5c13f55e-f438-47c1-9b2c-ffa10fe4464e"
        }
    },
    "result": {
        "action": "INFO",
        "detail": "NOT A VERIFICATION",
        "issues": []
    }
}

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

{
      "user": "USERNAME",
      "pass": "PASSWORD",
      "service": "VPINMatch5.0",
      "reference": "12345 {A UNIQUE ID}",
      "target":{
            "fn":"Barbara",
            "ln": "Miller",
            "addr": "123 Main St",
            "city": "Stratford",
            "state": "CT",
            "zip": "06614",
            "dob": "19740821",
            "ssn": "854125698",
            "phone": "2015106000",
            "email": "[e-mail]",
            "test_key": "general_identity"
          }
  }

Action and Detail Responses

The following are all values that will be returned in the result object of the response.

Action	Detail	Description
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.