Driver's License

Documentation for the data schema of the Driver's License model.

Driver's License Fields

Documentation for all fields present in the data schema.

Field accessors are used as the keys for accessing the values in the returned data. On the data schema interface, this is the "Field Name".

Field value types indicate how the value is returned by the API. On the data schema interface, this is the "Field Type".

First Name

The given name(s) or first name(s) of the person.

Accessor: first_name Value Type: string

Has a single value.

Last Name

The surnames or last names of the person.

Accessor: last_name Value Type: string

Has a single value.

Date of Birth

The date of birth of the person.

Accessor: date_of_birth Value Type: date

Has a single value.

Place of Birth

The place of birth of the person.

Accessor: place_of_birth Value Type: string

Has a single value.

Nationality

The nationality of the person.

Accessor: nationality Value Type: string

Has a single value.

Sex

The sex of the person.

Accessor: sex Possible Values: M, F, Other

Has a single value.

Document Id

The document number or the ID number of the document.

Accessor: document_id Value Type: string

Has a single value.

Issued Date

The date when the document was issued.

Accessor: issued_date Value Type: date

Has a single value.

Expiry Date

The date when the Document expires.

Accessor: expiry_date Value Type: date

Has a single value.

Country Code

Country code extracted as a string.

Accessor: country_code Value Type: string

Has a single value.

Issuing Authority

The authority that issued the document.

Accessor: issuing_authority Value Type: string

Has a single value.

Address

The address of the person.

Accessor: address

Subfields

  • Street The street address. Accessor: street Value Type: string

  • City The city. Accessor: city Value Type: string

  • State The state or province. Accessor: state Value Type: string

  • Postal Code The postal code. Accessor: postal_code Value Type: string

  • Country The country. Accessor: country Value Type: string

Has a single value.

MRZ

Machine-readable license number

Accessor: mrz Value Type: string

Has a single value.

Driver License Category

EU driver license holders categories

Accessor: category Value Type: string

Has a single value.

Last updated

Was this helpful?