Section 14: Driver History Transactions

From Nlets Wiki
Jump to: navigation, search

Driver History Transactions (KQ/KR)

This section describes how to obtain driver history information by sending a Driver History Query (KQ) to the state of record. Information may be requested either by the driver's license number (OLN) OR the name (NAM), date of birth (DOB), and sex (SEX).

U.S. commercial driver license queries are described in section 26: "Commercial Vehicle Information".

Mexican commercial driver license queries are described in Section 33: "Communicating with Mexico".

Driver History Query / Driver History Response

This section provides an overview and details regarding the Driver History Query by license number or by name/date of birth/sex to a state (KQ), and the corresponding Driver History Response (KR).

Overview

To send a Driver History Query (KQ), enter the License Number, (see "Query by License Number" below), or Name/Date of Birth/Sex (see "Query by Name/DOB/Sex" below). The user may request a photo image as an additional option.

Positive Driver's License Responses (KR) may contain information including the driver's name, address, date of birth, description, social security #, license type, restrictions, status, and license number. (See "Driver History Response" in the list below.) A Driver History Response (KR) may include an image if one was requested and is available.

Section14-KQ.jpg

Other possible responses to a query include:

  • NOT ON FILE
  • FILE NOT AVAILABLE
  • TEMPORARILY UNAVAILABLE

Query Requirements

  • All inquiries are in a fixed format.
  • Only a single 2-character state code destination address is allowed per inquiry.
  • The Driver History Query (KQ) format includes an optional image field (IMQ/). When this field is included in the inquiry with a "Y" as a value, the receiver should return an image if one is available.
  • The Driver History Query (KQ) format includes two additional optional fields, a purpose code field (PUR) and an attention field (ATN). When used, these must follow the last required field, and both be present in the given sequence (PUR followed by ATN). These fields may be required by some states before they can release driver history information. The states that require the PUR and ATN fields are AK, AL, AZ, CO, CT, GA, HI, MD, MS, MT, NC, ND, NM, PA, VA, WA and WY.

Query Notes

  • Driver History queries on name may result in multiple hits. Only close matches (i.e., exact match on the last name and DOB) should be returned.
  • Utilize the states help file for additional DMV ORI information.

Query Help

  • To obtain explanatory or supplementary information on a state's driver's license files, a user may send an Administrative Message to xxOLNHELP (where xx = 2-character state code).
  • A user may determine who is providing automated responses to driver history queries and who is a photo sharing participant by sending an Administrative Message to "NLOLNHELP".

More information on help files can be located in Help File Transactions.

Data Codes

Codes used as input and/or output in the driver's license query/response generally match NCIC formats and content. Please refer to Part II of your NCIC Manual for code translation and instruction.

Field Requirements

The table below describes the XML tags, legacy prefixes, field sizes, data requirements and a translation of each requirement.

XML Tag: Legacy
Prefix:		 Field
Size:		 Data
Requirements:		 Translation: 
nc:IdentificationID
OLN/ 1-20 Alphanumeric Driver's License
Number		 
nc:PersonFullName
NAM/ Max.
30		 Alpha Characters Name 
nc:PersonSexCode
SEX/ 1 M, F or U Sex 
nc:Date
DOB/ 8 or
10		 CCYYMMDD (text)
or ccyy-mm-dd (XML)		 Date of Birth 
n2:PurposeCode
PUR/ 1 Must be C, F, E, D,
J or S		 Purpose Code (optional)

See Introduction Page

for more information.		 
n2:ResponseAttentionDescriptionText
ATN/ 30 Alphanumeric Name of Requester
(Optional)		 
n2:ImageIndicator
IMQ/ 1 Y (true) or
N (false)		 Image Request
(Optional)

Driver History Responses (KR)

  • Response formats are at the discretion of the responding state, however, states are urged to avoid special codes or phrases that may be foreign to out-of-state agencies.
  • Responses to driver history inquiries will vary considerably depending on the responding states.

Top

GJXDM (DEPRECATED)

