---
title: US DL Verification
slug: us-apis/us-dl-verification
description: Learn how Signzy is developing a global product for conducting background checks on gig workers and other working classes. Discover how they have integrated National Criminal Checks, PEP, Adverse Media & Watchlists checks API from Vital4 and their need to
docTags: 
createdAt: 2022-12-09T07:28:39.000Z
---

## Introduction

**US Driver's License Verification** is a solution set to streamline the process of verifying the authenticity of driver's licenses within the United States. Leveraging data from the **American Association of Motor Vehicle Administrators (AAMVA)**, this API will perform comprehensive checks by comparing multiple parameters from the **AAMVA's** database against user/client provided information. This verification process ensures the high level of accuracy and security. In a world where trust and accuracy matter, our API ensures that the driver's license details you receive are not just valid but also meticulously verified.

## US Driver's License

A United States Driver's License, is an official document issued by state governments within the United States that authorizes individuals to operate motor vehicles legally on the country's roadways. It serves as both a form of personal identification and a permit to drive a car, motorcycle, or other types of motor vehicles, depending on the specific type of driver's license.

Here are some key points to understand about the U.S. Driver's License:

**1. Legal Requirement:** In the United States, it is typically a legal requirement to possess a valid driver's license in order to drive a motor vehicle on public roads. Driving without a valid license can result in legal penalties.

**2. State-Based:** Driver's licenses in the U.S. are issued by individual states and territories. Each state has its own Department of Motor Vehicles (DMV) or equivalent agency responsible for issuing and regulating driver's licenses.

**3. Types of Driver's Licenses:** There are various types of driver's licenses, including a regular driver's license for operating standard passenger vehicles, commercial driver's licenses (CDL) for driving commercial vehicles like trucks and buses, and learner's permits for those who are learning to drive.

**4. Identification:** Driver's licenses also serve as a form of personal identification. They typically include the driver's photograph, full legal name, date of birth, and residential address.

**5. Age Restrictions:** Some states issue driver's licenses to individuals as young as 16 for regular driving, while others have minimum age requirements for specific types of licenses, such as motorcycle endorsements.

**6. Expiry:** Driver's licenses have expiration dates, typically requiring renewal every few years. The expiration date can vary from state to state.

**7. Driving Records:** Each state maintains a driving record for license holders, which includes information on traffic violations, accidents, and other driving-related incidents.

**8. Interstate Recognition:** U.S. driver's licenses are generally recognized and accepted throughout the country. This means that you can typically use your home state's license when traveling or moving to a different state.

## What is AAMVA

The American Association of Motor Vehicle Administrators (AAMVA) is a non-profit organization that serves as a central authority and resource for motor vehicle and driver licensing agencies across the United States. At present **41 USA States** are members of AAMVA. AAMVA facilitates cooperation and collaboration among these agencies to improve and standardize various aspects of motor vehicle administration and regulation. Here's a brief context about AAMVA:

**Membership:** AAMVA's membership includes all U.S. states and U.S. territories. This extensive membership makes it a key organization for promoting uniformity in motor vehicle and driver licensing practices.

**Functions:** AAMVA provides a range of services, including research, information sharing, best practices, and the development of standards and specifications for driver licensing, vehicle registration, and other related functions.

**Data Exchange:** AAMVA plays a vital role in standardizing data sharing and information exchange among member jurisdictions. This is particularly important for activities such as driver's license verification and motor vehicle record sharing.

## Overview of US DL Verification API

US Driver's License Verification API offers a reliable and efficient way to verify driver's license details, enhancing data accuracy and security across a wide range of applications. The API provides real-time verification of driver's license details, offering a robust set of verification metrics and seamless integration capabilities.&#x20;

## API Applications

### B2B (Business-to-Business) Applications:

1. **Insurance Companies:** Insurance providers can use this API to validate driver's license details when customers apply for auto insurance.&#x20;
2. **Car Rental Agencies:** Car rental companies can integrate this API to confirm the validity of driver's licenses before renting vehicles.
3. **Employers and Background Check Services:** Employers and background check services can utilize this API for verifying driver's license information.
4. **Transportation and Logistics Companies:** Businesses in the transportation and logistics sector can employ this API to verify the driver's licenses of their delivery personnel.

### B2C (Business-to-Consumer) Applications:

