Driver License Verification API

API for driver license verification against DMV and MNO databases.
More information: https://trusona.com
Contact Info: support@trusona.com
Version: 1.0.0
BasePath:
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Bearer Token authentication (JWT)

Methods

[ Jump to Models ]

Table of Contents

IDVerifications

IDVerifications

Up 
post /api/v1/id_verifications
Initiate driver license verification against DMV and MNO databases (createIdVerification)
Starts an asynchronous verification process. Results will be sent to the provided callback URL when complete.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

IdVerificationRequest IdVerificationRequest (required)
Body Parameter —

Return type

Created

Example data

Content-Type: application/json
{
  "createdAt" : "2000-01-23T04:56:07.000+00:00",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Verification request created successfully Created

400

Bad request

401

Unauthorized

422

Unprocessable entity — transactionId is not unique

500

Internal server error
Up 
get /api/v1/id_verifications/{verificationId}
Get driver license verification results (getIdVerification)
Retrieve the results of a previously initiated verification request.

Path parameters

verificationId (required)
Path Parameter — default: null format: uuid

Return type

IdVerificationResponse

Example data

Content-Type: application/json
{
  "createdAt" : "2022-01-01T00:00:00.000+00:00",
  "dmvStatus" : "SUCCESS",
  "completedAt" : "2022-01-01T00:00:05.000+00:00",
  "dmvMatches" : {
    "firstName" : true,
    "lastName" : true,
    "middleName" : true,
    "dateOfBirth" : true,
    "documentNumber" : true,
    "issueDate" : true,
    "expiryDate" : false,
    "eyeColor" : true,
    "sex" : true,
    "address1" : true,
    "city" : true,
    "state" : true,
    "zipCode" : true
  },
  "mnoMatches" : {
    "firstName" : true,
    "lastName" : true,
    "dateOfBirth" : true,
    "phoneNumber" : true,
    "address1" : true,
    "city" : true,
    "state" : true,
    "zipCode" : true
  },
  "mnoStatus" : "SUCCESS",
  "id" : "bd30618f-06d3-45c5-ae52-c36751fc20b2"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Verification results retrieved successfully IdVerificationResponse

404

Verification not found

401

Unauthorized

500

Internal server error

Models

[ Jump to Methods ]

Table of Contents

  1. Created -
  2. DmvIdVerifier -
  3. IdVerificationRequest -
  4. IdVerificationResponse -
  5. IdVerifiers -
  6. MnoIdVerifier -

Created - Up

id (optional)
UUID format: uuid
createdAt (optional)
Date format: date-time

DmvIdVerifier - Up

documentCountry (optional)
String The country that issued the document. Currently only 'US' is supported.
documentCategory (optional)
String A coded categorization of a state document issued by a jurisdiction.
documentJurisdiction (optional)
String An identifier of the jurisdiction which issues a person's driving privileges. Two letter state code.
documentNumber (optional)
String An identifier of the License or Card (aka Driver License Number). Matching is not case sensitive.
expiryDate (optional)
String A date a credential expires in the format of YYYY-MM-DD.
issueDate (optional)
String A date a credential was issued in the format of YYYY-MM-DD.
eyeColor (optional)
String A code identifying the eye color of a person. From the ANSI D20 standard.
height (optional)
String A measurement of a person's height in feet-inches. e.g. 5 foot 10 inches = '510'
weight (optional)
String A measurement of a person's weight in pounds. e.g. 195 pounds = '195'
sex (optional)
String A code identifying the sex of a person. M = Male, F = Female

IdVerificationRequest - Up

transactionId
UUID A UUID to use for tracking this request. It must be unique for each request. format: uuid
agent (optional)
String Email address of the agent performing the verification. If omitted, a default system agent is used.
callbackUrl (optional)
URI URL where verification results will be sent upon completion format: uri
verifiers
IdVerifiers
firstName (optional)
String A person's first name
middleName (optional)
String A person's middle name
lastName (optional)
String A person's last name
suffix (optional)
String A term appended after the family name that qualifies the name. (e.g. 'Jr')
dateOfBirth (optional)
String A person's date of birth in the format of YYYY-MM-DD
address1 (optional)
String A person's street address 1
address2 (optional)
String A person's street address 2
city (optional)
String A name of a city or town.
state (optional)
String A state, commonwealth, province, or other such geopolitical subdivision of a country.
zipCode (optional)
String An identifier of a post office-assigned zone for an address.
zip4 (optional)
String The ZIP+4 extension of the postal code.

IdVerificationResponse - Up

id (optional)
UUID Unique identifier for the verification request. format: uuid
dmvMatches (optional)
map[String, Boolean] DMV verification match results from AAMVA. Each key is a field that was compared against DMV records, and the boolean value indicates whether that field matched. Possible keys: firstName, lastName, middleName, middleInitial, dateOfBirth, documentNumber, issueDate, expiryDate, eyeColor, sex, address1, address2, city, state, zipCode, zip4, height, weight, documentType. Only fields that were submitted and compared will appear.
dmvStatus (optional)
String Status of the DMV verification. Possible values: PENDING, SUCCESS, FAILURE, FATAL.
Enum:
PENDING
SUCCESS
FAILURE
FATAL
mnoMatches (optional)
map[String, Boolean] MNO (mobile network operator) verification match results. Each key is a field that was compared against the mobile carrier's records, and the boolean value indicates whether that field matched. Possible keys: firstName, lastName, dateOfBirth, phoneNumber, address1, address2, city, state, zipCode, country, phoneSim. Only fields that were submitted and compared will appear.
mnoStatus (optional)
String Status of the MNO verification. Possible values: PENDING, SUCCESS, FAILURE, FATAL.
Enum:
PENDING
SUCCESS
FAILURE
FATAL
createdAt (optional)
Date Timestamp when the verification request was created. format: date-time
completedAt (optional)
Date Timestamp when all requested verifications completed. Null while verification is still in progress. format: date-time

IdVerifiers - Up

dmv (optional)
DmvIdVerifier
mno (optional)
MnoIdVerifier

MnoIdVerifier - Up

phoneNumber (optional)
String A phone number with country code for mobile network operator verification. Must be a USA (+1), Canada (+1), or UK (+44) number.