GJXDM has been deprecated. Please contact Nlets for additional assistance with GJXDM.

Top

NIEM

Driver History NIEM Specifications

This section describes how to obtain driver history information by sending a Driver History Query (KQ) to the state of record. Information may be requested either by the driver's license number OR the name, date of birth and sex.

All Nlets NIEM messages must be based on the Nlets NIEM Message Structure and include the standard Nlets XML Header as detailed in Message Structure. The NIEM header and hierarchy of the elements in this section have been omitted to avoid redundancy. The associated schemas and instances should be consulted to determine the correct XPaths of the elements.

Element Dictionary

Transaction types detailed below include: Query by Name, DOB and Sex (KQ), Query by OLN (KQ), Response in Free Text (KR) and Standardized Response (KR).

Query Formats

Query by Name, DOB and Sex (KQ)

n2:NLETSInquiryData
This element will contain all elements specific to this transaction.

  n2c:Driver (xmlns:n2c="http://www.nlets.org/niem/nlets-core/1.0")
  This element encapsulates the information about the person being queried.

    nc:PersonBirthDate
    A date a person was born.

      nc:Date
      A full date.
      This element contains the DOB for the person being queried on. This data in this element must
      be in xsd:date format, that is: yyyy-mm-dd.

    nc:PersonName
    A combination of names and/or titles by which a person is known.

      nc:PersonGivenName
      A first name of a person.
      This optional element containing a person's first name may be sent via XML if available but will
      only be forwarded onto states receiving XML.

      nc:PersonMiddleName
      A middle name of a person.
      This optional element containing a person's middle name may be sent via XML if available but
      will only be forwarded onto states receiving XML.

      nc:PersonSurName
      A last name or family name of a person.
      This optional element containing a person's last name may be sent via XML if available but will
      only be forwarded onto states receiving XML.

      nc:PersonFullName
      A complete name of a person.
      This required element must contain the full name of the person in the format LAST,FIRST MIDDLE.
      The data from this element is the only name data that will be passed onto states
      receiving text.

    nc:PersonSexCode
    A gender or sex of a person.
    Value must be M, F or U.

    n2:PurposeCode
    This optional element identifies the reason for query.
    Valid values are: C, F, E, D, J or S.

  n2:ResponseAttentionDescriptionText
  This optional element contains identification of the person or entity to whose attention the driver history response
  will be directed.
  This element contains identification of the person or entity to whose attention the driver history response will be directed.

  n2:ImageIndicator
  A value of "true" in this element indicates that an image is being requested if available.

Query by Drivers License Number (OLN) (KQ)

n2:NLETSInquiryData
This element will contain all elements specific to this transaction.

  n2c:Driver (xmlns:n2c="http://www.nlets.org/niem/nlets-core/1.0")
  This element encapsulates the information about the person being queried.

    nc:DriverLicense
    Details about a license issued to a person granting driving privileges.

      nc:DriverLicenseIdentification
      Details about a driver license identifier or driver license permit identifier, including the number
      and state.

        nc:IdentificationID
        A value that identifies something.
        This element should contain the person's driver license number.

  n2:PurposeCode
  This optional element identifies the reason for query.
  Valid values are: C, F, E, D, J or S.

  n2:ResponseAttentionDescriptionText
  This optional element contains identification of the person or entity to whose attention the driver history response will
  be directed.
  This element contains identification of the person or entity to whose attention the driver history response will be directed.

  n2:ImageIndicator
  A value of "true" in this element indicates that an image is being requested if available.

Response Formats

Driver History Response in Free Text (KR)

Response Data (n2:NLETSResponseData)
This element will contain all elements specific to this transaction.

  Response Text (n2:ResponseText)


  This element will contain the free text driver's license response. Nlets recommends the use of 

<!&#91;CDATA&#91;&#93;&#93;>