1. **Consumer Auto Insurance:** Individuals seeking auto insurance can use this API to verify their driver's license details during the online application process.&#x20;
2. **Ride-Sharing and Carpooling Services:** Ride-sharing and carpooling platforms can incorporate this API to validate the driver's licenses of drivers.
3. **Peer-to-Peer Car Rentals:** Platforms that facilitate peer-to-peer car rentals can offer drivers the option to verify their licenses through this API.
4. **Job Seekers:** Individuals applying for jobs that involve driving, such as delivery or transportation roles, can use this API to validate their driver's license information.

## API Details

You must first login before sending the request. The authorization header in the request must include the access token obtained from the login API call.

Need to pass the following information. **Providing personFullname,** **nationalId, personDob is mandatory**.&#x20;

- **firstName**(required)
- **middleName**
- **lastName**(required)
- **dateOfBirth**
- **sex**
- **address**
- **addressLine2**
- **city**
- **state**(required)
- **zip**
- **ssn**
- **driverLicenseNumber**(required)
- **driverLicenseIssueDate**
- **driverLicenseExpirationDate**
- **confidenceThreshold**

### Sample cURL

::::Tabs
:::Tab{title="Pre-Production"}
```curl
curl --location 'https://api-preproduction.signzy.us/api/v3/dl-verification' \
--header 'Content-Type: application/json' \
--header 'Authorization: <token>' \
--data '{
    "firstName": <string>,
    "middleName": <string>,
    "lastName": <string>,
    "dateOfBirth": <yyyy-mm-dd>,
    "sex": <M or F>,
    "address": <string>,
    "addressLine2": <string>,
    "city": <string>,
    "state": <string>,
    "zip": <string>,
    "ssn": <string>,
    "driverLicenseNumber": <string>,
    "driverLicenseIssueDate": <yyyy-mm-dd>,
    "driverLicenseExpirationDate": <yyyy-mm-dd>,
    "confidenceThreshold": <number>
}'
```
:::

:::Tab{title="Production"}
```curl
curl --location 'https://api.signzy.us/api/v3/dl-verification' \
--header 'Content-Type: application/json' \
--header 'Authorization: <token>' \
--data '{
    "firstName": <string>,
    "middleName": <string>,
    "lastName": <string>,
    "dateOfBirth": <yyyy-mm-dd>,
    "sex": <M or F>,
    "address": <string>,
    "addressLine2": <string>,
    "city": <string>,
    "state": <string>,
    "zip": <string>,
    "ssn": <string>,
    "driverLicenseNumber": <string>,
    "driverLicenseIssueDate": <yyyy-mm-dd>,
    "driverLicenseExpirationDate": <yyyy-mm-dd>,
    "confidenceThreshold": <number>
}'
```
:::
::::

### Request Body Parameters

