KYC/CIP Compliance

Identity verification via trusted and verified data sources in the United States with watchlist screening included.

post
IDMatchCOMPLY5.1
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
Response
Request
Body Parameters
user
required
string
Your account's API username
pass
required
string
Your account's API password
service
required
string
The service name (IDMatch5.0)
reference
optional
string
A unique identifier for your customer
target
required
object
The individual being sent for verification
fn
required
string
The target's first name
ln
required
object
The target's last name
addr
required
string
The target's street address (line 1 and line 2)
city
optional
string
the target's city
state
optional
string
The target's state
zip
required
string
The target's zip
dob
optional
string
The target's Date of Birth (YYYYMMDD format)
ssn
optional
string
The target's SSN (either 4 or 9)
phone
optional
string
The target's phone number
email
optional
string
The target's email address
age
optional
string
The age to check (must be sent like "age+" i.e. "18+", "21+" etc.)
test_key
optional
string
The test key value that you are using to test
Response
200: OK
Transaction processed and result returned
{
  "meta": {
    "company": "Company ABC, Inc.",
    "confirmation": "21201890",
    "reference": "12345 {A UNIQUE ID}",
    "service": "IDMatchCOMPLY5.1",
    "timestamp": "2020-08-08 17:56:14",
    "user": "user@company.com"
  },
  "result": {
    "action": "REVIEW",
    "detail": "TRANSACTION REQUIRES FURTHER ATTENTION",
    "issues": [
      "SSN CHECK FAILED"
    ]
  }
}
Sample Request Body
{
      "user": "USERNAME",
      "pass": "PASSWORD",
      "service": "IDMatchCOMPLY5.1",
      "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": "bmiller@veratad.com",
            "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. 
​
A PASS will still occur if the only issue is ADDRESS DISCREPANCY 
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
ADDRESS DISCREPANCY
The address provided is a partial match to one of the addresses found
YEAR OF BIRTH CHECK FAILED
The Year of Birth provided does not match any on file
SSN CHECK FAILED
The SSN provided does not match any on file
NAME FOUND ON WATCHLIST
The target has been found on a watchlist
Example for PASS with an issue
This service is slightly different from other services in that it can return one issue with a PASS action. This issue is ADDRESS DISCREPANCY and it will only return as PASS if there are no other issues present. 
{
  "meta": {
    "company": "Company ABC, Inc.",
    "confirmation": "21201890",
    "reference": "12345 {A UNIQUE ID}",
    "service": "IDMatchCOMPLY5.1",
    "timestamp": "2017-08-08 17:56:14",
    "user": "user@company.com"
  },
  "result": {
    "action": "PASS",
    "detail": "ALL CHECKS PASSED",
    "issues": [
      "ADDRESS DISCREPANCY"
    ]
  }
}
Rules
IDMatch+COMPLY 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 or the only issue is ADDRESS DISCREPANCY 
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
Service Testing
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.
Test Cases
/testing-1/additional-test-cases

With KBA Escalation

COPPA Compliance

Last updated 7 months ago

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. A `PASS` will still occur if the only issue is `ADDRESS DISCREPANCY`

Issue	Description
ADDRESS CHECK FAILED	The address provided does not match any on file
ADDRESS DISCREPANCY	The address provided is a partial match to one of the addresses found
YEAR OF BIRTH CHECK FAILED	The Year of Birth provided does not match any on file
SSN CHECK FAILED	The SSN provided does not match any on file
NAME FOUND ON WATCHLIST	The target has been found on a watchlist

KYC/CIP Compliance

postIDMatchCOMPLY5.1

Sample Request Body

Action and Detail Responses

Issues Responses

Example for PASS with an issue

Rules

Service Testing

post
IDMatchCOMPLY5.1