United States

Identity verification via trusted and verified data sources in the United States.

IDMatch5.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 (IDMatch5.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": {
    "company": "Company ABC, Inc.",
    "confirmation": "21201890",
    "reference": "12345 {A UNIQUE ID}",
    "service": "IDMatch5.0",
    "timestamp": "2017-08-08 17:56:14",
    "user": "[e-mail]"
  },
  "result": {
    "action": "REVIEW",
    "detail": "TRANSACTION REQUIRES FURTHER ATTENTION",
    "issues": [
      "SSN CHECK FAILED"
    ]
  }
}

Use the test_key attribute to test the service. When the test_key is provided the system will dynamically drop the live data sources and use the testing database. These transactions are free of charge. To access live data do not send this attribute. The below sample request is one of the available test cases. To access more click the link below.

pageTest Cases

Sample Request Body

{
      "user": "USERNAME",
      "pass": "PASSWORD",
      "service": "IDMatch5.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]",
            "age": "21+",
            "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
FAIL	NO MATCH	No matching identity found in the data sources
FAIL	TARGET IS DECEASED	Target found as a deceased identity
REVIEW	TRANSACTION REQUIRES FURTHER ATTENTION	Target found and not deceased, but at least one identity attribute provided does not match. This will also populate the "issues" object with a list of the identity attributes that did not match. See full list below.
PASS	ALL CHECKS PASSED	Target was found, is not deceased and has passed all verification checks

Issues Responses

When a transaction returns as REVIEW then there will be a list of issues. This list can include any of the below values.

Issue	Description
ADDRESS CHECK FAILED	The address provided does not match any on file
DATE OF BIRTH CHECK FAILED	The Date of Birth provided does not match any on file
YEAR OF BIRTH CHECK FAILED	The Year of Birth provided does not match any on file
MONTH OF BIRTH CHECK FAILED	The Month of Birth provided does not match any on file
DAY OF BIRTH CHECK FAILED	The Day of Birth provided does not match any on file
SSN CHECK FAILED	The SSN provided does not match any on file
PHONE CHECK FAILED	The phone number provided does not match any on file
EMAIL CHECK FAILED	The email address provided does not match any on file
AGE CHECK FAILED	The target does not meet the age attribute provided
POSSIBLE MINOR	The target is detected as a minor

Rules

IDMatch will process with the default base ruleset:

The base ruleset will return a PASS when:

• A match is found

• The target is not deceased

• The target has provided all valid identity attributes

The base ruleset will return a REVIEW when:

• A match is found

• The target is not deceased

• The target's identity attributes do not all match

The base ruleset will return a FAIL when:

• A match is not found

• The target is deceased