Version of the API.

The requested endpoint.

Processing result status code. See ID Verification processResult Definitions.

DocumentProcessOK DocumentBadRead DocumentBadDevice DocumentUnknown Document1DDocument ErrorBadConfiguration UnexpectedError

Processing result diagnostic code. Values are Y, U, B, IUX, F, 1, UEE.

Y U B IUX F 1 UEE

Contains the first name.

Contains the middle name.

Contains the last name with suffix if present.

Contains line one of the residence address.

Contains line two of the residence address.

Contains the city of residence.

Contains the jurisdiction of residence.

Contains the postal code (zip code) of residence.

Contains the date of birth in MM/DD/YYYY format. When a partial birth date is encoded on the document, the fields that are unknown will be filled in with ? characters. For example: 01/12/???? will be returned for a document that does not encode the birth date year.

Contains the height in centimeters as specified on the ID.

Contains the height in feet and inches as specified on the ID, for example, 5’2”.

Contains the weight in kilograms as specified on the ID.

Contains the weight in pounds as specified on the ID.

Contains the eye color. If the jurisdiction code for eye color is known, the color’s name is returned, for example, brown, blue, hazel. If the code is not recognized, the code that is encoded on the document is returned.

Contains the hair color. If the jurisdiction code for hair color is known, the color’s name is returned, for example, brown, black, blonde. If the code is not recognized, the code that is encoded on the document is returned.

Contains the gender. Either Male or Female.

This field is intentionally blank.

Contains the media type of the processed document. Examples include MAG and 2D.

Contains the raw driver license or ID (DL/ID) value. This will not contain any formatting characters, such as spaces and hyphens. It will contain only the alphanumeric characters that make up the DL/ID.

Contains the formatted driver license or ID (DL/ID) value. This will contain the formatting characters, such as spaces and hyphens, as it appears on the printed document.

Contains the restriction codes encoded on the document.

Contains the endorsement codes encoded on the document.

Contains the driver class codes encoded on the document.

Contains Yes or No indicating if the document owner is an organ donor.

Contains the expiration date of the processed document in MM/DD/YYYY format or the word NEVER for documents that do not expire. When a partial expiration date is encoded on the document, the fields that are unknown will be filled in with ? characters. For example, 01/12/???? will be returned for a document that does not encode the expiration year.

Contains the expiration status of the document. Values are Yes, No, or Unknown.

Yes No Unknown

Contains the date of issuance of the document in MM/DD/YYYY format.

Contains the full name of the issuing jurisdiction, for example, New York.

Contains the name of the issuing jurisdiction as an abbreviation. This value will always be two letters, for example, NY.

Contains the document duplication status. Values are Yes, No, or empty. An empty value means the duplicate status is unknown.

Yes No {empty}

Contains the date the duplicate document was issued in MM/DD/YYYY format.

Contains the type of document (if available) from the barcode, for example, Driver's License, Learner's Permit, Operator License, and so on. Values vary by issuing jurisdiction. An empty value means the type is not identifiable.

Contains the document category acronym from the barcode. The value is typically one of the following: DL (driver license), HC (health card), ID (identification card), MIL (military identification). Rarely, certain other values are possible: WPN (weapon), HCP (handicap), WV (water vehicle), EMP (employee), OID (other). An empty value means the category is not identifiable.

DL HC ID MIL WPN HCP WV EMP OID {empty}

Contains the document REAL ID status. Values are Yes, No, or empty. Yes means the document was issued in compliance with United States Department of Homeland Security (DHS) requirements for the REAL ID Act passed by Congress in 2005. No means it was not. An empty value means the document did not have enough information to determine a result.

Yes No {empty}

Contains a status of whether the address state compared to the document issuer are mismatched. Values are Yes, No, or Unknown. Yes means the state and issuer do not match. No means the state and issuer match. Unknown means the match status is not known.

No Yes Unknown

Contains a transaction ID.