tags to


  ensure that the response does not contain any characters illegal in XML.

  Digital Image (j2:PersonDigitalImage)
  GJXDM: A photograph or image of a person in a digital format.
  This optional element may contain a person's driver license photo and related metadata. This element should only
  be returned when the original query contained an image request.

    Base64 Encoded Image (j2:BinaryObject.Base64)
    GJXDM: A binary encoding of data, e.g., a binary encoding of a picture, photo, image, graphic,
    sound or video.
    This element contains the Base64 encoded image.

    Binary Format (j2:BinaryFormatText)
    GJXDM: A format of a binary object, e.g., image/jpeg
    This element contains the format and value should be image/jpeg.

    Binary Type (j2:BinaryTypeText)
    GJXDM: A type of binary object that is encoded, e.g., mug shot, driver license picture, audio
    confession.
    This element contains the type.

    Capture Date (j2:BinaryCaptureDate)
    GJXDM: A date on which the data represented by the binary object is captured, e.g., an image
    taken or an audio recorded.
    This element contains the date a photo was taken.

    Capture Time (j2:BinaryCaptureTime)
    GJXDM: A time at which the data represented by the binary object is captured, e.g., an image
    taken or an audio recorded.
    This element contains the time a photo was taken.

    Available Indicator (j2:BinaryAvailableIndicator)
    GJXDM: True if a binary is available; false if it is not.
    This element should be present with a value of true if a photo is being returned.

Standardized Driver History Response (KR)

Response Data (n2:NLETSResponseData)
This element will contain all elements specific to this transaction.

  Driver Status (n2:DriverHistory)
  This element will contain the standardized driver history response as defined in the collaboration of AAMVA
  and Nlets for Driver License Exchange (CANDLE) specifications.

Driver History NIEM Examples

Example 1: A Driver History query by name, date of birth and sex. 

<n2:NLETS xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" n2:version="4.00" xmlns:nc="http://niem.gov/niem/niem-core/2.0" xmlns:n2="http://www.nlets.org/niem/1.0">
  <n2:NLETSMessageHeader>
    <nh2:MessageKeyCodeText>KQ</nh2:MessageKeyCodeText>
    <nh2:OriginatingORIID>AZNLETS47</nh2:OriginatingORIID>
    <nh2:DestinationORIID>AZ</nh2:DestinationORIID>
    <nh2:DocumentControlFieldText><![CDATA[CROSSFIRE1]]></nh2:DocumentControlFieldText>
  </n2:NLETSMessageHeader>
  <n2:NLETSInquiryData n2:key="KQ">
    <n2c:Driver xmlns:n2c="http://www.nlets.org/niem/nlets-core/1.0">
      <nc:PersonName>
        <nc:PersonFullName>SMITH,JOHN</nc:PersonFullName>
      </nc:PersonName>
      <nc:PersonBirthDate>
        <nc:Date>2001-10-01</nc:Date>
      </nc:PersonBirthDate>
      <nc:PersonSexCode>M</nc:PersonSexCode>
    </n2c:Driver>
  </n2:NLETSInquiryData>
</n2:NLETS>

Example 2: A Driver History query by OLN. 

<n2:NLETS xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" n2:version="4.00" xmlns:nc="http://niem.gov/niem/niem-core/2.0" xmlns:n2="http://www.nlets.org/niem/1.0">
  <n2:NLETSMessageHeader>
    <nh2:MessageKeyCodeText>KQ</nh2:MessageKeyCodeText>
    <nh2:OriginatingORIID>AZNLETS47</nh2:OriginatingORIID>
    <nh2:DestinationORIID>AZ</nh2:DestinationORIID>
    <nh2:DocumentControlFieldText><![CDATA[CROSSFIRE1]]></nh2:DocumentControlFieldText>
  </n2:NLETSMessageHeader>
  <n2:NLETSInquiryData n2:key="KQ">
    <n2c:Driver xmlns:n2c="http://www.nlets.org/niem/nlets-core/1.0">
      <nc:DriverLicense>
        <nc:DriverLicenseIdentification>
          <nc:IdentificationID>123456</nc:IdentificationID>
        </nc:DriverLicenseIdentification>
      </nc:DriverLicense>
    </n2c:Driver>
  </n2:NLETSInquiryData>
