---
title: "eIDV"
method: POST
path: "/services/us/eidv"
tags: ["🇺🇸 USA"]
---

# eIDV

`POST /services/us/eidv`

The USA eIDV (electronic Identity Verification) service provides automated, remote identity verification for individuals within the United States. It utilizes a person's first name, last name, and date of birth to check against official records. The service returns a match score along with a detailed description of the verification outcome, enabling quick and reliable identity checks.

## Request body

- object
  - `middle_name` string, name, nullable — The middle name of a person
  - `address` string, nullable — An address (a street name, a building number, and a unit number) of a person or a company
  - `city` string, nullable — A city or a town of a person or a company
  - `state` string, nullable — A state of a person or a company
  - `postal_code` string, nullable — A postal code (zip code, postcode) of a person or a company
  - `phone` string, nullable — The phone number of a person or a company
  - `email` string, email, nullable — The email address of a person or a company
  - `ssn` string, nullable — The US Social Security Number of a person (SSN). The value must be an unformatted string of digits, either 4 digits (partial) or exactly 9 digits (full). No dashes, spaces, or other characters are allowed
  - `drivers_license` string, nullable — The unique driver identification number issued by a US state or territory. It is a mix of numbers and letters, and its format is state-dependent

## Response `200`

**OK**

The request was successful, and our system returned an expected response.

- object
  - `data` object
    - `match_score` number, float, nullable — Overall identity match score
    - `name_match` 'MATCH' | 'PARTIAL_MATCH' | 'NO_MATCH' | 'null', nullable — The type of match found for the person’s full name during US eIDV verification - **MATCH**: The person’s full name has a total match against the record in the database - **PARTIAL_MATCH**: The person’s full name address partially matches the record in the database - **NO_MATCH**: The person’s full name address did not match a record in the database - **null**: No data was provided in the request
    - `dob_match` 'MATCH' | 'PARTIAL_MATCH' | 'NO_MATCH' | 'null', nullable — The type of match found for the person’s date of birth during US eIDV verification - **MATCH**: The person’s date of birth has a total match against the record in the database - **PARTIAL_MATCH**: The person’s date of birth partially matches the record in the database - **NO_MATCH**: The person’s date of birth did not match a record in the database - **null**: No data was provided in the request
    - `address_match` 'MATCH' | 'PARTIAL_MATCH' | 'NO_MATCH' | 'null', nullable — The type of match found for the person’s address during US eIDV verification - **MATCH**: The person’s address has a total match against the record in the database - **PARTIAL_MATCH**: The person’s address partially matches the record in the database - **NO_MATCH**: The person’s address did not match a record in the database - **null**: No data was provided in the request
    - `city_match` 'MATCH' | 'PARTIAL_MATCH' | 'NO_MATCH' | 'null', nullable — The type of match found for the person’s city during US eIDV verification - **MATCH**: The person’s city has a total match against the record in the database - **PARTIAL_MATCH**: The person’s city partially matches the record in the database - **NO_MATCH**: The person’s city did not match a record in the database - **null**: No data was provided in the request
    - `state_match` 'MATCH' | 'PARTIAL_MATCH' | 'NO_MATCH' | 'null', nullable — The type of match found for the person’s state during US eIDV verification - **MATCH**: The person’s state has a total match against the record in the database - **PARTIAL_MATCH**: The person’s state partially matches the record in the database - **NO_MATCH**: The person’s state did not match a record in the database - **null**: No data was provided in the request
    - `postal_code_match` 'MATCH' | 'PARTIAL_MATCH' | 'NO_MATCH' | 'null', nullable — The type of match found for the person’s postal code (ZIP) during US eIDV verification - **MATCH**: The person’s postal code (ZIP) has a total match against the record in the database - **PARTIAL_MATCH**: The person’s postal code (ZIP) partially matches the record in the database - **NO_MATCH**: The person’s postal code (ZIP) did not match a record in the database - **null**: No data was provided in the request
    - `phone_match` 'MATCH' | 'PARTIAL_MATCH' | 'NO_MATCH' | 'null', nullable — The type of match found for the person’s phone number - **MATCH**: The person’s phone number has a total match against the record in the database - **PARTIAL_MATCH**: The person’s phone number partially matches the record in the database - **NO_MATCH**: The person’s phone number did not match a record in the database - **null**: No data was provided in the request
    - `email_match` 'MATCH' | 'PARTIAL_MATCH' | 'NO_MATCH' | 'null', nullable — The type of match found for the person’s email address during US eIDV verification - **MATCH**: The person’s email address has a total match against the record in the database - **PARTIAL_MATCH**: The person’s email address partially matches the record in the database - **NO_MATCH**: The person’s email address did not match a record in the database - **null**: No data was provided in the request
    - `ssn_match` 'MATCH' | 'PARTIAL_MATCH' | 'NO_MATCH' | 'null', nullable — The type of match found for the person’s Social Security Number (SSN) during US eIDV verification - **MATCH**: The person’s SSN has a total match against the record in the database - **PARTIAL_MATCH**: The person’s SSN partially matches the record in the database - **NO_MATCH**: The person’s SSN did not match a record in the database - **null**: No data was provided in the request
    - `drivers_license_match` 'MATCH' | 'PARTIAL_MATCH' | 'NO_MATCH' | 'null', nullable — | The type of match found for the person’s driver’s license number during US eIDV verification - **MATCH**: The person’s driver’s license number has a total match against the record in the database - **PARTIAL_MATCH**: The person’s driver’s license number partially matches the record in the database - **NO_MATCH**: The person’s driver’s license number did not match a record in the database - **null**: No data was provided in the request

## Other responses

- `400` — **Bad Request** Our system could not process the request due to invalid syntax, missing parameters, or incorrect data format. Check the request structure and try again.
- `402` — **Payment Required** Access to the requested resource is restricted until a payment is successfully processed. Ensure your account has a valid payment method or sufficient funds to complete this action.
- `404` — **Not Found** The requested resource does not exist or can’t be found in our system.
- `500` — **Internal Server Error** This response indicates that our system encountered an unexpected condition that prevented it from fulfilling the request.
- `502` — **Bad Gateway** This response indicates that our system is unable to reach or communicate properly with an upstream server it relies on, the URL provided is incorrect, or a required token is missing from the request.

---

[API](https://skmtc.net/kycaid/apis/overview.md) · [All operations](https://skmtc.net/kycaid/apis/overview/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kycaid/overview/versions/971fdaeccced/schema)