VLS
JURISDICTION FUNCTIONAL SPECIFICATIONS
(AMIE PROTOCOL)
VERSION 1.2.4
FOR
VERIFICATION OF LAWFUL STATUS
RELEASE 1.2
CLIN 0001
DHS CONTRACT: HSSCCG-10-C-00021
AAMVA - Official Use Only
VLS System Specification Release 1.2.2
The American Association of Motor Vehicle Administrators (AAMVA) is a nonprofit organization, representing the
state and provincial officials in the United States and Canada who administer and enforce motor vehicle laws. This
document was produced by the Systems Analysis Department of AAMVA.
Address : AAMVA, Inc 4301 Wilson Boulevard Suite 400 Arlington, Virginia 22203 Telephone : 1‐703‐522‐4200 Fax : 1‐703‐522‐1553 Website : www.aamva.org This document and associated work product were produced by AAMVA under contract HSSCCG‐10‐C‐00021 from the United States Department of Homeland Security (DHS). Points of view or opinions expressed in this document are those of the authors and do not necessarily represent the official position of policies the U.S. Department of Homeland Security. DHS has unlimited rights to use, disclose, reproduce, prepare derivative works, distribute copies to the public, and perform publicly, in any manner and for any purpose, and to have or permit others to do so. © 2011 AAMVA. All rights reserved Page ii
VLS System Specification Release 1.2.2
Document History Section
This section provides control for the construction and distribution of revisions to this document up to the
point of approval. The table below includes the following: revision number, revision date, author’s initials
responsible for documenting the change, section changed, change type, and a brief description of the scope of
the changes within the revision. All revisions within this document are listed in chronological order.
Release 1.1.0 Changes in July 2010
These changes were made to align VLS with SAVE messages. The alignment is intended to make it easier for DHS
to support the jurisdictions by making all the SAVE data available.
Release 1.1.1 Changes in August 2010
These changes were made to correct a typo.
Release 1.1.2 Changes in November 2010
The original 1.1 release was written to match the DHS documentation of their SAVE system. Testing found a few
differences between how SAVE worked and how it was documented. These changes were made to reflect these
recent findings
Release 1.2.0 Changes in December 2010
This release adds the Password Reset transaction. Also made some corrections.
Message
Element
Change
IP - Initial Inquiry Document Type ID (BFDUDT)
Correction of a description: In “Table 1 - Input
Parameters by Document Type”, on the row for
document type “21”, the description now says
“Temporary I-551 Stamp (on passport)”, it
used to say “… (on passport or I-94)”. This
stamp should never be on the I-94.
IP - Initial Inquiry Document Type ID (BFDUDT)
Update of a “Table 1 - Input Parameters by
Document Type”, on the row for document
type “10”, the Expiration Date has been
changed from Optional to Required.
Appendix A and
Error Message (GERMSG)
Correct typo on the element’s call list name.
D.
Appendix D.
Removed the note about the element being
USCIS Eligibility Statement Code
right justified. The data is left justified.
(BFDESC)
Added a more detailed explanation of the error.
Appendix E.
Error 1G
Added an explanation of the error.
Appendix E.
Error 1Z
UP and CP
Added new Update Password transaction.
Release 1.2.1 Changes in February 2011
Clarified display requirements (section 3.6) and updated response messages to specify the specific elements to
display
Also clarified password issuance / renewal process in UP message definition
Document changes (Version 1.2.2) applied February 18, 2011
Page 5: Section 3.4.2 SDLA Security – replaced Memorandum of Understanding (MOU) to Memorandum of
Agreement (MOA). Also replaced MOU to MOA throughout the document.
All Pages: replaced the word, Optional to Conditional.
Page 11: Section 4.1.1.1 Population and Transmission of the Initial Inquiry (IP) Message - modified language for
number 6 to clarify the Agency User ID entity. Provided a definition for the word, entity.
Page 12: Provided definition to the term, conditional.
Page iii
VLS System Specification Release 1.2.2
Page 13: Table 1 – Input Parameters by Document Type – modified to now read, Temporary I-551 Stamp (on
passport or I-94).
Document changes (Version 1.2.3) applied February 23, 2011
Page 13: changed language to now read, "C" indicates that the element is “conditional”. It is not a required element
and must be provided if it is available.
Document changes (Version 1.2.4) applied April 6, 2011
revised document disclaimer to be in-line with DHS approved language
Section 4.1.3.2: ‘SAVE Web Service Version (BFDWSV)’ data element on RP is required to be displayed by the end
user if provided on the response.
Page iv
VLS System Specification Release 1.2.2
TABLE OF CONTENTS
1. DOCUMENT INTRODUCTION............................................................................................................................ 1 1.1 1.2 DOCUMENT PURPOSE .......................................................................................................................................... 1 ADDITIONAL INFORMATION ................................................................................................................................ 1 2. PROJECT OVERVIEW .......................................................................................................................................... 3 2.1 BACKGROUND ..................................................................................................................................................... 3 2.2 PARTICIPANTS ..................................................................................................................................................... 3 2.2.1 USCIS ......................................................................................................................................................... 4 2.2.2 State Driver Licensing Agency ................................................................................................................... 4 2.2.3 AAMVA ..................................................................................................................................................... 4 3. SYSTEM ARCHITECTURE .................................................................................................................................. 5 3.1 SYSTEM DESIGN .................................................................................................................................................. 5 3.2 HOURS OF OPERATION ........................................................................................................................................ 5 3.2.1 VLS ............................................................................................................................................................ 5 3.2.2 AAMVAnet ................................................................................................................................................ 5 3.3 PERFORMANCE REQUIREMENTS .......................................................................................................................... 5 3.4 SECURITY REQUIREMENTS .................................................................................................................................. 6 3.4.1 Security at AAMVA ................................................................................................................................... 6 3.4.2 SDLA Security ........................................................................................................................................... 6 3.4.3 USCIS Security........................................................................................................................................... 6 3.5 BILLING REQUIREMENTS ..................................................................................................................................... 6 3.6 DISPLAY REQUIREMENTS .................................................................................................................................... 6 4. VERIFICATION OF LAWFUL STATUS ............................................................................................................. 7 OVERVIEW ...................................................................................................................................................................... 7 4.1 INITIATE INITIAL REQUEST ................................................................................................................................ 11 4.1.1 Initiate Request for Verification of Lawful Status (SDLA) ...................................................................... 12 4.1.2 Verify Lawful Status (USCIS).................................................................................................................. 14 4.1.3 Process Lawful Status Response (SDLA)................................................................................................. 15 4.1.4 Resubmit Initial Inquiry (SDLA) .............................................................................................................. 18 4.2 UPDATE PASSWORD .......................................................................................................................................... 20 4.2.1 Request Password Update (SDLA)........................................................................................................... 22 4.2.2 Verify Lawful Status (USCIS).................................................................................................................. 22 4.2.3 Process Password Update Confirmation (SDLA) ..................................................................................... 23 4.3 SUBSEQUENT TRANSACTIONS ........................................................................................................................... 25 5. AMIE TRANSACTION DESIGN......................................................................................................................... 26 5.1 AMIE MESSAGE FORMAT ................................................................................................................................. 26 5.1.1 Network Control Block............................................................................................................................. 27 5.1.2 Message Exchange Control Block ............................................................................................................ 28 5.1.3 Other Application Text Blocks ................................................................................................................. 28 5.2 ELEMENT FORMATS .......................................................................................................................................... 28 5.2.1 Printable Characters .................................................................................................................................. 29 5.2.2 Dates ......................................................................................................................................................... 29 5.2.3 Numbers ................................................................................................................................................... 29 5.2.4 Text ........................................................................................................................................................... 29 5.3 ERROR PROCESSING .......................................................................................................................................... 30 5.3.1 Error Block Formats ................................................................................................................................. 30 5.3.2 Types Of Errors ........................................................................................................................................ 30 6. NIEM ....................................................................................................................................................................... 35 TABLE OF CONTENTS
Page v
VLS System Specification Release 1.2.2
6.1 NIEM COMPLIANT UNI INTERFACE .................................................................................................................. 35 6.1.1 OperateOutbound NIEM UNI Interface Operation .................................................................................. 35 6.1.2 OperateInbound NIEM UNI Interface Operation ..................................................................................... 36 6.2 MAPPING BETWEEN AMIE AND NIEM MESSAGES ............................................................................................ 37 6.3 MAPPING BETWEEN AMIE AND NIEM DATA ELEMENTS .................................................................................. 37 6.4 NIEM SCHEMAS................................................................................................................................................ 39 7. NETWORK INTERFACE – UNIFIED NETWORK INTERFACE (UNI) ...................................................... 40 7.1 7.2 7.3 7.4 A. CALL LIST ......................................................................................................................................................... 40 CALL LIST FORMAT ........................................................................................................................................... 40 UNI SUB-SYSTEM CODE .................................................................................................................................... 41 MESSAGE SPLITTING ......................................................................................................................................... 41 APPENDIX OF DATA ELEMENTS BY MESSAGE TYPE ......................................................................... 42 IP - INITIAL INQUIRY ............................................................................................................................................... 44 RP - INITIAL RESPONSE ........................................................................................................................................... 44 UP - PASSWORD UPDATE ........................................................................................................................................ 45 CP - PASSWORD UPDATE CONFIRMATION ......................................................................................................... 46 B. APPENDIX OF BLOCKS BY MESSAGE TYPE ........................................................................................... 47 IP - INITIAL INQUIRY ............................................................................................................................................... 47 RP - INITIAL RESPONSE ........................................................................................................................................... 47 UP - PASSWORD UPDATE ........................................................................................................................................ 47 CP - PASSWORD UPDATE CONFIRMATION ......................................................................................................... 48 C. APPENDIX OF DATA ELEMENTS BY BLOCK .......................................................................................... 49 NETWORK CONTROL BLOCK (00/0) ...................................................................................................................... 49 CDLIS / DLR / PDPS MSG EXCHANGE CONTROL (02/2)...................................................................................... 51 DRIVER NAME / DESCRIPTIVE DATA – SOI (10/1) .............................................................................................. 52 DRIVER NAME (10/D) ............................................................................................................................................... 52 CITIZENSHIP AND IMMIGRATION BLOCK 1 (20/4)............................................................................................. 52 CITIZENSHIP AND IMMIGRATION BLOCK 2 (20/5)............................................................................................. 54 CITIZENSHIP AND IMMIGRATION BLOCK 3 (20/6)............................................................................................. 54 CITIZENSHIP AND IMMIGRATION BLOCK 4 (20/7)............................................................................................. 54 CITIZENSHIP AND IMMIGRATION BLOCK 5 (20/8)............................................................................................. 54 CITIZENSHIP AND IMMIGRATION BLOCK 6 (20/9)............................................................................................. 55 CITIZENSHIP AND IMMIGRATION BLOCK 7 (20/A) ............................................................................................ 55 CITIZENSHIP AND IMMIGRATION BLOCK 8 (20/B) ............................................................................................ 55 DRIVER LICENSE APPLICATION BLOCK (54/1) .................................................................................................. 55 RETURN AS RECEIVED BLOCK (98/3) ................................................................................................................... 55 EDIT/ERROR DESCRIPTIVE BLOCK – ALL (99/1) ................................................................................................ 55 D. APPENDIX - DATA DICTIONARY ................................................................................................................ 57 E. APPENDIX – SAVE APPLICATION AND SYSTEM ERRORS .................................................................. 69 F. APPENDIX – SAVE CLASS OF ADMISSION (COA) CODES........................................................................ 73 G. APPENDIX – SAVE COUNTRY CODES ....................................................................................................... 83 H. APPENDIX - GLOSSARY ................................................................................................................................ 87 TABLE OF CONTENTS
Page vi
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
1.
DOCUMENT INTRODUCTION
1.1
Document Purpose
This document, prepared by the American Association of Motor Vehicle Administrators (AAMVA), presents the
system specifications for the Verification of Lawful Status (VLS) System.
The purpose of this document is to provide all participants of the application with the functional requirements needed to
implement applications to exchange information via the VLS system over the AAMVAnet secure network. Participants
include the United States Citizenship and Immigration Services (USCIS) and State Driver License Agencies (SDLAs).
Both manual and automated procedures are described in this document.
1.2
Additional Information
The following document is referenced in this specification and provides more detailed information related to the UNI
software:

Unified Network Interface (UNI) Application Developers Reference Manuals
The following document should be referenced for additional information related to the implementation considerations as
they related to satisfying Real ID requirements;

Real ID Verification Systems Implementation Guide (to be developed)
Release 1.1 of VLS, supports a specific version of the SAVE system. The version of SAVE that corresponds to this
document is documented in;

Interface Control Agreement Between Agency Web Service Access Method And Agencies Version 31.2 for
VIS Release 3.0)
Questions regarding this document or the system itself should be directed to the AAMVA Operations Department.
Contact information follows:
Hours:
Telephone:
Fax:
E-mail:
Website:
Address:
8:00 a.m. - 6:00 p.m. Eastern Time
1-888-AAMVA-80 (1-888-226-8280)
1-703-522-1553
HelpDesk@aamva.org
www.aamva.org
AAMVA, Inc, 4301 Wilson Boulevard, Suite 400, Arlington, Virginia 22203
Questions regarding the Systematic Alien Verification for Entitlements (SAVE) Program should be directed to USCIS.
Contact information follows:
SAVE Program Assistance: 202-358-7710
SAVE Technical Assistance: 888-464-4218
E-mail:
save.help@dhs.gov
AAMVA should be the initial point of contact for most queries.
Business questions for DHS-USCIS should be directed to: Quintion Eaton
Telephone :
202 443 0132 E‐mail : quintion.eaton@dhs.gov Questions about the technical operation of the DHS component, should be directed to: Surojit Paul or James Dien
1 DOCUMENT INTRODUCTION
Page 1
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
Telephone :
571 468 5882 E‐mail : surojit.paul@cbp.dhs.gov 1 DOCUMENT INTRODUCTION
Page 2
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
2.
PROJECT OVERVIEW
2.1
Background
The Verification of Lawful Status (VLS) System provides a mechanism for the Motor Vehicle Agencies in the United
States to verify the lawful status of a non-US citizen. This system allows a State Driver Licensing Agency (SDLA) to
communicate with the United States Citizenship and Immigration Services (USCIS) via the AAMVAnet network for
the purpose of verifying an individual’s lawful status.
The need to check lawful status was brought about by the passage of the REAL ID act of 2005. Division B of Public
Law 109-13, May 11, 2005. Section 202(c)(2)(B) of the REAL ID Act requires ‘evidence of lawful status’ before
issuance of state-issued driver's licenses and state-issued identification cards in order for those documents to be
acceptable for Federal purposes. Section 202(a) of the Act prohibits federal agencies from accepting for any official
purpose after May 11, 2008, driver's licenses and identification cards issued by states not in compliance with the Act.
Section 202(c)(3)(A) requires MVAs to ‘… verify, with the issuing agency, the issuance, validity, and completeness of
each document required to be presented'. Extensions to the May 11, 2008 deadline have subsequently been granted by
the Department of Homeland Security (DHS).
The USCIS operates the Systematic Alien Verification for Entitlements (SAVE) Program. The SAVE program enables
federal, state, and local government agencies and licensing bureaus to obtain immigration status information they need
to determine a non-citizen applicant's eligibility for many public benefits, including Driver Licenses, Permits and
Identification Cards. SAVE was created after 1986 in response to a requirement in the Immigration and Naturalization
Services (INS) to implement a system for the verification of immigration status.
USCIS currently supports a number of different access methods for interacting with SAVE. One such method is
through a stand-alone graphical user interface provided by USCIS as a turn-key application. When this access method
is used, information is exchanged between a jurisdiction and SAVE via a secure Internet connection. No integration
with the jurisdiction’s existing driver application(s) is provided. This stand-alone approach is often used for back-office
or central processing as opposed to front-line support.
In contrast to the above access method, the VLS System allows the SDLA to leverage the existing AAMVAnet
infrastructure to provide an electronic interface to the SAVE system that more fully integrates the verification process
into existing Driver License, Permit and Identification Card issuance processes.
The remainder of this document focuses exclusively on the integrated solution utilizing the AAMVAnet infrastructure.
Requests for details about other options should be directed to USCIS.
2.2
Participants
VLS stakeholders consist of USCIS, any participating SDLA and AAMVA. The following diagram provides an
overview of the entities that interact with VLS.
2 PROJECT OVERVIEW
Page 3
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
Figure 1 - Context of VLS
U.S. Motor
Vehicle
Agencies
USCIS
Lawful Status
Lawful Status
VLS
Infrastructure Support
AAMVA
2.2.1 USCIS
The United States Citizenship and Immigration Services (USCIS) is a bureau in the United States Department of
Homeland Security (DHS). The USCIS operates the Systematic Alien Verification for Entitlements (SAVE) Program.
The SAVE system is responsible for administering programs involving customer access to information contained in the
Verification Information System (VIS) database. This database is a nationally accessible database of selected
immigration status information on over 60 million records. The SAVE program enables Federal, state, and local
government agencies and licensing bureaus to obtain immigration status information they need in order to determine a
non-citizen applicant's eligibility for many public benefits.
For VLS, USCIS provides a service to allow an SDLA to verify a person's lawful status.
2.2.2 State Driver Licensing Agency
A State Driver Licensing Agency (SDLA) is the agency in any state, district, territory, possession or province of the
U.S. that issues the Driver License, Permit and/or Identification Cards. SDLA personnel are the only people who will
be allowed to use the system. The use is further restricted specifically for the purpose of issuing a Driver License,
Permit or Identification Card.
2.2.3 AAMVA
The American Association of Motor Vehicle Administrators (AAMVA) is a non-governmental, voluntary, tax-exempt,
nonprofit educational association. AAMVA is a private corporation which strives to develop model programs in motor
vehicle administration, police traffic services, and highway safety. The association is composed of Motor Vehicle and
Law Enforcement Administrators and Executives from all 50 states, the District of Columbia, and Canadian Territories
and Provinces (the "MVAs").
2 PROJECT OVERVIEW
Page 4
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
3.
SYSTEM ARCHITECTURE
The system architecture is the representation of a system in which functionality is mapped to hardware and software
components. The VLS system architecture consists of the system design and software design.
3.1
System Design
The system design of the VLS system consists of the following components:



The AAMVAnet network which connects USCIS and the SDLA.
The SDLA issuing the Driver License, Permit and/or Identification Card.
o Most MVAs incorporate checks like the verification of lawful status into their issuance process.
o While not a required component, MVAs normally use the UNI tool to provide the network interface to
AAMVAnet.
The USCIS maintains the service to access the data sources and verify lawful status.
o Within USCIS the service is reached through UNI and their Enterprise Service Bus.
Figure 2 - System Architecture
U.S. Jurisdiction
Issuance
Application
UNI
USCIS
AAMVAnet
UNI
Enterprise
Bus
Lawful
Status Data
Sources
For detailed information regarding the AAMVAnet Message Interchange Envelope (AMIE) and the Unified Network
Interface (UNI) software, please refer to sections 5 and 6 of this document, respectively.
3.2
Hours Of Operation
3.2.1 VLS
Four regions are supported by the VLS System and include development, test, model office and production. The
production and test regions are available 24 hours a day 7 days a week, with the following exceptions:
 The SAVE system is unavailable due to weekly maintenance from 6 PM Sunday to 12 AM Monday, weekly,
Eastern time.
 Approximately every three months, the SAVE system is unavailable due to software upgrades from 12 AM
Sunday to 12 AM Monday, Eastern time.
3.2.2 AAMVAnet
System is available 24 hours a day 7 days a week except for the regularly scheduled maintenance window every Sunday
2-5am Eastern time.
3.3
Performance Requirements
VLS contains some real-time transactions and some pseudo-batch transactions.
The primary objective of the real-time transactions is to provide the SDLA's field office officials with the capability to
comply with the REAL ID requirements to query VLS while the applicant is present at the counter. The jurisdictions
need the responses to their real-time inquiries returned within 7 seconds (as the jurisdictions need to set their time-out
parameters).
3 SYSTEM ARCHITECTURE
Page 5
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
The 7 seconds includes the time it takes for messages to travel over AAMVAnet to and from USCIS and the processing
time at USCIS.
3.4
Security Requirements
Access to the production system is limited to the exclusive use of the State Driver Licensing Agency’s (SDLA’s)
personnel for the purpose of issuing a Driver License, Permit and/or Identification Card.
AAMVA will establish security and privacy mechanisms in compliance with all applicable federal standards for
supporting its components of the system.
3.4.1 Security at AAMVA
The AAMVA security concerns and constraints for the VLS system are identified in the Interconnection Security
Agreement (ISA) between DHS-USCIS and AAMVA document.
3.4.2 SDLA Security
Any specific security requirements applicable to the State Driver Licensing Agency (SDLA) are provided in the project
Memorandum of Agreement (MOA).
3.4.3 USCIS Security
The DHS/USCIS security concerns and constraints for the VLS system are identified in the Interconnection Security
Agreement (ISA) between DHS-USCIS and AAMVA document.
3.5
Billing Requirements
USCIS charges for the use of SAVE and performs the billing function for this service. Each SDLA utilizing the VLS
service must have executed an MOA and MOA with USCIS and have been assigned a billing identifier related to its
User ID(s). A User ID is passed with each transaction and is used to link billable transaction activity to the specific
SDLA utilizing the service.
3.6
Display Requirements
It may be noted that data elements on the return message may be similar to those provided on the request. In some cases
this appears to be the same data element that was sent on the request (e.g., name). However, the data being returned is
actually the data as found in the SAVE database(s) and could differ from the data provided by the requestor.
In other cases, response messages may include additional data that is pulled from the SAVE database(s). All data
returned from the SAVE database(s) are provided to aid the jurisdiction decision making process.
To mirror SAVE’s Web3 capabilities and ensure the implementing jurisdiction has all the data necessary to make a
lawful status determination, the VLS implementer is required to display on the requestor’s screen all the response
message data elements that originate from SAVE database(s). Specific data elements will be called out in each
applicable response message description. If there is an exception to this display requirement, the exception will be noted
in each pertinent response of this document.
3 SYSTEM ARCHITECTURE
Page 6
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
4.
VERIFICATION OF LAWFUL STATUS
Overview
When an applicant goes to the State Driver Licensing Agency (SDLA) to request the issuance, replacement or renewal
of a Driver License, Permit or Identification Card, several different verifications are performed by the State Driver
Licensing Agency (SDLA) to ensure that the applicant meets minimum requirements for receiving such a benefit.
Proving lawful status may be a prerequisite for the issuance of a Driver License, Permit or Identification Card.
Confirming whether or not the applicant is authorized to work – and therefore whether or not the applicant is eligible for
a Social Security Number – may also be a prerequisite for issuance. Specific issuance requirements are determined by
the given State Driver Licensing Agency (SDLA) and are dependent on state and federal laws.
Categories of lawful status include the following:

US Citizen

US National

Alien lawfully admitted for permanent or temporary residence in the US

Alien with conditional permanent resident status in the US

Alien with valid nonimmigrant status in the US

Alien with pending application for asylum in the US

Alien with pending or approved application for temporary protected status

Alien with approved deferred action status

Alien with pending application for lawful permanent residency or conditional permanent residence
An applicant may present one or more of the following identity documents. Those marked with an asterisk may also be
used to verify lawful status.

Valid, unexpired US passport* – not verified through VLS

Certified copy of a birth certificate* – not verified through VLS

Consular Report of birth* – not verified through VLS

Valid, unexpired permanent resident card*

Unexpired employment authorization document

Unexpired foreign passport with a valid, unexpired US visa affixed, accompanied by an approved I-94 form

Certificate of Naturalization*

Certificate of Citizenship*
When the applicant submits an immigration document as proof of lawful status, the following process may be used to
verify the status of that applicant via the VLS System. The following diagram and text provides a high-level overview
of the verification of lawful status through VLS.
4 VERIFICATION OF LAWFUL STATUS
Overview
Page 7
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
Figure 3 - Overview of the Verification of Lawful Status Process
4 VERIFICATION OF LAWFUL STATUS
Overview
Page 8
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
Initial Verification
Information from the immigration document is captured by the Customer Service Representative at the State Driver
Licensing Agency (SDLA) and is provided to USCIS via the initial inquiry request for verification of lawful status.
Immigration documents typically contain one or more unique identifier(s) such as the Alien Number or I-94 Number.
The type of identifier will vary depending on the kind of immigration document being used. The State Driver Licensing
Agency (SDLA) provides the unique identifier(s) along with additional information pertaining to the applicant to be
used during the verification process.
The initial verification request is an automated process. It is designed to provide a real-time response to the State Driver
Licensing Agency (SDLA) that either provides the applicant’s lawful status data or indicates that additional verification
steps must be executed before the applicant’s lawful status can be confirmed.
When USCIS receives an initial verification request, it attempts to validate the applicant’s information against
information it has on file. If USCIS is able to locate the lawful status data based on the initial information it receives, it
immediately sends a response back to the State Driver Licensing Agency (SDLA) with the applicant’s immigration
status data.
Note that the response reflects the lawful status data of the applicant rather than the status of the immigration document
used for the inquiry. This distinction is important because the status of the document may very well be different from
the lawful status of the individual. An example might be a document that reflects an expired date while the person’s
status has either changed or has not yet expired.
It is understood that if the SDLA only implements the initial verification in VLS, the SDLA is required to utilize the
secondary and tertiary verifications via Web3
Resubmission of Initial Verification
In some situations lawful status cannot be determined because the information on file indicates that the applicant is a
student or exchange visitor, while the initial inquiry did not reflect the applicant’s Student and Exchange Visitor
Identification Number (SEVIS ID). In this particular situation USCIS returns an initial response indicating that the
State Driver Licensing Agency (SDLA) should resubmit the initial inquiry with the additional information.
In other situations, one or more validation checks fail when processing the initial inquiry (i.e., incorrect date of birth,
name, or document information). USCIS provides the State Driver Licensing Agency (SDLA) with a one-time
opportunity to correct the information in question and resubmit the initial inquiry for processing. Only the data
identified as erroneous may be submitted.
Resubmission of an initial verification is option for the SDLA.
Secondary Verification (2nd Step, “Initiate Additional Verification”)
In some situations USCIS cannot determine lawful status through the automated process. This might occur if an older
immigration document is being presented, and therefore isn’t on file in automated data sources at USCIS, or if the
applicant’s name has changed and does not match the name on file. When this occurs, USCIS sends back an initial
response indicating that the State Driver Licensing Agency (SDLA) should institute a secondary verification request if it
wants to continue the lawful status verification request.
The secondary verification is a manual process for the status verifiers at DHS and is not automatically initiated without
the specific request of the State Driver Licensing Agency (SDLA). The SDLA may choose not to initiate a secondary
verification if the applicant does not want to pursue the verification further. Note that an applicant’s status is not
considered to have been verified unless all required verification steps have been completed, including the secondary
verification step if the results of the initial verification indicate that it is necessary.
The State Driver Licensing Agency (SDLA) requests a secondary verification on behalf of the applicant by submitting a
request to USCIS that contains the Case Number established by USCIS based on the initial request. Additional
supportive information may also be provided to assist with the verification process. While the actual research
4 VERIFICATION OF LAWFUL STATUS
Overview
Page 9
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
associated with the secondary verification is a manual process and may take several days to complete, receipt of the
secondary request is confirmed immediately by USCIS sending a confirmation message to the SDLA
Because the results of a secondary verification may take several days, some jurisdictions may choose to issue an interim
Driver License, Permit or Identification Card for the applicant to use while the secondary verification is being processed
at USCIS. The decision to do so is driven by State Driver Licensing Agency (SDLA) guidelines and is dependent on
state laws.
When a secondary verification request is received at USCIS, a case worker is assigned responsibility for further
researching the applicant’s status. In many cases lawful status can be successfully verified during the secondary
verification process. When this is true, the case worker updates the applicant’s case information indicating a positive
verification of lawful status.
In some situations, even the secondary verification process is not enough to confirm lawful status without the case
worker receiving additional documentation from the applicant. When this is true, the case worker updates the
applicant’s case information indicating that additional documentation is necessary.
The results of the secondary verification are not automatically sent back to the State Driver Licensing Agency (SDLA)
once the case has been updated. Instead, the SDLA must specifically request the results of one or more cases before
USCIS will return the associated results.
The SDLA should wait 3 business days before requesting the results of a given case, since it is very likely that the case
worker will not have been able to fully research the case in less time. However, this is usually done same day or next
day and it is up to the agency to decide if more frequent checks are needed.
Tertiary Verification (3rd Step, G-845 Submission)
If the results of a secondary verification indicate that additional documentation must be sent to USCIS for inspection
before verification of lawful status can be completed, the State Driver Licensing Agency (DSLA) may choose to initiate
a tertiary verification request on behalf of the applicant. The tertiary verification is a manual process and is not
automatically initiated without the specific request of the SDLA. Receipt of the tertiary request is confirmed
immediately by USCIS sending a confirmation message to the SDLA.
As with the secondary verification, the results of the tertiary verification are not automatically sent back to the State
Driver Licensing Agency (SDLA) once the case has been updated. Instead, the SDLA must specifically request the
results of one or more cases before USCIS will return the associated results. The SDLA can only see the results in the
system if a 3rd step was initiated. If the 3rd step is not initiated in VLS or Web3, the G-845 is mailed back to the SDLA.
The SDLA has two options for requesting the results of secondary and tertiary verifications. The first is to request the
results of a specific case by providing the identifying Case Number assigned by USCIS when the case was initially
established. The second is to request the results of all worked cases initiated by the SDLA.
Case Closure
Whether completed via initial, secondary or tertiary verification, when the State Driver Licensing Agency (SDLA)
deems that a given case has been taken to its logical conclusion, the SDLA may request that the case be closed at
USCIS. Sending the request for case closure message through AAMVAnet is conditional for the SDLA. The SDLA
may alternately choose to close a case via the USCIS web-site, or if no action is taken to close the case, it will be
automatically closed by USCIS after 60 days.
4 VERIFICATION OF LAWFUL STATUS
Overview
Page 10
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
4.1
Initiate Initial Request
The State Driver Licensing Agency (SDLA) initiates the initial request for verification of lawful status by sending an
Initial Inquiry (IP) message to USCIS. This is triggered by an applicant approaching an SDLA requesting the issuance
of a Driver License, Permit or Identification Card, where the SDLA requires proof of lawful status before issuing such a
document.
The following diagram illustrates the message flow and processing associated with the initial request for verification of
lawful status.
Figure 4 - Initial Inquiry Request
4 VERIFICATION OF LAWFUL STATUS
4.1 Initiate Initial Request
Page 11
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
4.1.1 Initiate Request for Verification of Lawful Status (SDLA)
4.1.1.1
Population and Transmission of the Initial Inquiry (IP) Message
The following information is unconditionally required on the Initial Inquiry (IP) message:
1.
2.
3.
4.
5.
6.
7.
8.
USCIS Benefit Code (BFDBFC) set to a value indicating the type of application being processed.
USCIS Document Type ID (BFDUDT) set to a value indicating the type of immigration document presented by the
applicant.
Driver Date of Birth (DDVDOB) set to the date of birth of the applicant as it appears on the immigration document
Driver First Name (DDVNMF) set to the first name of the applicant as it appears on the immigration document.
While the length of Driver First Name (DDVNMF) is defined as 40 characters, USCIS will return an error if more
than 25 characters are submitted.
Driver Last Name (DDVNML) set to the last name of the applicant as it appears on the immigration document
Agency User Id (BFDUSR) set to the user id associated with the entity sending the request. The entity is defined as
the Jurisdiction for which the Agency User ID originated.
Agency Password (BFDUPW) set to the password specifically assigned to the User Id (BFDUSR) provided above.
Message Destination (GMSDST) set to ‘DD’.
If the name of the applicant as it appears on the immigration document also reflects one or more middle names, then the
following must also be included on the Initial Inquiry (IP) message:
9.
Driver Middle Name (DDVNMM) set to all the middle names of the applicant as they appear on the immigration
document
The Initial Inquiry (IP) message must also include the identifier number(s) associated with the immigration document
presented by the applicant. One or more of the following identifier numbers must be conditionally provided on the
Initial Inquiry (IP) message based on the type of document being used for the inquiry. Table 1 below indicates the
identifier numbers(s) required for each specific document type currently supported.
10. USCIS Alien Registration Number (BFDARN) set to the number on the immigration document. Note that the ‘A’
at the beginning of the number must be omitted. If the number is shorter than 9 digits, leading zeroes should be
appended to the front end of the number.
11. USCIS I-94 Number (BFDI94) set to the number on the immigration document.
12. VISA Number (BFDUVN) set to the number on the immigration document.
13. USCIS SEVIS Number (BFDUSN) set to the number issued by US Immigration and Customs Enforcement on the
immigration document.
14. Passport Number (BFDPPN) set to the number on the foreign passport.
15. Document Certificate Number (BFDCTN) set to the receipt number on the I-551 (Permanent Resident Card),
naturalization number on the Naturalization Certificate, or citizenship number on the Certificate of Citizenship.
NOTEs:
 I-551