</n2:NLETS>

Example 3: A Driver History response in free text form. 

<n2:NLETS xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" n2:version="4.00" xmlns:nc="http://niem.gov/niem/niem-core/2.0" xmlns:n2="http://www.nlets.org/niem/1.0">
  <n2:NLETSMessageHeader>
    <nh2:MessageKeyCodeText>KR</nh2:MessageKeyCodeText>
    <nh2:OriginatingORIID>SDDLP0000</nh2:OriginatingORIID>
    <nh2:DestinationORIID>AZNLETS47</nh2:DestinationORIID>
    <nh2:DocumentControlFieldText><![CDATA[CROSSFIRE1]]></nh2:DocumentControlFieldText>
    <nh2:MessageReceiveDate>10/22/2019</nh2:MessageReceiveDate>
    <nh2:MessageReceiveTime>14:53</nh2:MessageReceiveTime>
    <nh2:MessageSendDate>10/22/2019</nh2:MessageSendDate>
    <nh2:MessageSendTime>14:53</nh2:MessageSendTime>
    <nh2:ReceiveMessageNumeric>00000</nh2:ReceiveMessageNumeric>
    <nh2:SendMessageNumeric>01267</nh2:SendMessageNumeric>
  </n2:NLETSMessageHeader>
  <n2:NLETSResponseData n2:key="KR">
    <n2:ResponseText>KR.SDDDLP0000.TXT
        OLN/00616775

SAMPLE,SAMMY,JACOB JOHN
118 W CAPITOL AVE
PIERRE, SD 575012000
OLN            : 00616775
DATE OF BIRTH  : 1982-08-08 SOC/013256945
PHY DESCRIPTION: SEX/M. HGT/5-01. WGT/427 LBS. EYE/BRO.
LICENSE CLASS  :  - Identification Card
LICENSE TYPE   : I - Identification Card
LICENSE STATUS : Inactive/Eligible
LICENSE DATES  : ISS/2018-11-20. EXP/2020-02-24.
ORGAN DONOR    : NO
PERMIT QUANTITY: 0


         * * *   N O   D R I V E R   H I S T O R Y   E X I S T S   * * *



 ***   E N D   O F   D A T A   ***</n2:ResponseText>
  </n2:NLETSResponseData>
</n2:NLETS>

Example 4: A Driver History response. 

