NIEM Examples - Mobile Device Lookup (MDQ/MDR)
Mobile Device Lookup NIEM Specifications
This section provides NIEM format and examples for Mobile Device Lookup Transactions (MDQ/MDR).
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 are omitted to avoid redundancy. Consult the associated schemas and instances to determine the correct XPaths of the elements.
Element Dictionary
Transaction types detailed below include: Mobile Device Query (MDQ) and Mobile Device Response (MDR).
Query Formats
Mobile Device query (MDQ)
Inquiry Data (n2:NLETSInquiryData)
This element will contain all elements specific to this transaction.
DeviceQuery (n2c:DeviceQuery)
Information to specify the identity of a mobile device and the puspose for querying.
Device (nc:Device)
NIEM: A data type for a device.
Device IMEI Identification (nc:DeviceIMEIIdentification)
NIEM: An identification number of a device specified as an International Mobile Equipment Identity assigned to every mobile phone by the manufacturer.
Identification ID (nc:IdentificationID)
NIEM: An identifier.
Purpose Code (n2c:PurposeCode)
Identifies the purpose for a mobile device query.
Activity Identification (nc:ActivityIdentification)
NIEM: An identification that references an activity.
Identification ID (nc:IdentificationID)
NIEM: An identifier.
Response Formats
Mobile Device Response (MDR)
Response Data (n2:NLETSResponseData)
All data relevant to the response message.
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.
Mobile Device Lookup NIEM Examples
Example 1: Query of a mobile phone by IMEI with optional Activity ID.
<n2:NLETS n2:version="4.00"
xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0"
xmlns:nc="http://release.niem.gov/niem/niem-core/5.0/"
xmlns:n2="http://www.nlets.org/niem/1.0"
xmlns:n2c="http://www.nlets.org/niem/nlets-core/1.0">
<n2:NLETSMessageHeader>
<nh2:MessageKeyCodeText>MDQ</nh2:MessageKeyCodeText>
<nh2:OriginatingORIID>AZNLETS49</nh2:OriginatingORIID>
<nh2:DestinationORIID>NL</nh2:DestinationORIID>
<nh2:DocumentControlFieldText>MDQEXAMPL1</nh2:DocumentControlFieldText>
</n2:NLETSMessageHeader>
<n2:NLETSInquiryData n2:key="MDQ">
<n2c:DeviceQuery>
<n2c:PurposeCode>INT</n2c:PurposeCode>
<nc:Device>
<nc:DeviceIMEIIdentification>
<nc:IdentificationID>629328085231522</nc:IdentificationID>
</nc:DeviceIMEIIdentification>
</nc:Device>
<nc:ActivityIdentification>
<nc:IdentificationID>CASE 123456789</nc:IdentificationID>
</nc:ActivityIdentification>
</n2c:DeviceQuery>
</n2:NLETSInquiryData>
</n2:NLETS>
Example 2: Response to query by mobile phone IMEI with optional Activity ID.
<n2:NLETS n2:version="4.00"
xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0"
xmlns:n2c="http://www.nlets.org/niem/nlets-core/1.0"
xmlns:nc="http://release.niem.gov/niem/niem-core/5.0/"
xmlns:n2="http://www.nlets.org/niem/1.0">
<n2:NLETSMessageHeader>
<nh2:MessageKeyCodeText>MDR</nh2:MessageKeyCodeText>
<nh2:OriginatingORIID>NL0000000</nh2:OriginatingORIID>
<nh2:DestinationORIID>AZNLETS49</nh2:DestinationORIID>
<nh2:DocumentControlFieldText><![CDATA[MDQEXAMPL1]]></nh2:DocumentControlFieldText>
</n2:NLETSMessageHeader>
<n2:NLETSInquiryData n2:key="MDQ">
<n2c:DeviceQuery>
<n2c:PurposeCode>INT</n2c:PurposeCode>
<nc:Device>
<nc:DeviceIMEIIdentification>
<nc:IdentificationID>629328085231522</nc:IdentificationID>
</nc:DeviceIMEIIdentification>
</nc:Device>
<nc:ActivityIdentification>
<nc:IdentificationID>CASE 123456789</nc:IdentificationID>
</nc:ActivityIdentification>
</n2c:DeviceQuery>
</n2:NLETSInquiryData>
<n2:NLETSResponseData n2:key="MDR">
<n2:ResponseText>-------------- MOBILE DEVICE RESPONSE --------------
SEARCHED IMEI: 629328085231522
ACTIVITY IDENTIFICATION: CASE 123456789
VALID IMEI: FALSE
-------------- SUMMARY --------------
PROTECTED BY RECIPERO ASSET WATCH: FALSE
MOBILE NETWORK BLOCK EXISTS: FALSE
POLICE CRIME REPORT EXISTS: FALSE
POLICE FOUND REPORT EXISTS: FALSE
INFORMATION REPORT EXISTS: FALSE
INSURANCE CLAIM EXISTS: FALSE
POLICE LOST REPORT EXISTS: FALSE
REGISTERED ON RECIPERO IMMOBILISE: FALSE
SEARCH HISTORY ON RECIPERO SYSTEMS: recipero-nmpr
-------------- SEARCH RESULTS --------------
---- RESULT 1 ----
SEARCH REASON CODE: county-lines-related
SEARCH REASON TEXT: county-lines-related
DATE OF EVENT: 2022-05-13T18:10:16Z
DATE ADDED TO RECIPERO SYSTEM: 2022-05-13T18:10:16Z
RECIPERO SYSTEM EVENT SOURCE: The NMPR (Police Interest)
EVENT HISTORY TYPE: search
FULL IDENTIFIER MATCHED: 629328085231522
AGENCY NAME: Nlets
ASSOCIATED COUNTRY: UK
---- RESULT 2 ----
SEARCH REASON CODE: county-lines-related
SEARCH REASON TEXT: county-lines-related
DATE OF EVENT: 2022-05-13T18:05:54Z
DATE ADDED TO RECIPERO SYSTEM: 2022-05-13T18:05:54Z
RECIPERO SYSTEM EVENT SOURCE: The NMPR (Police Interest)
EVENT HISTORY TYPE: search
FULL IDENTIFIER MATCHED: 629328085231522
AGENCY NAME: Nlets
ASSOCIATED COUNTRY: UK
---- RESULT 3 ----
SEARCH REASON CODE: county-lines-related
SEARCH REASON TEXT: county-lines-related
DATE OF EVENT: 2022-05-13T15:24:09Z
DATE ADDED TO RECIPERO SYSTEM: 2022-05-13T15:24:09Z
RECIPERO SYSTEM EVENT SOURCE: The NMPR (Police Interest)
EVENT HISTORY TYPE: search
FULL IDENTIFIER MATCHED: 629328085231522
AGENCY NAME: Nlets
ASSOCIATED COUNTRY: UK
---- RESULT 4 ----
SEARCH REASON CODE: county-lines-related
SEARCH REASON TEXT: county-lines-related
DATE OF EVENT: 2022-05-12T17:27:47Z
DATE ADDED TO RECIPERO SYSTEM: 2022-05-12T17:27:47Z
RECIPERO SYSTEM EVENT SOURCE: The NMPR (Police Interest)
EVENT HISTORY TYPE: search
FULL IDENTIFIER MATCHED: 629328085231522
AGENCY NAME: Nlets
ASSOCIATED COUNTRY: UK
</n2:ResponseText>
</n2:NLETSResponseData>
</n2:NLETS>
Example 3: Response when there are no records for a device.
<n2:NLETS n2:version="4.00"
xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0"
xmlns:n2c="http://www.nlets.org/niem/nlets-core/1.0"
xmlns:nc="http://release.niem.gov/niem/niem-core/5.0/"
xmlns:n2="http://www.nlets.org/niem/1.0">
<n2:NLETSMessageHeader>
<nh2:MessageKeyCodeText>MDR</nh2:MessageKeyCodeText>
<nh2:OriginatingORIID>NL0000000</nh2:OriginatingORIID>
<nh2:DestinationORIID>AZNLETS49</nh2:DestinationORIID>
<nh2:DocumentControlFieldText><![CDATA[MDQNORCFND]]></nh2:DocumentControlFieldText>
</n2:NLETSMessageHeader>
<n2:NLETSInquiryData n2:key="MDQ">
<n2c:DeviceQuery>
<n2:PurposeCode>INT</n2:PurposeCode>
<nc:Device>
<nc:DeviceIMEIIdentification>
<nc:IdentificationID>DOESNOTEXIST04</nc:IdentificationID>
</nc:DeviceIMEIIdentification>
</nc:Device>
<nc:ActivityIdentification>
<nc:IdentificationID>CASE 123456789</nc:IdentificationID>
</nc:ActivityIdentification>
</n2c:DeviceQuery>
</n2:NLETSInquiryData>
<n2:NLETSResponseData n2:key="MDR">
<n2:ResponseText>-------------- MOBILE DEVICE RESPONSE --------------
SEARCHED IMEI: DOESNOTEXIST04
*** RECORD NOT FOUND ***
</n2:ResponseText>
</n2:NLETSResponseData>
</n2:NLETS>
Example 4: Response to query by mobile phone IMEI with all possible text fields.
<n2:NLETS n2:version="4.00"
xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0"
xmlns:n2c="http://www.nlets.org/niem/nlets-core/1.0"
xmlns:nc="http://release.niem.gov/niem/niem-core/5.0/"
xmlns:n2="http://www.nlets.org/niem/1.0">
<n2:NLETSMessageHeader>
<nh2:MessageKeyCodeText>MDR</nh2:MessageKeyCodeText>
<nh2:OriginatingORIID>NL0000000</nh2:OriginatingORIID>
<nh2:DestinationORIID>AZNLETS49</nh2:DestinationORIID>
<nh2:DocumentControlFieldText><![CDATA[MDQEXAMPL3]]></nh2:DocumentControlFieldText>
</n2:NLETSMessageHeader>
<n2:NLETSInquiryData n2:key="MDQ">
<n2c:DeviceQuery>
<n2c:PurposeCode>INT</n2c:PurposeCode>
<nc:Device>
<nc:DeviceIMEIIdentification>
<nc:IdentificationID>100000010000023</nc:IdentificationID>
</nc:DeviceIMEIIdentification>
</nc:Device>
<nc:ActivityIdentification>
<nc:IdentificationID>TEST FULL MODEL</nc:IdentificationID>
</nc:ActivityIdentification>
</n2c:DeviceQuery>
</n2:NLETSInquiryData>
<n2:NLETSResponseData n2:key="MDR">
<n2:ResponseText>-------------- MOBILE DEVICE RESPONSE --------------
SEARCHED IMEI: 100000010000023
ACTIVITY IDENTIFICATION: TEST FULL MODEL
VALID IMEI: FALSE
-------------- SUMMARY --------------
PROTECTED BY RECIPERO ASSET WATCH: FALSE
MOBILE NETWORK BLOCK EXISTS: FALSE
POLICE CRIME REPORT EXISTS: FALSE
POLICE FOUND REPORT EXISTS: FALSE
INFORMATION REPORT EXISTS: FALSE
INSURANCE CLAIM EXISTS: FALSE
POLICE LOST REPORT EXISTS: FALSE
REGISTERED ON RECIPERO IMMOBILISE: TRUE
SEARCH HISTORY ON RECIPERO SYSTEMS: recipero-nmpr
-------------- SEARCH RESULTS --------------
---- RESULT 1 ----
SEARCH REASON CODE: intelligence
SEARCH REASON TEXT: intelligence
DATE OF EVENT: 2022-04-08T20:24:59Z
DATE ADDED TO RECIPERO SYSTEM: 2022-04-08T20:24:59Z
DATE EVENT EXPIRES: 2022-04-08T20:24:59Z
LOCATION OF EVENT: The Shire
RECIPERO SYSTEM EVENT SOURCE: The NMPR (Police Interest)
EVENT HISTORY TYPE: search
FULL IDENTIFIER MATCHED: HAPPYCAM001
ASSOCIATED IDENTIFIERS: HAPPYCAM001,ABC123DEF456
ASSOCIATED REFERENCE: RCP-FND-12345
ACCOUNT NAME: Elrond
ACCOUNT ADDRESS: 1234 S Rivendell Ave
ACCOUNT EMAIL: elrond@rivendell.com
ACCOUNT PHONE 1 NUMBER: 07949004301
ACCOUNT PHONE 1 TYPE: general
ACCOUNT POSTAL CODE: 12345-0001
AGENCY NAME: Nlets
AGENCY ADDRESS: 123 E Bag End
AGENCY CONTACT EMAIL: frodo@theringbearer.com
AGENCY CONTACT NUMBER: 123-456-7890
AGENCY POSTAL CODE: 12345-1234
SUB AGENCY: The Sub Agency
SUB AGENCY ID: SUB-12345
AGENT NAME: Agent of the Dark Lord
AGENT ID: AGENT 12345
AGENT EMAIL: agent@theagency.com
ASSOCIATED COUNTRY: UK
DEVICE DESCRIPTION: Description of device
DEVICE IDENTIFIER TYPE: IMEI
DEVICE MAKE/MODEL: ReciperoMake ReciperoModel
DEVICE VENDOR PRODUCT ID: Apple iPhone 12 XR
ASSOCIATED IP ADDRESS: 10.10.10.10
SELLER NAME: The Shire Phone Sales
SELLER IDENTIFICATION: SEL-123
SELLER ADDRESS: 456 E Shire Blvd
CERTIFICATE ID: CERT 001
CHECKER IN POSSESSION OF DEVICE: Not Stated
--- ITEMS RELATED TO RESULT 1 ---
--- RELATED ITEM 1 ---
DESCRIPTION: TEST DEVICE 1
MAKE/MODEL: ReciperoMake1 ReciperoModel1
DATE FOUND: 2022-04-08T20:24:59Z
CATEGORY: Video Camera
IDENTIFIERS: ABC123DEF456,GHI123
REFERENCE: REF-123
VALUE: $1,000
--- RELATED ITEM 2 ---
DESCRIPTION: TEST DEVICE 2
MAKE/MODEL: ReciperoMake2 ReciperoModel2
DATE FOUND: 2022-04-08T20:24:59Z
CATEGORY: Phone
IDENTIFIERS: ABC123DEF456,GHI123
REFERENCE: REF-456
VALUE: $10,000
---- RESULT 2 ----
SEARCH REASON CODE: intelligence
SEARCH REASON TEXT: intelligence
DATE OF EVENT: 2022-04-08T20:24:59Z
DATE ADDED TO RECIPERO SYSTEM: 2022-04-08T20:24:59Z
DATE EVENT EXPIRES: 2022-04-08T20:24:59Z
LOCATION OF EVENT: The Shire
RECIPERO SYSTEM EVENT SOURCE: The NMPR (Police Interest)
EVENT HISTORY TYPE: search
FULL IDENTIFIER MATCHED: HAPPYCAM001
ASSOCIATED IDENTIFIERS: HAPPYCAM001,ABC123DEF456
ASSOCIATED REFERENCE: RCP-FND-12345
ACCOUNT NAME: Elrond
ACCOUNT ADDRESS: 1234 S Rivendell Ave
ACCOUNT EMAIL: elrond@rivendell.com
ACCOUNT PHONE 1 NUMBER: 07949004301
ACCOUNT PHONE 1 TYPE: general
ACCOUNT POSTAL CODE: 12345-0001
AGENCY NAME: Nlets
AGENCY ADDRESS: 123 E Bag End
AGENCY CONTACT EMAIL: frodo@theringbearer.com
AGENCY CONTACT NUMBER: 123-456-7890
AGENCY POSTAL CODE: 12345-1234
SUB AGENCY: The Sub Agency
SUB AGENCY ID: SUB-12345
AGENT NAME: Agent of the Dark Lord
AGENT ID: AGENT 12345
AGENT EMAIL: agent@theagency.com
ASSOCIATED COUNTRY: UK
DEVICE DESCRIPTION: Description of device
DEVICE IDENTIFIER TYPE: IMEI
DEVICE MAKE/MODEL: ReciperoMake ReciperoModel
DEVICE VENDOR PRODUCT ID: Apple iPhone 12 XR
ASSOCIATED IP ADDRESS: 10.10.10.10
SELLER NAME: The Shire Phone Sales
SELLER IDENTIFICATION: SEL-123
SELLER ADDRESS: 456 E Shire Blvd
CERTIFICATE ID: CERT 001
CHECKER IN POSSESSION OF DEVICE: Not Stated
--- ITEMS RELATED TO RESULT 2 ---
--- RELATED ITEM 1 ---
DESCRIPTION: TEST DEVICE 1
MAKE/MODEL: ReciperoMake1 ReciperoModel1
DATE FOUND: 2022-04-08T20:24:59Z
CATEGORY: Video Camera
IDENTIFIERS: ABC123DEF456,GHI123
REFERENCE: REF-123
VALUE: $1,000
--- RELATED ITEM 2 ---
DESCRIPTION: TEST DEVICE 2
MAKE/MODEL: ReciperoMake2 ReciperoModel2
DATE FOUND: 2022-04-08T20:24:59Z
CATEGORY: Phone
IDENTIFIERS: ABC123DEF456,GHI123
REFERENCE: REF-456
VALUE: $10,000
</n2:ResponseText>
</n2:NLETSResponseData>
</n2:NLETS>
Top
Mobile Device Lookup Response Definitions
The content of the text in the response will contain the Header Fields, Summary Fields, and some or all of the Results Fields depending on the history for the device IMEI.
The following table defines the Header fields.
HEADER FIELDS
Field
Type
Meaning
SEARCHED IMEI
String
The IMEI of the device in the original Nlets query.
ACTIVITY IDENTIFICATION
String
The text of the activity identification from the original Nlets query, if entered.
VALID IMEI
TRUE/FALSE
True means the IMEI of the queried device has a valid TAC.
The following table defines the Summary fields.
SUMMARY FIELDS
Field
Type
Meaning
PROTECTED BY RECIPERO ASSET WATCH
TRUE/FALSE
The device with the searched identifier is protected by Recipero AssetWatch.
MOBILE NETWORK BLOCK EXISTS
TRUE/FALSE
A mobile network block exists for a device matching the searched identifier.
POLICE CRIME REPORT EXISTS
TRUE/FALSE
A crime report exists for a device matching the searched identifier.
POLICE FOUND REPORT EXISTS
TRUE/FALSE
A found report exists for a device matching the searched identifier.
INFORMATION REPORT EXISTS
TRUE/FALSE
An information report exists for a device matching the searched identifier.
INSURANCE CLAIM EXISTS
TRUE/FALSE
An insurance claim exists for a device matching the searched identifier.
POLICE LOST REPORT EXISTS
TRUE/FALSE
A police lost report exists for a device matching the searched identifier.
REGISTERED ON RECIPERO IMMOBILISE
TRUE/FALSE
An ownership record exists for a device matching the searched identifier.
SEARCH HISTORY ON RECIPERO SYSTEMS
List of Strings
A list of Recipero systems for which there are previous searches for the IMEI. An empty list indicates the identifier has not been searched on Recipero systems.
The following table defines the Results fields, some or all of which will be present depending on the information in the Recipero system for the device having searched IMEI.
RESULTS FIELDS
Field
Type
Meaning
SEARCH REASON CODE
String
The reason for the search.
DATE OF EVENT
String
The date of the history event. Recipero systems may have become aware of this record later than this date. The DATE ADDED field provides the date the record was added to the system.
DATE ADDED TO RECIPERO SYSTEM
String
The date the history event was added to the Recipero system.
DATE EVENT EXPIRES
String
Some history events expire. After the record expires it will no longer impact checks on systems such as CheckMEND.
LOCATION OF EVENT
String
If the history event include location information it will be included in this property. This is most likely to be returned for loss related events where it would indicate the loss location.
RECIPERO SYSTEM EVENT SOURCE
String
The name of the system that provided the event, e.g., The NMPR, Claimscheck, Recipero AssetWatch.
EVENT HISTORY TYPE
String
The type of history event for the device IMEI recorded in the Recipero system.
FULL IDENTIFIER MATCHED
String
The full identifier from the history event that matched the searched identifier.
ASSOCIATED IDENTIFIERS
List of Strings
A list of identifiers associated with the device having the searched IMEI.
ASSOCIATED REFERENCE
String
A reference value for the associated item(s).
ACCOUNT NAME
String
The name associated with the Recipero account.
ACCOUNT ADDRESS
String
The address associated with the Recipero account.
ACCOUNT EMAIL
String
The email associated with the Recipero account.
ACCOUNT PHONE NUMBER
String
The phone number associated with the Recipero account. There may be multiple numbers.
ACCOUNT PHONE TYPE
String
The phone type associated with the Recipero account.
ACCOUNT POSTAL CODE
String
The postal code associated with the Recipero account.
AGENCY NAME
String
The name of the agency associated with the history event for the device. This could be a law enforcement agency or other agency depending on the type of event.
AGENCY ADDRESS
String
The address of the agency associated with the history event for the device.
AGENCY CONTACT EMAIL
String
The email address of the agency associated with the history event for the device.
AGENCY CONTACT NUMBER
String
The phone number of the agency associated with the history event for the device.
AGENCY POSTAL CODE
String
The postal code of the agency associated with the history event for the device.
SUB AGENCY
String
A sub agency of the agency associated with the history event for the device.
SUB AGENCY ID
String
An identification associated with a sub agency.
AGENT
String
The name of the agent associated with the agency for the history event.
AGENT ID
String
An identification associated with an agent.
AGENT EMAIL
String
The email addresss associated with an agent.
ASSOCIATED COUNTRY
String
The country associated with the history event for the device IMEI, if known.
DEVICE DESCRIPTION
String
A description of the device having the searched IMEI.
DEVICE IDENTIFIER TYPE
String
The type of identifier registered against the history item, e.g., IMEI
DEVICE MAKE/MODEL
String
The manufacturer make and model of the device.
DEVICE VENDOR PRODUCT ID
String
The product ID from a retailer or other seller, if known.
ASSOCIATED IP ADDRESS
String
An IP address associated with the device, if known.
SELLER NAME
String
The name of the seller of the device.
SELLER IDENTIFICATION
String
An identification of the seller of the device.
SELLER ADDRESS
String
The address of the seller of the device.
CERTIFICATE ID
String
The associated certificate ID of the device if it is in the Recipero CheckMEND system.
CHECKER IN POSSESSION OF DEVICE
String
If the type of EVENT HISTORY TYPE is 'check', this will indicate if the checker was in possession of the device. Values will be NOT STATED, YES, or NO
If there are items related to the device having the searched IMEI, the response will list information about the related items using the fields below. If there are multiple related devices, the response will contain a RELATED ITEM block for each related device.
RELATED ITEMS FIELDS
DESCRIPTION
String
A description of the item related to the device having the searched IMEI.
MAKE/MODEL
String
The make and model of the related item.
DATE FOUND
String
The date the related item was found.
CATEGORY
String
A category of the related item.
IDENTIFIERS
List of Strings
A list of identifiers for the related item.
REFERENCE
String
A reference associated to the related item, such as a case number or other association.
VALUE
String
The monetary value of the related item.