o The Receipt Number is 13 characters long. The first 3 characters are alpha characters and the remaining
10 are numeric characters
 Naturalization Certificate and Certificate of Citizenship
o The Naturalization or Citizenship Certification Number must be between 7 and 12 characters long and
must contain numeric characters
o pre-1956 certificates do not contain an alien number; in this case, enter 999999999 in the alien number
The Initial Inquiry (IP) message may also conditionally include the following information, depending on the type of
document being used for the inquiry.
16. Federal Document Expiration Date (BFDEXP) set to either the expiration date on the immigration document, if
present, or set to the Passport Expiration Date. Table 1 indicates the population rules based on document type.
17. Federal Document Description (BFDUDD) set to the description of the type of document being used (i.e., “I-151
4 VERIFICATION OF LAWFUL STATUS
4.1 Initiate Initial Request
Page 12
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
Card”). Note that the Federal Document Description (BFDUDD) should only be provided when the USCIS
Document Type ID (BFDUDT) is set to a value of “01” indicating “Other Document”.
Table 1 identifies the additional input that is either required or conditionally required on the initial inquiry, based on the
type of document presented by the applicant. “R” and “C” are used in the table to indicate the following:
1. "R" indicates that the element is “required”.
2. "C" indicates that the element is “conditional”. It is not a required element and must be provided if it is
available.
3. an empty cell indicates the element is not used.
Document
Certificate
Number
Document
Description
C
I-551 - Permanent Resident (Green) Card
04
R
C
22
R
21
R
I-571 - Refugee Travel Document
05
R
C
I-766 - Employment Authorization Card
09
R
R
Certificate of Citizenship
23
R
R
Naturalization Certificate
20
R
R
DS2019 - Exchange Visitor (J-1) Certificate
27
R
R
C
I-20 - Nonimmigrant Student (F-1) Certificate
26
R
R
C
I-94 - Arrival/Departure Record
02
R
C
C
Unexpired Foreign Passport
10
R
C
R
30
C
01
R
Machine Readable Immigrant Visa (with
Temporary I-551 Language)
Temporary I-551 Stamp (on passport or I-94)
Waiver Traveler/Waiver Business (WT/WB)
Admission Stamp in Unexpired Foreign
Passport
Other documents for Students (this is the
catch-all option used for any document not
listed above which has a SEVIS Number)
Other documents for non-students (this is the
catch-all option used for any document not
listed above which has an Alien Number)
01
R
C
C
SEVIS
ID
R
Passport
Number
03
Visa
Number
Alien
Number
I-327 - Reentry Permit
Document Name
I-94
Number
Document
Type ID
Expiration
Date
Table 1 - Input Parameters by Document Type
R
C
C
C
R
R
R
R
C
C
R
C
R
The Initial Inquiry (IP) message may conditionally include:
18. User Field (BFDUSF) set to the identifier of the user who types in the inquiry. DHS and the jurisdiction should
have an agreement (via the MOA with USCIS) on the user identifiers that a Jurisdiction will be required to submit.
This parameter is required if the user credentials (Agency User ID, Agency Password) are scoped to the
Jurisdictional level. This parameter is not required if the user credentials are scoped to the individual level. The
Jurisdiction is responsible for uniquely identifying the sender of the request. If the user credentials are scoped to the
individual level, dialogue is required with USCIS.
19. Up to five (5) instances of Return as Received Text (GRREC2) set to any free-form text the State Driver Licensing
Agency (DSLA) wishes. All instances of Return as Received Text (GRREC2) that are provided on the Initial
4 VERIFICATION OF LAWFUL STATUS
4.1 Initiate Initial Request
Page 13
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
Inquiry (IP) message are passed back untouched to the SDLA in any associated response messages.
See Appendix A of this document for more information regarding the population of the elements contained in the
associated Network Control Block (NCB) and Message Exchange Control (MEC) block.
Note: The systems, to which the inquiries are made, may not thoroughly validate the inquiry data and can return
ambiguous error messages. So the Jurisdiction should thoroughly validate their data before it is submitted. This
validation should include checking the appropriate fields are submitted for a given document type (see the table above).
4.1.2 Verify Lawful Status (USCIS)
4.1.2.1
Receipt of the Initial Inquiry (IP) Message
USCIS receives the Initial Inquiry (IP) message from the State Driver Licensing Agency (SDLA) requesting the
verification of lawful status for an applicant.
4.1.2.2
Validation of the Contents of the Initial Inquiry (IP) Message
Some validation checks are performed on the Initial Inquiry (IP) message by USCIS. (The primary responsibility for
detecting errors in the data lies with the jurisdiction not USCIS). If any errors are detected, the original Initial Inquiry
(IP) message is updated with the appropriate error information and is returned to the State Driver Licensing Agency
(SDLA). No additional processing takes place at USCIS without further action being taken by the SDLA.
Please refer to the Error Processing section of this document for further details on error processing as it relates to the
AMIE message format.
Please refer to Appendix E of this document for a comprehensive list of application error messages and their specific
meanings as defined by the SAVE system.
4.1.2.3
Retrieval and Verification of Lawful Status
When a valid inquiry is received, USCIS attempts to retrieve and verify the lawful status of the applicant based on the
information provided on the Initial Inquiry (IP) message.
4.1.2.4
Population and Transmission of the Initial Response (RP) Message
If USCIS is able to process the inquiry successfully, SAVE generates a response message that is then translated into a
VLS-compatible Initial Response (RP) message. It is the Initial Response (RP) message that is forwarded onto the State
Driver Licensing Agency (SDLA). The Initial Response (RP) message contains the following information:
1.
Processing Status (GPROST) set to '00' (successful).
2.
Message Locator/Header (GMSLOC) set to the value received on the original Initial Inquiry (IP) message.
Return as Received Data (GRREC2) set to the value received on the original Initial Inquiry (IP) message. Up See
Appendix A of this document for more information regarding the population of the elements contained in the associated
Network Control Block (NCB) and Message Exchange Control (MEC) block.
Most of the business elements in the RP message are passed along from the SAVE service. For a full listing and
description of RP message business elements, refer to section 4.1.3.2 and to Appendix A.
The business elements which are re-formatted are:

Admitted-to Text. The ten character code is truncated to a one character code.

Date elements which have their format converted to the AMIE form.
4 VERIFICATION OF LAWFUL STATUS
4.1 Initiate Initial Request
Page 14
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
4.1.2.5
Errors
Population and Transmission of the Initial Inquiry (IP) Message with
If any errors are detected while processing the Initial Inquiry (IP) message (i.e. SAVE ‘ReturnStatus’ parameter on the
Initial Verification Response is non-zero), the original Initial Inquiry (IP) message is updated with the appropriate error
information and is returned to the SDLA. For a full listing and description of the Errors elements, refer to the Error
Processing section of this document.
4.1.3 Process Lawful Status Response (SDLA)
The State Driver Licensing Agency (SDLA) should always anticipate receiving one or the other of the following two
responses:


The Initial Inquiry (IP) message is returned to the SDLA with errors, or
The associated Initial Response (RP) message is received by the SDLA
If no response is received from USCIS at the SDLA within the expected time-frame, the inquiry will need to be reinitiated by the SDLA for processing. Dialog between the SDLA and USCIS may be required to determine the cause of
the problem.
4.1.3.1
Initial Inquiry (IP) Message Received with Errors
If an error is encountered while processing the original Initial Inquiry (IP) message, it is returned to the SDLA with a
textual description of the error that was encountered. Potential errors include system errors, errors due to invalid data
provided on the inquiry message and errors resulting from a no-match situation at USCIS.
The error message must be reviewed by the SDLA and appropriate action taken to address the problem. Dialog
between the SDLA, USCIS and the applicant may be required to determine the problem’s root cause and/or most
effective corrective action.
The following data elements are set:
1.
USCIS Case Number (BFDCAN) set to the USCIS unique identifier associated with the case.
2.
Processing Status (GPROST) set to '01' (unsuccessful). (This element will be removed in release 2.0),
3.
Error Code (GERCOD) set when a system error is encountered by the ESB or by the network interface (UNI).
(It is set to spaces when there is no system error).
4.
Error Message (GERMSG) set to the description of the error encountered. Zero to 5 instances of this field may
be used to convey the error. The error may be:
a.
A system error reported by the ESB.
b.
A system error reported by the network interface (UNI).
c.
An execution status code reported by SAVE.
i. The first instance of the error is set to the SAVE return status code. Appendix E lists the
return statues as defined by the SAVE system, at the time this document was prepared. Note:
testing found some undocumented errors were returned under the generic errors “-1000” and
“-1001”. So the jurisdiction must review the text returned in the second and third instance of
the error. Please address questions about SAVE error messages to SAVE Program
Assistance.
ii. The second instance set to the first 54 characters of the SAVE return status message
iii. The third instance set to any characters in positions 55 and greater of the SAVE return status
4 VERIFICATION OF LAWFUL STATUS
4.1 Initiate Initial Request
Page 15
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
message.
When the Initial Inquiry (IP) message is returned to the SDLA with an error message indicating that the information
provided on the inquiry is incorrect or incomplete, the SDLA has the ‘one-time’ option of resubmitting the Initial
Inquiry (IP) message with the additional and/or corrected information.
Please refer to the Appendix E for a list of the errors and their explanations.
4.1.3.2
Initial Response (RP) Message Received
When USCIS has processed a successful initial verification query, the VLS system returns the Initial Response (RP)
message to the SDLA. The contents of the message must be reviewed by the SDLA to determine whether or not the
Driver License, Permit or Identification Card should be issued.
If, on the RP, the ‘USCIS Case Number’ is populated and ‘USCIS Eligibility Statement Code’ equals ‘32’ or ‘37’, the
SAVE system determined the initial verification failed due to incomplete or insufficient data on the request. The VLS
user has the option to resubmit the initial verification request (see section 4.1.4.2).
If data elements 4 – 20 (inclusive) are provided on the RP message, the SDLA must display them per the ‘display
requirements’ of section 3.6.
The Initial Response (RP) message contains the following information:
1.
Processing Status (GPROST) set to '00' (successful).
2.
Message Locator/Header (GMSLOC) set to the value on the original Initial Inquiry (IP) message.
3.
Return as Received Data (GRREC2) set to the value(s) on the original Initial Inquiry (IP) message. Up to five
(5) occurrences may be present
4.
SAVE Web Service Version (BFDWSV) set to the version number of the SAVE software which executed the
SAVE response. It has no business function, it is included to assist in trouble shooting problems. In most
environments this element will be automatically recorded in a message log (such as the UNI Message Log). It
is recommended that the log be retained for a period to support problem investigation.
5.
USCIS Case Number (BFDCAN) set by the SAVE system to a unique identifier associated with the case. This
number is used if additional verification request(s) are deemed necessary. The number can also be used as a
unique applicant identifier if/when corresponding with USCIS.
6.
USCIS Eligibility Statement Code (BFDESC) unique eligibility statement code (aka message code) provided
by the SAVE system. The data dictionary lists the possible eligibility statement codes defined by the SAVE
system.
Some values describe the status of the person. Others explain why a non-favorable status could not be returned,
these are:
‘5’ (INSTITUTE ADDITIONAL VERIFICATION) indicates that a secondary request must be submitted.
‘32’ (MISSING SEVIS ID) indicates the request should be resubmitted with the SEVIS ID (see section
4.1.4.1). This situation occurs when the initial verification could not be completely determined
because the Class of Admission (COA) code found for the non-citizen indicates a student or
exchange visitor. In order for the initial verification to be completed, the SEVIS ID for the student
or exchange visitor is needed.
‘37’ (INCOMPLETE) indicates the initial verification failed. The ‘USCIS IAV Code’ and ‘USCIS IAV Text’
indicate the reason for failure. When a value of 37 is returned the SDLA has the option to resubmit
the initial verification request correcting the field(s) in error.
‘119’ (REFER STUDENT/EXCHANGE VISITOR TO THEIR SCHOOL/PROGRAM SPONSOR), which
4 VERIFICATION OF LAWFUL STATUS
4.1 Initiate Initial Request
Page 16
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
may be returned when the IP is submitted / resubmitted with a SEVIS ID; this value is returned only
for students and exchange visitors. The applicant must contact their immigration sponsor, to review
their immigration status.
7.
USCIS Eligibility Statement Text (BFDEST) Eligibility statement text. Text may be used to determine if a
person is authorized to work. If the person is authorized to work, the text will include verbiage to that effect.
Note: An Eligibility Statement which has no Employment Authorization may explain why a person has no SSN.
Initial Response (RP) message will contain the following information, if it is found in the SAVE database and returned
by the SAVE system:
8.
USCIS Class of Admission (BFDCOA) is set to the Class of Admissions code as found in the SAVE database.
COA set to a value indicating the visa type or rule under which the applicant was admitted to this country. (i.e.,
an SDLA may want to look at this field to determine issuance if it does not issue a license to a person that is in
this country on a tourist visa).Appendix F lists the set of possible COA codes as defined by the SAVE system.
9.
Driver Date of Birth (DDVDOB) is set to the value as found in the SAVE database. If this date is different to
the date on the DL application or immigration document then the state should determine if they need to
institute an additional verification
10. Driver First Name (DDVNMF) is set to the name recorded in the SAVE database.
11. Driver Middle Name (DDVNMM) is set to the name recorded in the SAVE database.
12. Driver Last Name (DDVNML) is set to the name recorded in the SAVE database.
a.
If any part of the name returned is substantially different to the name on the immigration document
then the jurisdiction must investigate the cause. There may be valid reasons for the names to be
different (i.e. a name change due to a marriage). However the difference could be due to SAVE
returning details in the response for a person other than the individual being queried, so checking the
names returned is very important.
13. USCIS Admitted-to Date (BFDATD) is set to the date admitted until as found in the SAVE database, if
available. See the following table for when this element should be used.
14. USCIS Admitted-to Type (BFDATT) is set to the ‘Admitted-to Text’ as found in the SAVE database, if
available. See the following table for when this element should be used.
a.
When the code indicates Duration of the Stay, the end date is not available in the response, it will
have to be obtained from another source.
b.
When the code indicates Indefinite, an individual has no fixed end date on their stay. This is used for
individual who have no end-date on their stay (i.e. lawful permanent residents) and for individuals
who have a status which may be changed in the future, but what the changed status would be is
unknown (i.e. a refugee). When indefinite is returned, the jurisdiction can follow their own rules to
determine the expiration date of the license, ID card or permit.
15. USCIS Employment Authorization End Date (BFDEED) set to the expiration date of the most recently issued
employment authorization document as identified by the SAVE system. See the following table for when this
element should be used.
Jurisdiction have rules which specify the normal Expiration Date for a Driver License, Permit or Identification
Card. SAVE can return end dates for the lawful status of a person which may take precedence. The Expiration
Date associated with the Driver License, Permit or Identification Card, is set to the earlier of the dates, so the
Expiration Date is never greater than the end date associated with the lawful status of the applicant. The
following table identifies the combinations of dates that may be returned from SAVE and indicates which
should be used in determining the expiration date.
4 VERIFICATION OF LAWFUL STATUS
4.1 Initiate Initial Request
Page 17
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
Admittedto Date
(BFDATD)
Admitted-to
Type
(BFDATT)
Employment
Authorization
End Date
(BFDEED)
Element to Use:
No match, so no end date available
Present
Use BFDATD
Present
Present
Present
Use BFDATT
Present
Use BFDEED
Present
Use BFDATD
Present
Use BFDATT
16. USCIS Alien Entry Date (BFDAED) set to the value as found in the SAVE database. There is no requirement
for the jurisdictions to check this element, so jurisdictions can determine if they want to perform an extra check
and compare the value against the source documents.
17. USCIS Country of Citizenship Code (BFDUCC) set to the value as found in the SAVE database. Appendix G
lists the codes used by the SAVE system.
When the verification is performed based on a document from a foreign country (i.e. a Passport), jurisdictions
should check the country of origin of the document matches the country code returned by SAVE. The
description of some codes is 'Unknown', the DMV is not required to verify an immigration document matches
this value.
18. USCIS Country of Birth Code (BFDUBC) set to the value as found in the SAVE database. Appendix G lists
the codes used by the SAVE system. There is no requirement for the jurisdictions to check this element, so
jurisdictions can determine if they want to perform an extra check and compare the value against the source
documents.
19. USCIS IAV Code (BFDIVC) set to the code that describes some of the reasons for a match not being made as
defined by the SAVE system. The data dictionary lists the set of possible values as defined by the SAVE
system.
20. USCIS IAV Text (BFDIVT) set to the value as defined by the SAVE system.
4.1.4 Resubmit Initial Inquiry (SDLA)
If the data provided on the initial inquiry was erroneous or incomplete and resulted in a no-match the SDLA will receive
the Initial Inquiry (IP) message returned with an error message, or the Initial Response (RP) message is returned to the
SDLA with the ‘USCIS Eligibility Statement Code’ = 32 or 37. In these conditions the SDLA has the option of
resubmitting the Initial Inquiry (IP) message after adding and/or correcting the information being provided
4.1.4.1
Resubmit Due to SEVIS ID Omission
When the Initial Response (RP) message is returned to the SDLA with an Eligibility Statement Code = 32 (i.e. the
inquiry requires inclusion of a SEVIS ID), the SDLA may actually resubmit the Initial Inquiry (IP) message to USCIS
with the additional information. This situation occurs when the initial verification could not be completely determined
because the Class of Admission (COA) code found for the non-citizen indicates a student or exchange visitor. In order
for the initial verification to be completed, the SEVIS ID for the student or exchange visitor is needed.
The resubmitted Initial Inquiry (IP) message must contain the following information:
1.
USCIS Case Number (BFDCAN) set to the case number returned on the associated Initial Inquiry (IP) message
returned in error.
4 VERIFICATION OF LAWFUL STATUS
4.1 Initiate Initial Request
Page 18
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
2.
3.
4.
5.
6.
USCIS SEVIS Number (BFDUSN) set to the number provided by the applicant.
Agency User Id (BFDUSR) set to the user id associated with the entity within the SDLA sending the request
Agency Password (BFDUPW) set to the password specifically assigned to the Agency User Id (BFDUSR)
provided above.
Message Destination (GMSDST) set to ‘DD’.
Transaction Resubmission Type (GTRRST) set to a value of ‘A’ indicating that additional information (the
SEVIS Number) is being provided.
Any additional information provided on the resubmitted Initial Inquiry (IP) message will be ignored during subsequent
processing by USCIS.
4.1.4.2
Resubmit for Other Reason
When the Initial Response (RP) message is returned to the SDLA with an ‘USCIS Eligibility Statement Code’ = 37 and
the ‘USCIS IAV Code’ populated, the SDLA has the ‘one-time’ option of resubmitting the Initial Inquiry (IP) message
with the additional and/or corrected information included.
The resubmitted Initial Inquiry (IP) message must contain the following information:
1.
USCIS Case Number (BFDCAN) set to the case number returned on the associated Initial Inquiry (IP) message
returned in error.
2.
3.
Agency User Id (BFDUSR) set to the user id associated with the entity within the SDLA sending the request
Agency Password (BFDUPW) set to the password specifically assigned to the User Id (BFDUSR) provided
above.
Message Destination (GMSDST) set to ‘DD’.
Transaction Resubmission Type (GTRRST) set to a value of ‘C’ indicating that data has been corrected.
USCIS Document Type ID (BFDUDT) set to a value indicating the type of immigration document presented
by the applicant and sent during the initial inquiry.
4.
5.
6.
Depending on the reason for the resubmission, only the following additional data element(s) – and no others – may be
submitted (if extraneous information is submitted, an error is returned):
If the ’USCIS IAV Code’ is equivalent to a Date Of Birth mismatch
 Driver Date of Birth (DDVDOB) set to the corrected date of birth of the applicant as it appears on the
immigration document
NOTE: no name or document information may be submitted
If the ’USCIS IAV Code’ is equivalent to a name mismatch
 Driver First Name (DDVNMF) set to the corrected first name of the applicant as it appears on the immigration
document
 Driver Middle Name (DDVNMM) set to the corrected middle name(s) of the applicant as it/they appear on the
immigration document (if the name of the applicant as it appears on the immigration document reflects one or
more middle names)
 Driver Last Name (DDVNML) set to the corrected last name of the applicant as it appears on the immigration
document
NOTE: no DOB or document information may be submitted
If the ‘USCIS IAV Code’ is equivalent to a ‘Record Not Found’ value
 Document data (as indicated in Table 1) set to the corrected information as it appears on the immigration
document based on the document type to be verified. SDLA’s will need to reference Table 1 - Input Parameters
by Document Type to determine which element may be in error.
NOTE: no DOB or name information may be submitted
4 VERIFICATION OF LAWFUL STATUS
4.1 Initiate Initial Request
Page 19
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
4.2
Update Password
The USCIS passwords expire after 90 days and the State Driver Licensing Agency (SDLA) must provide USCIS with a
new password before the old password expires. Daily email notifications announcing the SDLA’s password will expire
are sent beginning 14 days prior to expiration. These notifications are sent via email to the SDLA’s technical point of
contact on file with the USCIS SAVE Program. DHS recommends the SDLA keep track of the expiration timeline on
their own to ensure that their password is reset on time to limit the interruption of service.
To change the password before it expires, the jurisdiction can use the ‘Update Password’ message (as defined below).
If the password is allowed to expire, the SDLA must request a new password from the SAVE Program directly (email:
vis-help-desk@csc.com).
The following diagram illustrates the message flow and processing associated with the request.
Figure 4 – Update Password
DHS-USCIS applies the following rules for a new Password:
1. Passwords have a maximum lifetime of 90 days.
2. With the exception of the initial password, the password lifespan shall be no less than 5 days.
3. The re-use of any of the previous six passwords is not allowed.
4. An 8 to 14-character password composed with the following characteristics:
a. At least one uppercase and one lowercase letter.
b. At least one number.
c. At least one special character ( ! @ $ % * ( ) < > ? : ; { } + - ~ ).
Note: There is a constraint on the characters which may be used on AAMVAnet, the “{” and “}”
characters may not translate on some computer platforms and should be avoided. For more details see the
Printable Characters section of this document.
d. Contain no more than two identical consecutive characters in any position from the previous password.
e. Contain a non-numeric in the first and last position.
4 VERIFICATION OF LAWFUL STATUS
4.1 Initiate Initial Request
Page 20
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
Additionally, as a DHS-USCIC policy, passwords shall not:
1. Contain any dictionary word.
2. Contain any proper noun or the name of any person, pet, child, or fictional character, nor any employee
serial number, Social Security Number, birth date, phone number, or any information that could be readily
guessed about the creator of the password.
3. Contain any simple pattern of letters or numbers,
4 VERIFICATION OF LAWFUL STATUS
4.1 Initiate Initial Request
Page 21
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
4.2.1 Request Password Update (SDLA)
4.2.1.1
Population and Transmission of the Password Update (UP) Message
The following information is required on the Password Update (UP) message:
1.
2.
3.
Agency User Id (BFDUSR) set to the user id associated with the entity within the SDLA sending the request.
Agency Password (BFDUPW) set to the current password specifically assigned to the Agency User Id
(BFDUSR) provided above.
Agency New Password (BFDUPN) set to the new password for the Agency User Id (BFDUSR).
The Update Password (UP) message may conditionally include:
4.
Up to five (5) instances of Return as Received Text (GRREC2) set to any free-form text the State Driver
Licensing Agency (SDLA) wishes. All instances of Return as Received Text (GRREC2) that are provided on
the request are passed back untouched to the SDLA in any associated response messages.
See Appendix A of this document for more information regarding the population of the elements contained in the
associated Network Control Block (NCB) and Message Exchange Control (MEC) block.
4.2.2 Verify Lawful Status (USCIS)
4.2.2.1
Receipt of the Password Update (UP) Message
USCIS receives the Password Update (UP) message from the State Driver Licensing Agency (SDLA).
4.2.2.2
Validation of the Contents of the Password Update (UP) Message
Some validation checks are performed on the message by USCIS. (The primary responsibility for detecting errors in the
data lies with the jurisdiction not USCIS). If any errors are detected, the original message is updated with the
appropriate error information and is returned to the State Driver Licensing Agency (SDLA). No additional processing
takes place at USCIS without further action being taken by the SDLA.
Please refer to Appendix E of this document for a comprehensive list of application error messages and their specific
meanings as defined by the SAVE system.
Please refer to the Error Processing section of this document for further details on error processing as it relates to the
AMIE message format.
4.2.2.3
Retrieval and Verification of Lawful Status
When a valid request is received, USCIS attempts to update the user password.
4.2.2.4
Population and Transmission of the Password Update Confirmation
(CP) Message
If USCIS is able to process the request successfully, SAVE generates a response message (with a SAVE ‘ReturnStatus’
of zero) that is then translated into a VLS-compatible Password Update Confirmation (CP) message. It is the Password
Update Confirmation (CP) message that is forwarded onto the State Driver Licensing Agency (SDLA). The Password
Update Confirmation (CP) message contains the following information:
1.
Message Locator/Header (GMSLOC) set to the value received on the original Password Update (UP) message.
4 VERIFICATION OF LAWFUL STATUS
4.1 Initiate Initial Request
Page 22
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
2.
Return as Received Data (GRREC2) set to the value received on the original Password Update (UP) message.
See Appendix A of this document for more information regarding the population of the elements contained in the
associated Network Control Block (NCB) and Message Exchange Control (MEC) block.
4.2.2.5
Population and Transmission of the Password Update (UP) Message
with Errors
If any errors are detected while processing the Password Update (UP) message (i.e. SAVE ‘ReturnStatus’ parameter is
non-zero), the original Password Update (UP) message is updated with the appropriate error information and is returned
to the SDLA. For a full listing and description of the Errors elements, see the “Password Update (UP) Message
Received with Errors” section below and the “Error Processing” section of this document.
4.2.3 Process Password Update Confirmation (SDLA)
The State Driver Licensing Agency (SDLA) should always anticipate receiving one or the other of the following two
responses:


The Password Update (UP) message is returned to the SDLA with errors, or
The associated Password Update Confirmation (CP) message is received by the SDLA
If no response is received from USCIS at the SDLA within the expected time-frame, the inquiry will need to be reinitiated by the SDLA for processing. Dialog between the SDLA and USCIS may be required to determine the cause of
the problem.
4.2.3.1
Password Update (UP) Message Received with Errors
If an error is encountered while processing the original Password Update (UP) message, it is returned to the SDLA with
a textual description of the error that was encountered. Potential errors include system errors and errors due to invalid
data provided on the request. The error message must be reviewed by the SDLA and appropriate action taken to address
the problem.
The following data elements are set:
1.
Error Code (GERCOD) set when a system error is encountered by the ESB or by the network interface (UNI).
(It is set to spaces when there is no system error, i.e. when the error reported comes from the SAVE
‘ReturnStatus’).
2.
Error Message (GERMSG) set to the description of the error encountered. Zero to 5 instances of this field may
be used to convey the error. The error may be:
a.
A system error reported by the ESB.
b.
A system error reported by the network interface (UNI).
c.
An execution status code reported by SAVE.
i. The first instance of the error is set to the SAVE return status code. Appendix E lists the
return statues as defined by the SAVE system, at the time this document was prepared. Note:
testing found some undocumented errors were returned under the generic errors “-1000” and
“-1001”. So the jurisdiction must review the text returned in the second and third instance of
the error. Please address questions about SAVE error messages to SAVE Program
Assistance.
ii. The second instance set to the first 54 characters of the SAVE return status message
iii. The third instance set to any characters in positions 55 and greater of the SAVE return status
message.
4 VERIFICATION OF LAWFUL STATUS
4.1 Initiate Initial Request
Page 23
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
Please refer to the Appendix E for a list of the errors and their explanations.
4.2.3.2
Password Update Confirmation (CP) Message Received
When USCIS has successfully processed the password reset, the VLS system returns the Password Update
Confirmation (CP) message to the SDLA. Receipt of this message is confirmation that the update was successful.
The SDLA is not required to display CP message data per the ‘display requirements’ of section 3.6.
The Password Update Confirmation (CP) message contains the following information:
1.
Message Locator/Header (GMSLOC) set to the value on the original Password Update (UP) message.
2.
Return as Received Data (GRREC2) set to the value(s) on the original Password Update (UP) message. Up to
five (5) occurrences may be present.
4 VERIFICATION OF LAWFUL STATUS
4.1 Initiate Initial Request
Page 24
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
4.3
Subsequent Transactions
The secondary verification and tertiary verification requests, as well as other SAVE transactions, are not supported in
VLS release 1.2. They will be available in VLS release 2.0.
4 VERIFICATION OF LAWFUL STATUS
Error! Reference source not found. Error! Reference source not found.
Page 25
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
5.
AMIE TRANSACTION DESIGN
An AAMVAnet Message Interchange Envelope (AMIE) transaction is a set of AMIE messages needed to perform a
business function. A simple transaction may involve an inquiry message from one site to another and the response going
back.
5.1
AMIE Message Format
Messages in VLS transactions are sent in the AMIE message format. The AMIE format is used to exchange data
between network nodes using the Network Control Software (NCS). Each message follows the same basic format but
contains different data depending on the purpose of the message.
The AMIE format defines message types of variable length based on blocks of position-defined data that are 66 bytes
(i.e., characters) long. Due to early network limitations, up to 55 blocks are allowed within a message, resulting in a
maximum message length of 3630 bytes.
Each message begins with a Network Control Block (NCB), which contains information about the message type,
routing, length, and other relevant data. Subsequent blocks are part of the application text block pool. A message may
contain zero to 54 application text blocks. Each block is not a separate message (or packet), but the NCB and related
application text blocks are bundled together as a single network message.
A typical message contains one Network Control Block (NCB) and a number of Application Text Blocks. The
Application Text Blocks can have:



One Message Exchange Control (MEC) block on each message.
Zero to 52 business application blocks may be included, depending on the message type. The application
blocks contain the details specific to the application. Normally these blocks hold the application's business
data, but they may also be used to hold technical information (e.g. a Return as Received block).
Zero to five error blocks may be included, depending on the number of errors detected. See the Error
Processing section for details.
The following figure depicts the blocks of an AMIE message and their lengths. It also shows the layout of each
application text block, with its 5-byte text block key and the 61-byte text block data area.
Figure 10 - Message Blocks
NCB
← 66 →
Text block 1
← 66 →
Text block 2
← 66 →
to
Text block key
Type
←2→
SubT
←1→
Line
←2→
Text block n
← 66 →
Text block data
← 61 →
The application text block key uniquely identifies a block. It consists of the block identifier and a line number. The
block identifier consists of the block type and sub-type. When a block is being referenced, it is often described as
type/sub-type. When the same block type/sub-type is used multiple times within a message, the line number is used to
distinguish the occurrences of the block type/sub-type. The line numbers are allocated sequentially, starting with 01, for
a given block type/sub-type occurrence within a message.
Blocks in a message are ordered by block type. As the block type is numeric, this order can be applied to all platforms.
The block sub-type may be a number or a letter. Because of the different computer architectures, there is no guarantee
5 AMIE TRANSACTION DESIGN
Page 26
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
that blocks sub-types will always have the same order (e.g. the block sort order on an IBM will be 30/A, 30/1; while on
a UNIX box the order would be 30/1, 30/A).
Messages are often defined with application text blocks that are conditional. To improve efficiency, only application
text blocks that contain application data should be transmitted.
5.1.1 Network Control Block
Every message contains a Network Control Block (NCB), which contains information used by the NCS to identify and
route the message. A layout of the elements in the NCB block is provided in this document in the 'Data Elements By
Block' appendix. Many of the fields are automatically populated by a network interface tool, such as AAMVA’s
Unified Network Interface (UNI) tool. The remaining fields must be filled by the application programs.
See the Source Code definitions in the 'Data Elements by Message Type' appendix for a description of how the elements
in the block are populated and used.
Note: When UNI populates an NCB field, it may:





Calculate the field.
Fill the field from the parameter list destination table.
Fill the field from a configuration constants copy member.
Derive the field based on a default for this application.
Derive the field based on a value from the parameter list.
The NCB block has no text block key, however it is often referred to as block '00/0'.
5.1.1.1
Network Addresses
Message addressing is accomplished through the use of three fields in the Network Control Block:



Message Destination. Indicates to which node the message is to be sent.
Message Origin. Indicates which node sent the message.
Transaction Originator. Indicates the initiator of the transaction of which the message is a part.
Since the contents are shifted between the fields during response processing, all of these fields have the same 7 byte
alpha-numeric format. The first three bytes of the address are known as the GAP (Government/Application Provider)
Code and the last 4 bytes of the address contain the User Extension. The GAP code is broken down further into the
Primary Address in the first 2 bytes and the Interface Code in the third.
Figure 11 - Network Address
This figure shows
the layout of a
Network Address.
It uses the code
used by the New
York DMV as an
example.
N
Primary
Address
Y
Interface
Code
Gap Code
User Extension
Network Address
The Primary Address is the 2-character code for MVAs (normally the postal abbreviation) and AAMVA processing
sites. The Primary Address is the only part that is required. Positions 3 to 7 of the Network Address contain spaces
when they are not needed.
5 AMIE TRANSACTION DESIGN
Page 27
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
The Interface Code is used to distinguish between multiple systems at a single site. For example, in some jurisdictions
the driver licensing and vehicle registration systems are operated on different physical machines. The Interface Codes
would be different for each.
The User Extension field of the Primary User description can be used at the discretion of the users, within the normal
parameters for AMIE messages. This field is frequently used to identify a particular workstation that originated the
message and therefore should receive the response. Other uses are possible depending on the needs of the users.
AAMVA manages the addresses and therefore is responsible for assigning all values as necessary for the GAP Codes.
5.1.2 Message Exchange Control Block
The Message Exchange Control (MEC) block is counted as one of the Application Text Blocks. It contains fields that
are commonly used while processing. The fields in the block tend to be used to manage a transaction (i.e., both an
initial message and its responses). The use of most of the fields in the MEC block is dependent on the type of message,
so their use is described in the processing description sections of the specification. The Message Locator element
(GMSLOC) of the MEC block is used in all messages.
See the Source Code definitions in the 'Data Elements by Message Type' appendix for a description of how the elements
in the block are populated and used in each message.
The MEC block has a text block type of '02'.
5.1.3 Other Application Text Blocks
The other application text blocks in a message contain the business information. The majority of the other application
text blocks are used once within a message. However instances exist where an AMIE text block is used multiple times
within a message. These multiple repetitions exist when:



A field is too long to fit in a single 61 byte block. For example a 108 byte address is transmitted in two AMIE
text blocks. The first 61 bytes are sent in the first block and the final 47 bytes are sent in the second block.
The application data is needed multiple times, where a single occurrence of the data will fit into one block.
The number of blocks will correspond to the number of occurrences of the data.
The data is needed multiple times, however the total length of the data to be repeated exceeds one block. In
these situations the number of AMIE text blocks used is the product of the number of blocks used to hold a
single occurrence, times the number of occurrences.
To be unique, the Text Block Key will use an incremented line number to distinguish between the multiple occurrences
of block types and maintain the sort sequence.
5.2
Element Formats
Data in an AMIE message must consist of printable characters. This means that non-printable bytes are not allowed in
any AMIE message. This limitation has been imposed because different types of computers use different data encoding
schemes. Therefore, to communicate across the network, only characters that are common on all the computers
connected to the network can be used.
For example, the AT&T Global Network Services (AGNS) network and IBM mainframes store character data in
EBCDIC, while UNIX, Unisys, Bull, and most other computer types store character data in ASCII. Translation
between these code sets is performed as part of the network transmission to or from an ASCII based machine. The
translation occurs by replacing a bit pattern from one code set with the corresponding bit pattern from the other code set.
As the translation is performed on each byte of data traveling on the data path without regard to the content of the data,
non-printable data would be corrupted when the bit patterns were replaced as if the byte contained character data.
5 AMIE TRANSACTION DESIGN
Page 28
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
5.2.1 Printable Characters
All application data elements must contain printable characters that can be used in both ASCII and common versions of
EBCDIC (such as US-EBCDIC). The printable characters are:
space
a to z
A to Z
0 to 9
!"#$%&'()*+,-./:;<=>?@
Other characters are not printable in ASCII and common versions of EBCDIC, and must be excluded. The user will
need to determine if the non-printable characters will be omitted or if they will substitute another character. The
recommendation for the Spanish characters is to convert them to similar English characters (e.g., a 'N' with a '~' above it
(ñ) is converted to 'N').
To ensure only printable bytes exist in a message, all unused areas of each block must be initialized with spaces. This
ensures unaddressable areas, such as the reserved bytes at the end of most blocks, contain valid AMIE data. The unused
fields should also be initialized to spaces regardless of the data type of the field. For example, a date field is normally
numeric, yet if the field is not a valid part of the message being built, the field should contain spaces rather than zeroes.
Do not initialize AMIE blocks or fields to LOW-VALUES or HIGH-VALUES, as these are binary zeroes or ones,
respectively, and do not represent printable data.
5.2.2 Dates
All dates sent in the application specific blocks of the messages are passed as eight character fields in 'ccyymmdd' form,
(e.g., '19951231').
5.2.3 Numbers
All numeric data sent in a message is passed in an unpacked form with leading zeros (e.g., a field with six integer digits
and a value of '1234' is transmitted as '001234' in an alpha-numeric field). This allows for the exchange of data between
users regardless of the compatibility of their internal numeric storage formats.
Unpacked numbers are used because different machine types store computational numeric data in a format native to the
processor. Assuming numeric data could move between AAMVAnet nodes without adulteration, the data would
probably be unusable by the destination node unless the origination and destination nodes happen to be compatible
machine types.
Eventually, exceptions to this rule may be required to allow movement of complex data in an efficient manner, possibly
using encoding and compression schemes. At that time, specific exceptions will be defined and will be documented to
an extent that potentially affected users will be aware of their limitations. However, the general rule will still apply to
all other messages which may be sent between nodes running on different computer types.
5.2.4 Text
Normally alphanumeric or textual elements do not have any leading spaces (i.e., they are left justified). Elements
needing other justifications may specify it in the element definition.
Most textual elements use upper-case letters. Elements needing lower-case letters may specify this in the element
definition.
Elements that represent codes will use the specified values listed for the individual element definition in the Data
Dictionary appendix.
5 AMIE TRANSACTION DESIGN
Page 29
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
5.3
Error Processing
When a processor encounters an error on an incoming message, it returns the message in error with error flags set and 1
to 5 error blocks. Each error block identifies a data element in error and gives an explanation of the error.
5.3.1 Error Block Formats
An Error Block (99/1) will use one of two formats, AMIE or UNI.
AMIE (GERPDP) Format: This format is used when the message is in AMIE, or network block format. The format
can be identified by the fifth character of the block containing a number. The block format contains:



Error Block Type (GERBTY), Error Block Sub-type (GERBST) and Error Block Line Number (GERLIN) are
set to the block identifier of the block that contains the element in error. For errors that are not attributable to a
single block within the message, it contains all nines or all zeroes. The Line Number is typically used when an
element occurs multiple times in a messages and the line identifies which occurrence of the element contains
the error.
Error Code (GERCOD) is set to a code identifying the error. The number is unique within a given block/block
subtype, thus identifying the data element within the block that was in error.
Error Text (GERMSG) containing the description of the error
UNI (GERUEB) Format: This is the format of error blocks appended by UNI when UNI detects an error. Positions 1
through 4 contain a UNI error code, with a "U" indicator in position 5.




UNI Error Code (GERUEC) is set to the UNI error (see the UNI documentation for details).
UNI Error Indicator (GERUCD) is set to "U" which identifies the format as a UNI error
Error Sub-Code (GERU2C) is set to a code which provides additional details about the error (see the UNI
documentation for details).
Error Text (GERMSG) containing the description of the error
Examples of Error Block Formats: The different formats of the error blocks are illustrated in examples below. Note the
way to differentiate the formats, is to look at the fifth character of the block:
AMIE (GERPDP)
UNI (GERUEB)
0910103SSN REQUIRED
0054U01APPLICATION WINDOW IS CLOSED
5.3.2 Types Of Errors
The types of errors can be categorized as:



network errors
system errors
application errors
NOTE: There are exceptions to this procedure for some messages. See the detailed process descriptions for the
messages that differ.
5.3.2.1
Network Errors
Network errors occur when the origination or destination node drops from the network, the network itself encounters a
failure, or there is a problem with the format of the message. There are established availability requirements that
minimize occurrences of this nature, but occasionally a failure does occur.
5.3.2.1.1
Issuing Network Errors
5 AMIE TRANSACTION DESIGN
Page 30
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
Network errors are issued by the Network Control Software (NCS). There is no need for the network interface software
(e.g., UNI) or the application to issue network errors to other users. However, the network interface software must be
able to detect when:



NCS issues an error
the originating node is not connected to the network
the network is completely down
NCS checks for certain conditions and performs its undeliverable processing if an error is encountered. When this
happens, NCS:




swaps the origin (GMSORG) and destination (GMSDST)
sets the Network Control Block (NCB) Error Code (GNCBER) to 'U'
records the error reason in the Network Status Indicator (GNETST), setting it to a value other than zero
attempts to return the message to the originator
The following codes may be set in the Network Status Indicator (GNETST) by the NCS:
Code
01
02
03
04
05
06
07
08
Explanation
The destination's connection (or terminals in the case of LU2 sites) is not active to the NCS.
The destination is not a valid jurisdictional site. This code no longer applies, as all jurisdictions are
defined in the NCS state code table.
The destination is not a valid destination (not defined to NCS).
The origin is invalid (not defined to NCS).
The Message Length field in the NCB contains a value that is less than the minimum (66) or the message
length specified in the NCB and the actual data length computed by the NCS do not match.
Applies only when the destination is the NCS (GAP code 'II'). The origin ID and the billing ID do not
match.
The NCS received an undeliverable message (a 'U' in the NCB Error Code field).
The message type received was not IN or IX. Applies only when the destination is NCS (GAP code 'II').
The only message types that are valid for destination to the NCS are IN or IX.
5.3.2.1.2
Receiving or Detecting Network Errors
As mentioned above, users must be able to detect when there is a problem with its originating node or when the network
is down. In addition, when a message is received, it should be inspected to determine whether a problem with the
destination has caused the message to be undeliverable. This is accomplished by inspecting the NCB error code
(GNCBER) and the network status indicator (GNETST).
To maintain data integrity, when any condition prevents an update message from being sent and delivered, the message
must be resent later. Inquiry messages may be resent at the discretion of the originating site.
AAMVA's UNI network interface tool offers this functionality. It detects when there is a problem with the originating
node or the network and automatically invokes its message pending process to temporarily store messages. If the
destination node or application is down, UNI detects the error, notifies the originator, and again sets the message(s)
aside for later transmission. Many of the parameters governing this process are configurable by the originating site.
See the UNI documentation for more information.
5.3.2.2
System Errors
System errors occur when program problems, database errors, program aborts, system availability issues, or failed
authorization checks are encountered. Many system errors are caused by an incorrect setup of the environment or
incorrect message parameters in the programs. Hence, system errors are common during development, but they should
occur infrequently in production.
System errors may be generated by the network interface or the application. UNI handles both inbound and outbound
system errors. UNI processes system errors according to the options configured in the UNI setup.
5 AMIE TRANSACTION DESIGN
Page 31
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
5.3.2.2.1
Issuing System Errors
To the extent possible, message recipients should detect system error conditions and return the original message with
the appropriate indicators to inform the originator of the problem. When a message is received and system errors are
detected:







Swap the origin (GMSORG) and destination (GMSDST)
Set the NCB Error Code (GNCBER) to 'Y'
Set the Processing Status (GPROST) to '02'
Set the Application Status Code (GAPPST) to the appropriate value, if applicable (see the Data Dictionary
appendix for valid values)
Attach an error block indicating the error
Attempt to return the message to the originator
UNI can issue errors for the following:
 Invalid message types
 Failed message origin authorization checks
 Message received outside the application's operating hours
 The system is unavailable. The Network Status Indicator (GNETST) is set as follows:
98 - Network window closed
99 - Local network down
 Other system errors that may be reported when program or environmental problems occur
The most common system error responses from UNI are:






"0007: TABLE ENTRY NOT FOUND" when the message origin is unknown to the site receiving the
message
"0025: ROUTING VALIDATION ERROR - CANNOT RECEIVE" when a message is sent to a site and the
site is not allowed to receive the message type. Error 0025 is issued when an update message is received
during the inquiry only window
"0026: ROUTING VALIDATION ERROR - CANNOT SEND" when the message origin is not allowed to
send the message type
"0052: ORIGIN/DEST NOT VALID FOR BRIDGE" when UNI cannot match the origin or destination
(depending on whether the message is being sent inbound or outbound) with the values in the UNI bridge table.
The bridge option is used by a site that needs to operate as multiple sites, e.g. the site that operates the bridge to
the Canadian jurisdictions.
"0053: APPLICATION IS CURRENTLY UNAVAILABLE" when a message is received by a site but the
application program is unavailable, the message is normally issued when a message is sent outside of the
normal hours of operation
"0054: APPLICATION WINDOW IS CURRENTLY CLOSED" when a message is sent outside of the hours
of operation defined in UNI's Application table.
Please note the list above does not include every UNI error nor does it include all causes for the errors listed. Please see
the UNI documentation for complete information.
5.3.2.2.2
Receiving System Errors
When a message is received, the recipient should check the NCB error code (GNCBER) and the error block area of the
message. Inspecting the first five bytes of the error block will reveal whether the error is an application error or a UNI
error.
If the fifth byte contains a 'U', the error was issued by UNI. UNI returns the error number in the first four bytes. For
example, the following error block was issued by UNI:
0025U25ROUTING VALIDATION ERROR - CANNOT RECEIVE
5 AMIE TRANSACTION DESIGN
Page 32
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
If the fifth byte does not contain a 'U’, the error was issued by the application. For example, the following error block
was issued by the application:
1230112TRANSACTION NOT COMPLETED, CALL THE HELP DESK
Appendix C contains the layout for the error block. It shows the format for both application and UNI errors (the UNI
error format redefines the application error format). In either event, the error message must be interpreted and
appropriate action taken to correct and/or resend the message. Application and common UNI system errors are listed in
the previous section.
Most UNI errors describe a problem with the system that will negatively impact message processing. It is
recommended that the receiving program issue an immediate alert so the problem can be investigated promptly. UNI's
System Error Utility Screen provides a listing of system errors, a detailed description of each error, and its probable
cause (see UNI documentation for details).
5.3.2.3
Application Errors
Application errors occur when the application tries to process a message. An error is issued when a message cannot be
processed. When an error is encountered, the error blocks are attached to the original incoming message and the
original message is returned.
The error blocks can accommodate up to five errors and warnings. If more than five are found, only the first five will
be reported.
5.3.2.3.1
Issuing Application Errors
When an application error or warning is encountered, the recipient should:

Swap the origin (GMSORG) and destination (GMSDST).

Set the standard error or warning settings (including setting the NCB error code (GNCBER) to 'Y' for errors).

Set the Application Status Code (GAPPST) to the appropriate value, if applicable (see the Data Dictionary
appendix for valid values).

Attach an error block indicating the error or warning using the applicable application error/warning codes.

Return the original message or the response.
The standard error message settings are:

NCB Error Code (GNCBER) set to 'Y' (yes).

Processing Status (GPROST) set to a value described in the Data Dictionary appendix.

Error Block Type (GERBTY) and Error Block Sub-type (GERBST) set to the block identifier of the block that
contains the element in error.

Error Block Line Number (GERLIN) set to the line within the Block Type and Sub-type that contains the
element in error. Typically this is needed when an element occurs multiple times in a message and the line
identifies which occurrence of the element contains the error.

Error Code (GERCOD) is set to a code identifying the error.

Error Text (GERMSG) containing the description of the error.
5.3.2.3.2
Receiving Application Errors
When a message is received with the NCB error code set to 'Y', there is no way to know whether the message contains a
5 AMIE TRANSACTION DESIGN
Page 33
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
system error or an application error without checking the first several characters of the error block itself. Use the
process described above for determining whether a system or application error has been received.
The error message must be interpreted and appropriate action taken to correct and/or resend the message.
5 AMIE TRANSACTION DESIGN
Page 34
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
6.
NIEM
The NIEM is the National Information Exchange Model. It is an XML data model used by Federal agencies and their
business partners to exchange information with one another. The VLS application supports the NIEM format in
addition to the AMIE/Call List formats. Information about NIEM can be found on the NIEM website at:
www.niem.gov.
The NIEM interface design leverages open standards and support WS-I specifications such as WS-Addressing and WSSecurity. Details about the WS-I specifications can be obtained through the Web Services Interoperability Organization
(WS-I) web site at: www.ws-i.org
6.1
NIEM compliant UNI Interface
Using the NIEM requires the state application to use specific UNI Web services. Detailed information about those
services, as well as the WSDL, can be found in the UNI Application Developers Reference Manuals.
The UNI interface consists of two operations with specific message contracts. Those operations are:

OperateOutbound

OperateInbound
6.1.1 OperateOutbound NIEM UNI Interface Operation
Detailed description of the interface operations can be found in the UNI documentation.
The outbound operation represents the traditional AAMVA Site Application to UNI communication. The
“OperateOutbound” Operation will be hosted as a UNI Windows Service and accessed by a Site Application reference
proxy client.
The data contract associated with the Outbound Operation is defined in the MessageOutbound data object defined in the
SOAP Header fragment below.
MessageOutbound
The Outbound Message data contract, “MessageOutbound”, defines the data object and all corresponding elements
required for the OperateOutbound Operation contract. The Outbound Operate function and the Outbound Message
6 NEIM
Page 35
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
object together represent the outbound communication mechanism.
<wsdl:operation name="OperateOutbound">
<soap12:operation soapAction=
"http://aamva.org/AAMVA/OperateOutbound"/>
<wsdl:input name="MessageOutbound">
<soap12:header . . . part="AddressData" use="literal"/>
<soap12:header . . . part="ParameterGeneral" use="literal"/>
<soap12:header . . . part="ParameterInbound" use="literal"/>
<soap12:header . . . part="ParameterOutbound" use="literal"/>
<soap12:header . . . part="ProgramExceptions" use="literal"/>
<soap12:body use="literal"/>
</wsdl:input>
6.1.2 OperateInbound NIEM UNI Interface Operation
Detailed description of the interface operations can be found in the UNI documentation.
The Inbound Operation represents the traditional AAMVA UNI to Site Application communication. The
“OperateInbound” Operation will be hosted by a service within the Site Application and accessed by an externally
located reference proxy client.
The data contract associated with the Inbound Operation is defined in the MessageInbound data object defined in the
SOAP Header fragment below.
MessageInbound
The Inbound Message data contract, “MessageInbound”, defines the data object and all corresponding elements
required for the OperateInbound Operation contract. The Inbound Operate function and the Inbound Message object
together represent the inbound communication mechanism.
<wsdl:operation name="OperateInbound">
<soap12:operation soapAction=
"http://aamva.org/AAMVA/OperateInbound"/>
<wsdl:input name="MessageInbound">
<soap12:header . . . part="ExpectedResponses" use="literal"/>
<soap12:header . . . part="ParameterGeneral" use="literal"/>
<soap12:body use="literal"/>
</wsdl:input>
6 NEIM
Page 36
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
6.2
Mapping between AMIE and NIEM messages
Each of the VLS messages have an AMIE and a NIEM equivalent. In a case of VLS, the mapping is very straight
forward. The table illustrates the relationships:
Call List/AMIE Message Type
IP - INITIAL INQUIRY
RP - INITIAL RESPONSE
IQ – SECONDARY INQUIRY
RQ - SECONDARY RESPONSE
IT – TERTIARY INQUIRY
RT – TERTIARY INQUIRY CONFIRMATION
IS – CASE RESULTS REQUEST
RS – CASE RESULTS RESPONSE
IR – ALL CASE RESULTS REQUEST
RR – ALL CASE RESULTS CONFIRMATION
RW – ALL CASE RESULTS RESPONSE
CR – CONFIRM OF RECEIPT OF ALL CASE RESULTS
IC – REQUEST CASE CLOSURE
RC – CASE CLOSURE RESPOSE
RQ - SECONDARY RESPONSE
UP – PASSWORD UPDATE
CP – PASSWORD UPDATE CONFIRMATION
NIEM Schema
28_IP
28_RP
28_IQ
28_RQ
28_IT
28_RT
28_IS
28_RS
28_IR
28_RR
28_RW
28_CR
28_IC
28_RC
28_RQ
28_UP
28_PC
The data elements of the NIEM messages are pulled, for the most part, from existing NIEM domains. Where required
data elements do not exist in the NIEM domains, the schemas are extended. The VLS application includes two
extended schemas:

USCISExtension

