NIEM Examples - Immigration Alien Transactions (IAQ/IAR)
NIEM
Immigration Alien NIEM Specifications
This section describes formats and provides examples for INS's Law Enforcement Support Center queries and responses (IAQ/IAR).
All Nlets NIEM messages must be based on the Nlets NIEM Message Structure and include the standard Nlets XML Header as detailed in Message Structure. The NIEM header and hierarchy of the elements in this section have been omitted to avoid redundancy. The associated schemas and instances should be consulted to determine the correct XPaths of the elements.
Element Dictionary
Transaction types detailed below include: LESC Query (IAQ) and LESC Response (IAR).
Query Formats
LESC Query (IAQ)
n2:NLETSInquiryData
This element will contain all elements specific to this transaction.
n2:PurposeCode
This element identifies the reason for query.
This optional element contains a code indicating the purpose for which the record is being requested.
Valid values are: C, F
n2:ResponseAttentionDescriptionText
This element contains identification of the person or entity to whose attention the driver history response will be
directed.
This optional element contains identification of the person or entity to whose attention the response will be directed.
nc:ContactInformation
Details about how to contact a person or an organization.
nc:ContactTelephoneNumber
A telephone number for a telecommunication device by which a person or organization may be contacted.
nc:FullTelephoneNumber
A full telephone number.
nc:TelephoneNumberFullID
A complete telephone number.
Telephone number for the inquirer.
n2:Person
This element encapsulates the information about the person being queried.
j4:ChargeNCICCode
This element will indicate the NCIC offense code, most serious charge. * If no code is available use generic code
of "0399".
nc:Status
A state of something or someone.
nc:StatusText
A status or condition of something or someone.
This element will indicate whether a subject is in custody or not. Valid values are "In Custody" or "Not In Custody".
nc:DriverLicense
Details about a license issued to a person granting driving privileges.
nc:DriverLicenseIdentification
Details about a driver license identifier or driver license permit identifier, including the number and state.
nc:IdentificationID
A value that identifies something.
n2:PersonFather
This optional element will contain information about the person's father.
nc:PersonName
A combination of names and/or titles by which a person is known.
nc:PersonGivenName
A first name of a person.
This optional element containing a person's first name may be sent via XML if available but will only be forwarded
onto users receiving XML.
nc:PersonSurName
A last name or family name of a person.
This optional element containing a person's last name may be sent via XML if available but will only be forwarded
onto users receiving XML.
n2:PersonMother
This optional element will contain information about the person's mother.
nc:PersonName
A combination of names and/or titles by which a person is known.
nc:PersonGivenName
A first name of a person.
This optional element containing a person's first name may be sent via XML if available but will only be forwarded
onto users receiving XML.
nc:PersonMaidenName
An original surname of a person before changed by marriage.
This optional element will contain a mother's maiden name.
j4:PersonAugmentation
Additional information about a person.
j4:PersonBirthPlaceCode
A state or country of a person's birth.
This element contains the birthplace for the person being queried on. This data in this element should conform
with NCIC POB codes.
j4:PersonFBIIdentification
A number issued by the FBI's Automated Fingerprint Identification System (AFIS) based on submitted
fingerprints.
nc:IdentificationID
A value that identifies something.
This optional element will contain the FBI number of the person being queried on.
j4:PersonStateFingerprintIdentification
An identifier assigned to a person by a state identification bureau, generally based on submission of the person's
fingerprints to the state's Automated Fingerprint Identification System (AFIS).
nc:IdentificationID
A value that identifies something.
This optional element will contain the SID number of the person being queried on.
nc:PersonBirthDate
A date a person was born.
nc:Date
A full date.
This element contains the DOB for the person being queried on. This data in this element must be in xsd:date
format, that is: yyyy-mm-dd
nc:PersonEyeColorText
A color of the eyes of a person.
Optional element containing a subject's eye color. Value should conform to NCIC EYE codes.
nc:PersonHeightMeasure
A measurement of the height of a person.
nc:MeasurePointValue
A specific measurement value.
Optional element containing subject's height in NCIC format' 3 digits indicating feet followed by inches. For
instance, a subject that is 5'11" would have the height value "511".
nc:PersonName
A combination of names and/or titles by which a person is known.
nc:PersonGivenName
A first name of a person.
This optional element containing a person's first name may be sent via XML if available but will only be forwarded
onto users receiving XML.
nc:PersonMiddleName
A middle name of a person.
This optional element containing a person's middle name may be sent via XML if available but will only be
forwarded onto users receiving XML.
nc:PersonSurName
A last name or family name of a person.
This optional element containing a person's last name may be sent via XML if available but will only be forwarded
onto users receiving XML.
nc:PersonFullName
A complete name of a person.
This required element must contain the full name of the person in the format LAST,FIRST MIDDLE. The data from
this element is the only name data that will be passed onto users receiving text.
nc:PersonOtherIdentification
Information about an identifier with a kind that is not explicitly defined in the standard that refers to a person within
a certain domain.
nc:IdentificationID
A value that identifies something.
Optional element containing alien registration number, passport number, booking number, or miscellaneous
number. This is a key ICE file identifier and should be used if known.
nc:IdentificationCategoryDescriptionText
A description of a kind of identification.
Should be set to AR to indicate that the ID is Alien Registration. Set to PP to indicate that the ID is Passport.
Set to Booking to indicate that the ID is a booking number.
nc:PersonSexCode
A gender or sex of a person.
GJXDM: A code identifying the gender or sex of a person. Value must be M, F or U.
nc:PersonSSNIdentification
A unique reference to a living person; assigned by the United States Social Security Administration.
nc:IdentificationID
A value that identifies something.
Optional element containing SSN.
nc:PersonWeightMeasure
A measurement of the weight of a person.
nc:MeasurePointValue
A specific measurement value.
element containing the subject's weight in pounds.
n2:Remarks
This optional element may include additional information and remarks.
Response Formats
LESC Response (IAR)
n2:NLETSResponseData
n2:ResponseText
This element will contain the free text response. Nlets recommends the use of a CDATA section
to ensure that the response does not contain any characters illegal in XML.
Immigration Alien NIEM Examples
Example 1: Immigration Alien query.
<n2:NLETS xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" n2:version="4.00" xmlns:nc="http://niem.gov/niem/niem-core/2.0" xmlns:n2="http://www.nlets.org/niem/1.0">
<n2:NLETSMessageHeader>
<nh2:MessageKeyCodeText>IAQ</nh2:MessageKeyCodeText>
<nh2:OriginatingORIID>AZNLETS43</nh2:OriginatingORIID>
<nh2:DestinationORIID>P3</nh2:DestinationORIID>
<nh2:DocumentControlFieldText>CONTROLFLD</nh2:DocumentControlFieldText>
</n2:NLETSMessageHeader>
<n2:NLETSInquiryData n2:key="IAQ">
<n2:PurposeCode>J</n2:PurposeCode>
<n2:ResponseAttentionDescriptionText>OFC R P MCMURPHY</n2:ResponseAttentionDescriptionText>
<nc:ContactInformation>
<nc:ContactTelephoneNumber>
<nc:FullTelephoneNumber>
<nc:TelephoneNumberFullID>602 652 2000</nc:TelephoneNumberFullID>
</nc:FullTelephoneNumber>
</nc:ContactTelephoneNumber>
</nc:ContactInformation>
<n2:Person>
<nc:PersonBirthDate>
<nc:Date>1945-06-10</nc:Date>
</nc:PersonBirthDate>
<nc:PersonEyeColorText>BLUE</nc:PersonEyeColorText>
<nc:PersonHeightMeasure>
<nc:MeasurePointValue>6.2</nc:MeasurePointValue>
</nc:PersonHeightMeasure>
<nc:PersonName>
<nc:PersonGivenName>String</nc:PersonGivenName>
<nc:PersonMiddleName>String</nc:PersonMiddleName>
<nc:PersonSurName>String</nc:PersonSurName>
<nc:PersonMaidenName>String</nc:PersonMaidenName>
<nc:PersonFullName>Doe, John</nc:PersonFullName>
</nc:PersonName>
<nc:PersonOtherIdentification>
<nc:IdentificationID>Alien123</nc:IdentificationID>
<nc:IdentificationCategoryDescriptionText>AR</nc:IdentificationCategoryDescriptionText>
</nc:PersonOtherIdentification>
<nc:PersonOtherIdentification>
<nc:IdentificationID>Passport123</nc:IdentificationID>
<nc:IdentificationCategoryDescriptionText>PP</nc:IdentificationCategoryDescriptionText>
</nc:PersonOtherIdentification>
<nc:PersonOtherIdentification>
<nc:IdentificationID>Booking123</nc:IdentificationID>
<nc:IdentificationCategoryDescriptionText>ID</nc:IdentificationCategoryDescriptionText>
</nc:PersonOtherIdentification>
<nc:PersonSexCode>F</nc:PersonSexCode>
<nc:PersonSSNIdentification>
<nc:IdentificationID>123456789</nc:IdentificationID>
</nc:PersonSSNIdentification>
<nc:PersonWeightMeasure>
<nc:MeasurePointValue>200</nc:MeasurePointValue>
</nc:PersonWeightMeasure>
<j:PersonAugmentation xmlns:j="http://niem.gov/niem/domains/jxdm/4.1">
<j:PersonBirthPlaceCode>MM</j:PersonBirthPlaceCode>
<j:PersonFBIIdentification>
<nc:IdentificationID>FBI123</nc:IdentificationID>
</j:PersonFBIIdentification>
<j:PersonStateFingerprintIdentification>
<nc:IdentificationID>SID123</nc:IdentificationID>
</j:PersonStateFingerprintIdentification>
</j:PersonAugmentation>
<nc:Status>
<nc:StatusText>In Custody</nc:StatusText>
</nc:Status>
<nc:DriverLicense>
<nc:DriverLicenseIdentification>
<nc:IdentificationID>DL123123</nc:IdentificationID>
</nc:DriverLicenseIdentification>
</nc:DriverLicense>
<n2:PersonFather>
<nc:PersonName>
<nc:PersonGivenName>Father</nc:PersonGivenName>
<nc:PersonSurName>Doe</nc:PersonSurName>
<nc:PersonFullName>Doe, Father</nc:PersonFullName>
</nc:PersonName>
</n2:PersonFather>
<n2:PersonMother>
<nc:PersonName>
<nc:PersonGivenName>Mother</nc:PersonGivenName>
<nc:PersonMaidenName>Maiden, Mother</nc:PersonMaidenName>
<nc:PersonFullName>Doe, Mother</nc:PersonFullName>
</nc:PersonName>
</n2:PersonMother>
<j:ChargeNCICCode xmlns:j="http://niem.gov/niem/domains/jxdm/4.1">0399</j:ChargeNCICCode>
</n2:Person>
<n2:Remarks>NLETS TEST MESSAGE </n2:Remarks>
</n2:NLETSInquiryData>
</n2:NLETS>
Example 2: Immigration Alien response.
<n2:NLETS xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" n2:version="4.00" xmlns:nc="http://niem.gov/niem/niem-core/2.0" xmlns:n2="http://www.nlets.org/niem/1.0">
<n2:NLETSMessageHeader>
<nh2:MessageKeyCodeText>IAR</nh2:MessageKeyCodeText>
<nh2:OriginatingORIID>AZNLETS20</nh2:OriginatingORIID>
<nh2:DestinationORIID>AZNLETS20</nh2:DestinationORIID>
<nh2:DocumentControlFieldText><![CDATA[1234567890]]></nh2:DocumentControlFieldText>
<nh2:MessageReceiveDate>06/22/2019</nh2:MessageReceiveDate>
<nh2:MessageReceiveTime>09:25</nh2:MessageReceiveTime>
<nh2:MessageSendDate>06/22/2019</nh2:MessageSendDate>
<nh2:MessageSendTime>09:25</nh2:MessageSendTime>
<nh2:ReceiveMessageNumeric>12345</nh2:ReceiveMessageNumeric>
<nh2:SendMessageNumeric>12345</nh2:SendMessageNumeric>
</n2:NLETSMessageHeader>
<n2:NLETSResponseData n2:key="IAR">
<n2:ResponseText><![CDATA[
*** LAW ENFORCEMENT SENSITIVE ***
IAQ RECEIVED: 2019/06/22 11:12 EDT
ORI/ AZNLETS20 ATN/ NLETS_ANALYST PHN/ 8005284020 BKN/
NAM/ MOUSE, MICKEY FAUNTLEROY DOB/ 11/18/1928 CUS/ N
OFF/ 0239 PUR/ F POB/ DR SEX/ M
FBI/ ARN/ SOC/ 123456789 SID/ OLN/ MNU/
PAS/ REM/ APPEAL, NTN - 123456789 LESC ID:12345678
**** QUERY MESSAGE TEXT ENDS - L.E.S.C. RESPONSE BEGINS ****
THIS IS NOT A GOVERNMENT DETAINER! THIS INFORMATION IS FOR
LAW ENFORCEMENT USE AND IS BEING PROVIDED FOR INFORMATIONAL
PURPOSES ONLY. THIS RESPONSE IS NOT SUPPORTED BY FINGERPRINTS.
**** BASED ON THE INFORMATION PROVIDED *****
THE FOLLOWING I.C.E. RECORD APPEARS TO RELATE:
NAM/ MOUSE, MICKEY FAUNTLEROY
DOB/ 11/18/1928
COB/ DL
ARN/ 123456789
Certificate#/ 12345678
FCO/ UNK
DOE/ 11/18/1928
COL/ N/A
REM/
I.C.E. RECORDS INDICATE THAT THIS SUBJECT IS A
UNITED STATES CITIZEN. THIS INDIVIDUAL IS NOT
SUBJECT TO REMOVAL FROM THE UNITED STATES. NO
FURTHER ACTION BY I.C.E. WILL BE TAKEN.
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
SUBJECT IS A DERIVED USC
***************************************
FOR FURTHER INFORMATION CONTACT THE ICE LAW ENFORCEMENT
SUPPORT CENTER AT (802) 872-6020. REQUESTING ORI
INFORMATION: AGENCY/ Placeholder - FL PHONE/
L.E.S.C. QUERY ID: 1234567
****** LAST MODIFIED: 2019/06/22 14:57 EDT******
*** LIMITED OFFICIAL USE ***
END OF RESPONSE . . .]]>
</n2:ResponseText>
</n2:NLETSResponseData>
</n2:NLETS>