<n2:NLETS xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" n2:version="4.00" xmlns:nc="http://niem.gov/niem/niem-core/2.0" xmlns:n2="http://www.nlets.org/niem/1.0">
  <n2:NLETSMessageHeader>
    <nh2:MessageKeyCodeText>KR</nh2:MessageKeyCodeText>
    <nh2:OriginatingORIID>NYDMVNY00</nh2:OriginatingORIID>
    <nh2:DestinationORIID>AZNLETS47</nh2:DestinationORIID>
    <nh2:DocumentControlFieldText><![CDATA[CROSSFIRE1]]></nh2:DocumentControlFieldText>
    <nh2:MessageReceiveDate>10/22/2019</nh2:MessageReceiveDate>
    <nh2:MessageReceiveTime>14:55</nh2:MessageReceiveTime>
    <nh2:MessageSendDate>10/22/2019</nh2:MessageSendDate>
    <nh2:MessageSendTime>14:55</nh2:MessageSendTime>
    <nh2:ReceiveMessageNumeric>00000</nh2:ReceiveMessageNumeric>
    <nh2:SendMessageNumeric>01270</nh2:SendMessageNumeric>
  </n2:NLETSMessageHeader>
  <n2:NLETSInquiryData n2:key="KQ">
    <n2c:Driver xmlns:n2c="http://www.nlets.org/niem/nlets-core/1.0">
      <nc:PersonBirthDate />
      <n2c:DriverLicense>
        <nc:DriverLicenseIdentification>
          <nc:IdentificationID>256523954</nc:IdentificationID>
        </nc:DriverLicenseIdentification>
      </n2c:DriverLicense>
    </n2c:Driver>
    <n2:PurposeCode>C</n2:PurposeCode>
    <n2:ResponseAttentionDescriptionText>TEST_MSG</n2:ResponseAttentionDescriptionText>
  </n2:NLETSInquiryData>
  <n2:NLETSResponseData n2:key="KR">
    <ndh2:DriverHistory xmlns:ndh2="http://www.nlets.org/niem/nlets-driver-history/1.0">
      <ndh2:StandardResponse>
        <n2c:Driver xmlns:n2c="http://www.nlets.org/niem/nlets-core/1.0">
          <nc:PersonBirthDate>
            <nc:Date>1946-01-01</nc:Date>
          </nc:PersonBirthDate>
          <nc:PersonEyeColorText>BLUE</nc:PersonEyeColorText>
          <nc:PersonHeightMeasure>
            <nc:MeasurePointValue>600</nc:MeasurePointValue>
          </nc:PersonHeightMeasure>
          <nc:PersonName>
            <nc:PersonGivenName>HHR</nc:PersonGivenName>
            <nc:PersonMiddleName>DOV</nc:PersonMiddleName>
            <nc:PersonSurName>DMVTEST</nc:PersonSurName>
            <nc:PersonNameSuffixText></nc:PersonNameSuffixText>
          </nc:PersonName>
          <nc:PersonOtherIdentification>
            <nc:IdentificationID>D138297181822065746000</nc:IdentificationID>
          </nc:PersonOtherIdentification>
          <nc:PersonSexText>MALE</nc:PersonSexText>
          <nc:PersonSSNIdentification />
          <nc:PersonWeightMeasure />
          <j:DriverHistorySummary xmlns:j="http://niem.gov/niem/domains/jxdm/4.1">
            <j:DriverHistoryAccidentQuantity>0</j:DriverHistoryAccidentQuantity>
            <j:DriverHistoryConvictionQuantity>0</j:DriverHistoryConvictionQuantity>
            <j:DriverHistoryWithdrawalQuantity>0</j:DriverHistoryWithdrawalQuantity>
          </j:DriverHistorySummary>
          <n2c:DriverLicense>
            <nc:DriverLicenseIdentification>
              <nc:IdentificationID>256523954</nc:IdentificationID>
              <j:IdentificationJurisdictionNCICLSTACode xmlns:j="http://niem.gov/niem/domains/jxdm/4.1">NY</j:IdentificationJurisdictionNCICLSTACode>
            </nc:DriverLicenseIdentification>
            <j:DriverLicenseEndorsement xmlns:j="http://niem.gov/niem/domains/jxdm/4.1">
              <j:DriverLicenseHMEThreatDate />
            </j:DriverLicenseEndorsement>
            <nc:DriverLicenseExpirationDate>
              <nc:Date>2013-01-01</nc:Date>
            </nc:DriverLicenseExpirationDate>
            <nc:DriverLicenseIssueDate>
              <nc:Date>2005-01-18</nc:Date>
            </nc:DriverLicenseIssueDate>
            <nc:DriverLicenseNonCommercialClassText>D</nc:DriverLicenseNonCommercialClassText>
            <nc:DriverLicenseNonCommercialStatusText>EXPIRED</nc:DriverLicenseNonCommercialStatusText>
            <nc:DriverLicensePermitQuantity>0</nc:DriverLicensePermitQuantity>
            <n2c:DriverLicenseNonCommercialLocalClassText>*D*</n2c:DriverLicenseNonCommercialLocalClassText>
          </n2c:DriverLicense>
        </n2c:Driver>
      </ndh2:StandardResponse>
    </ndh2:DriverHistory>
  </n2:NLETSResponseData>
</n2:NLETS>

Top

Legacy (DEPRECATED)

Driver History Legacy Specifications

This section includes formats and examples for driver history queries and responses (KQ/KR).

Query Formats

To send a Driver History Query (KQ), enter the following.