AAMVAExtension
The definitions of the XML elements and the structure of the XML messages are provided by the schemas.
6.3
Mapping between AMIE and NIEM data elements
Each VLS data elements describe within these specifications has an AMIE and a NIEM equivalent. The table below
provides a quick mapping between the two.
AMIE
Code
MAX
Element Name
Blk
Occ.
Len.
Pos.
XML tag
GAPPID
APPLICATION ID
B000
1
2
39
See UNI documentation
GAPPST
B000
1
1
61
See UNI documentation
GLSEGI
APPLICATION STATUS
LAST SEGMENT
INDICATOR
B000
1
1
45
See UNI documentation
GMSDAT
MESSAGE DATE
B000
1
6
23
See UNI documentation
GMSDST
MESSAGE DESTINATION
B000
1
7
9
See UNI documentation
GMSLEN
MESSAGE LENGTH
B000
1
4
5
See UNI documentation
GMSORG
MESSAGE ORIGIN
B000
1
7
16
See UNI documentation
GMSSEQ
MESSAGE SEQUENCE ID
B000
1
4
35
See UNI documentation
6 NEIM
Page 37
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
GMSTIM
MESSAGE TIME
B000
1
6
29
See UNI documentation
GMSTYP
MESSAGE TYPE
NUMBER OF TEXT
BLOCKS COUNT
B000
1
2
41
See UNI documentation
B000
1
2
46
See UNI documentation
NCB ERROR CODE
NETWORK SESSION
INDICATOR
B000
1
1
51
See UNI documentation
B000
1
1
48
See UNI documentation
B000
1
2
59
See UNI documentation
B000
1
2
43
See UNI documentation
B000
1
1
49
See UNI documentation
GTRORG
NETWORK STATUS
SEGMENT SEQUENCE
NUMBER
TEST/PRODUCTION
INDICATOR
TRANSACTION
ORIGINATOR
B000
1
7
52
See UNI documentation
GXMODC
TRANSMIT MODE CODE
B000
1
1
50
See UNI documentation
GMSBID
BATCH IDENTIFIER
B022
1
15
111
aa:BatchIdentifier
GMSCN4
MESSAGE MATCH COUNT
MESSAGE
LOCATOR/HEADER
MESSAGE MATCH
SEQUENCE ID
B022
1
4
103
aa:BatchSequenceID
B022
1
26
67
See UNI documentation
B022
1
4
107
B022
1
2
98
GTRRST
PROCESSING STATUS
TRANSACTION
RESUBMISSION TYPE
B022
1
1
100
aa:TransactionResubmissionIndicator
DDVDOB
DRIVER DATE OF BIRTH
B101
1
8
311
nc:PersonBirthDate
DDVNMF
DRIVER FIRST NAME
B10D
1
40
1222
nc:PersonGivenName
DDVNML
DRIVER LAST NAME
B10D
1
40
1182
nc:PersonSurName
DDVNMM
B10D
1
35
1262
nc:PersonMiddleName
BFDARN
DRIVER MIDDLE NAME
USCIS ALIEN
REGISTRATION NUMBER
B204
1
9
1487
im:AlienNumber
BFDI94
USCIS I-94 NUMBER
B204
1
11
1496
im:AdmissionIdentification
BFDPPN
PASSPORT NUMBER
B204
1
12
1525
nc:PassportNumberIdentification
BFDUSN
USCIS SEVIS NUMBER
B204
1
10
1515
uscis:SEVISID
BFDUVN
USCIS VISA NUMBER
B204
1
8
1507
scr:VisaNumberID
BFDBFC
B205
1
3
1606
uscis:BenefitsCode
B205
1
13
1548
nc:DocumentIdentification
B205
1
8
1598
nc:Document/nc:DocumentExpirationDate
B205
1
35
1563
nc:DocumentCategoryName
BFDUDT
USCIS BENEFIT CODE
DOCUMENT CERTIFICATE
NUMBER
FEDERAL DOCUMENT
EXPIRATION DATE
FEDERAL DOCUMENT
DESCRIPTION
USCIS DOCUMENT TYPE
ID
B205
1
2
1561
nc:DocumentCategoryID
BFDCAN
USCIS CASE NUMBER
B206
1
15
1609
nc:CaseTrackingID
BFDUSF
USCIS USER FIELD
USCIS CLASS OF
ADMISSION
USCIS ELIGIBILITY
STATEMENT CODE
USCIS ELIGIBILITY
STATEMENT TEXT
USCIS LAWFUL
PRESENCE END DATE
USCIS LAWFUL
PRESENCE END TYPE
USCIS VERIFICATION
RESPONSE CODE
USCIS VERIFICATION
RESPONSE CODE
B206
1
40
1624
uscis:UserText
B207
1
3
1670
scr:ClassOfAdmissionCategoryCodeType
B207
1
3
1688
uscis:EligibilityStatementCode
B207
1
64
1691
uscis:EligibilityStatementText
B207
1
8
1674
im:AuthorizationEndDate
B207
1
1
1673
uscis:USCISLawfulPresenceEndCode
B207
1
3
1682
uscis:G845Code
B207
2
3
1685
uscis:G845Code
GNBTXT
GNCBER
GNETSI
GNETST
GSGSEQ
GTPIND
GMSLOC
GMSMS4
GPROST
BFDCTN
BFDEXP
BFDUDD
BFDCOA
BFDESC
BFDEST
BFDLED
BFDPET
BFDVER
BFDVER
6 NEIM
Page 38
aa:BatchQuantity
aa:ProcessingCode
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
BFDVET
USCIS VERIFICATION
RESPONSE TEXT
USCIS VERIFICATION
RESPONSE TEXT
BFDUPW
AGENCY PASSWORD
B209
1
14
2044
See UNI documentation
BFDUSR
AGENCY USER ID
B209
1
8
2036
See UNI documentation
BFDWSV
WEB SERVICE VERSION
B209
1
30
2058
uscis:WebServiceVersionNumber
BFDAED
B20A
1
8
2107
uscis:AlienUSEntryDate
B20A
1
8
2123
uscis:AlienAdmittedToDate
B20A
1
1
2124
B20A
1
8
2115
uscis:AlienAdmittedToCode
uscis:AlienEmploymentAuthorizationEndDat
e
B20A
1
5
2097
im:AlienBirthCountryName
BFDUCC
ALIEN ENTRY DATE
USCIS ALIEN ADMITTED
TO DATE
USCIS ALIEN ADMITTED
TO TEXT
USCIS EMPLOYMENT
AUTH END DATE
USCIS BIRTH COUNTRY
CODE
USCIS CITIZENSHIP
COUNTRY CODE
B20A
1
5
2102
im:AlienCitizenshipCountryName
BFDIVC
USCIS IAV CODE
B20A
1
5
2132
uscis:USCISIAVCode
BFDIVT
USCIS IAV TEXT
B20A
1
20
2137
uscis:USCISIAVText
BFDUPN
AGENCY NEW PASSWORD
B20B
1
14
2402
uscis:USCISNewPasswordText
DLACOM
B541
1
160
2242
im:AuthorizationRemarkText
B983
1
61
877
aa:ReturnAsReceived
B983
2
61
938
aa:ReturnAsReceived
B983
3
61
999
aa:ReturnAsReceived
B983
4
61
1060
aa:ReturnAsReceived
GRREC2
APPLICATION COMMENT
RETURN AS RECEIVED
TEXT/BLOCK
RETURN AS RECEIVED
TEXT/BLOCK
RETURN AS RECEIVED
TEXT/BLOCK
RETURN AS RECEIVED
TEXT/BLOCK
RETURN AS RECEIVED
TEXT/BLOCK
B983
5
61
1121
aa:ReturnAsReceived
GERCOD
ERROR CODE
B991
1
2
576
max:ExceptionID
GERCOD
ERROR CODE
B991
2
2
637
max:ExceptionID
GERCOD
ERROR CODE
B991
3
2
698
max:ExceptionID
GERCOD
ERROR CODE
B991
4
2
759
max:ExceptionID
GERCOD
ERROR CODE
B991
5
2
820
max:ExceptionID
GERMSG
ERROR MESSAGE
B991
1
54
578
max:ExceptionText
GERMSG
ERROR MESSAGE
B991
2
54
639
max:ExceptionText
GERMSG
ERROR MESSAGE
B991
3
54
700
max:ExceptionText
GERMSG
ERROR MESSAGE
B991
4
54
761
max:ExceptionText
GERMSG
ERROR MESSAGE
B991
5
54
822
max:ExceptionText
BFDVET
BFDATD
BFDATT
BFDEED
BFDUBC
GRREC2
GRREC2
GRREC2
GRREC2
6.4
B208
1
100
1792
uscis:G845Text
B208
2
100
1892
uscis:G845Text
NIEM Schemas
The VLS NIEM compliant schemas can be found in the [VLS XML.ZIP] archive. Those schemas are organized
according to the guidelines of the NIEM Information Exchange Package Documentation. The ZIP archive contains a
[Readme.txt] file with further information.
6 NEIM
Page 39
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
7.
NETWORK INTERFACE – UNIFIED NETWORK INTERFACE (UNI)
Although using AAMVAnet's network interface tool is not a requirement, most developers will choose to implement the
system using the Unified Network Interface (UNI). UNI has several valuable functions available to assist the
developers (such as message control, routing validation, logging, audit trails, and message grouping). A jurisdiction's
network interface team needs to understand UNI's functions to avoid duplicating those functions within the application.
The purpose of this section is to supplement the UNI documentation by calling attention to several UNI features that
users have found particularly useful. Although they are documented in the UNI Application Developer's Reference, we
have included a brief synopsis here along with suggested settings, where applicable.
AAMVA's web site (www.aamva.org) has an up-to-date listing of the platforms on which UNI runs.
UNI acts as an interpreter between the network message format, AAMVAnet Message Interchange Envelope (AMIE),
and the system participant's application program. It handles the conversion of information between the system
participant's internal data format and the AMIE format.
UNI is a uniform application interface which provides the translation between the AMIE message structure (required for
transaction and message formatting) and some form of data element mapping (e.g., a call list) used by the user's
application programs. It also provides for a variety of other application interface support features such as message
grouping, routing validation, and queuing. Specifically, UNI has both a pseudo-batch interface and store-and-forward
capabilities.
Figure 12 - UNI
Receiving Site
Sending Site
Sending
application
program
7.1
AAMVAnet
parameter
& call list
UNI
AMIE message
UNI
control &
call list
Receiving
application
program
Call List
The call list is the COBOL layout of data passed between UNI and the application programs. It is used for data coming
to and from UNI. Depending on the UNI options selected, the call list data may be passed in files or queues.
The UNI group at AAMVA is responsible for distributing UNI and the COBOL Copy books containing the call list(s).
Developers who are not using COBOL may request the Offset reports from the UNI group. The offset reports provide
the addresses of the elements within the call list. When contacting the UNI Help Desk for copies of Call list(s) or Offset
Report(s), please specify the application(s) and the release of the application.
This application uses the Driver Call List (CLMF12).
7.2
Call List Format
Note for UNI uses not on a Windows platform. There is a record type indicator in the Driver Call List (CLMF-DESCRECORD-TYPE) that is populated by UNI when a message is received. This indicator is used to identify how much of
the variable length Call List is being used. When the indicator contains a:



"L" the type of record is a long record.
"S" the type of record is a short record.
"R" the type of record is a return as received
Under normal operation, the indicator need not be checked. In an exceptional case where data is expected in the long
part of the call list, but no data is received for the long part, application programs could encounter problems.
Addressing an element in the long part of the call list when only a short call list exists may cause the application
Page 40
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
program crash.
7.3
UNI Sub-system Code
UNI has a table in which each site has its type classified for an application (i.e., this site is a Jurisdiction). This
classification is recorded in the UNI sub-system code. The table is used when messages are sent and received to ensure
the Message Type can be sent or received from that class of site. When configuring UNI for a given environment and
application, the sub-systems codes must be setup correctly for each site with which messages will be exchanged.
The VLS sub-system codes are:



0 = PASS THRU
1 = STATE
2 = USCIS
This information is also located in the ‘Read Me’ text provided with each UNI release.
7.4
Message Splitting
UNI provides an option to send the data in the call list to multiple destinations (i.e. a single inquiry could be passed to
UNI and UNI could forward it to SSA and USCIS). When the responses are received, UNI will group them all under the
same Message Control entry. The UNI Call List has been defined to support this option.
When one of the sites returns an error, the message control will be set as having an error. So all of the responses
returned will be marked as having an error. This feature is needed for some transactions. If this feature will not provide
the desired effect, the messages should be sent individually.
Page 41
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
A. APPENDIX OF DATA ELEMENTS BY MESSAGE TYPE
This section describes the data elements (by AMIE block) that are included in each message type.
Every message has a Network Control Block (NCB), so the NCB elements used in each message are the same. Rather
than repeating these elements in each message description, a note line is shown as a reminder that these NCB elements
will be included in the message. The elements in the NCB are:
Call List Data Element Name
Element
Code
Source
CLMF-NUMB-NCB-MSG-LEN
GMSLEN
CLMF-CODE-MSG-DEST
GMSDST
CLMF-CODE-ORIGIN
GMSORG
CLMF-DATE-NCB-MSG
GMSDAT
CLMF-TIME-NCB-MSG
GMSTIM
CLMF-DESC-NCB-MSG-SEQ-ID
GMSSEQ
CLMF-CODE-NET-APPL-ID
GAPPID
CLMF-CODE-MSG-TYPE
GMSTYP
CLMF-NUMB-NCB-SEG
GSGSEQ
CLMF-INDC-NCB-LAST-SEG
GLSEGI
CLMF-CNT-NCB-NUM-TXT-BLKS
GNBTXT
CLMF-INDC-NET-SESSION
GNETSI
CLMF-INDC-TST-PROD
GTPIND
CLMF-CODE-NCB-XMIT-MODE
GXMODC
CLMF-CODE-NCB-ERROR
GNCBER
CLMF-CODE-NCB-TRANS-ORIGINATOR
GTRORG
The field is required for network processing.
UNI will calculate the field. UNI calculates the field based on
the supplied message.
The field is required for network processing.
UNI will use a like-named field on the parameter list.
The field is required for network processing.
UNI will calculate the field from the configuration tables when
a bridge is not used. When a bridge is used the value must be
supplied in the call list.
The field is required for network processing.
UNI will calculate the field. UNI obtains it from the system.
The field is required for network processing.
UNI will calculate the field. UNI obtains it from the system.
The field is required for network processing.
UNI will calculate the field. UNI calculates the field based on
the messages supplied and the system.
The field is required for network processing.
UNI will use a like-named field on the parameter list.
The field is required for network processing.
UNI will use a like-named field on the parameter list.
The field is required for network processing.
UNI will calculate the field when the field is left blank in the
call list. UNI calculates the field based on the supplied
message, the host system, or a configuration table.
The field is required for network processing.
UNI will calculate the field when the field is left blank in the
call list. UNI calculates the field based on the supplied
message, the host system, or a configuration table.
The field is required for network processing.
UNI will calculate the field. UNI calculates the field based on
the supplied message.
The field is required for network processing.
UNI will calculate the field. UNI derives it from the network
source code in the parameter list.
The field is required for network processing.
UNI will calculate the field when the field is left blank in the
call list. UNI calculates the field based on the supplied
message, the host system, or a configuration table.
The field is required for network processing. UNI will use a
like-named field on the parameter list. It is set based on the
parameter lists network service code.
The field is required for network processing.
UNI will calculate the field when the field is left blank in the
call list. UNI calculates the field based on the supplied
message. Initially it defaults to 'N'.
Transaction originator is required on unsolicited messages.
A APPENDIX OF DATA ELEMENTS BY MESSAGE TYPE
Page 42
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
CLMF-CODE-NET-STATUS
GNETST
CLMF-CODE-APPL-STATUS
GAPPST
If the 4-byte suffix is not used in the Gap Code, the application
can fill the field or the 7 bytes may be left blank then UNI will
fill the field with the 7-byte value from the site default field in
the UNI's configuration tables. When a bridge is not used in
UNI, the recommendation is to leave the field blank and allow
UNI to fill it.
If the site uses the 4-byte suffix field, the application must fill
all seven bytes of the Transaction Originator field (using the 4byte suffix is not recommended in UNI).
The field is required for network processing.
UNI will calculate the field when the field is left blank in the
call list. UNI calculates the field based on the supplied
message, the host system, or a configuration table. Initially it
defaults to '00' when a message is sent.
This field defaults to a space in the initial message in a
transaction. It is required for the subsequent messages in the
transaction and has to be set by the application.
The Data Elements by AMIE Message Type matrices shows the data elements (by AMIE block) that are included in
each message type. If an element is not sent in an AMIE message, it is not shown in the report. The details in the report
include:





COBOL Call List Element Name references the code that will be used in the applications to reference the
fields.
Block Type and Sub-Type references the AMIE block in which the data is transmitted. (An asterisk before the
block code is included to aid in the building of the call list. It indicates the call list name is used in other
blocks).
Source code shows how a field is set when a message is initiated. The values listed for the application
elements are:
O Conditional in the application, see the filling rules in the Process Description sections for
specific details.
P Pass-through fields are required. The application must pass-through the entire length of this
field from the unsolicited inbound message to the same field in the outbound message(s).
R Application required. This field is required for this message type.
Element Code provides a key to the data dictionary appendix.
Number of Occurrences indicates whether an element occurs multiple times within the message. The value
describes the maximum number of occurrences possible. If an element occurs 2 times in a block and the block
is used 3 times in the message, this column would have a value of 6.
When a field occurs multiple times in a message, the filling rules described by the source code can be ambiguous. In
some instances, the number of occurrences of a data element may be from zero to the specified maximum. In other
instances, the number must be from one to the specified maximum. Some fields occur independently of other fields,
while others occur as part of a repeated group of elements. Therefore, when a field occurs multiple times, see the filling
rules in the Process Description sections for specific details.
When a message is used in multiple processes, an element may be required in one process, but not required in another.
Since each message type is only listed once in this appendix (regardless of the number of processes in which it is used),
data elements that are required in one process but not in another are assigned a source code of 'conditional'. Because of
the ambiguity, see the Process Description sections for instruction on how to fill these elements.
A APPENDIX OF DATA ELEMENTS BY MESSAGE TYPE
Page 43
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
IP - INITIAL INQUIRY
(2851)
Call List Data Element Name
CLMF-NUMB-NCB-MSG-LEN
CLMF-CODE-MSG-DEST
CLMF-CODE-ORIGIN
CLMF-DATE-NCB-MSG
CLMF-TIME-NCB-MSG
CLMF-DESC-NCB-MSG-SEQ-ID
CLMF-CODE-NET-APPL-ID
CLMF-CODE-MSG-TYPE
CLMF-NUMB-NCB-SEG
CLMF-INDC-NCB-LAST-SEG
CLMF-CNT-NCB-NUM-TXT-BLKS
CLMF-INDC-NET-SESSION
CLMF-INDC-TST-PROD
CLMF-CODE-NCB-XMIT-MODE
CLMF-CODE-NCB-ERROR
CLMF-CODE-NCB-TRANS-ORIGINATOR
CLMF-CODE-NET-STATUS
CLMF-CODE-APPL-STATUS
CLMF-DESC-MEC-MSG-LOCATOR
CLMF-CODE-MEC-PROCESS-STATUS
CLMF-TXN-RESUB-TYPE
CLMF-USCIS-CASE-NUM
CLMF-BENEFIT-CODE
CLMF-USCIS-DOC-TYPE
CLMF-GRP-USER-ID
CLMF-GRP-PSWD
CLMF-DRIVER-FIRST-NAME
CLMF-DRIVER-MIDDLE-NAME
CLMF-DRIVER-LAST-NAME
CLMF-DOB-CURRENT
CLMF-ALIEN-REG-NUM
CLMF-I94-NUMBER
CLMF-VISA-NUM
CLMF-SEVIS-NUM
CLMF-PASSPORT-NUM
CLMF-DOC-CERT-NUM
CLMF-FEDERAL-DOC-EXPIRE
CLMF-DOC-DESC
CLMF-USCIS-USER-FIELD
CLMF-DESC-RET-AS-RCVD-3
CLMF-DESC-ERROR-MSG-CODE
CLMF-DESC-ERROR-MSG-TEXT
Block
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
* 02/2
* 02/2
02/2
20/6
20/5
20/5
20/9
20/9
10/D
10/D
10/D
* 10/1
20/4
20/4
20/4
20/4
20/4
20/5
20/5
20/5
20/6
98/3
* 99/1
* 99/1
Source
O
R
O
O
R
R
R
R
O
O
O
O
O
O
O
O
O
O
O
O
O
O
O
O
Element
Code
GMSLEN
GMSDST
GMSORG
GMSDAT
GMSTIM
GMSSEQ
GAPPID
GMSTYP
GSGSEQ
GLSEGI
GNBTXT
GNETSI
GTPIND
GXMODC
GNCBER
GTRORG
GNETST
GAPPST
GMSLOC
GPROST
GTRRST
BFDCAN
BFDBFC
BFDUDT
BFDUSR
BFDUPW
DDVNMF
DDVNMM
DDVNML
DDVDOB
BFDARN
BFDI94
BFDUVN
BFDUSN
BFDPPN
BFDCTN
BFDEXP
BFDUDD
BFDUSF
GRREC2
GERCOD
GERMSG
Nbr Of
Occurs
Element
Nbr Of
5
5
5
RP - INITIAL RESPONSE
(2852)
A APPENDIX OF DATA ELEMENTS BY MESSAGE TYPE
Page 44
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
Call List Data Element Name
CLMF-NUMB-NCB-MSG-LEN
CLMF-CODE-MSG-DEST
CLMF-CODE-ORIGIN
CLMF-DATE-NCB-MSG
CLMF-TIME-NCB-MSG
CLMF-DESC-NCB-MSG-SEQ-ID
CLMF-CODE-NET-APPL-ID
CLMF-CODE-MSG-TYPE
CLMF-NUMB-NCB-SEG
CLMF-INDC-NCB-LAST-SEG
CLMF-CNT-NCB-NUM-TXT-BLKS
CLMF-INDC-NET-SESSION
CLMF-INDC-TST-PROD
CLMF-CODE-NCB-XMIT-MODE
CLMF-CODE-NCB-ERROR
CLMF-CODE-NCB-TRANS-ORIGINATOR
CLMF-CODE-NET-STATUS
CLMF-CODE-APPL-STATUS
CLMF-DESC-MEC-MSG-LOCATOR
CLMF-CODE-MEC-PROCESS-STATUS
CLMF-DOB-CURRENT
CLMF-DRIVER-FIRST-NAME
CLMF-DRIVER-MIDDLE-NAME
CLMF-DRIVER-LAST-NAME
CLMF-USCIS-CASE-NUM
CLMF-ELIG-STATMT-CODE
CLMF-ELIG-STATMT-TEXT
CLMF-USCIS-ADMISSION-CLASS
CLMF-WEB-SERV-VERSION
CLMF-USCIS-BIRTH-CODE
CLMF-USCIS-CITIZEN-CODE
CLMF-FEDERAL-DOC-ENTRY
CLMF-FEDERAL-DOC-WORK-END
CLMF-FEDERAL-DOC-ADMITTED-TO
CLMF-USCIS-ADMITTED-TYPE
CLMF-USCIS-IAV-CODE
CLMF-USCIS-IAV-TEXT
CLMF-DESC-RET-AS-RCVD-3
CLMF-DESC-ERROR-MSG-CODE
CLMF-DESC-ERROR-MSG-TEXT
Block
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
* 02/2
* 02/2
* 10/1
10/D
10/D
10/D
20/6
20/7
20/7
20/7
20/9
20/A
20/A
20/A
20/A
20/A
20/A
20/A
20/A
98/3
* 99/1
* 99/1
Source
Block
NCB
NCB
NCB
NCB
NCB
NCB
Source
P
P
R
O
O
O
O
R
O
O
O
O
O
O
O
O
O
O
O
O
O
O
O
Code
GMSLEN
GMSDST
GMSORG
GMSDAT
GMSTIM
GMSSEQ
GAPPID
GMSTYP
GSGSEQ
GLSEGI
GNBTXT
GNETSI
GTPIND
GXMODC
GNCBER
GTRORG
GNETST
GAPPST
GMSLOC
GPROST
DDVDOB
DDVNMF
DDVNMM
DDVNML
BFDCAN
BFDESC
BFDEST
BFDCOA
BFDWSV
BFDUBC
BFDUCC
BFDAED
BFDEED
BFDATD
BFDATT
BFDIVC
BFDIVT
GRREC2
GERCOD
GERMSG
Occurs
Element
Code
GMSLEN
GMSDST
GMSORG
GMSDAT
GMSTIM
GMSSEQ
Nbr Of
Occurs
5
5
5
UP - PASSWORD UPDATE
(2871)
Call List Data Element Name
CLMF-NUMB-NCB-MSG-LEN
CLMF-CODE-MSG-DEST
CLMF-CODE-ORIGIN
CLMF-DATE-NCB-MSG
CLMF-TIME-NCB-MSG
CLMF-DESC-NCB-MSG-SEQ-ID
A APPENDIX OF DATA ELEMENTS BY MESSAGE TYPE
Page 45
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
CLMF-CODE-NET-APPL-ID
CLMF-CODE-MSG-TYPE
CLMF-NUMB-NCB-SEG
CLMF-INDC-NCB-LAST-SEG
CLMF-CNT-NCB-NUM-TXT-BLKS
CLMF-INDC-NET-SESSION
CLMF-INDC-TST-PROD
CLMF-CODE-NCB-XMIT-MODE
CLMF-CODE-NCB-ERROR
CLMF-CODE-NCB-TRANS-ORIGINATOR
CLMF-CODE-NET-STATUS
CLMF-CODE-APPL-STATUS
CLMF-DESC-MEC-MSG-LOCATOR
CLMF-CODE-MEC-PROCESS-STATUS
CLMF-GRP-USER-ID
CLMF-GRP-PSWD
CLMF-GRP-PSWD-NEW
CLMF-DESC-RET-AS-RCVD-3
CLMF-DESC-ERROR-MSG-CODE
CLMF-DESC-ERROR-MSG-TEXT
*
*
*
*
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
02/2
02/2
20/9
20/9
20/B
98/3
99/1
99/1
O
R
R
R
R
O
O
O
GAPPID
GMSTYP
GSGSEQ
GLSEGI
GNBTXT
GNETSI
GTPIND
GXMODC
GNCBER
GTRORG
GNETST
GAPPST
GMSLOC
GPROST
BFDUSR
BFDUPW
BFDUPN
GRREC2
GERCOD
GERMSG
5
5
5
Source
Element
Code
Nbr Of
Occurs
GMSLEN
GMSDST
GMSORG
GMSDAT
GMSTIM
GMSSEQ
GAPPID
GMSTYP
GSGSEQ
GLSEGI
GNBTXT
GNETSI
GTPIND
GXMODC
GNCBER
GTRORG
GNETST
GAPPST
GMSLOC
GPROST
GRREC2
GERCOD
GERMSG
5
5
5
CP - PASSWORD UPDATE CONFIRMATION
(2872)
Call List Data Element Name
CLMF-NUMB-NCB-MSG-LEN
CLMF-CODE-MSG-DEST
CLMF-CODE-ORIGIN
CLMF-DATE-NCB-MSG
CLMF-TIME-NCB-MSG
CLMF-DESC-NCB-MSG-SEQ-ID
CLMF-CODE-NET-APPL-ID
CLMF-CODE-MSG-TYPE
CLMF-NUMB-NCB-SEG
CLMF-INDC-NCB-LAST-SEG
CLMF-CNT-NCB-NUM-TXT-BLKS
CLMF-INDC-NET-SESSION
CLMF-INDC-TST-PROD
CLMF-CODE-NCB-XMIT-MODE
CLMF-CODE-NCB-ERROR
CLMF-CODE-NCB-TRANS-ORIGINATOR
CLMF-CODE-NET-STATUS
CLMF-CODE-APPL-STATUS
CLMF-DESC-MEC-MSG-LOCATOR
CLMF-CODE-MEC-PROCESS-STATUS
CLMF-DESC-RET-AS-RCVD-3
CLMF-DESC-ERROR-MSG-CODE
CLMF-DESC-ERROR-MSG-TEXT
Block
*
*
*
*
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
NCB
02/2
02/2
98/3
99/1
99/1
A APPENDIX OF DATA ELEMENTS BY MESSAGE TYPE
P
P
R
O
O
O
Page 46
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
B. APPENDIX OF BLOCKS BY MESSAGE TYPE
The following information describes which blocks are used in which AMIE message. The description contains:




Block Number.
Block Name.
Required / Conditional indicator. The column shows if an occurrence of the block will be present in a
message. Empty blocks (containing no data) are not transmitted, hence may not be present. See the
specifications for the given transaction to see under which circumstances an “conditional” block is “required”.
Occurrence. When a message can contain a block multiple times, this column indicates the maximum number
of times the block may appear. The occurrence is a count of the physical blocks used (a logical block that is
122 bytes long and is used 3 times would have an occurrence count of 6).
A summary of the size of each AMIE message, is included after the list of blocks.
IP - INITIAL INQUIRY
(2801)
Block Type/Sub-Type - Name
Comment
00/0
02/2
10/1
10/D
20/4
20/5
20/6
20/9
98/3
99/1
Required
Required
Required
Required
Conditional
Required
Conditional
Required
Conditional
Conditional
NETWORK CONTROL BLOCK
CDLIS/DLR/PDPS MSG EXCHANGE CONTROL
DRIVER NAME/DESCRIPTIVE DATA - SOI
DRIVER NAME
CITIZENSHIP AND IMMIGRATION BLOCK 1
CITIZENSHIP AND IMMIGRATION BLOCK 2
CITIZENSHIP AND IMMIGRATION BLOCK 3
CITIZENSHIP AND IMMIGRATION BLOCK 6
RETURN AS RECEIVED BLOCK
EDIT/ERROR DESCRIPTIVE BLOCK - (all)
Variable Length:
396 to
1254, in
Occurs
2
5
5
19 Blocks of 66 characters.
RP - INITIAL RESPONSE
(2802)
Block Type/Sub-Type - Name
Comment
00/0
02/2
10/1
10/D
20/6
20/7
20/9
20/A
98/3
99/1
Required
Required
Conditional
Conditional
Required
Conditional
Conditional
Conditional
Conditional
Conditional
NETWORK CONTROL BLOCK
CDLIS/DLR/PDPS MSG EXCHANGE CONTROL
DRIVER NAME/DESCRIPTIVE DATA - SOI
DRIVER NAME
CITIZENSHIP AND IMMIGRATION BLOCK 3
CITIZENSHIP AND IMMIGRATION BLOCK 4
CITIZENSHIP AND IMMIGRATION BLOCK 6
CITIZENSHIP AND IMMIGRATION BLOCK 7
RETURN AS RECEIVED BLOCK
EDIT/ERROR DESCRIPTIVE BLOCK - (all)
Variable Length:
264 to
1320, in
Occurs
2
2
5
5
20 Blocks of 66 characters.
UP - PASSWORD UPDATE
B APPENDIX OF BLOCKS BY MESSAGE TYPE
Page 47
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
(2821)
Block Type/Sub-Type - Name
Comment
00/0
02/2
20/9
20/B
98/3
99/1
Required
Required
Required
Required
Conditional
Conditional
NETWORK CONTROL BLOCK
CDLIS/DLR/PDPS MSG EXCHANGE CONTROL
CITIZENSHIP AND IMMIGRATION BLOCK 6
CITIZENSHIP AND IMMIGRATION BLOCK 8
RETURN AS RECEIVED BLOCK
EDIT/ERROR DESCRIPTIVE BLOCK - (all)
Variable Length:
264 to
924, in
Occurs
5
5
14 Blocks of 66 characters.
CP - PASSWORD UPDATE CONFIRMATION
(2822)
Block Type/Sub-Type - Name
Comment
00/0
02/2
98/3
99/1
Required
Required
Conditional
Conditional
NETWORK CONTROL BLOCK
CDLIS/DLR/PDPS MSG EXCHANGE CONTROL
RETURN AS RECEIVED BLOCK
EDIT/ERROR DESCRIPTIVE BLOCK - (all)
Variable Length:
132 to
792, in
B APPENDIX OF BLOCKS BY MESSAGE TYPE
Occurs
5
5
12 Blocks of 66 characters.
Page 48
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
C. APPENDIX OF DATA ELEMENTS BY BLOCK
Each AMIE block used in the system is described in detail below. A block description includes the block name, block
code and a list of all the application data elements. These physical block layouts sometimes include data elements that
are not used by this application. All data elements within a block are shown because this appendix describes the offset
of a data element within a block. A physical block is transmitted as 66 bytes. In all blocks (except for the NCB), the
first 5 bytes are reserved for addressing the block. This appendix shows the business data elements in bytes 6 through
66 (except for the NCB where all data elements are shown).
The description of a data element consists of:






DATA ELEMENT CODE—Six-character code of the data element, used as a reference the data element in the
data dictionary
DATA ELEMENT NAME—Short descriptive term for the data element
DATA ELEMENT TYP—alphanumeric type of the data element: AN=alpha-numeric, N=numeric
DATA ELEMENT LENG—length of data element in bytes
DATA ELEMENT OCC—the code for the maximum number of times the data element occurs in the block.
The first (or only) occurrence of a data element has an OCC value of <blank>, the second occurrence has an
OCC value of 1, the third occurrence has an OCC value of 2, etc.)
DATA ELEMENT POS—the starting address of the data element within the logical block)
A data element may be a group or an elementary element. A group element will be made up of a group of elementary
elements. An elementary element may or may not be part of a group element. The code of elementary elements that
make up a group are offset to the right by 2 characters.
It is possible for a data element to occupy the same position in a block as another element, that is they redefine the area
used. In this appendix the second (and subsequent) element(s) is indicated with an '*R'.
NETWORK CONTROL BLOCK (00/0)
DATA ELEMENT
GTXNPR GMSLEN GMSDST GMSGPI
R*
GMSORG
GMSDAT
GMSTIM
GMSSEQ
GAPPID
GMSTYP
GSGSEQ
GLSEGI
GNBTXT
GNBT9T
GNETSI
GTPIND
GXMODC
GNCBER
GTRORG
GNETST
GAPPST
GMSRTA
-
TRANSACTION CODE
MESSAGE LENGTH
MESSAGE DESTINATION
- GAP CODE USER NETWORK ID
- RESERVED
MESSAGE ORIGIN
MESSAGE DATE
MESSAGE TIME
MESSAGE SEQUENCE ID
APPLICATION ID
MESSAGE TYPE
SEGMENT SEQUENCE NUMBER
LAST SEGMENT INDICATOR
NUMBER OF TEXT BLOCKS COUNT
NUMBER OF TEXT BLOCKS COUNT
NETWORK SESSION INDICATOR
TEST/PRODUCTION INDICATOR
TRANSMIT MODE CODE
NCB ERROR CODE
TRANSACTION ORIGINATOR
NETWORK STATUS
APPLICATION STATUS
NUMBER OF ROUTING ATTEMPTS
C APPENDIX OF DATA ELEMENTS BY BLOCK
TYP LENG OCC
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
N
AN
AN
AN
AN
AN
AN
AN
AN
4
4
7
3
4
7
6
6
4
2
2
2
1
2
2
1
1
1
1
7
2
1
1
POS
1
5
9
9
12
16
23
29
35
39
41
43
45
46
46
48
49
50
51
52
59
61
62
Page 49
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
- RESERVED
C APPENDIX OF DATA ELEMENTS BY BLOCK
AN
4
63
Page 50
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
CDLIS / DLR / PDPS MSG EXCHANGE CONTROL (02/2)
DATA ELEMENT
R*
R*
R*
R*
R*
GMSLOC GMSCNT GMSIND GMSMSI DTNSSC GPROST GMSLMI GTRRST GMSSOR GMSDRV GMSLEI
GMSPSW
GMSSCH
GMSDUP
GMSCDL
GMSHBC
GMSCSS
GMSHBO
GMSCNM
GMSDEL
GMSNMI
GMSNMN
GMSVRC
IMGGRP GDIRQT
GMSMSZ
GDIDST
R*
R*
GDIERS
GDIRQN
GDINST
GDIPST
BATGRP GMSCN4
GMSMS4
GMSBID
GMSSRL DEDELG -
MESSAGE LOCATOR/HEADER
MESSAGE MATCH COUNT
MESSAGE MATCH INDICATOR
MESSAGE MATCH SEQUENCE ID
SELECTIVE SERVICE INTERNAL CODE
PROCESSING STATUS
LAST MATCH INDICATOR
TRANSACTION RESUBMISSION TYPE
JURISDICTION CODE - STATE OF RECORD
MESSAGE DRIVER DATA
- MESSAGE MATCH LIMIT EXCEEDED IND
- MESSAGE SENDER PASSWORD
- MESSAGE SOR CHANGE IN PROGRESS IND
- MESSAGE DRIVER DUPLICATE INDICATOR
- RESERVED
- MESSAGE AKA DLN COUNT
- HME CHECK CURRENT SOR UP
- MESSAGE AKA SSN COUNT
- HME CHECK OLD SOR DOWN
- MESSAGE AKA NAME COUNT
- RESERVED
- MESSAGE DELAYED SEARCH IND
- MESSAGE NUMBER OF SEARCH NAMES
- MESSAGE NUMBER OF UPDATE NAMES
- SSA VERIFICATION RESPONSE CODE
Image Group
- RESERVED
- IMAGE REQUEST TYPE
- MESSAGE MAXIMUM SIZE
- IMAGE DESTINATION
- RESERVED
- EXPECTED IMAGE RESPONSE INDICATOR
- NUMBER OF IMAGES REQUESTED
- NUMBER OF IMAGES SENT
- IMAGE PROCESSING STATUS
Batch Group
- MESSAGE MATCH COUNT
- MESSAGE MATCH SEQUENCE ID
- BATCH IDENTIFIER
SYSTEM RELEASE CODE
ELIGIBILITY INDICATOR
C APPENDIX OF DATA ELEMENTS BY BLOCK
TYP LENG OCC
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
26
2
1
2
2
2
1
1
2
23
1
7
1
1
5
1
1
1
1
1
1
1
1
1
1
23
6
1
1
7
3
1
2
2
2
23
4
4
15
1
1
POS
1
27
29
30
30
32
34
34
35
37
37
38
45
46
47
52
52
53
53
54
55
56
57
58
59
37
37
43
44
45
52
55
56
56
58
37
37
41
45
60
61
Page 51
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
DRIVER NAME / DESCRIPTIVE DATA – SOI (10/1)
DATA ELEMENT
R*
R*
R*
R*
R*
R*
R*
R*
R*
R*
R*
R*
R*
R*
R*
R*
R*
R*
R*
R*
R*
R*
R*
DDVNAM
DDVKNM
DDVKN2
DDVKN3
DDVNM2
DDVNM4
DDVKN4
DDVKN5
DDVKN6
DDVDOB
DDVKDB
DDVKD2
DDVKD3
DDVDO3
DDVKD4
DDVKD5
DDVKD6
DDVDSC
-
DRIVER NAME
DRIVER AKA NAME
DRIVER AKA 2ND NAME
DRIVER AKA 3RD NAME
DRIVER CURRENT NAME
SSA DRIVER NAME
DRIVER AKA NAME - PDPS
DRIVER AKA 2ND NAME - PDPS
DRIVER AKA 3RD NAME - PDPS
DRIVER DATE OF BIRTH
DRIVER AKA DATE OF BIRTH
DRIVER AKA 2ND DATE OF BIRTH
DRIVER AKA 3RD DATE OF BIRTH
DRIVER CURRENT DATE OF BIRTH
DRIVER AKA DATE OF BIRTH - PDPS
DRIVER AKA 2ND DATE OF BIRTH - PDPS
DRIVER AKA 3RD DATE OF BIRTH - PDPS
DRIVER DESCRIPTIVE INFORMATION
- RESERVED
DDVSEX - DRIVER SEX
DDVSX1 - DRIVER SEX - PDPS
DDVSX3 - DRIVER CURRENT SEX
DDVHGT - DRIVER HEIGHT
DDVHG1 - DRIVER HEIGHT - FEET
DDVHG2 - DRIVER HEIGHT - PLUS INCHES
DDVHT1 - DRIVER HEIGHT - PDPS
DDVHT3 - DRIVER CURRENT HEIGHT
DDVWGT - DRIVER WEIGHT
DDVWT1 - DRIVER WEIGHT - PDPS
DDVWT3 - DRIVER CURRENT WEIGHT
DDVEYE - DRIVER EYE COLOR
DDVEY1 - DRIVER EYE COLOR - PDPS
DDVEY3 - DRIVER CURRENT EYE COLOR
TYP LENG OCC
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
35
35
35
35
35
35
35
35
35
8
8
8
8
8
8
8
8
18
8
1
1
1
3
1
2
2
2
3
3
3
3
3
3
POS
1
1
1
1
1
1
1
1
1
36
36
36
36
36
36
36
36
44
44
52
52
52
53
53
54
53
53
55
55
55
58
58
58
DRIVER NAME (10/D)
DATA ELEMENT
DDVNML
DDVNMF
DDVNMM
DDVNMS
-
DRIVER LAST NAME
DRIVER FIRST NAME
DRIVER MIDDLE NAME
DRIVER NAME SUFFIX
RESERVED
TYP LENG OCC
AN
AN
AN
AN
AN
40
40
35
5
2
POS
1
41
81
116
121
CITIZENSHIP AND IMMIGRATION BLOCK 1 (20/4)
DATA ELEMENT
C APPENDIX OF DATA ELEMENTS BY BLOCK
TYP LENG OCC
POS
Page 52
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
BFDARN
BFDI94
BFDUVN
BFDUSN
BFDPPN
-
USCIS ALIEN REGISTRATION NUMBER
USCIS I-94 NUMBER
USCIS VISA NUMBER
USCIS SEVIS NUMBER
PASSPORT NUMBER
RESERVED
C APPENDIX OF DATA ELEMENTS BY BLOCK
AN
AN
AN
AN
AN
AN
9
11
8
10
12
11
1
10
21
29
39
51
Page 53
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
CITIZENSHIP AND IMMIGRATION BLOCK 2 (20/5)
DATA ELEMENT
BFDCTN
BFDUDT
BFDUDD
BFDEXP
BFDBFC
-
DOCUMENT CERTIFICATE NUMBER
USCIS DOCUMENT TYPE ID
FEDERAL DOCUMENT DESCRIPTION
FEDERAL DOCUMENT EXPIRATION DATE
USCIS BENEFIT CODE
TYP LENG OCC
AN
AN
AN
AN
AN
13
2
35
8
3
POS
1
14
16
51
59
CITIZENSHIP AND IMMIGRATION BLOCK 3 (20/6)
DATA ELEMENT
BFDCAN - USCIS CASE NUMBER
BFDUSF - USCIS USER FIELD
- RESERVED
TYP LENG OCC
AN
AN
AN
15
40
6
POS
1
16
56
CITIZENSHIP AND IMMIGRATION BLOCK 4 (20/7)
DATA ELEMENT
BFDCOA
BFDPET
BFDLED
BFDVER
BFDVER
BFDESC
BFDEST
-
USCIS CLASS OF ADMISSION
USCIS LAWFUL PRESENCE END TYPE
USCIS LAWFUL PRESENCE END DATE
USCIS VERIFICATION RESPONSE CODE
USCIS VERIFICATION RESPONSE CODE
USCIS ELIGIBILITY STATEMENT CODE
USCIS ELIGIBILITY STATEMENT TEXT
RESERVED
TYP LENG OCC
AN
AN
AN
AN
AN
AN
AN
AN
3
1
8
3
3
3
64
37
1
POS
1
4
5
13
16
19
22
86
CITIZENSHIP AND IMMIGRATION BLOCK 5 (20/8)
DATA ELEMENT
BFDGRP BFDGRP BFDVET
BFDVET
-
Text Group
Text Group
- USCIS VERIFICATION RESPONSE TEXT
- USCIS VERIFICATION RESPONSE TEXT
RESERVED
C APPENDIX OF DATA ELEMENTS BY BLOCK
TYP LENG OCC
AN
AN
AN
AN
AN
100
100
100
100
44
1
1
POS
1
101
1
101
201
Page 54
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
CITIZENSHIP AND IMMIGRATION BLOCK 6 (20/9)
DATA ELEMENT
BFDUSR - AGENCY USER ID
BFDUPW - AGENCY PASSWORD
BFDWSV - USCIS SAVE WEB SERVICE VERSION
- RESERVED
TYP LENG OCC
AN
AN
AN
AN
8
14
30
9
POS
1
9
23
53
CITIZENSHIP AND IMMIGRATION BLOCK 7 (20/A)
DATA ELEMENT
BFDUBC
BFDUCC
BFDAED
BFDEED
BFDATD
BFDATT
BFDIVC
BFDIVT
-
USCIS BIRTH COUNTRY CODE
USCIS CITIZENSHIP COUNTRY CODE
FEDERAL DOCUMENT ALIEN ENTRY DATE
USCIS EMPLOYMENT AUTH END DATE
USCIS ALIEN ADMITTED TO DATE
USCIS ALIEN ADMITTED TO TYPE
USCIS IAV CODE
USCIS IAV TEXT
RESERVED
TYP LENG OCC
AN
AN
AN
AN
AN
AN
AN
AN
AN
5
5
8
8
8
1
5
20
1
POS
1
6
11
19
27
35
36
41
61
CITIZENSHIP AND IMMIGRATION BLOCK 8 (20/B)
DATA ELEMENT
BFDUPN - AGENCY NEW PASSWORD
- RESERVED
TYP LENG OCC
AN
AN
14
47
POS
1
15
DRIVER LICENSE APPLICATION BLOCK (54/1)
DATA ELEMENT
- RESERVED
DLACOM - APPLICATION COMMENT
TYP LENG OCC
AN
AN
POS
23
160
1
24
TYP LENG OCC
POS
RETURN AS RECEIVED BLOCK (98/3)
DATA ELEMENT
GRREC2 - RETURN AS RECEIVED TEXT/BLOCK
AN
61
1
EDIT/ERROR DESCRIPTIVE BLOCK – ALL (99/1)
DATA ELEMENT
C APPENDIX OF DATA ELEMENTS BY BLOCK
TYP LENG OCC
POS
Page 55
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
R*
R*
R*
R*
GEROUT - ERROR BLOCK OUT
GERELN - ERROR ELEMENT NUMBER - CDLIS
GEREL9 - ERROR ELEMENT NUMBER
- RESERVED
GERCDO - ERROR CODE OUT
GERCD9 - ERROR CODE OUT
GERMSO - ERROR MESSAGE OUT
GERPDP - ERROR BLOCK PDPS
GERBTY - ERROR BLOCK TYPE
GERBST - ERROR BLOCK SUBTYPE
GERLIN - ERROR BLOCK LINE NUMBER
GERCOD - ERROR CODE
GERMSG - ERROR MESSAGE
GERUEB - UNI ERROR BLOCK
GERUEC - UNI ERROR CODE
GERUCD - UNI ERROR INDICATOR
GERU2C - UNI ERROR CODE LAST 2 CHARACTERS
GERUET - UNI ERROR MESSAGE TEXT
C APPENDIX OF DATA ELEMENTS BY BLOCK
AN
AN
N
AN
AN
N
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
AN
61
4
4
1
2
2
54
61
2
1
2
2
54
61
4
1
2
54
1
1
1
5
6
6
8
1
1
3
4
6
8
1
1
5
6
8
Page 56
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
D. APPENDIX - DATA DICTIONARY
The following table describes all the data elements used in VLS. The table includes the following information:







