# United States (DMV)

## AgeMatch5.0.DMV

<mark style="color:green;">`POST`</mark> `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 attributes that match the document. 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<mark style="color:red;">\*</mark>    | string | Your account's API username                                                                                                                                          |
| pass<mark style="color:red;">\*</mark>    | string | Your account's API password                                                                                                                                          |
| service<mark style="color:red;">\*</mark> | string | <p>The service name<br><br>(AgeMatch5.0.DMV)<br></p>                                                                                                                 |
| reference                                 | string | A unique identifier for your customer                                                                                                                                |
| target                                    | object | The individual being sent for verification                                                                                                                           |
| age<mark style="color:red;">\*</mark>     | string | <p>The age to check<br><br>(must be sent like "age+" i.e. "18+", "21+" etc.)<br></p>                                                                                 |
| document                                  | object | The data from the document                                                                                                                                           |
| fn<mark style="color:red;">\*</mark>      | string | The target's document first name                                                                                                                                     |
| mn                                        | string | The target's document middle name                                                                                                                                    |
| ln<mark style="color:red;">\*</mark>      | string | The target's document last name                                                                                                                                      |
| suffix                                    | string | The target's document name suffix                                                                                                                                    |
| addr<mark style="color:red;">\*</mark>    | string | <p>The target's document street address<br><br>(line 1 and line 2)<br></p>                                                                                           |
| city                                      | string | the target's document city                                                                                                                                           |
| state                                     | string | The target's document state                                                                                                                                          |
| zip<mark style="color:red;">\*</mark>     | string | The target's document zip                                                                                                                                            |
| dob                                       | string | <p>The target's document Date of Birth<br><br>(YYYYMMDD format)<br></p>                                                                                              |
| number                                    | string | The target's document ID number                                                                                                                                      |
| expiration                                | string | The target's document expiration date                                                                                                                                |
| issue                                     | string | The target's document issue date                                                                                                                                     |
| height                                    | string | <p>The target's document height<br><br>(provided in feet and inches i.e. 5 feet 10 inches is presented as "510")<br></p>                                             |
| weight                                    | string | The target's document weight                                                                                                                                         |
| eye\_color                                | string | The target's document eye color                                                                                                                                      |
| gender                                    | string | <p>The target's document gender<br><br>m = male<br>f = female<br></p>                                                                                                |
| category                                  | string | <p>The target's document category<br><br>1 = Driver License<br>2 = Driver Permit<br>3 = ID Card<br><br>(if none is supplied then Driver License will be assumed)</p> |

{% tabs %}
{% tab title="200 Transaction processed and result returned" %}

```javascript
{
  "meta": {
    "company": "Company, LLC",
    "confirmation": "21201890",
    "reference": "12345 {A UNIQUE ID}",
    "service": "AgeMatch5.0.DMV",
    "timestamp": "2020-01-01 17:56:14",
    "user": "user@company.com"
  },
  "result": {
    "action": "REVIEW",
    "detail": "TRANSACTION REQUIRES FURTHER ATTENTION",
    "issues": [
      "DOB CHECK FAILED",
      "LAST NAME CHECK FAILED"
    ]
  }
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
Service testing is done with the live data source. Veratad will provide you with an amount of free transactions for testing purposes.
{% endhint %}

## Sample Request Body

```javascript
{
      "user": "USERNAME",
      "pass": "PASSWORD",
      "service": "AgeMatch5.0.DMV",
      "reference": "12345 {A UNIQUE ID}",
      "target":{
        "document":{
            "fn":"Barbara",
            "mn":"Anne",
            "ln": "Miller",
            "suffix": "JR",
            "addr": "123 Main St APT 6",
            "city": "Stratford",
            "state": "CT",
            "zip": "06614",
            "dob": "19740821",
            "height": "502",
            "weight": "120",
            "eye_color": "blue",
            "gender": "f",
            "number": "D0415 73071 06822",
            "expiration": "20220412",
            "issue": "20170412",
            "category": "1"
          }
          "age": "21+"
        }
  }
```

## 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 match found with document ID number                                                                                                                                                                 |
| REVIEW | TRANSACTION REQUIRES FURTHER ATTENTION | Target found, 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 and has passed all verification checks                                                                                                                                                |
| PASS   | VERIFICATION EXISTS                    | If Veratad storage is active then an already verified customer will PASS without the search at the data source                                                                                         |

## 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                                                                             |
| ----------------------------- | --------------------------------------------------------------------------------------- |
| FIRST NAME CHECK FAILED       | The first name provided does not match data associated with document number             |
| MIDDLE NAME CHECK FAILED      | The middle name provided does not match data associated with document number            |
| LAST NAME CHECK FAILED        | The last name provided does not match data associated with document number              |
| NAME SUFFIX CHECK FAILED      | The name suffix provided does not match data associated with document number            |
| ADDRESS CHECK FAILED          | The address provided does not match data associated with document number                |
| ADDRESS POD CHECK FAILED      | The address point of delivery does not match data associated with document number       |
| CITY CHECK FAILED             | The city provided does not match data associated with document number                   |
| STATE CHECK FAILED            | The state provided does not match data associated with document number                  |
| ZIP CHECK FAILED              | The zip provided does not match data associated with document number                    |
| DATE OF BIRTH CHECK FAILED    | The Date of Birth provided does not match data associated with document number          |
| ID EXPIRATION CHECK FAILED    | The ID expiration date provided does not match data associated with the document number |
| ID ISSUE CHECK FAILED         | The ID issue date provided does not match data associated with the document number      |
| GENDER CHECK FAILED           | The gender provided does not match data associated with the document number             |
| EYE COLOR CHECK FAILED        | The eye color provided does not match data associated with the document number          |
| WEIGHT CHECK FAILED           | The weight provided does not match data associated with the document number             |
| HEIGHT CHECK FAILED           | The height provided does not match data associated with the document number             |
| AGE CHECK FAILED              | The Date of Birth provided is under the age requirement                                 |
| CURRENT DOCUMENT CHECK FAILED | The expiration date provided is in the past                                             |

## Rules

AgeMatch5.0.DMV will process with the default base ruleset:

{% hint style="success" %}
The base ruleset will return a PASS when:

* A match is found
* There are no issues
  {% endhint %}

{% hint style="warning" %}
The base ruleset will return a REVIEW when:

* A match is found
* The target's identity attributes do not all match
  {% endhint %}

{% hint style="danger" %}
The base ruleset will return a FAIL when:

* A match is not found
  {% endhint %}