Entry # Char. Explanation
KQ. 2 Message type followed by a period.
Message Header 13-36 Standard input message header, may include control field but
only one two character state code followed by a period.
TXT 3 Fixed filed prefix to beginning of message.
CR,LF,DEL 3 Control characters (optional).
NAM/ 4 Prefix to identify name.
Name Max. 30

Full name; format is last name, comma, space after comma is
optional) first name, space, middle initial or name, space,
suffix (Jr., III, etc.) Followed by a period. Titles or degrees
should not be used as part of the name.

DOB/ 4 Prefix to identify date of birth.
Date of Birth 6-8

Date of Birth followed by a period. Express as mmddyy or
ccyymmdd. Complete DOB must be present. Some states
have different requirements.

SEX/ 4 Prefix to identify sex.
Sex 1 Sex followed by a period; conforms to NCIC codes.
OR
OLN/ 4 Prefix to identify driver license field.
Driver Lic. # Max.20 Driver license number followed by a period.
AND, AS OPTIONAL ELEMENTS
PUR/ 4 Prefix to identify purpose code.
Purpose code 1 Must be C, F, E, D, J or S followed by a period.
ATN/ 4 Prefix to identify attention field.
Attention field 30 Name of requester.
IMQ/ 4 (For XML use only) Prefix to identify image request field.
Image Request 1 Y to request driver photo; omit IMQ/ field if photo not
wanted.
Driver History Legacy Examples

Example 1: A Driver History query by name, date of birth and sex.

KQ.AZNLETS20.AZ.TXT
NAM/SMITH,JOHN.DOB/19500101.SEX/M.PUR/C.ATN/NLETS_ANALYST

Example 2: A Driver History query by OLN.

KQ.AZNLETS20.AZ.TXT
OLN/D11111111.PUR/C.ATN/NLETS_ANALYST

Example 3: A Driver History response.

KR.AZDMV0000
09:49 10/12/2011 99782
09:49 10/12/2011 00827 AZNLETS20
TXT
ACCIDENTS NOTED ON THIS DOCUMENT SHALL NOT BE
CONSIDERED DETERMINATIVE OF FAULT OR NEGLIGENCE
ON THE PART OF THE INDIVIDUAL
**
CERTIFIED A TRUE COPY OF THE D/L RECORD OF THE PERSON NAMED HEREIN AS APPEARS
ON THE AUTOMATED SYSTEM OF DMV. G.S.20-26(B)..NAME: JOHN SMITH
RESIDENCE ADDRESS: 1234 ANY STREET; PHOENIX,AZ 85000
COUNTRY: UNITED STATES
DATE OF BIRTH: 1950-01-01
HEIGHT: 506
EYE COLOR: BLUE
HAIR COLOR: BROWN
GENDER: Male
RACE: White
*** DRIVER LICENSE DETAILS ***
DRIVER AUTHORIZATION ID: D11111111
JURISDICTION AUTHORITY CODE: AZ
ISSUE DATE: 2010-01-01
EXPIRATION DATE: 2045-01-01
DRIVING RESTRICTION CODE: 1
DRIVER LICENSE PERMIT QUANTITY: 0
DRIVER LICENSE NON-COMMERCIAL CLASS: C
DRIVER LICENSE NON-COMMERCIAL CLASS CODE: C
LICENSED COMMERCIAL DRIVER: NO
LICENSED NON-COMMERCIAL DRIVER: YES
DRIVER LICENSE NON-COMMERCIAL STATUS: ACTIVE (CRD TRNS:1111111111)
*** DRIVING INCIDENT ***
DATE: 2002-01-01
DRIVER ACCIDENT SEVERITY: ACDNT: GLENDALE, AZ
DRIVER ACCIDENT SEVERITY: ACDNT: CASE ID:10000000

Top

Downloads

Download KQ Schema

Download KQ Stylesheet

Download KR Schema (updated 6/28/2019)

Download KR Stylesheet (updated 03/19/2020)


CANDLE Specifications

Top

Retrieved from "https://wiki.nlets.org/index.php?title=Section_14:_Driver_History_Transactions&oldid=545"