Element Code—the 6-character alphanumeric identifier for the data element.
Business Name—the descriptive, identifying term for the data element.
Call List Name—the identifier used in the UNI call list for the data element.
Type—the data format for the element, either alphanumeric or numeric. (Most elements are defined as
alphanumeric, even numbers. This is to support cases where they hold a space. To indicate an element should
be treated as a number, the values will include a note saying "Numeric Values When Present").
Length—the number of bytes (characters) used in the message for the value of the data element.
Description—a short explanation or definition of the data element.
Values—the allowable values or data filling rules for the data element.
When the specification references elements, the data element code is listed. This table is listed in element code order to
allow for easy reference.
Element Code Business & Call List Names
BFDAED
FEDERAL DOCUMENT ALIEN
ENTRY DATE
BFDARN
CLMF-FEDERAL-DOC-ENTRY
USCIS ALIEN REGISTRATION
NUMBER
Type
/Len
AN
8
AN
9
CLMF-ALIEN-REG-NUM
BFDATD
USCIS ALIEN ADMITTED TO DATE
AN
CLMF-FEDERAL-DOC-ADMITTED-TO 8
BFDATT
BFDBFC
BFDCAN
USCIS ALIEN ADMITTED TO TYPE
AN
CLMF-USCIS-ADMITTED-TYPE
1
USCIS BENEFIT CODE
AN
CLMF-BENEFIT-CODE
3
USCIS CASE NUMBER
AN
Description & Values
The date on which an alien entered the U.S.
The format of the date is CCYYMMDD.
The alien registration number is assigned by the USCIS
to a person who is not a citizen of the United States.
The number is the identifier of the USCIS file for the
alien. It is commonly known as the "A-number".
When printed it appears as "A" followed by seven,
eight or nine digits. In electronic form the "A" is
omitted and the digits are right justified with leading
zeros.
A date associated with certain immigration types that
specifies the date up to which an alien is allowed to be
lawfully present in the U.S.
The format of the date is CCYYMMDD.
A code indicating the type of the duration that an
immigration document authorizes.
VALUE MEANING/DESCRIPTION
I
Indefinite. There either is no specific end date
or it is unknown (USCIS is unable to determine the end
date).
D
Duration of Stay.
A code indicating the reason for making an inquiry to
USCIS. The reason is expressed in terms of the benefit
a person will receive.
VALUE MEANING/DESCRIPTION
005
Drivers License or Permit
060
State ID Card
The case number is an identifier assigned by USCIS to
a set of inquiries on a person's record.
Page 57
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
Element Code Business & Call List Names
BFDCOA
CLMF-USCIS-CASE-NUM
USCIS CLASS OF ADMISSION
Type
/Len
15
AN
CLMF-USCIS-ADMISSION-CLASS
3
BFDCTN
DOCUMENT CERTIFICATE
NUMBER
AN
BFDEED
CLMF-DOC-CERT-NUM
USCIS EMPLOYMENT AUTH END
DATE
AN
BFDESC
CLMF-FEDERAL-DOC-WORK-END
USCIS ELIGIBILITY STATEMENT
CODE
AN
13
8
3
CLMF-ELIG-STATMT-CODE
BFDEST
USCIS ELIGIBILITY STATEMENT
TEXT
AN
BFDI94
64
CLMF-ELIG-STATMT-TEXT
FEDERAL DOCUMENT EXPIRATION AN
DATE
8
CLMF-FEDERAL-DOC-EXPIRE
USCIS I-94 NUMBER
AN
BFDIVC
CLMF-I94-NUMBER
USCIS IAV CODE
11
AN
CLMF-USCIS-IAV-CODE
5
BFDEXP
Description & Values
The visa or rule under which a non-citizen is allowed
to enter the U.S.
VALUE MEANING/DESCRIPTION
The list of codes and their meanings is maintained by
USCIS.
A unique identifier of a document. It is normally a
number printed on the document or card.
A date associated with employment authorization that
specifies the date up to which an alien is allowed to
lawfully work in the U.S.
The format of the date is CCYYMMDD.
A code indicating if a person is eligible to enter the
U.S.
VALUE MEANING/DESCRIPTION
1
Lawful permanent resident - employment
authorized
4
Cuban/Haitian entrant-temporary employment
authorized
5
Institute additional verification
10
Temporary employment authorized
13
Non-immigrant
18
Refugee - employment authorized
20
Asylee - employment authorized
22
Temporary resident - temporary employment
authorized
24
United States Citizen
26
If principal - temporary employment
authorized
32
Missing SEVIS ID is not listed
37
Institute additional verifications
119
Refer student/exchange visitor to their sponsor
A textual field describing the eligibility of an
individual to enter the U.S.
The date after which a document is no longer valid.
The format of the date is CCYYMMDD.
The number printed on an I-94 Arrival-Departure form.
The number is used to identify the entry and exit of a
non-US citizen from the USA.
A code returned by the SAVE Initial Verification. The
code provides some (though not all) of the reasons why
an initial verification failed and why a SAVE re-verify
transaction may be needed.
Page 58
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
Element Code Business & Call List Names
BFDIVT
Type
/Len
USCIS IAV TEXT
AN
CLMF-USCIS-IAV-TEXT
20
BFDLED
USCIS LAWFUL STATUS END DATE AN
BFDPET
CLMF-LAW-PRES-END-DATE
USCIS LAWFUL STATUS END TYPE
8
AN
CLMF-USCIS-PRESENCE-TYPE
1
Description & Values
VALUE MEANING/DESCRIPTION
NMM Name Mismatch
(on first, middle or last name)
BDMM DOB Mismatch
RNF Record Not Found
(for SEVIS ID, Alien, I-94, Naturalization Citizenship,
Receipt, Passport, or Visa Number)
Text returned by the SAVE Initial Verification. The
description provides some (though not all) of the
reasons why an initial verification failed and why a
SAVE re-verify transaction may be needed.
The date a person's lawful status in the USA ends.
Format is CCYYMMDD.
The USCIS Lawful Status End Type indicates how the
end period of lawful status is defined by USCIS.
BFDPPN
PASSPORT NUMBER
AN
VALUE MEANING/DESCRIPTION
I
Indefinite. There either is no specific end date
or it is unknown (USCIS is unable to determine the end
date).
D
The end date is defined by Status End Date.
S
Duration of Stay.
The number identifying a passport.
BFDUBC
CLMF-PASSPORT-NUM
USCIS BIRTH COUNTRY CODE
12
AN
A code which identifies the country of a person's birth.
CLMF-USCIS-BIRTH-CODE
5
USCIS CITIZENSHIP COUNTRY
CODE
AN
BFDUCC
5
CLMF-USCIS-CITIZEN-CODE
BFDUDD
BFDUDT
FEDERAL DOCUMENT
DESCRIPTION
AN
VALUE MEANING/DESCRIPTION
The codes are maintained by USCIS.
A code which identifies the country of a person's
citizenship.
VALUE MEANING/DESCRIPTION
The codes are maintained by USCIS.
A description of a type of document.
35
CLMF-DOC-DESC
USCIS DOCUMENT TYPE ID
AN
CLMF-USCIS-DOC-TYPE
2
A code used by USCIS to indentify a type of
document.
VALUE MEANING/DESCRIPTION
01
Other document type
02
I-94 Arrival/Departure Card
03
I-327 Reentry Permit
04
I-551 Permanent Resident (Green) Card
05
I-571 Refugee Travel Document
06
I-688 Temporary Resident Card
07
I-688A Employment Authorization Card
Page 59
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
Element Code Business & Call List Names
Type
/Len
BFDUPN
AGENCY NEW PASSWORD
AN
BFDUPW
CLMF-GRP-PSWD-NEW
AGENCY PASSWORD
14
AN
BFDUSF
CLMF-GRP-PSWD
USCIS USER FIELD
14
AN
BFDUSN
CLMF-USCIS-USER-FIELD
USCIS SEVIS NUMBER
40
AN
BFDUSR
CLMF-SEVIS-NUM
AGENCY USER ID
10
AN
BFDUVN
CLMF-GRP-USER-ID
VISA NUMBER
8
AN
CLMF-VISA-NUM
USCIS VERIFICATION RESPONSE
CODE
8
AN
BFDVER
3
Description & Values
08
I-688B Employment Authorization Document
09
I-766 Employment Authorization Card
10
Foreign Passport
20
Certificate of Naturalization
21
Temporary I-551 Stamp (on passport or I-94)
22
Machine Readable Immigrant Visa
23
Certificate of Citizenship
26
I-20 Nonimmigrant Student (F-1)
27
DS2019 Exchange Visitor (J-1)
30
Waiver Traveler/Business Admission Stamp
A new password associated with an Agency, Group
Subgroup or Person.
A password associated with an Agency, Group
Subgroup or Person for the purpose of accessing a
system.
An identifier of a user, used for tracking purposes.
DHS-USCIS and the jurisdiction have an agreement
(via a MOA) on the identifiers that may be used.
The number used to identify a record in the SEVIS
system. The SEVIS system is used to manage the
details about foreign students and exchange visitors.
A User Identification assigned to an agency, group or
person for the purpose of accessing a system.
The number printed on a travel visa.
A code describing the outcome of verifying a
document. The codes relate to the numbers on a USCIS
G-845 form.
CLMF-VER-RESP-CODE
BFDVET
USCIS VERIFICATION RESPONSE
TEXT
AN
100
VALUE MEANING/DESCRIPTION
The list of codes and their meanings is maintained by
USCIS.
A textual description of the outcome of verifying a
document. The codes relate to the numbers on a USCIS
G-845 form.
CLMF-VER-RESP-TEXT
VALUE MEANING/DESCRIPTION
The list of codes and their meanings is maintained by
USCIS.
BFDWSV
BJUCDE
USCIS SAVE WEB SERVICE
VERSION
AN
30
CLMF-WEB-SERV-VERSION
JURISDICTION CODE
AN
CLMF-JURISDICTION-CODE
2
A number identifying the version of the SAVE CPS
software.
A jurisdiction is an organization with power, right or
authority to interpret and apply the law, or the limit or
territory within which authority may be exercised. The
codes listed describe the values used within the scope
Page 60
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
Element Code Business & Call List Names
Type
/Len
Description & Values
of AAMVA systems.
VALUE MEANING/DESCRIPTION
------------------ United States --------------------'AK'
Alaska
'AL'
Alabama
'AR'
Arkansas
'AZ'
Arizona
'CA'
California
'CO'
Colorado
'CT'
Connecticut
'DC'
District of Columbia
'DE'
Delaware
'FL'
Florida
'GA'
Georgia
'HI'
Hawaii
'IA'
Iowa
'ID'
Idaho
'IL'
Illinois
'IN'
Indiana
'KS'
Kansas
'KY'
Kentucky
'LA'
Louisiana
'MA' Massachusetts
'MD' Maryland
'ME'
Maine
'MI'
Michigan
'MN' Minnesota
'MO' Missouri
'MS'
Mississippi
'MT'
Montana
'NC'
North Carolina
'ND'
North Dakota
'NE'
Nebraska
'NH'
New Hampshire
'NJ'
New Jersey
'NM' New Mexico
'NV'
Nevada
'NY'
New York
'OH'
Ohio
'OK'
Oklahoma
'OR'
Oregon
'PA'
Pennsylvania
'RI'
Rhode Island
'SC'
South Carolina
'SD'
South Dakota
'TN'
Tennessee
'TX'
Texas
'UT'
Utah
'VA'
Virginia
'VT'
Vermont
Page 61
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
Element Code Business & Call List Names
Type
/Len
Description & Values
'WA'
'WI'
'WV'
'WY'
Washington
Wisconsin
West Virginia
Wyoming
-------------- US Government Agencies ---------------'D2'
U.S. Department of Justice
'DS'
U.S. Department of State
'DT'
U.S. Department of Transportation
'FH'
Federal Motor Carrier Safety Administration
(FMCSA used to be the OMC in the FHWA)
'GS'
General Services Administration (GSA)
'IR'
Internal Revenue Service (IRS)
'TS'
Transportation Security Administration (TSA)
------------ US Territorial Possessions -------------'AS'
American Samoa
'FM'
Federal States of Micronesia
'GM' Guam
'MH' Marshal Islands
'MP'
Northern Mariana Islands
'PW'
Palau (till 1994)
'PZ'
Panamanian Canal Zone (till December 2000)
'PR'
Puerto Rico
'VI'
Virgin Islands
'WK' Wake Island
--------------------- Canada ------------------------'AB'
Alberta
'BC'
British Columbia
'MB'
Manitoba
'NB'
New Brunswick
'NF'
Newfoundland and Labrador
'NT'
Northwest Territory
'NS'
Nova Scotia
'NU'
Nunavut
'ON'
Ontario
'PE'
Prince Edward Island
'QC'
Quebec
'SK'
Saskatchewan
'YT'
Yukon Territory
--------------------- Mexico ------------------------'MX' Mexico (United Mexican States)
'AG'
'BA'
'BJ'
'CE'
'CH'
'CI'
Aguascalientes
Baja California
Baja California Sur
Campeche
Chihuahua
Chiapas
Page 62
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
Element Code Business & Call List Names
Type
/Len
DDVDOB
DRIVER DATE OF BIRTH
AN
DDVNMF
CLMF-DOB-CURRENT
DRIVER FIRST NAME
8
AN
DDVNML
CLMF-DRIVER-FIRST-NAME
DRIVER LAST NAME
40
AN
DDVNMM
CLMF-DRIVER-LAST-NAME
DRIVER MIDDLE NAME
40
AN
DLACOM
CLMF-DRIVER-MIDDLE-NAME
APPLICATION COMMENT
35
AN
GAPPID
CLMF-APP-COMMENT
APPLICATION ID
160
AN
CLMF-CODE-NET-APPL-ID
2
Description & Values
'CL'
Colima
'CU'
Coahuila de Zaragoza
'DF'
Distrito Federal Mexico
'DO'
Durango
'EM'
Estado de Mexico (the state within the
country)
'GR'
Guerrero
'GU'
Guanajuato
'HL'
Hidalgo
'JL'
Jalisco
'MC'
Michoacan de Ocampo
'MR'
Morelos
'NA'
Nayarit
'NL'
Nuevo Leon
'OA'
Oaxaca
'PB'
Puebla
'QR'
Quintana Roo
'QU'
Queretaro de Arteaga
'SI'
Sinaloa
'SL'
San Luis Potosi
'SO'
Sonora
'TA'
Tamaulipas
'TB'
Tabasco
'TL'
Tlaxcala
'VC'
Veracruz-Llave
'YU'
Yucatan
'ZA'
Zacatecas
The birth date of a driver. The date format is
CCYYMMDD.
The first name of a driver.
The last name of a driver. Also referred to as surname
of a driver.
The middle name(s) of a driver.
Comments regarding the application for a license,
permit or ID card.
The Application ID uniquely identifies an application
used by a site to exchange information with another
site through AAMVAnet.
VALUE MEANING/DESCRIPTION
'01'
(Old NDR)
'02'
CDLIS
'03'
DLR
'04'
AAMVAnet
Page 63
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
Element Code Business & Call List Names
GAPPST
Type
/Len
APPLICATION STATUS
AN
CLMF-CODE-APPL-STATUS
1
GERCOD
ERROR CODE
AN
GERMSG
CLMF-DESC-ERROR-MSG-CODE
ERROR MESSAGE
2
AN
GLSEGI
CLMF-DESC-ERROR-MSG-TEXT
LAST SEGMENT INDICATOR
54
AN
CLMF-INDC-NCB-LAST-SEG
1
Description & Values
'05'
SR22/26
'06'
RRT
'07'
E/MCO
'08'
RLA
'09'
(Old NRVC)
'10'
ELT
'11'
NMVTIS release 1
'12'
PDPS
'13'
BPEVR
'14'
PRISM AMIE
'15'
DVD
'16'
VI
'17'
SSOLV
'18'
PRISM X12
'19'
EDL
'20'
SSR
'21'
NLETS Driver Queries
'22'
NMVTIS release 2
'23'
PPI for NMVTIS
'24'
EVVER
'25'
AID
'26'
ENS
'27'
VIN Ping
'28'
VLS
'29'
Consumer Access
'30'
RIDE
'31'
AXLE
'32'
PaCa
'99'
IBM KIOSK
The Application Status defines the status of an
application. It must be filled in when responding to a
message.
VALUE MEANING/DESCRIPTION
''
Outbound message default
'0'
Status OK
'1'
Application inactive
'2'
Application invalid
'3'
Application security error
'9'
Application window closed
The Error Code contains the Error Code related to the
Element in error in the message's error block.
This is a free-form text field that may be used to
further describe the error.
When there is too much data to fit into a single
message, the message is split into multiple segments.
The Last Segment Indicator specifies whether or not
this is the last segment for the message.
Page 64
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
Element Code Business & Call List Names
Type
/Len
GMSBID
BATCH IDENTIFIER
AN
GMSCN4
CLMF-BATCH-ID
MESSAGE MATCH COUNT
15
AN
CLMF-MEC-MATCH-COUNT4
4
GMSDAT
MESSAGE DATE
AN
GMSDST
CLMF-DATE-NCB-MSG
MESSAGE DESTINATION
6
AN
GMSLEN
CLMF-CODE-MSG-DEST
MESSAGE LENGTH
7
AN
CLMF-NUMB-NCB-MSG-LEN
4
GMSLOC
MESSAGE LOCATOR/HEADER
AN
CLMF-DESC-MEC-MSG-LOCATOR
26
Description & Values
VALUE MEANING/DESCRIPTION
'Y'
Yes this is the last segment
'N'
No this is not the last segment
The batch identifier identifies which messages belong
to a given batch.
The number of matches that were found for a given
transaction.
VALUE MEANING/DESCRIPTION
NUMERIC VALUES WHEN PRESENT
The Message Date represents the date that the message
was sent. The format is YYMMDD.
The Message Destination contains the network ID of
the destination of the message.
The Message Length specifies the length of the
Network
Message in bytes.
The length is calculated as:
((Number of Text blocks + 1) * 66 )
The Message Locator/Header contains information
necessary to match up confirmations and/or responses
to their respective originating messages.
The originator of the initial message in a transaction
sets a value in the locator. Subsequent messages in the
transaction pass along the locator from the original
message.
GMSMS4
GMSORG
MESSAGE MATCH SEQUENCE ID
AN
CLMF-MEC-MATCH-SEQ-ID4
4
MESSAGE ORIGIN
AN
CLMF-CODE-ORIGIN
7
The locator generated by UNI is composed of:
- date - 6 bytes
- time - 6 bytes
- sequence - 4 bytes
- spaces - 4 bytes
- message splitting destination count - 1 byte
- "UNI" - 3 bytes
- initial message type in transaction - 2 bytes
The Message Match Sequence Id represents the match
identifier of a record found. It is used in transactions
where multiple responses are returned. The first
response contains "0001", the second contains "0002",
etc.
VALUE MEANING/DESCRIPTION
NUMERIC VALUES WHEN PRESENT
The Message Origin contains the network ID of the site
from which the message was originally sent.
Page 65
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
Element Code Business & Call List Names
GMSSEQ
MESSAGE SEQUENCE ID
Type
/Len
AN
CLMF-DESC-NCB-MSG-SEQ-ID
4
GMSTIM
MESSAGE TIME
AN
GMSTYP
CLMF-TIME-NCB-MSG
MESSAGE TYPE
6
AN
GNBTXT
CLMF-CODE-MSG-TYPE
2
NUMBER OF TEXT BLOCKS COUNT AN
CLMF-CNT-NCB-NUM-TXT-BLKS
2
Description & Values
The Message Sequence ID is used to uniquely identify
a given message from all others generated by the same
originator within the same second.
VALUE MEANING/DESCRIPTION
NUMERIC VALUES WHEN PRESENT
The Message Time contains the time the message was
sent. The format is HHMMSS, where HH can be 00 to
23.
The Message Type uniquely identifies the kind of
message within the given application.
The Number of Text Blocks Count contains the count
of the number of text blocks within the given text pool.
It does NOT include the NCB block, so the value will
range from 0 to 54.
For example, if the message contains an NCB, a
Message Exchange Control Block, and a Vehicle
Identification Block, this field will contain a value of
'02'.
GNCBER
GNETSI
GNETST
NCB ERROR CODE
AN
CLMF-CODE-NCB-ERROR
1
NETWORK SESSION INDICATOR
AN
CLMF-INDC-NET-SESSION
1
NETWORK STATUS
AN
CLMF-CODE-NET-STATUS
2
VALUE MEANING/DESCRIPTION
NUMERIC VALUES WHEN PRESENT
The NCB Error Code is a flag to indicate whether an
error has been detected on a given message. The field
is also used to indicate that the message could not be
delivered to its destination.
VALUE MEANING/DESCRIPTION
'N'
No error, this is the default value.
'Y'
Error, detected by application or network
interface.
'U'
Undeliverable (set by the network).
The Network Session Indicator specifies whether or
not the message is sent through NCS.
VALUE MEANING/DESCRIPTION
'Y'
Yes
'N'
No
The Network Status contains the status of the network.
This value is entered by NCS or by UNI.
VALUE MEANING/DESCRIPTION
' '
Outbound message default
'00'
Status Ok
'01'
Destination inactive
'02'
Destination not registered
'03'
Destination not defined
'04'
Origin error
'05'
Message length error
Page 66
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
Element Code Business & Call List Names
GPROST
PROCESSING STATUS
Type
/Len
AN
CLMF-CODE-MEC-PROCESS-STATUS 2
Description & Values
'06'
Billing ID error
'07'
Received undeliverable
'08'
Invalid message ID
'11'
TRAC/NCS down
'98'
Network window closed
'99'
Local network down
This field indicates the status of the transaction. A
value of zero indicates that there is no error in the
message. A value other than zero will indicate an
invalid process (e.g. record not found, syntax error or
any other application error). The non-zero values are
defined within a given application.
VALUE MEANING/DESCRIPTION
*** ALL APPLICATIONS ***
'00'
Processing successful
*** MOST APPLICATIONS ***
* (all applications except 02, 05 & 12) *
'01'
Processing unsuccessful
*** CDLIS (02) ***
'01'
Logic error (such as record not found)
'02'
System error (such as file off-line)
'03'
Syntax error (edit errors)
'04'
Security Exception
'05'
Confirmation of new SOR, but DHR not ready
'06'
Message sent outside of CDLIS processing
window
*** SR22/SR26 (05) ***
'01'
Syntax error detected
'02'
Driver record not found by jurisdiction
'03'
Driver found; SR22/26 not pertinent; Record
not
updated
'04'
Driver found; SR22/26 not pertinent; Record
updated
'05'
Driver record found; SR22/26 is duplicate
'06'
Security violation (not authorized to send)
'07'
Insufficient identifiers; cannot search driver
record
*** PDPS (12) ***
'01'
Logic error (such as record not found)
'02'
System error (such as file off-line)
'03'
Syntax error for DLN Survey only
*** ESI ***
'76'
User is not a valid originator
'77'
Destination is not a valid receiver
Page 67
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
Element Code Business & Call List Names
Type
/Len
Description & Values
'78'
'79'
'80'
'81'
'82'
GRREC2
GSGSEQ
GTPIND
GTRORG
GTRRST
RETURN AS RECEIVED
TEXT/BLOCK
AN
61
CLMF-DESC-RET-AS-RCVD-3
SEGMENT SEQUENCE NUMBER
AN
CLMF-NUMB-NCB-SEG
2
TEST/PRODUCTION INDICATOR
AN
CLMF-INDC-TST-PROD
1
TRANSACTION ORIGINATOR
AN
CLMF-CODE-NCB-TRANSORIGINATOR
7
TRANSACTION RESUBMISSION
TYPE
AN
1
Invalid message number
Invalid block number
Invalid error code
Out of sequence text blocks
Actual number of text blocks does not match
the count in the NCB block
'83'
Network is down
A free form field that allows a transaction originator to
store data in a message.
If a message is too large to be contained in one
segment, it is split into multiple segments. The
Segment Sequence Number is used to specify which, in
a possible series of segments, is current.
VALUE MEANING/DESCRIPTION
NUMERIC VALUES WHEN PRESENT
The Test / Production Indicator specifies whether to
route the message to Test or Production at the site.
VALUE MEANING/DESCRIPTION
'T'
Test
'P'
Production
The Transaction Originator contains the network ID of
the site that originated the transaction. On the initial
message in a transaction, it contains the origin of the
message. On subsequent messages in the transaction
the value from the original message is passed along.
Conveys that a transaction is a resubmission of a
previously submitted transaction. It also reflects the
reason that the transaction is being resubmitted.
CLMF-TXN-RESUB-TYPE
GXMODC
TRANSMIT MODE CODE
AN
CLMF-CODE-NCB-XMIT-MODE
1
VALUE MEANING/DESCRIPTION
A
Additional information has been provided
C
Data has been corrected
The Transmit Mode Code indicates the type of network
service used during the transmission.
VALUE MEANING/DESCRIPTION
'1'
NCS
'2'
Information Exchange
'3'
Batch
Page 68
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
E. APPENDIX – SAVE APPLICATION AND SYSTEM ERRORS
The following table lists the errors returned by SAVE. At the time this document was prepared, this list matched the
errors documented by DHS and the errors found during testing of SAVE.
The codes and text (other than code 0) are returned in the AMIE messages in the Error Message.
Return
Status
Codes
0
-1000
ReturnStatusMSG Text
Meaning of the Return Code and Text
SUCCESSFUL
Invalid or missing input parameter.
-1001
System error submitting Initial Verification.
-1001
System error submitting Initial
Verification.Database Error -301: THE
DOCUMENT TYPE DESCRIPTION IS NULL
-1001
System error submitting Initial
Verification.Database Error -33: INVALID
CURRENT STATE:
Operation=DHS_RESUBM
System error submitting Initial
Verification.Database Error -383: The document
description must be NULL.
System error submitting Initial
Verification.Database Error -453: The document
type id must not be null.
System error submitting Initial
Verification.Database Error -463: Both the alien
number and I94 must not exist
System error submitting Initial
Verification.Database Error -504: Null
Document Expiration Date.
System error submitting Initial
Verification.Database Error -506: The Alien
Number must be NULL
System error submitting Initial
Verification.Database Error -578: Card Number
must be exactly 3 alphabetic
System error submitting Initial
Verification.Object reference not set to an
instance of an object.
System error submitting Initial
Verification.String was not recognized as a valid
DateTime.
System error submitting Secondary Request.
Web Service call completed successfully.
An internal Web Service or database error was detected
while processing a Web Service request.
OR
The required parameter Alien Number was not received
by the Web Service method.
OR
The required parameter I94 Number was not received by
the Web Service method.
An internal Web Service or database error was detected
while initiating an Initial Verification query.
The required parameter DocOtherDesc was not received
by the Web Service method.
OR
The length of the Document Type parameter is invalid.
Document Types can be up to 35 characters long. See
Appendix B, table B-4 for the set of valid values.
The length of the Case Number parameter is invalid.
Case numbers must be 15 characters long and can be
alpha/numeric.
-1001
-1001
-1001
-1001
-1001
-1001
-1001
-1001
-1002
The DocOtherDesc field may only contain data when the
DocType field is set to “Other”.
The required parameter DocType was not received by
the Web Service method.
An Alien number or an I94 number must be in the Web
Service call but not both.
The required parameter DocExpDate was not received
by the Web Service method.
Invalid document type value received
Card number must be exactly 3 alphabetic
characters [A-Z] followed by 10 digits [0-9].
The required parameter BenefitCode was not received
by the Web Service method.
Invalid date received. An invalid month, day or year was
received.
An internal Web Service or database error was detected
Page 69
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
Return
Status
Codes
ReturnStatusMSG Text
-1003
-1004
System error retrieving the next pending case
number.
System error retrieving a Secondary Resolution.
-1005
System error deleting next pending case number.
-1006
System error closing case “case number”.
-1007
-1008
System error retrieving details for case “case
number”.
System error setting password.
-1020
Alien number or I94 number must exist.
-1021
-1022
Cannot have both an Alien number and an I94
number.
Required input field (BenefitCode) is null.
-1023
Required input field (Alien Number) is null.
-1024
Required input field (I94 Number) is null.
-1025
Required input field (Case Number) is null.
-1026
Required input field (DocType) is null.
-1027
Required input field (DocOtherDesc) is null.
-1028
Required input field (DocExpDate) is null.
-1029
Required input field (DocLastName) is null.
-1030
Required input field (DocFirstName) is null.
-1031
Required input field (DocBirthDate) is null.
-1032
Required input field (Birth Date) is null.
-1033
Required input field (Hire Date) is null.
-1034
Required input field (Referral Date) is null.
-1035
Required input field (Close Status) is null.
-1040
Invalid input field format, length/format (Alien
Number).
Invalid input field format, length/format (I94
Number).
Invalid input field format, length/format (Case
Number).
-1041
-1042
Meaning of the Return Code and Text
while initiating a Secondary Request query.
An internal Web Service or database error was detected
while retrieving a pending case number.
An internal Web Service or database error was detected
while retrieving a Secondary Resolution.
An internal Web Service or database error was detected
while deleting a pending case number.
An internal Web Service or database error was detected
while closing a case.
An internal Web Service or database error was detected
while retrieving case details.
An internal Web Service or database error was detected
while changing a password.
A “required field” error, either an Alien number or an
I94 number must be in the Web Service call.
An Alien number or an I94 number must be in the Web
Service call but not both.
The required parameter BenefitCode was not received
by the Web Service method.
The required parameter Alien Number was not received
by the Web Service method.
The required parameter I94 Number was not received by
the Web Service method.
The required parameter Case Number was not received
by the Web Service method.
The required parameter DocType was not received by
the Web Service method.
The required parameter DocOtherDesc was not received
by the Web Service method.
The required parameter DocExpDate was not received
by the Web Service method.
The required parameter DocLastName was not received
by the Web Service method.
The required parameter DocFirstName was not received
by the Web Service method.
The required parameter DocBirthDate was not received
by the Web Service method.
The required parameter BirthDate was not received by
the Web Service method.
The required parameter HireDate was not received by
the Web Service method.
The required parameter ReferralDate was not received
by the Web Service method.
The required parameter CloseStatus was not received by
the Web Service method.
Alien numbers must be 9 characters long and must be
numeric.
I94 numbers must be 11 characters long and must be
numeric.
The length of the Case Number parameter is invalid.
Case numbers must be 15 characters long and can be
alpha/numeric.
Page 70
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
Return
Status
Codes
-1043
ReturnStatusMSG Text
Meaning of the Return Code and Text
Invalid input field format, length/format
(DocType).
The length of the Document Type parameter is invalid.
Document Types can be up to 35 characters long. See
Appendix B, table B-4 for the set of valid values.
The length of the Document Description parameter is
invalid. Document Descriptions can be up to 35
characters long.
The length of the Last Name parameter is invalid. Last
name field can be up to 40 characters long.
The length of the First Name parameter is invalid. First
Name field can be up to 25 characters long.
Benefit code received is not a valid code or is not
configured for user.
Invalid document type value received. See Appendix B,
table B-4 for the set of valid values.
Invalid date received. An invalid month, day or year was
received.
Invalid date received. An invalid month, day or year was
received.
The length of the ClientSftwrVer parameter is invalid.
ClientSftwrVer field can be up to 30 characters long.
The length of the UserField parameter is invalid. First
UserField can be up to 40 characters long.
The length of the Aka parameter is invalid. Aka field can
be up to 40 characters long.
The length of the DocComment parameter is invalid.
DocComment field can be up to 160 characters long.
The Web Service user does not have the appropriate
permissions to access a particular case.
The DocOtherDesc field may only contain data when the
DocType field is set to “Other”.
The initial verification method has not configured for the
calling user/agency.
The Last Name field in the SubmitAdditVerif method
call should be null(This usually happens when an
Agency2 user calls the SubmitAdditVerif method
instead of the Agency2SubmitAdditVerif method).
The First Name field in the SubmitAdditVerif method
call should be null(This usually happens when an
Agency2 user calls the SubmitAdditVerif method
instead of the Agency2SubmitAdditVerif method).
The DOB field in the SubmitAdditVerif method call
should be null(This usually happens when an Agency2
user calls the SubmitAdditVerif method instead of the
Agency2SubmitAdditVerif method).
The Document Type field in the SubmitAdditVerif
method call should be null(This usually happens when
an Agency2 user calls the SubmitAdditVerif method
instead of the Agency2SubmitAdditVerif method).
The Document Description field in the
SubmitAdditVerif method call should be null(This
usually happens when an Agency2 user calls the
SubmitAdditVerif method instead of the
-1044
Invalid input field format, length/format
(DocOtherDesc).
-1045
-1047
Invalid input field format, length/format
(DocLastName).
Invalid input field format, length/format
(DocFirstName).
Invalid Benefit Code for user.
-1048
Invalid DocType.
-1049
Invalid Document Expiration Date.
-1050
Invalid Document Birth Date.
-1051
Invalid input field length (ClientSftwrVer)
-1052
Invalid input field length (UserField).
-1053
Invalid input field length (Aka).
-1054
Invalid input field length (DocComment).
-1055
No permissions to access this case.
-1056
-1081
Doc Other Description cannot have a value for
selected Doc Type.
The called method is not authorized for use by
this agency.
The Last Name field should be null.
-1082
The First Name field should be null.
-1083
The DOB field should be null.
-1084
The Document Type field should be null.
-1085
The Document Description field should be null.
-1046
-1079
Page 71
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
Return
Status
Codes
ReturnStatusMSG Text
-1086
The Document Expiration Date field should be
null.
-1090
Case does not exist or you do not have the
correct privileges to access case.
-1103
Invalid input field format,
length/format (Card/Receipt Number).
-1119
Invalid input field format,
length/format (Naturalization Number)
Invalid input field format,
length/format (Citizenship Number).
1G - System exception encountered
-1120
1Z - System exception encountered
Meaning of the Return Code and Text
Agency2SubmitAdditVerif method).
The Document Expiration field in the SubmitAdditVerif
method call should be null(This usually happens when
an Agency2 user calls the SubmitAdditVerif method
instead of the Agency2SubmitAdditVerif method).
The case number received in a method call does not
exist in the CPS database or the user invoking the
method does not have the correct privileges to access the
case.
Card number must be exactly 3 alphabetic
characters [A-Z] followed by 10 digits [0-9].
OR
Naturalization Number must be between 7 and
12 digits. Commas are not allowed.
Naturalization Number must be between 7 and
12 digits. Commas are not allowed.
Citizenship Number must be between 7 and 12
digits. Commas are not allowed.
The initial verification method has not configured for the
calling user/agency.
This may also be issued when:
 UserID is invalid
 UserID is blank
 Password is invalid
 Password is blank