| **Parameter**               | **Data Type** | **Required** | **Description**                                                                                                                                                                             |
| --------------------------- | ------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| firstName                   | string        | Yes          | **Required** First name of the individual.                                                                                                                                                  |
| middleName                  | string        | No           | **Optional&#x20;**&#x4D;iddle name of the individual.                                                                                                                                       |
| lastName                    | string        | Yes          | **Required&#x20;**&#x4C;ast name of the individual.                                                                                                                                         |
| dateOfBirth                 | string        | No           | **Optional** Date of birth of the individual **(ISO 8601)** **(yyyy-mm-dd** forma&#x74;**)**.                                                                                               |
| sex                         | string        | No           | **Optional&#x20;**&#x47;ender of the individual(only **M** or **F** values allowed).                                                                                                        |
| address                     | string        | No           | **Optional&#x20;**&#x53;treet address of the individual.                                                                                                                                    |
| addressLine2                | string        | No           | **Optional&#x20;**&#x41;ddress line 2 (if applicable).                                                                                                                                      |
| city                        | string        | No           | **Optional&#x20;**&#x43;ity of residence.                                                                                                                                                   |
| state                       | string        | Yes          | **Required&#x20;**&#x53;tate of residence. Should be of **two letter state code**(list provided above).                                                                                     |
| zip                         | string        | No           | **Optional&#x20;**&#x5A;IP code of the location.                                                                                                                                            |
| ssn                         | string        | No           | **Optional&#x20;**&#x53;ocial Security Number.                                                                                                                                              |
| driverLicenseNumber         | string        | Yes          | **Required&#x20;**&#x44;river's license number.                                                                                                                                             |
| driverLicenseIssueDate      | string        | No           | **Optional&#x20;**&#x44;river's license issue date **(ISO 8601)** **(yyyy-mm-dd** forma&#x74;**)**.                                                                                         |
| driverLicenseExpirationDate | string        | No           | **Optional&#x20;**&#x44;river's license expiration date **(ISO 8601)** **(yyyy-mm-dd** forma&#x74;**)**.                                                                                    |
| confidenceThreshold         | number        | No           | **Optional&#x20;**&#x43;onfidence threshold provided by the user. Only numeric values from **0.7 to 1&#x20;**&#x61;llowed(if not passed, default value of **0.7&#x20;**&#x77;ill be added). |

### Sample Response

:::CodeblockTabs
Validation Successful 200

```json
{
    "result": {
        "driverLicenseVerificationResult": {
            "documentCategoryMatch": "true",
            "personLastNameExactMatch": "true",
            "personLastNameFuzzyPrimaryMatch": "",
            "personLastNameFuzzyAlternateMatch": "",
            "personFirstNameExactMatch": "true",
            "personFirstNameFuzzyPrimaryMatch": "",
            "personFirstNameFuzzyAlternateMatch": "",
            "personMiddleNameExactMatch": "false",
            "personMiddleNameFuzzyPrimaryMatch": "false",
            "personMiddleNameFuzzyAlternateMatch": "false",
            "personMiddleInitialMatch": "false",
            "personBirthDateMatch": "true",
            "driverLicenseIssueDateMatch": "true",
            "driverLicenseExpirationDateMatch": "true",
            "driverLicenseNumberMatch": "true",
            "addressLine1Match": "true",
            "addressLine2Match": "",
            "addressCityMatch": "true",
            "addressStateCodeMatch": "true",
            "addressZIP5Match": "true",
            "addressZIP4Match": "",
            "personSexCodeMatch": "true",
            "addressLine1FuzzyMatch": ""
        },
        "confidenceThreshold": 0.7,
        "confidenceScore": 1,
        "validationResult": "Validation Successful"
    }
}
```

Validation Failure 200

```json
{
    "result": {
        "driverLicenseVerificationResult": {
            "documentCategoryMatch": "true",
            "personLastNameExactMatch": "true",
            "personLastNameFuzzyPrimaryMatch": "",
            "personLastNameFuzzyAlternateMatch": "",
            "personFirstNameExactMatch": "false",
            "personFirstNameFuzzyPrimaryMatch": "false",
            "personFirstNameFuzzyAlternateMatch": "false",
            "personMiddleNameExactMatch": "false",
            "personMiddleNameFuzzyPrimaryMatch": "false",
            "personMiddleNameFuzzyAlternateMatch": "false",
            "personMiddleInitialMatch": "false",
            "personBirthDateMatch": "false",
            "driverLicenseIssueDateMatch": "true",
            "driverLicenseExpirationDateMatch": "true",
            "driverLicenseNumberMatch": "true",
            "addressLine1Match": "true",
            "addressLine2Match": "",
            "addressCityMatch": "true",
            "addressStateCodeMatch": "true",
            "addressZIP5Match": "true",
            "addressZIP4Match": "",
            "personSexCodeMatch": "true",
            "addressLine1FuzzyMatch": ""
        },
        "confidenceThreshold": 0.85,
        "confidenceScore": 0.8,
        "validationResult": "Validation Failed"
    }
}
```

Unsupported State 200

```json
{
    "result": {
        {
    "serviceName": "DMV Verification",
    "serviceDescription": "Driver License Data Verification",
    "error": "<StateName> state is not yet supported by DMV Data Verification   service. Check back later.",
    "success": false
 }

}
```

State Server Unavailable 200

```json
{
    "result": {
        {
    "serviceName": "DMV Verification",
    "serviceDescription": "Driver License Data Verification",
    "error": "<StateName> state server is temporarily unavailable. Please, try again later",
    "success": false
 }

}
```

Error in Processing 200

```json
{
    "result": {
        {
    "serviceName": "DMV Verification",
    "serviceDescription": "Driver License Data Verification",
    "error": "An error has occurred while processing your request, please contact us",
    "success": false
 }

}
```

Unable to Complete Request 200

```json
{
    "result": {
        {
    "serviceName": "DMV Verification",
    "serviceDescription": "Driver License Data Verification",
    "error": "Unable to complete request, please contact us",
    "success": false
 }

}
```

Subscription Expired 200

```json
{
    "result": {
        {
    "serviceName": "DMV Verification",
    "serviceDescription": "Driver License Data Verification",
    "error": "Our subscription to the Screening service DMV Verification has expired.Please contact Signzy at help@signzy.com",
    "success": false
 }

}
```
:::

### Response Body parameters

| **Parameter**                   | **Data Type** | **Description**                                                                                                                                                             |
| ------------------------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| driverLicenseVerificationResult | Object        | Verification details for the driver's license                                                                                                                               |
| confidenceThreshold             | String        | Confidence Threshold from request( assigned as **0.7** by default if not provided).                                                                                         |
| confidenceScore                 | Number        | Confidence Score calculated based on driverLicenseVerificationResult details. Value may vary from **0 to 1.**                                                               |
| validationResult                | Number        | Final validation result for DL Verification. (Value is **"Validation Successful"** if confidenceScore is greater than or equal to threshold, else **"Validation Failed"**). |

### driverLicenseVerificationResult Parameters

| **Name**                            | **Type** | **Description**                                                                            |
| ----------------------------------- | -------- | ------------------------------------------------------------------------------------------ |
| documentCategoryMatch               | string   | Indicates if the document category matches.                                                |
| personLastNameExactMatch            | string   | Indicates if the person's last name is an exact match.                                     |
| personLastNameFuzzyPrimaryMatch     | string   | Indicates if the person's last name is a fuzzy primary match.                              |
| personLastNameFuzzyAlternateMatch   | string   | Indicates if the person's last name is a fuzzy alternate match.                            |
| personFirstNameExactMatch           | string   | Provides the information if Indicates if the person's first name is an exact match.        |
| personFirstNameFuzzyPrimaryMatch    | string   | Indicates if the person's first name is a fuzzy primary match.                             |
| personFirstNameFuzzyAlternateMatch  | string   | Indicates if the person's first name is a fuzzy alternate match.                           |
| personMiddleNameExactMatch          | string   | Indicates if the person's middle name is an exact match.                                   |
| personMiddleNameFuzzyPrimaryMatch   | string   | Indicates if the person's middle name is a fuzzy primary match.                            |
| personMiddleNameFuzzyAlternateMatch | string   | Based on a check against Indicates if the person's middle name is a fuzzy alternate match. |
| personMiddleInitialMatch            | string   | Indicates if the person's middle initial is a match.                                       |
| personBirthDateMatch                | number   | Indicates if the person's birth.                                                           |
| driverLicenseIssueDateMatch         | string   | Indicates if the driver's license issue date matches.                                      |
| driverLicenseExpirationDateMatch    | string   | Indicates if the driver's license expiration date matches.                                 |
| driverLicenseNumberMatch            | string   | Indicates if the driver's license number matches.                                          |
| addressLine1Match                   | string   | Indicates if address line 1 matches.                                                       |
| addressLine2Match                   | string   | Indicates if address line 2 matches.                                                       |
| addressCityMatch                    | string   | Indicates if the address city matches.                                                     |
| addressStateCodeMatch               | string   | Indicates if the address state code matches.                                               |
| addressZIP5Match                    | string   | Indicates if the ZIP5 of the address matches.                                              |
| addressZIP4Match                    | string   | Indicates if the ZIP4 of the address matches.                                              |
| personSexCodeMatch                  | string   | Indicates if the person's gender code matches(**M or F)**.                                 |
| addressLine1FuzzyMatch              | string   | Indicates if address line 1 matches.                                                       |

:::hint{type="info"}
### driverLicenseVerificationResult Parameters Values

For all the parameters in **driverLicenseVerificationResult,&#x20;**&#x74;heir values will b&#x65;**&#x20;"true"**(if validation for corresponding request param is successful),**&#x20;"false"**(if validation for corresponding request param is failure) or **""**(if the corresponding request param is either not provided from the client or has invalid/corrupt value).
:::

:::hint{type="info"}
### Confidence Score Logic

Our validation process checks specific details like names, license numbers, and dates you provide. Each detail has a different importance. The API checks specific details to calculate a validation score namely:  **\['driverLicenseNumber', 'firstName', 'lastName', 'stateCode', 'personDob', 'driverLicenseIssueDate', 'driverLicenseExpirationDate']**

**Weight Importance:** Each detail has a different level of importance in the check. For instance:

- 'driverLicenseNumber' matching is most crucial (given the highest weight of 0.50).
- Exact matches in 'firstName' or 'lastName' are important too (weighted at 0.10 each), while close matches count a bit less (0.075).
- 'state' match, birthdate, and specific dates on the license carry moderate weight (0.10).
- Dates like 'driverLicenseIssueDate' and 'driverLicenseExpirationDate' are less critical (0.05).

**Scoring System:&#x20;**&#x54;he API assigns scores to each detail based on whether they match exactly or closely. These scores are added up, and if the total reaches 1, it means everything matched perfectly. If the total is slightly less than 1, it implies some details didn't match as well.

**Validation Threshold:** The goal is to achieve a combined score of 0.70 or higher. This benchmark ensures that most parts match well. If the total score meets or exceeds 0.70, the API considers it a successful validation. If it falls below, it indicates some discrepancies.

In general, we suggest keeping the passing score at 0.70 or higher to ensure a strong verification. If you're unsure, we can leave it as is, and we'll use 0.70 as the default passing score for the verification.
:::

## States Supported by DMV:



| State Abbreviation | State Name     |
| ------------------ | -------------- |
| AL                 | Alabama        |
| AZ                 | Arizona        |
| AR                 | Arkansas       |
| CO                 | Colorado       |
| CT                 | Connecticut    |
| FL                 | Florida        |
| GA                 | Georgia        |
| HI                 | Hawaii         |
| ID                 | Idaho          |
| IL                 | Illinois       |
| IN                 | Indiana        |
| IA                 | Iowa           |
| KS                 | Kanas          |
| KY                 | Kentucky       |
| ME                 | Maine          |
| MD                 | Maryland       |
| MA                 | Massachusetts  |
| MI                 | Michigan       |
| MS                 | Mississippi    |
| MO                 | Missouri       |
| MT                 | Montana        |
| NE                 | Nebraska       |
| NV                 | Nevada         |
| NH                 | New Hampshire  |
| NJ                 | New Jersey     |
| NM                 | New Mexico     |
| NC                 | North Carolina |
| ND                 | North Dakota   |
| OH                 | Ohio           |
| OK                 | Oklahoma       |
| OR                 | Oregon         |
| RI                 | Rhode Island   |
| SC                 | South Carolina |
| SD                 | South Dakota   |
| TN                 | Tennessee      |
| TX                 | Texas          |
| VT                 | Vermont        |
| VA                 | Virginia       |
| WA                 | Washington     |
| WV                 | West Virginia  |
| WI                 | Wisconsin      |
| WY                 | Wyoming        |



## States Not Supported by DMV:

| State Abbreviation | State Name           |
| ------------------ | -------------------- |
| AK                 | Alaska               |
| CA                 | California           |
| DE                 | Delaware             |
| DC                 | District of Columbia |
| LA                 | Louisiana            |
| MN                 | Minnesota            |
| NY                 | New York             |
| PA                 | Pennsylvania         |
| UT                 | Utah                 |

### Sample Error

:::CodeblockTabs
Empty firstName 400

```json
{
  "error": {
    "name": "error",
    "message": "firstName is not allowed to be empty",
    "status": 400,
    "reason": "VALIDATION_ERROR",
    "type": "Bad Request",
    "statusCode": "400"
  }
}
```

firstName not passed 400

```json
{
    "error": {
        "name": "error",
        "message": "\"firstName\" is required",
        "status": 400,
        "reason": "VALIDATION_ERROR",
        "type": "Bad Request",
        "statusCode": "400"
    }
}
```

Malformatted firstName 400

```json
{
    "error": {
        "name": "error",
        "message": "Bad Request. firstName is invalid.",
        "status": 400,
        "reason": "VALIDATION_ERROR",
        "type": "Bad Request",
        "statusCode": "400"
    }
}
```

Empty lastName 400

```json
{
  "error": {
    "name": "error",
    "message": "lastName is not allowed to be empty",
    "status": 400,
    "reason": "VALIDATION_ERROR",
    "type": "Bad Request",
    "statusCode": "400"
  }
}
```

lastName not passed 400

```json
{
    "error": {
        "name": "error",
        "message": "\"lastName\" is required",
        "status": 400,
        "reason": "VALIDATION_ERROR",
        "type": "Bad Request",
        "statusCode": "400"
    }
}
```

Malformatted  lastName 400

```json
{
    "error": {
        "name": "error",
        "message": "Bad Request. lastName is invalid.",
        "reason": "VALIDATION_ERROR",
        "type": "Bad Request",
        "statusCode": "400"
    }
}
```

Empty state 400

```json
{
  "error": {
    "name": "error",
    "message": "state is not allowed to be empty",
    "status": 400,
    "reason": "VALIDATION_ERROR",
    "type": "Bad Request",
    "statusCode": "400"
  }
}
```

state not passed 400

```json
{
    "error": {
        "name": "error",
        "message": "\"state\" is required",
        "status": 400,
        "reason": "VALIDATION_ERROR",
        "type": "Bad Request",
        "statusCode": "400"
    }
}e
```

Malformatted state 400

```json
{
    "error": {
        "name": "error",
        "message": "Bad Request. state is invalid.",
        "status": 400,
        "reason": "VALIDATION_ERROR",
        "type": "Bad Request",
        "statusCode": "400"
    }
}
```

Unsupported state 400

```json
{
    "error": {
        "name": "error",
        "message": "Bad Request. Input state is not supported by DMV.",
        "status": 400,
        "reason": "BAD_REQUEST",
        "type": "Bad Request",
        "statusCode": "400"
    }
}
```

Empty middleName 400

```json
{
  "error": {
    "name": "error",
    "message": "middleName is not allowed to be empty",
    "status": 400,
    "reason": "VALIDATION_ERROR",
    "type": "Bad Request",
    "statusCode": "400"
  }
}
```

Malformatted middleName 400

```json
{
    "error": {
        "name": "error",
        "message": "Bad Request. middleName is invalid.",
        "status": 400,
        "reason": "VALIDATION_ERROR",
        "type": "Bad Request",
        "statusCode": "400"
    }
}
```

Empty dateOfBirth 400

```json
{
  "error": {
    "name": "error",
    "message": "dateOfBirth is not allowed to be empty",
    "status": 400,
    "reason": "VALIDATION_ERROR",
    "type": "Bad Request",
    "statusCode": "400"
  }
}
```

Malformatted dateOfBirth 400

```json
{
    "error": {
        "name": "error",
        "message": "Bad Request. dateOfBirth is invalid.",
        "status": 400,
        "reason": "VALIDATION_ERROR",
        "type": "Bad Request",
        "statusCode": "400"
    }
}
```

Empty Sex 400

```json
{
  "error": {
    "name": "error",
    "message": "sex is not allowed to be empty",
    "status": 400,
    "reason": "VALIDATION_ERROR",
    "type": "Bad Request",
    "statusCode": "400"
  }
}
```

Malformatted Sex 400

```json
{
    "error": {
        "name": "error",
        "message": "\"sex\" must be one of [M, F]",
        "status": 400,
        "reason": "VALIDATION_ERROR",
        "type": "Bad Request",
        "statusCode": "400"
    }
}
```

Empty address 400

```json
{
  "error": {
    "name": "error",
    "message": "address is not allowed to be empty",
    "status": 400,
    "reason": "VALIDATION_ERROR",
    "type": "Bad Request",
    "statusCode": "400"
  }
}
```

Malformatted address 400

```json
{
    "error": {
        "name": "error",
        "message": "Bad Request. address is invalid.",
        "status": 400,
        "reason": "VALIDATION_ERROR",
        "type": "Bad Request",
        "statusCode": "400"
    }
}
```

Empty addressLine2 400

```json
{
  "error": {
    "name": "error",
    "message": "addressLine2 is not allowed to be empty",
    "status": 400,
    "reason": "VALIDATION_ERROR",
    "type": "Bad Request",
    "statusCode": "400"
  }
}
```

Malformatted addressLine2 400

```json
{
    "error": {
        "name": "error",
        "message": "Bad Request. addressLine2 is invalid.",
        "status": 400,
        "reason": "VALIDATION_ERROR",
        "type": "Bad Request",
        "statusCode": "400"
    }
}
```

Bad Request 400

```json
{
    "error": {
        "name": "error",
        "message": "Bad Request. Invalid input data.",
        "status": 400,
        "reason": "VALIDATION_ERROR",
        "type": "Bad Request",
        "statusCode": "400"
    }
}
```

Upstream Error 409

```json
{
    "error": {
        "name": "error",
        "message": "Error in getting data from Upstream",
        "status": 409,
        "reason": "ERROR",
        "type": "Conflict",
        "statusCode": 409
    }
}
```

Internal Server Error 500

```json
{
    "error": {
        "name": "error",
        "message": "Internal Server Error",
        "status": 500,
        "reason": "ERROR",
        "type": "Conflict",
        "statusCode": 500
    }
}
```
:::

### Error Response Parameters

| **Parameter**    | **Description**                    |
| ---------------- | ---------------------------------- |
| error            | This parameter contains the error. |
| error.name       | the error name.                    |
| error.message    | the error message.                 |
| error.status     | Status of the api                  |
| error.reason     | Reason for error                   |
| error.type       | Type of the error                  |
| error.statusCode | Request Status code from Signzy    |



:::hint{type="info"}
### Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [help@signzy.com](#). We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.

We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!
:::