An unknown error was encountered by the DHS ESB.
The error normally indicates a configuration problem.
Page 72
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
F. APPENDIX – SAVE CLASS OF ADMISSION (COA) CODES
The following list described the Class of Admission (COA) Codes and their meanings. At the time this document was
prepared, this list was complete. USCIS may make changes to the codes over time.
Code
0-1
0-2
0-3
01
02
03
1
12
12A
12C
13A
2
2-C
2-D
2-E
2-F
2-G
231
2C
2C6
2D
2E
2F
2G
3
3-B
3-C
317
318
3B
3B2
3B3
3B4
3C
4
4-A
4-B
4-C
4-D
4-F
407
4A
4A?
4B
4C
4D
4F
5
503
COA Description
Temp Worker Of Extraordinary Ability
Temp Worker Accompanying 01
Spouse/Child Of 01 Or 02
Temp Worker Extraordinary Ability
Temp Worker Accompanying 01
Spouse/Child Of 01 Or 01
Native Virgin Islands Res Foreign
Person Of Germanic Ethnic Orgins
German Ethnic Origin
Child Adopted USC German/Austrian
Child Born Subsequent Visa Iss/Reentry
Chinese Act Of Dec 17, 1943
Displaced Persons Act Of 1948
Displaced Persons Act Of 1948
Displaced Persons Act Of 1948
Displaced Persons Act Of 1948
Displaced Persons Act Of 1948
Philippine Citz, Wife/Unmar Child
Displaced Persons Act Of 1948
Displaced Persons Act Of 1948
Displaced Person Political Refugee
Eligible Displaced Orphan
Orphan Adopted Or To Be Adopted
Displaced Person Act Of 1948
Spouse/Child Of 01 Or 01
Displaced Persons Act Of 1948
Displaced Persons Act Of 1948
Expatriated Dual National
Former Citz Expatriated Thru Parents
Displaced Person
Displaced Person-Child
Displaced Person-Poland
Displaced Person-Greece
Displaced Person-European
Displaced Person In US
Refugee Relief Act Of 1953
Alien Returning From Temp Abro
Refugee
Refugee
Refugee
I-407 Executed; Admitted As A Visitor
German Expellee In Western Germany,
Berlin Or Austria
Refugee
Alien Returning Temp Visit Abroad
Refugee
Minister/Refugee Minister/Spouse/Child
Female Refugee Lost USC By Marriage
Orphan Under 10 Years Of Age
Holder Cert Of Id Prosecute Action
6
6-A
6A
6A1
6A2
6A3
991
992
993
994
999
A-1
A-2
A-3
A1
A11
A12
A16
A17
A2
A3
A31
A32
A33
A36
A37
A38
A41
A42
A43
A46
A47
A48
AA1
AA2
AA3
AA6
AA7
AA8
ABD
ABS
AM1
AM2
AM3
AM6
AM7
AM8
AO
AR
Refugee In The US
Ins Act Of 1924
Ins Act Of 1924
1st Pref Ref Act Of 1924
2nd Pref Ref Act Of 1924
Nonpreference Alien/Refugee Alien
Carter Special
Carter General
Spellman General
Spellman Humanitarian
Asylum Applicant Awaiting Decision
Ambass, Minister, Dipl
Other For Govt Officia
A1-A2 Atten, Serv, Emp
Ambass, Minister, Diplomat & Imm Family
Unmarried Child Of USC Under Pl 97-359
Child Of A11
Unmarr Amerasian Son/Daugh
Child Of A16
Foreign Govt Official Or Emp & Imm
Family
Attendant,Servant,Empl Of A1/A2 & Imm
Family
Married Amerasian Son/Dau Of USC
Spouse Of A31
Child Of A31
Married Amerasian Son/Dau Of USC
Spouse Of A36
Child Of A36
Married Son/Daug Of USC Pl 97-3359
Spouse Of A41
Child Of A41
Married Son/Daug Of USC Pl 97-359
Spouse Of A46
Child A46
Diversity Transition
Spouses Of Aa1
Child Of Aa1
Diversity Transition
Spouse Of Aa6
Child Of Aa6
Abandonment Of Residency
No Description
Amerasian Born In Vietnam USC Father
Spouse Or Child Of Am1
Mother/Guardian Of Am1
Amerasian Born Vietnam USC Father
Spouse/Child Of Am6
Mother/Guardian/Spouse/Child Of Am6
Asylee Applicant W/O Work Auth
Admission Refused
Page 73
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
AR1
AR6
ARC
AS
AS1
AS2
AS3
AS6
AS7
AS8
ASD
ASP
ASR
AW
AY
AY1
AY2
B-1
B-2
B1
B11
B12
B16
B17
B2
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B31
B32
B33
B36
B37
B38
BC1
BC2
BC3
BC6
BC7
BC8
BCC
BCD
BE
BX1
BX2
BX3
BX6
BX7
Child Of USC Under Pl 97-359
Child Of Citizen Born, Laos, Korea, Vietnam
Administratively Closed/Refugee Applicant
A# -Asylee App W/ Work Auth -- I94# Asylee
Approved Asylee Principal
Approved Spouse Of Asylee
Approved Child Of Asylee
Asylee Principal Lpr
Spouse Of As6 Asylee Lpr
Child Of As6 Asylee Lpr
Asylum Status Denied
Asylee W/ Lpr App Pending
Asylum Status Revoked
Raw Applied For At A Port
Asylee Admission
Ayuda-Employment Authorization
Ayuda-No Employment Authorization
Visitor For Business
Visitor For Business
Visitor For Business
Self-Petition Unmarried Son/Daughter USC
Child Of B11
Self-Pet Unmarried Son/Daughter USC
Child Of A B16
Visitor For Pleasure
Child Of B29
Self-Petition Spouse Of Lpr
Self-Petition Child Of Lpr
Child Of B21
Self-Petition Unmarried Son/Daughter Lpr
Child Of B24
Self-Petition Spouse Of LPR
Self-Petition Child Of LPR
Child Of B26, B27
Slf-Petition Unmarried Son/Daughter Lpr
Self-Petition Married Son/Daughter USC
Spouse B31
Child Of B31
Self-Petition Married Son/Daughter USC
Spouse Of B36
Child Of B36
Spec Broadcaster/Ibcb Of Bbg, Prin
Spouse Of Bc1
Child Of Bc1
Special Broadcaster/Ibcb Of Bbg, Prin
Spouse Of Bc6
Child Of Bc6
Border Crossing Card
Denied Border Crossing Card
Bering Strait Entries
Self-Petition Spouse Of Lpr, Exempt
Self-Petition Child Of Lpr, Exempt
Child Of Bx1
Self-Petition Spouse Of LPR
Self-Petition Child Of LPR
BX8
C-1
C-2
C-3
C-4
C1
C2
C20
C21
C22
C23
C24
C25
C26
C27
C28
C29
C3
C31
C32
C33
C36
C37
C38
C4
C41
C42
C43
C46
C47
C48
C4?
C51
C52
C53
C56
C57
C58
C7P
CB1
CB2
CB6
CB7
CC
CF1
CF2
CH
CH6
CNP
CP
CPT
CR1
CR2
CR6
Child Of A Bx6, Bx7
Alien In Transit
Alien In Transit To United Nations
Foreign Govt Official In Transit
Transit Without Visa
Alien In Transit
Alien In Transit To United Nations
Conditional-Child Of C29
Conditional-Lpr Spouse
Conditional-Step Ch Under 21 Of Lpr
Conditional-Child Of C21 Or C22
Conditional-Unmarr Child Of Lpr Over 21
Conditional-Child Of C24
Conditional-Lpr Spouse
Conditional-Step Ch Under 21 Of Lpr
Conditional- Child Of C26 Or C27
Conditional-Unmarr Step-Child 21+
Foreign Govt Official In Transit
Condtional-Married Child Of USC
Conditional-Spouse Of C31
Conditional-Child Of C31
Conditional- Child Of USC
Conditional-Spouse Of C36
Conditional-Child Of C36
Transit Without Visa
Conditional-Married Step-Ch USC
Conditional-Spouse Of C41
Conditional-Child Of C41
Conditioal-Married Step-Child USC
Conditional-Spouse Of C46
Conditional-Child Of C46
Transit Without A Visa
Conditional-Employment Creation Area
Conditional-Spouse Of C51
Conditional-Child Of C51
Conditional-Emp Creation Immigrant
Conditional-Spouse Of C56
Conditional-Child Of C56
Cuban Refugee Or Non-Cuba Sp/Child Cuba
Ref
Conditional-Spouse Of Cuban Haitian Ent
Conditional-Child Of Cuban Haitian Ent
Conditional-Spouse Of Cuban Haitian Ent
Conditional-Child Of Legal Conditional
Entrant
Mass Migration Cuban Parolees
Conditional-Fiance/Fiancee Of USC
Conditional-Minor Child Of Cf1
Parolee (Humanitarian)
Cuban-Hitian Entrant
Cuban Refugee Non-Cuba Sp/Child Nonpref
Parolee (Public Interest)
Continued Presence Terminated
Conditional-Spouse Of USC
Conditional-Step-Child Of USC
Conditional-Spouse Of USC
Page 74
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
CR7
CRI
CS1
CS2
CS3
CSS
CT
CU0
CU6
CU7
CU8
CU9
CUP
CX1
CX2
CX3
CX6
CX7
CX8
D-1
D-2
D1
D2
DA
DAS
DE
DEF
DEP
DFC
DHR
DNA
DP
DP?
DS1
DT
DT1
DT2
DT3
DT6
DT7
DT8
DV1
DV2
DV3
DV6
DV7
DV8
DX
E-1
E-2
E1
E10
E11
E12
E13
E14
Conditional-Step-Child Of USC
Criminal Prosecution
Catholic Social Services-Employ Auth
Catholic Social Services-No Employment
Catholic Social Services
Ineligible Catholic Social Services
No Description
Cuban Refugee Parent Of USC
Cuban Refugee
Non-Cuban Spouse/Child Of Cu6
Cuban Refugee Spouse Of USC
Cuban Refugee Child Of USC
Cuban Refugee/Non Cuban Sp/Child-Other
Conditional-Spouse Of Lpr
Conditional-Minor Child Of Lpr, Under 21
Conditional-Child Of Cx2
Conditional-Spouse Of Lpr
Conditional-Minor Child Of Lpr
Conditional-Child Of Cx7
Crewman On Vessel Or Aircraft
Alien Crewman
29 Days Or Less On Ves Or Airline
Alien Crewman
Advance Parole (District)
Deferred Action Status
Deferred Inspection
Deferred Inspection (Exp 0/30/91)
Deportation
Documented False Claim
Denial-Haitian Refugee
Denaturalization Cases
Displaced Person
Displaced Person
Record Creation Dipl Status Born In US
Parolee - District/Poe
Displaced Tibetans
Spouse Of Dt1
Child Of Dt1
Displaced Tibetans
Spouse Of Dt6
Child Of Dt6
Diversity Immigrant
Spouse Of Dv1
Child Of Dv1
Diversity Immigrant
Spouse Of Dv6
Child Of Dv6
Crew Arrg/Detained Onboard Ship
Treaty Trader, Spouse And Children
Treaty Investor, Spouse And Children
Treaty Trader, Spouse & Child
Child Of Priority Workers
Alien With Extraordinary Ability
Outstanding Professor/Researcher
Priority Worker-Multinat Exec/Mgr
Spouse Of Priority Worker
E15
E16
E17
E18
E19
E2
E21
E22
E23
E26
E27
E28
E3
E30
E31
E32
E34
E35
E36
E37
E39
E51
E52
E53
E56
E57
E58
EC6
EC7
EC8
ERF
ERP
ERR
ES1
ES5
ES6
EW0
EW3
EW4
EW5
EW8
EW9
EWI
EX1
EX2
EX3
EX6
EX7
EX8
EXC
EXP
F-1
F-2
F1
F11
F12
Child Of Priority Worker
Alien With Extraordinary Ability
Outstanding Professor/Researcher
Priority Worker-Multinat Exec/Mgr
Spouse Of Priority Worker
Treaty Investor, Spouse & Child
Professional Exceptional Ability
Spouse Of E21
Child Of E21
Professional Exceptional Ability
Spouse Of E26
Child Of E26
Australian Free Trade Agreement
Child Of E36 Or E37
Skilled Worker
Professional
Spouse Of E31 Or E32
Child Of E32 Or E32
Skilled Worker
Professional
Spouse Of E36 Or E37
Targeted Employment Area
Spouse Of E51
Child Of E51
Employment Creation Immigrant
Spouse Of E56
Child Of E56
Chinese Student Protection Act
Spouse Of Chinese Student Protection Act
Child Of Chinese Student Protection Act
Expedited Rem. Pend. Credible Fear
Expedited Removal Pending Other
Expedited Removal Alien Removed
Soviet Scientist Principal
Soviet Scientist Principal
Soviet Scientist Principal
Child Of Ew8
Unskilled Labor
Spouse Of Ew3
Child Of Ew3
Unskilled Workers
Spouse & Children Of Ew8
Entry Without Inspection
Schedule-A Worker
Spouse Of Ex1
Child Of Ex1
Schedule-A Worker
Spouse Of Ex6
Child Of Ex6
Exclusion
Expatriation
Student
Spouse Or Child Of Student
Student
Unmarried Son/Daug Of USC
Child Of F11
Page 75
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
F16
F17
F2
F20
F21
F22
F23
F24
F25
F26
F27
F28
F29
F3
F31
F32
F33
F36
F37
F38
F41
F42
F43
F46
F47
F48
FFD
FFG
FFP
FFW
FSM
FUG
FX1
FX2
FX3
FX6
FX7
FX8
G-1
G-2
G-3
G-4
G-5
G1
G2
G3
G4
G5
GA6
GA7
GA8
GB
Unmarried Son/Daugh Of USC
Child Of F16
Spouse Or Child Of Student
Child Of F29
Spouse Of Lpr
Minor Child Of Lpr
Child Of F21
Unmarried Son/Daugh 21> Of Lpr
Child Of F24
Spouse Of Lpr
Minor Child Of Lpr
Child Of F26
Unmarried Son/Daugh 21> Of Lpr
Canadian/Mexican National Commuter
Student
Married Son/Daugh Of USC
Spouse Of F31
Child Of F31
Married Son/Daugh Of USC
Spouse Of F36
Child Of F36
Brother Or Sister Of USC
Spouse Of F41
Child Of F41
Brother Or Sister Of USC
Spouse Of F46
Child Of F46
Denied-Family Fairness
Granted Family Fairness
Pending Family Fairness
Family Fairness Granted W/Emp Auth
Citizen Of The Federal States Of Micronesia
Family Unity Extended Vol Dep
Spouse Of Lpr
Child Under 21 Of Lpr
Child Of Fx1 Or Fx2
Spouse Of Lpr
Child Under 21 Of Lpr
Child Of Fx7
Rep Of Recognized Foreign Government
Other Rep Of Recognized Foreign Gov
Rep Of Nonrecognized Foreign Government
Officer Or Employee Of Intl Org And
Immediate Family
Staff Of G1, G2, G3 Or G4 And Immediate
Family
Rep Of Rec For Govt, Staff & Imm Fam
Other Rep Of For Mem Govt & Imm Family
Rep Nonrec Or Nonmem Govt & Imm
Family
Intl Org Officer Or Employ & Imm Family
Staff Of G1, G2, G3 Or G4 & Imm Family
Guam Asylee, Principal
Guam Asylee, Spouse
Guam Asylee, Child
Visitor Business Guam Visa Waiv Pil
GR
GT
H-3
H-4
H1
H1A
H1B
H1C
H2
H2A
H2B
H2R
H3
H3A
H3B
H4
HA6
HA7
HA8
HA9
HB6
HB7
HB8
HB9
HC6
HC7
HC8
HC9
HD6
HD7
HD8
HD9
HE6
HE7
HE8
HE9
HK1
HK2
HK3
HK6
HK7
HK8
HR
HSC
I
I1
I51
I52
I53
I56
I57
I58
IB0
Visa Waiver Refusal
Visitor Guam Visa Waiver Pilot
Trainee Temp Worker
Spouse/Child Of H-1, H-2 Or H-3
Temp Worker Specialty Occupation
Program Expired-Registered Nurse
Professional Noncitizen
Registered Nurse
Temporary Worker
Agricultural Worker
Non-Agricultural Worker
Returning (H2B) Worker Not Subject To
Cap
Trainee Temp Worker
Special Education Training
Special Education Training
Sp/Ch Of H1, S9(H2a), H2 Or H3
Haitian Granted LPR Under902(B1a)O
Spouse Of An HA6
Child Of An HA6
Unmarried Son Or Daughter Of HA6
Haitian Granted LPR Under 902(B1b)
Spouse Of A HB6
Child Of An HB6
Unmarried Son Or Daughter Of HB6
Haitian Granted LPR Under 902(B1c)
Spouse Of HC6
Child Of HC6
Unmarried Son Or Daughter Of HC6
Haitian Granted LPR Under 902(B1c)
Spouse Of HD6
Child Of HD6
Unmarried Son Or Daughter Of HD6
Haitian Granted LPR Under 902(B1)
Spouse Of HE6
Child Of HE6
Unmarried Son Or Daughter Of HE6
Employ Of US Business In Hong Kong
Spouse Of Hk1
Child Of Hk1
Employ Of US Business In Hong Kong
Spouse Of Hk6
Child Of Hk6
Returning (H2B) Worker Not Subject To
Cap
H1B1 Under Singapore/Chile Free Trade
Agreement Act
Foreign Media, Spouse And Children
Rep Forg Info Media, Sp & Child
Conditional-Investor Pilot
Conditional-Spouse Of I51
Conditional-Child Of E51
Conditional-Investor Pilot Target Principal
Conditional-Spouse Of I56
Conditional-Child Of I56
Battered Or Abused Parent Of U.S. Citizen
Page 76
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
IB1
IB2
IB3
IB5
IB6
IB7
IB8
IC6
IC7
ID6
IF1
IF2
IJ
IMM
IN
IR0
IR1
IR2
IR3
IR4
IR5
IR6
IR7
IR8
IR9
IT
IT1
IT2
IT3
IT6
IT7
IT8
IW1
IW2
IW6
IW7
J-1
J-2
J1
J2
K-1
K-2
K-3
K-4
K-5
K-6
K-7
K-8
K-9
K1
K10
K11
K12
Self-Petition Spouse Of USC
Self-Petition Child Of USC
Child Of An Ib1
Battered Or Abused Parent Of U.S. Citizen
Self-Petition Spouse Of USC
Self-Petition Child Of USC
Child Of An Ib6
Indochinese Refugee
Spouse/Child Of Indochinese Refugee
Indochinese Parolee
Alien Rec Adm For Lpr Creation
Minor Child Of If1
Referred To Immigration Judge
Immigrant
Parolee-Indefinite
Parent Of USC
Spouse Of USC
Child Of USC
Orphan Adopted Abroad By USC
Orphan To Be Adopted By USC
Parent Of USC
Spouse Of USC
Child Of USC
Orphan Adopted Abroad By USC
Orphan To Be Adopted By USC
In Transit Passenger - No Admittance
Conditional Status Terminated-Principal
Conditional Status Terminated-Spouse
Conditional Status Terminated-Child
Conditional Status Terminated-Principal
Conditional Status Terminated-Spouse
Conditional Status Terminated-Child
Widow/Widower Of USC
Child Of Iw1
Widow/Widower Of USC
Child Of Iw6
Exchange Visitor
Spouse Child Of J-1
Exchange Visitor
Spouse/Child Of J1
Eligible Orphan Adopted Aboard-Code No
Longer In Use
Eligible Orphan To Be Adopted AbroadCode No Longer In Use
Spouse Or Child Of Adjusted First
Preference Immigrant
Ben 1st Pref Prt Apr P 7-1-58
Sp/Ch 1st Pref Pet Apr P 7-1-58
Ben 2nd Pre Pet Appr P 7-1-57
Ben 3rd Pref Pet Appr P 7-1-57
German Expellee
Netherlands Refugee Or Relativ
Fiance/Fiancee Of A USC
Refugee-Escapee
Azores Natural Calamity Victim
Accom Spouse/Unmar Minor Ch Of K11
K13
K14
K15
K16
K17
K18
K19
K2
K20
K21
K22
K23
K24
K25
K26
K3
K3M
K4
K4M
K5
K6
K7
K8
K9
KIC
KIP
KN4
KP4
KR3
KR4
KS3
KS4
KT4
KU4
L-1
L-2
L1
L1A
L1B
L2
LA6
LB1
LB2
LB6
LB7
LE1
LE2
LPR
LTR
LU1
LU2
Netherlands National Displaced Fr Indonesia
Accom Sp/Unmarr Minor Child Of K13
Parent USC Prior To 12/31/53
Spouse/Child Of Lpr Prior 12/31/53
Bro/Sis/Son/Dau Of USC Prior 12/31/53
Spouse/Child Of K15, K16 Or K17
Parent USC Ref Relief Act Of 1953
Child Of Fiance/Fiancee Of USC
Spouse/Child Ref Relief Act 1953
2nd Pref Prior 7/1/61
3rd Pref Prior 7/1/61
1st Pref Prior To 4/1/62
Spouse/Child Of K23, Kr3, Or Kr4
4th Pref Prior To 1/1/62
Spouse/Ch Of K25
Life Act
Spouse/Child Adj 1st Pref Immigrant
Life Act
Ben 1st Pref Petition Apr Prior 6-1-58
Spouse/Child Of Ben 1st Pref Prior 7/1/1958
Beneficiary 2nd Pref Prior 7/1/57
Beneficiary 3rd Pref Prior 7/1/57
German Expellee
Netherlands Refugee Or Relative
Kickapoo Indian USC-Special CategoryUnited States Citizen
Kickapoo Indian Pass Freely-Not Lpr-Law
States Free To Enter &To Li
Nonquota Prior 7/1/61
3rd Pref Prior 7/1/61
1st Pref Prior To 4/1/62
1st Pref Prior To 4/1/62
Spouse/Child Of K23, Kr3 Or Kr4
Spouse/Ch Of K23 Or Kr4
4th Pref Pet Fuled Prior To 4/54
Sps/Ch Of K25 Or Kt4
Intra-Comp Transferee
Alien Spouse/Child Of L1
Intra-Company Transferee
Intracompany Transferee Managers &
Executives
Intracompany Transferee Specialized
Knowledge
Spouse/Child Of L1
Parolees Soviet
Union/Cambodia/Laos/Vietnam
Spouse Of Legalized Alien
Child Of Legalized Alien
Spouse Of Legalized Alien
Child Of Legalized Alien
Leap Class Member
Leap Class Member
Legal Permanent Resident
Lawful Temporary Resident (I-688, I-688a)
Lulac-Employment Authorization
Lulac-No Employment Authorization
Page 77
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
M-1
M-2
M-3
M-4
M-8
M-9
M1
M2
M3
M4
M8
M83
M9
M93
MI1
MI2
MI3
MIS
ML
MR0
MR6
MR7
N
N-1
N-2
N-3
N-4
N-5
N-6
N-7
N-8
N-9
N1
N1?
N2
N3
N4
N5
N51
N52
N53
N56
N57
N58
N6
N7
N8
N9
NA
NA3
NC
NC6
NC7
NC8
Spouse Of USC
Child Of USC
Eligible Orphan Adopted Abroad
Eligible Orphan To Be Adopted
Ref-Escapee Adm For Perm Res
Hung Parolee Adm For Perm Res
Vocational Student
Spouse/Child Of M1
Canadian/Mexican National Commuter
Vocational Student
Eligible Orphan To Be Adopted
Ref-Escapee Adm For Perm Res
Ref-Escapee Adm For Perm Res
Hung Parolee Adm For Perm Res
Hung Parolee Adm For Perm Res
Pacific Trust Terr Domiciled In US
Pacific Trust Terr-Domiciled Cont In US
Conditional Pacific Trust Terr Domiciled In
US
Citizen Of The Republic Of Marshall Islands
Parolee-Medical,Legal,Humanita
Parent USC Lpr Pl-94-2
Spouse USC Lpr Pl 94-2
Child USC Lpr Pl 94-241
Returning Resident
All Nato Admissions
Nato Admission
Nato Admission
Nato Admision
Nato Admission
Nato Admission
Nato Admission
Parent Of Sk3 Int Special Imm
Child Of N8/Sk1, Sk2 Or Sk4
All Nato Admissions
Nato Admission
Nato Admission
Nato Admission
Nato Admission
Nato Admission
Denied Lpr 5th Pref Principal
Denied Lpr-Spouse Of N51
Denied Lpr-Child Of N51
Denied Lpr 5th Pref Principal
Denied Lpr-Spouse Of N56
Denied Lpr-Child Of N56
Nato Admission
Nato Admission
Parent Of Sk3 Int Special Imm
Child Of N8/Sk1, Sk2, Or Sk4
Child Born Aboard Of Lpr/National
Child Born Aboard Of USC Or Lpr
Non-Controlled Alien
Nicaraguan Or Cuban Granted LPR
Spouse Of A NC6
Child Of A NC6
NC9
NP0
NP1
NP2
NP5
NP6
NP7
NP8
NP9
NT1
NT2
NT3
NT6
NT7
NT8
O1
O1A
O1B
O1M
O2
O2M
O3
O3M
OFC
OFM
OFO
OP
OP1
OP2
OP3
OP6
OPC
OPN
OPR
P-1
P-2
P-3
P-4
P-7
P1
P11
P12
P16
P17
Unmarried Son Or Daughter Of NC6
Natives Of Foreign States Affected By Pl 89236
203(A)(7)
Family Member Accom Cond Entrant
Natives Of Foreign Sates Affected By Pl89236
203(A)(7)
Family Member Accompanying Conditional
Immigrant
Investor Prior To 6/1/78
Spouse Or Child Of Np8
Conditional Status Terminated-5th Pref
Principal
Conditional Status Terminated-5th Pref
Spouse
Conditional Status Terminated-5th Pref
Child
Conditional Status Terminated-5th Pref
Principal
Conditional Status Terminated-5th Pref
Spouse
Conditional Status Terminated-5th Pref
Child
Temp Worker With Extradrdinary Ability
Extraordinary Alien - Non-Arts
Extraordinary Alien In Arts
Native Of West Hemis Countries
Temporary Worker Accompanying Or
Assisting O1
Spouse Of Alien Classified O1m
Spouse/Child Of O1 Or O2
Child Of Alien Classified O1m
Oral False Claim
Olympic Family Member
Olympic Family Override
Overseas Parolee-Pip
Lottery Immigrant - Pl 100-658, 11/15/1988
Spouse Of Alien Classified Op1
Child Of Alien Classified Op1
Ctry Diversity Prog.(Adjustment)
Administratively Closed/Parole Applicant
Offered Parole/Has Not Come To US
Other Positive Results (Exp 02/14/1997)
Internationally Recognized
Athlete/Entertainer
Temp Worker Artist/Entainer
Culturally Unique Temp Artist/Entertainer
Spouse/Child Of P1, P2 Or P3
Ref Adj Under Sec 203(A)(7)
Internationally Recognized
Athlete/Entertainer
1st Pref Unmar Child US Citz
1st Pref Child Of Alien P11/P16
Unmarried Son/Daugh Of Citz
Child Of P11 Or P16 Alien
Page 78
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
P1A
P1B
P1M
P1S
P2
P21
P22
P23
P26
P27
P28
P2M
P2S
P3
P31
P32
P33
P36
P37
P38
P39
P3M
P3S
P4
P41
P42
P43
P46
P47
P48
P51
P52
P53
P56
P57
P58
P61
P62
P63
P66
P67
P68
P7
P71
P72
P75
P76
PAC
PAL
PEN
PH6
PI
PL1
PL2
PR
Alien With Athletic Event
Alien With Entertainment Group
Indiv Lost Citizenship By Marriage
Support Person Of P-1
Temp Worker-Artist/Entertainer
2nd Pref Spouse Of Alien Resident
Unmarried Child Of Alien Resident
Child Alien P21, P22, P26 Or P27
Spouse Of Alien Resident
Unmar Son/Daugh Of Alien Res
Ch Of P21, P22, P26, P27 Alien
Lost Citz By Foreign Service
Support Person Of P-2
Culturally Unique Temp Artist/Entertainer
3rd Pref Pro Or Highly Skilled
Spouse Of Alien Class P31 Or P36
Child Of Alien Class P31 Or P36
Pro/Highly Skilled Imm
Spouse Of P31 Or P36 Alien
Child Of P31 Or P36 Alien
Lost Citz Parent's Forz ?????
Lost Citz Parent's Foreign Natz
Support Person Of P-3
Spouse/Child Of P1, P2 Or P3
4th Pref Mar Child Of US Citz
Spouse Of Alien Class P41 Or P46
Child Of Alien Class P41 Or P46
Married Son/Daug Of Citz
Sps Of Alien Class P41 Or P46
Ch Of P41 Or P46 Alien
5th Pref Bro/Sis Of US Citz
Spouse Of Alien Class P51 Or P56
Child Of Alien Class P51/P56
Brother/Sister Of Citizen
Spouse Of P51 Or P56 Alien
Child Of P51 Or P56 Alien
6th Pref Need Skill/Unskill Worker
6th Pref Spouse Class P61 Or P66
Child Of Alien Class P61/P66
Needed Skill/Unskill Worker
Sps Of P61 Or P66 Alien
Ch Of P61 Or P66 Alien
Ref Adj Under Sec 203(A)(7)
Cond Entry Under Pl 89-236
Cond Entry By Natural Calamity Vic
Refugee 7th Preference
Ref Adj Under Sec 203(A)(7)
Work Auth Card For Pacific Trust Terr
Citizen Of Palau
Adjustment Application Pending
Polish-Hungarian Parolee
Pacific Trust Terr-Employ Auth Doc
Pereales Class Member-Legalization Appl
Pereales Non-Class Member-Legalization
Appl
Indefinte Parolee (Imdac O
Q-1
Q-2
Q-3
Q1
Q1M
Q2
Q2M
Q3
Q3M
R-1
R-2
R-3
R1
R16
R1M
R2
R2M
R3
R4
R5
R51
R52
R53
R56
R57
R58
R86
RAD
RE
RE.
RE1
RE2
RE3
RE4
RE5
RE6
RE7
RE8
RE9
RE:
REC
REF
REM
REP
RF
RN6
RN7
RRA
RW
S1
S13
S16
S1D
S1W
Minister Of Religion
Spouse Of Alien Classifed As Q1
Null
International Cultural Exchange Visitor
Minister Of Religion
Irish Peace Process Cultural & Trng Program
Spouse Of Alien Classified Q1
Spouse/Child Of Q2
Child Of Alien Class Q1m
Certain Employees Or Former Employees Of
US Government
Accompanying Spouse/Child Of R-1
Accompanying Child Of Former Alien
Classified As R-1
Religous Worker
Replenishment Agricultural Worker
Emp/Form Emp Of U.S. Abroad
Spouse And Child Of R1
Accomp Spouse Of Alien Class R1
Person Paroled Into The US
Withdrawal
Stowaway
Conditional-Investor Pilot
Conditional-Spouse Of R51
Conditional-Child Of R51
Conditional-Investor Pilot
Conditional-Spouse Of R56
Conditional-Child Of R56
Refugee Paroled Into US Prior 4/1/80
Refugee Applicant Denied
Refugee
REFUGEE- Bwa
Refugee On/After 4/1/80
Spouse Of Refugee Re1
Child Of Refugee Class Re1
Derive Refugee Status From Re1
Haitian Refugee
Refugee Entry On/After 4/1/80
Spouse Of Refugee
Child Of Refugee
Perm Res Stat From Principal Refugee
REFUGEE- Bwa
Lpr Status Rescinded
Refugee
Removals/Per Ina Act 1952, Sec 252b
Refugee W/ Lpr App Pending
Refugee
Former H-1 Nonimmigrant Registered Nurse
Spouse/Child Of Rn6
Refugee Relief Act
Raw Applied At US Consulate
Special Agricultural Worker
American Indian Born In Canada
Seasonal Agricultural Worker Group 1
Legalization Denied Saw Group I
Seasonal Agricultural Workers
Page 79
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
S2
S26
S2D
S2W
S3
S4
S5
S6
S7
S8
S9
SA
SA1
SA2
SA3
SA6
SA7
SA8
SB1
SC1
SC2
SC6
SC7
SD1
SD2
SD3
SD6
SD7
SD8
SDF
SE1
SE2
SE3
SE6
SE7
SE8
SEH
SEK
SF1
SF2
SF6
SF7
SG1
SG2
SG6
SG7
SH1
SH2
SH6
SH7
SJ2
SJ6
Special Agricultural Worker
Seasonal Agricultural Worker Group 2
Legalization Denied Saw Group Ii
Seasonal Agricultural Workers
H1b1 Under Singapore/Chile Free Trade
Agreement Act
H1c Rn - Special Health Needs Area
Informant Of Criminal Organization
Informant Of Terrorism Information
Spouse Or Child Of S5 Or S6
H1a Registered Nurse
H2a Emergency Farm Worker
S Class Nonimmigrant - Referred For
Limited Asylum Hearing
Alien Born Indep W. Hemis Country
Spouse Alien Class Sa1 Or Sa6
Child Of Alien Class Sa1 Or Sa6
Alien Born In Independent Western
Hemisphere Country
Spouse Of Alien Class Sa1 Or Sa6
Child Of Alien Class Sa1 Or Sa6
Returning Resident
Lost US Citz By Marriage
Lost Citz By Foreign Service
Lost Citizenship By Marr
Lost Ctzship Ser Fgn Armed Forces
Minister Of Religion
Spouse Of Sd1
Child Of Sd1
Minister Of Religion
Spouse Of Sd6
Child Of Sd6
Suspected Document Fraud
Employees Of US Govt Abroad
Accompanying Spouse Of Se1
Accompanying Child Of Se1
Employee Of US Govt Abroad
Accompanying Spouse Of Se6
Accompanying Child Of Se6
Employee US Mission In Hong Kong
Employee US Mission In Hong Kong
Former Emp Of Panama Canal/Canal Zone
Gov
Accompany Spouse/Child Of Sf1
Former Emp Panama Canal/Canal Zone Gov
Accompanying Spouse/Child Of Sf6
Former Emp US Gov In Panama Canal
Accompanying Spouse/Child Sg1
Former Emp Of US Gov Panama Canal
Accompanying Spouse/Child Of Sg6
Form Empl Panama Canal Co/Govt
Accompanying Spouse/Child Sh1
Former Emp Canal Zone 4/1/79
Accompanying Spouse/Child Of Sh6
Spouse/Child Of Sj6
Med School Grad Pr 1-9-78
SJ7
SK1
SK2
SK3
SK4
SK6
SK7
SK8
SK9
SL1
SL6
SM0
SM1
SM2
SM3
SM4
SM5
SM6
SM7
SM8
SM9
SMO
SN1
SN2
SN3
SN4
SN6
SN7
SN8
SN9
SO1
SO2
SR1
SR2
SR3
SR6
SR7
SR8
ST
ST0
ST6
ST7
ST8
ST9
STC
SU0
SU2
SU6
Spouse/Child Of Sj6
Retired Employee Intl Organiza
Accompanying Spouse Sk1
Unmarried Child Intl Emp
Surviving Sp Deceased Intl Emp
Retired Employee Intl Organization
Accompanying Spouse Sk6
Unmarried Child Intl Employee
Surviving Sp Deceased Intl Emp
Juvenile Court Dependent
Juvenile Court Dependent
Spouse/Child Of Sm9
Alien U.S. Armed/12yrs/91)
Spouse Of Sm1
Child Of Sm1
Alien U.S. Armed/12yrs/91)
Spouse/Child Of Sm4
Alien U.S. Armed/12yrs After 10/1/91
Spouse Of Sm6
Child Of Sm6
Alien U.S. Armed/12yrs Before 10/1/91
Spouse Or Child Of Sm9
Certain Retired Nato6 Civilian Employee
Accompanying Spouse Of Sn1
Unmarried Son/Daughter Of Nato6 Civilian
Employee
Surviving Spouse Of Nato6 Civilian
Employee
Certain Retired Nato6 Civilian Employees
Accompanying Spouse Of Sn6
Unmarried Son/Daughter Of Nato6 Civilian
Employee
Surviving Spouse Of Nato6 Civilian
Employee
Legalization Appl-Sod Class Member W
Emp Auth
Legalization Appl-Sod Class Member No
Empl Auth
Religious Worker
Spouse Of Sr1
Child Of Sr1
Religious Worker
Spouse Of Sr6
Child Of Sr6
Stowaway
Paret Of St6
T1-Vic Severe Form Of Trafficking-Adj
Spouse Of St6
Child Of St6
Sibling Of A St6
Stowaway - Referred For Credible Fear
Interview
Parent Of Su6
Legalization Appl-Sugar Cane Class
Member No Ea
Victim Of Crime Act-U1-Adj
Page 80
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
SU7
SU8
SU9
SUP
SY6
SY7
SY8
T-1
T-2
T-3
T1
T1D
T1M
T2
T21
T22
T23
T26
T27
T28
T2D
T2M
T3
T3D
T3M
T4
T41
T42
T43
T46
T47
T48
T5
T51
T52
T53
T56
T57
T58
TA
TB
TC
TC1
TC2
TD
TF1
Spouse Of Su6
Child Of Su6
Sibling Of Su6
Su Ind W/Parol Stat Pre-Ent To US
Syrian Adj Under Pl 106-378
Spouse Od Ay6
Child Or Unmarried Son/Daughter Of Sy6
1st Pref Selected Alien
1st Pref Spouse Of Alien Class
1st Pref Child Of Alien Class
Victim Of Severe Form Of Trafficking In
Persons
Legalization Appl-Denied Temp Res StatusEwi
1st Pref Selected Alien
Spouse Of A Victim Of A Severe Form Of
Trafficking In Persons
Cond Status Denied/Reopen-Lpr Spouse
Cond Status Denied/Reopen-Unmarr Stepch
Of Lpr
Cond Status Denied/Reopen-Child Of C22
Cond Status Denied/Reopen-Lpr Spouse
Cond Status Denied/Reopen-Unmarr Stepch
Of Lpr
Cond Status Denied/Reopen-Child Of C27
Legalization Appl-Denied Temp Res StatusNonimm
1st Pref Spouse Of Alien Class T1m
Child Of Victim Of A Severe Form Of
Trafficking In Persons
Legalization Denied Temp Res Status-Evd
1st Pref Child Of Alien Class T1m
Parent Of Victim Of A Severe Form Of
Trafficking In Persons
Cond Status Denied/Reopen-Marr Stepch Of
USC
Cond Status Denied/Reopen-Spouse C41
Cond Status Denied/Reopen-Child Of C41
Cond Status Denied/Reopen-Marr Stepch Of
USC
Cond Status Denied/Reopen-Spouse C46
Cond Status Denied/Reopen-Child Of C46
Sibling Of A T1
Conditional-Targeted Employment Area
Conditional-Spouse Of T51
Conditional-Child Of T51
Conditional-Targeted Employment Area
Conditional-Spouse Of T56
Conditional-Child Of T56
Section 210 Special Agricultural Worker
Canadian Spouse/Child Of Tc
US-Canada Free Trade Agreement
Cond Status Denied/Reopen-Spouse Of USC
Cond Status Denied/Reopen-Child Of USC
Spouse/Child Of Tn
Cond Status Denied/Reopen-Fiance(E) Of
TF2
TI
TIA
TN
TN1
TN2
TPS
TR
TR1
TR2
TR6
TR7
TRM
TS1
TS2
TW1
TW2
TW3
U
U-1
U-2
U1
U1M
U2
U2M
U3
U4
U5
UCR
UN
USC
UU
V-1
V-2
V-3
V1
V1M
V2
V2M
V3
VD
VI0
VI5
VI6
VI7
VIO
W-1
W-2
W-3
W-4
W-5
USC
Cond Status Denied/Reopen-Child Of
Fiance(E) Of USC
Temporarily Inadmissible Under Section
235(C) Of Ina
Temporarily Inadmissible - Section 235(C)
Of Ina - Referred For Asylum Hearing
Nafta Professional Business
Nafta From Canada
Nafta From Mexico
Temporary Protective Status
Section 245 Legalization
Raw Applied Within US
Raw Applied Outside U.S.
Cond Status Denied/Reopen-Spouse Of USC
Cond Status Denied/Reopen-Child Of USC
Cond Resident Status Terminated
Section 210 Saw Group I
Section 210 Temp Saw Group Ii
Temp Res Ewi Prior To 1982 Sec 245a
Temp Res Nonimm Overstay Sec 245a
Temporary Resident Sec 245 Blanket Evd
Group
Parent Of USC
2nd Pref Parent Of U.S. Citize
2nd Pref Unmarried Son/Dau US
Victim Of Criminal Activity
2nd Pref Parent Of USC
Spouse Of A Victim Of Criminal Activity
2nd Pref Unmarried Son/Daughter Of USC
Child Of A Victim Of Criminal Activity
Parent Of A Victim Of Criminal Activity
Unmarried, Under 18, Sibling Of U1
U.S. Crew
Unknown, None, Or Not Reported
US Citizen
Unknown Or Not Reported
3rd Pref
Unmarried Son Or Daughter Of 3rd Pref
Life Act
Life Act
3rd Pref Spouse Of Alien Resident
Life Act
3rd Pref Unmarried Son/Daughter Of Lpr
Life Act
Voluntary Departure
Adj Parent Of US Citz Adj Pl-271
Parent USC Adnutted Vi6 Vi7 Pl-271
Adm Virgin Is As H-2
Sps-Ch Of H-2 Adm Virgin Island
Adj Parent Of US Citz 71
4th Pref Brother/Sister US Cit
4th Pref Married Child US Citz
4th Pref Accom Spouse Of W1 Or
4th Pref Accom Child Of W1 Or
4th Pref Adopted Child US Citz
Page 81
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
W1
W16
W1D
W2
W26
W2D
W3
W36
W3D
W4
W46
W5
WA
WB
WD
WD2
WI
WID
WP
WR
WT
X
X-5
X5
XA
XA3
XB
XB3
XE3
XF3
XN3
XR3
XX
XXX
Y-1
Y-2
Y-3
Y-4
Y-5
Y-6
Y-7
Y-8
Y-9
Y1
Y10
Y11
Applicant For Temp Legal Resident Status
Temp Res Status-Legalization Entered
Before 1/1/82
Denied-Legalization-Perm Resident Status
Applicant For Temp Legal Resident Status
Legalization Temp Res Prior 1/1/82
Denied-Legalization-Perm Resident Status
4th Pref Accom Spouse Of W1 Or W2
Legalization Blanket Evd
Denied-Legalization-Perm Resident Status
4th Pref Accom Child Of W1 Or W2
Legalized Aliens Adj Lpr Underlife
4th Pref Adopted Child USC
Visa Waiver - Referred For Limited Asylum
Hearing
Visa Waiver Pilot-Visitor For Business
Entry Withdrawal
Withdrawal - Application Terminated
Without Prejudice
Without Inspection
Visa Waiver - Inspection Deferred
Visa Waiver - Prosecution
Visa Waiver Pilot Refusal
Visa Waiver Pilot Visitor For Pleasure
Nonpreference Quota Immigrant
Non-Preference Quota Immigrant
Nonpreference Quota Immigrant
Child Born Subsequent To Parent Visa
Issuance
Child Born Subsequent To Parent Visa
Issuance
Presumed Lawfully Admitted For Permanent
Residence
Presumed Lpr
Parent Is An Employ-Based Pref Immigrant
Parent Is A Family Preference Immigrant
Parent Is Not In 1 Of The Above 3 Cat
Parent Is An Immediate Relative
Test Inspection Results
Test Coa For Testing Only
Ger Expelle In W Ger, Ber/Aust
Escapee In W Ger, Berlin/Austr
Escapee Nato Countries
Polish Vet Ref In British Isle
Italian Refugee Italy Or Tries
Italian Relative US Citz/Resid
Greek Refugee In Greece
Greek Rel US Citz/Resident
Dutch Ref In Netherlands
German Expellee In Western Germany,
Berlin & Austria
Dutch Relative Of USC/Resident Residing In
Netherlands
Far East Refugee - Asian
Y12
Y13
Y14
Y15
Y16
Y2
Y2A
Y3
Y4
Y5
Y6
Y64
Y7
Y8
Y9
Z-0
Z-1
Z-2
Z-3
Z-4
Z-5
Z-6
Z-7
Z-8
Z-9
Z0
Z03
Z1
Z11
Z13
Z14
Z15
Z2
Z3
Z33
Z4
Z41
Z43
Z5
Z56
Z57
Z6
Z66
Z7
Z8
Z83
Z9
Z91
ZM1
ZM2
ZN
ZO
Far East Refugee - Asian
Chinese Refugee
Palestine Refugee In The Near East
Orphan Under 10 Years Of Age
Refugee Relief Act, Adjustment
Escapee In W Ger, Berlin/Austria
Recent Hungarian Escapee
Escapee Nato Countries
Polish Verteran Refugee In The British Isles
Italian Refugee In Italy Or Trieste
Italian Relative US Citz/Resident
Refugee Relief Act, Adjustment
Greek Refugee In Greece
Greek Rel US Citz/Resident
Dutch Refugee In Netherlands
Alien Grant Sus Dep Ent P 5/19
Multiple Classes
Private Bill
Adjustment Of Status Of Orphan
Adm Perm Res 6/28/40-6/30/48
Adj Of Spouse/Child Of Z6
Adj Of Imm Rel Citizen/Spec Im
Adj Pref/Non-Pref Immigrant
Creation Of Record Of Admission
Rec Perm Res 6/30/24-6/28/40
Alien Granted Suspension Of Deportation
Alien Granted Suspension Of Deportation
Sus Dep/Adj Imm Rel/Special Imm
Vawa Suspend Deprt/Cancl Removl
Suspend Deprt/Cancel Removal Nacara
Multiple Classes
Null
Rec Adm Perm Res Pr 7/1/24
Private Bill
Adjustment By Private Law
Adj Pvt Law (Imm Rel Ctz/Spec Imm)
Adjustment
Sus Dep Crewman Ent Pr 7/64
Granted Suspension Of Deportation
Adjustment Of Principal Beneficiary
Adm Perm Res 6/28/40-6/30/48
Adj Of Spouse/Child Of Z6
Adj Of Imm Rel Citizen/Spec Imm
Adj Under Section 13
Adj Pref/Non-Pref Immigrant
Adjustment Of Foreign Official
Zambrano Class Member-Empl
Authorization
Zambrano Class Member-No Empl
Authorization
Null
Creation Of Record Of Admission
Page 82
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
G. APPENDIX – SAVE COUNTRY CODES
The following list described the Country Codes used by SAVE and their meanings. At the time this document was
prepared, this list was complete. USCIS may make changes to the codes over time.
Code
ADEN
AFGHA
AFRIC
ALBAN
ALGER
ANDOR
ANGOL
ANGUI
ANQUI
ANTAR
ANTIG
ANTIL
ARABI
ARABJ
ARGEN
ARMEN
ARUBA
ASAMO
ASIA
AUSTR
AZERB
AZORE
BAHAM
BAHRA
BALEA
BANGL
BARBA
BARBU
BELA
BELAR
BELGI
BELIZ
BENIN
BERMU
BGUIA
BHOND
BHUTA
BISSA
BOLIV
BONAI
BONIN
BORNE
BOSNI
BOTSW
BRADR
BRASI
BRAZI
BRHON
BRUNE
BULGA
Description
UNKNOWN
AFGHANISTAN
UNKNOWN
ALBANIA
ALGERIA
ANDORRA
ANGOLA
ANGUILLA
ANQUILLA
ANTARCTICA
ANTIGUA AND BARBUDA
NETHERLANDS ANTILLES
ARABIAN PENINSULA
UNKNOWN
ARGENTINA
ARMENIA
ARUBA
AMERICAN SAMOA
UNKNOWN
AUSTRIA
AZERBAIJAN
AZORES
BAHAMAS
BAHRAIN
UNKNOWN
BANGLADESH
BARBADOS
BARBUDA
BELARUS
BELARUS
BELGIUM
BELIZE
BENIN
BERMUDA
UNKNOWN
UNKNOWN
BHUTAN
GUINEA-BISSAU
BOLIVIA
BONAIRE
BENIN
BORNEO
BOSNIA AND HERZEGOWINA
BOTSWANA
UNKNOWN
BRASIL
BRAZIL
UNKNOWN
BRUNEI DARUSSALAM
BULGARIA
BURKI
BURMA
BURUN
BVI
BVIRG
BYELA
CAFRI
CAICO
CAMBO
CAMER
CAMPB
CANAD
CANAL
CANAR
CAPEV
CAR
CAYMA
CENTR
CEYLO
CHAD
CHANN
CHILE
CHINA
CHRIS
COCOS
COL
COLOM
COMOR
CONGO
COOK
COOKI
CORSI
COSTA
COTED
CRETE
CROAT
CSSR
CUBA
CURAC
CVI
CYPRU
CZ
CZECH
CZREP
DAHOM
DANZI
DECON
DENMA
DJIBO
DOMIN
DR
BURKINA FASO
BURMA
BURUNDI
BRITISH VIRGIN ISLANDS
BRITISH VIRGIN ISLANDS
BYELARUS
CENTRAL AFRICAN REPUBLIC
CAICOS ISLANDS
CAMBODIA
CAMEROON
CAMPBELL ISLAND
CANADA
UNKNOWN
CANARY ISLANDS
CAPE VERDE
UNKNOWN
CAYMAN ISLANDS
UNKNOWN
UNKNOWN
CHAD
UNKNOWN
CHILE
CHINA
CHRISTMAS ISLAND
COCOS (KEELING) ISLANDS
UNKNOWN
COLOMBIA
COMOROS
CONGO
COOK ISLANDS
COOK ISLAND
CORSICA
COSTA RICA
COTE D'IVOIRE
CRETE
CROATIA (local name: Hrvatska)
UNKNOWN
CUBA
CURACUO
UNKNOWN
CYPRUS
CZECH REPUBLIC
CZECH REPUBLIC
CZECH REPUBLIC
UNKNOWN
DANZI ISLAND
DEMOCRATIC REPUBLIC OF CONGO
DENMARK
DJIBOUTI
DOMINICA
DOMINICAN REPUBLIC
Page 83
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
ECUAD
EGERM
EGYPT
ELSAL
ENGLA
EQUAT
ERITR
ESTON
ETHIO
ETMOR
EUROP
FALKL
FAROE
FGUIA
FIJI
FINLA
FORMO
FPOLY
FRANC
FRG
FRGUI
FSAAA
FSM
FSOMA
GABON
GAMBI
GDR
GEORG
GERMA
GHANA
GIBRA
GILBE
GOA
GRBR
GREEC
GREEN
GRENA
GUADE
GUAM
GUATE
GUIBI
GUINE
GUYAN
HAITI
HOLLA
HONDU
HONGK
HUNG
HUNGA
ICELA
IFNI
INCIA
INDIA
INDOC
INDON
INICA
ECUADOR
EAST GERMANY
EGYPT
EL SALVADOR
ENGLAND
EQUATORIAL GUINEA
ERITREA
ESTONIA
ETHIOPIA
EAST TIMOR
EUROPA ISLAND
FALKLAND ISLANDS (MALVINAS)
FAROE ISLAND
FRENCH GUIANA
FIJI
FINLAND
FORMOSA ISLAND
FRENCH POLYNESIA
FRANCE
WEST GERMANY
FRENCH GUIANA
UNKNOWN
MICRONESIA,FEDERATED STATES OF
UNKNOWN
GABON
GAMBIA
EAST GERMANY
GEORGIA
GERMANY
GHANA
GIBRALTAR
UNKNOWN
UNKNOWN
GREAT BRITTAN
GREECE
GREENLAND
GRENADA
GUADELOUPE
GUAM
GUATEMALA
GUINEA-BISSAU
GUINEA
GUYANA
HAITI
HOLLAND
HONDURAS
HONG KONG
UNKNOWN
HUNGARY
ICELAND
UNKNOWN
UNKNOWN
INDIA
INDOCHINA
INDONESIA
DOMINICA
INIDA
IRAN
IRAQ
IRELA
ISRAE
ISRAJ
ITA
ITALY
IVORY
JAMAI
JAPAN
JAVA
JERSE
JORDA
KAMPU
KAZAK
KENYA
KERMA
KIRIB
KIT
KOREA
KUWAI
KYRGY
LAOS
LATVI
LEBAN
LESOT
LIBER
LIBYA
LIECH
LITHU
LUXEM
MACAO
MACAU
MACED
MADAG
MADEI
MALAW
MALAY
MALDI
MALI
MALTA
MANCH
MARIA
MARQU
MARSH
MARTI
MAUTA
MAUTI
MEX
MEXIC
MICRO
MIDWA
MOLDO
MONAC
MONGO
UNKNOWN
IRAN (ISLAMIC REPUBLIC OF)
IRAQ
IRELAND
ISRAEL
UNKNOWN
UNKNOWN
ITALY
IVORY COAST
JAMAICA
JAPAN
JAVA
JERSEY ISLAND
JORDAN
KAMPUCHEA
KAZAKHSTAN
KENYA
UNKNOWN
KIRIBATI
UNKNOWN
KOREA, REPUBLIC OF
KUWAIT
KYRGYZSTAN
LAOS
LATVIA
LEBANON
LESOTHO
LIBERIA
LIBYAN ARAB JAMAHIRIYA
LIECHTENSTEIN
LITHUANIA
LUXEMBOURG
MACAO
MACAU
MACEDONIA
MADAGASCAR
UNKNOWN
MALAWI
MALAYSIA
MALDIVES
MALI
MALTA
UNKNOWN
MARIANA ISLANDS,NORTHERN
UNKNOWN
MARSHALL ISLANDS
MARTINIQUE
MAURITANIA
MAURITIUS
MEXICO
MEXICO
MICRONESIA
MIDWAY
MOLDOVA, REPUBLIC OF
MONACO
MONGOLIA
Page 84
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
MONTS
MOROC
MOZAM
MUSCA
NAMER
NAMIB
NANTI
NAURU
NBORN
NEGUI
NEPAL
NETHE
NEVIS
NEWCA
NEWGU
NEWHE
NEWZE
NGUIA
NICAR
NIEI
NIGE
NIGEI
NIGER
NIGIA
NIGIR
NIREL
NIUE
NKORE
NMARI
NORFO
NORWA
NQUOT
NRHOD
NSTMA
NVIET
NYEME
OCEAN
OKINA
OMAN
ORCLE
OUTER
PACIF
PAFIC
PAKIS
PALAU
PALES
PANAM
PAPUA
PARAG
PERU
PGUIN
PHILI
PITCA
POLAN
POLYN
PORTU
MONTSERRAT
MOROCCO
MOZAMBIQUE
UNKNOWN
UNKNOWN
NAMIBIA
UNKNOWN
NAURU
UNKNOWN
UNKNOWN
NEPAL
NETHERLANDS
NEVIS
NEW CALEDONIA
NEW GUINEA
UNKNOWN
NEW ZEALAND
UNKNOWN
NICARAGUA
NIEI
NIGER
UNKNOWN
NIGERIA
NIGERIA
UNKNOWN
UNKNOWN
NIUE
NORTH KOREA
UNKNOWN
NORFOLK ISLAND
NORWAY
NON-QUOTA IMMIGRANT
UNKNOWN
UNKNOWN
UNKNOWN
UNKNOWN
OCEANA
OKINAWA
OMAN
ORACLE ISLAND
UNKNOWN
UNKNOWN
UNKNOWN
PAKISTAN
PALAU
UNKNOWN
PANAMA
PAPUA NEW GUINEA
PARAGUAY
PERU
UNKNOWN
PHILIPPINES
PITCAIRN
POLAND
FRENCH POLYNESIA
PORTUGAL
PR
PRINC
PUERT
QATAR
RALIA
RAPAI
REUNI
ROMAN
RUSSI
RWAND
RYUKY
S
SABA
SABAH
SAFRI
SAIPA
SALSA
SALVA
SAMER
SAMOA
SANAA
SANMA
SAOTO
SARAW
SAUDI
SCOTL
SENEG
SERBI
SEYCH
SHIP
SIERR
SINGA
SKORE
SLOVA
SLOVE
SNA
SOLOM
SOMAL
SOMBR
SPAIN
SRHOD
SRILA
STATE
STCHR
STEUS
STHEL
STKIT
STLUC
STMAR
STPIE
STRIA
STVIN
SUDAN
SURIN
SVIET
SWAIN
UNKNOWN
PRINCIPE
PUERTO RICO
QATAR
AUSTRALIA
UNKNOWN
REUNION
ROMANIA
RUSSIAN FEDERATION
RWANDA
UNKNOWN
UNKNOWN
UNKNOWN
UNKNOWN
SOUTH AFRICA
SAIPAN
UNKNOWN
UNKNOWN
UNKNOWN
SAMOA
UNKNOWN
SAN MARINO
SAO TOME AND PRINCIPE
UNKNOWN
SAUDI ARABIA
SCOTLAND
SENEGAL
UNKNOWN
SEYCHELLES
BORN ON BOARD SHIP
SIERRA LEONE
SINGAPORE
SOUTH KOREA
SLOVAKIA (Slovak Republic)
SLOVENIA
UNKNOWN
SOLOMON ISLANDS
SOMALIA
UNKNOWN
SPAIN
UNKNOWN
SRI LANKA
UNITED STATES
UNKNOWN
UNKNOWN
ST. HELENA
ST. KITTS-NEVIS
SANTA LUCIA ISLAND
UNKNOWN
ST. PIERRE AND MIQUELON
AUSTRIA
SAINT VINCENT ISLAND
SUDAN
SURINAME
UNKNOWN
UNKNOWN
Page 85
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
SWAN
SWAZI
SWEDE
SWITZ
SYRIA
TAIWA
TAJIK
TANGA
TANGI
TANZA
TASMA
TEST
THAIL
TIBET
TIMOR
TOBAG
TOGO
TONGA
TRINI
TRUST
TUNIS
TURKE
TURKM
TURKS
TUVAL
UAE
UAL
UAR
UGAND
UINEA
UNKNOWN
SWAZILAND
SWEDEN
SWITZERLAND
SYRIAN ARAB REPUBLIC
TAIWAN, PROVINCE OF CHINA
TAJIKISTAN
UNKNOWN
TANGIERS
TANZANIA, UNITED REPUBLIC OF
TASMANIA
UNKNOWN
THAILAND
TIBET
TIMOR
TOBAGO
TOGO
TONGA
TRINIDAD AND TOBAGO
UNKNOWN
TUNISIA
TURKEY
TURKMENISTAN
TURKS AND CAICOS ISLANDS
TUVALU
UNITED ARAB EMIRATES
UNKNOWN
UNKNOWN
UGANDA
GUINEA
UK
UKRAI
UNION
UNKNO
UPPER
URUGU
US
USA
USSR
UZBEK
VANUA
VATIC
VELEZ
VENEZ
VIETN
VIRGI
WAKE
WALES
WALLI
WASHI
WGERM
WSAHA
WSAMO
YEMEN
YUGOS
ZAIRE
ZAMBI
ZANZI
ZIMBA
UNITED KINGDOM
UKRAINE
UNION ISLAND
UNKNOWN COUNTRY
UNKNOWN
URUGUAY
UNITED STATES
UNITED STATES
USSR
UZBEKISTAN
VANUATU
VATICAN CITY STATE (HOLY SEE)
UNKNOWN
VENEZUELA
VIET NAM
VIRGIN ISLANDS (U.S.)
WAKE ISLAND
WALES
WALLIS AND FUTUNA ISLANDS
UNKNOWN
WEST GERMANY
WESTERN SAHARA
WESTERN SAMOA
YEMEN
YUGOSLAVIA
ZAIRE
ZAMBIA
UNKNOWN
ZIMBABWE
Page 86
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
H. APPENDIX - GLOSSARY
This glossary defines acronyms used in this document as well as terms that have a special meaning in VLS.
AAMVA
American Association of Motor Vehicle Administrators
AAMVAnet
The telecommunication network which electronically links all Motor Vehicle Departments and
other public and private sector authorized users.
AMIE
AAMVAnet Message Interchange Envelope; the definition of the data elements in an AAMVAnet
Standard Message.
ANSI
American National Standards Institute
ANSI D-20
A common set of coding instructions for data elements related to traffic record systems.
CICS
Customer Information Control System; an IBM teleprocessing monitor.
Data (Element)
Dictionary
The list of data elements and their definitions which are used in the application. Each data element
is listed by its business and call list name, element code, description, values, type and length.
Development
All of the activities necessary to create the system specification and complete internal (not
structured) testing. These activities include analysis, design, programming, and documenting the
business and technical specifications.
DHS
Department of Homeland Security
DLN
Driver's License Number
DOB
Date of Birth
Driver
Any individual who has ever held a driver license or who has been known by a state Department of
Motor Vehicles (DMV) to drive.
Driver License
A license issued by a jurisdiction to an individual to operate a motor vehicle. This includes all
licenses issued, not just those that are current.
Electronic
Means
Electronic means include (but are not limited to): internet, interactive voice response (IVR) and
telephone.
ID
Identification
Implementation
The relatively short period of time necessary to move programs, utilities, etc., from the development
region to the production region. This phase also includes performance of structured testing with the
pilot states.
Linenum
An AAMVAnet convention which is used in the documentation to indicate how many occurrences
of a block type are valid, and used in the transaction to indicate the occurrence number.
Maintenance
Any changes to the system after operation has begun.
MEC
Message Exchange Control
Message
Originator
The entity that builds a message.
NCB
Network Control Block
NCS
Network Control Software, an AAMVAnet-supported utility which routes messages. NCS allows
each state (and central site) to establish a session with NCS, rather than requiring a session with
each other AAMVAnet user.
NDR
National Driver Register
Operation
The period after structured or acceptance testing is complete and VLS transactions are being sent
and received by the pilot participants.
H APPENDIX - GLOSSARY
Page 87
VLS Jurisdiction Functional Specification (AMIE) Release 1.2.2
PIC
Process Implementation Chart
RAR
Return as Received
Solicited
Message
This message contains information in response to some request. Usually, this message is received
by the originator of a transaction in response to the initial message of the transaction, e.g., the
transaction originator sends the initial message of a transaction to request information. The
response that is returned to the transaction originator is the solicited message.
SAVE
Systematic Alien Verification for Entitlements (SAVE) Program.
SSN
Social Security Number
Transaction
A series of messages sent to accomplish a specific business function.
Transaction
Originator
The entity that started the transaction process.
UNI
Unified Network Interface
Unsolicited
Message
This message contains information not requested by the receiver. Usually it is the first message
within a transaction.
USCIS
United States Citizenship and Immigration Services (USCIS).
H APPENDIX - GLOSSARY
Page 88