U.S. flag

An official website of the United States government, Department of Justice.

Data Imports

Description

Overview 

NamUs is currently developing a data import capability for use with trusted external clients, consisting of case import and case cancellation features. These features will allow external clients to periodically import (or upload) a limited and prescribed subset of case data to NamUs, rather than having to enter that data directly in the NamUs website. For previously imported cases that should be canceled or resolved, the process will allow case cancellations to be submitted for review by the jurisdictional Regional Program Specialist (RPS). 

Case data imported through either the server-to-server or bulk upload process may become NamUs cases, if it validates successfully for both completeness and correctness. All imported case data will be logged, validated and queued for submission.  

Once all queued data for a job is processed, the job will be complete and NamUs will communicate the job results through email to the importing agency, as well as the RPS for the case administrative region(s). 

Just like cases manually entered into NamUs, the entering party and case contributors will be able to view and edit imported cases directly through the NamUs website even prior to publication. 

As implied, this data import will be unidirectional, from the client to NamUs. One or more cases, up to NamUs-defined limits, may be included in a single data import request. Except for case cancellation requests, NamUs provides no extra support for data synchronization.

Please contact NamUs at [email protected] for more information.

Data Integration Requirements and Scope 

Requirements: 

  • Any data transformation needed to meet NamUs field and system requirements will be performed prior to submission. 
  • Minimum data requirements for NamUs case creation will be provided by NamUs and must be met for successful import, regardless of method used for transmission. 
  • A limited number of additional data elements will be allowed, as specified by NamUs.  There is no mechanism provided for import of data outside the minimum data requirements and the limited specified additional/optional NamUs Fields. 
  • Server-to-server (key and certificate) authentication will be established based on OJP and NamUs standards.  Active and sponsored user accounts for external importing parties that have import permissions will be established within the NamUs system. 
  • The server-to-server data transfer will be automated per an agreed upon schedule by both parties, and will include case volume limits. 
  • Testing throughout the integration process will be conducted by both parties, including user acceptance testing. 
  • The importing agency will get permission from the case owner to send data to NamUs prior to transmission.  
  • Permission for the case to be published must be obtained by the Investigating Agency (IA).  Each imported case will be reviewed by a NamUs RPS, and they will procure permission to publish from the IA.  
  • NamUs will only accept case data provided that it meets the following criteria: 
    • It meets the minimum required field specifications, or the minimum plus limited additional data elements allowed by policy. 
    • A matching field and data type already exists in NamUs 
    • Data conforms to the field requirements, either via raw data or transformation before submission. 
    • Each job (submission) can contain no more than a 100 cases, and may not exceed size limits as set by OJP.  Multiple jobs per 24-hour period are allowed, but a maximum job/day limit will be set. 

Scope: 

In Scope for NamUs: 

  • NamUs will provide information about data fields, data types, and requirements via an Interface Control Document (ICD), to external importing parties. 
  • NamUs will provide technical means, through an API, for server-to-server data imports. 
  • NamUs will provide a mechanism for secure authentication and data transmission. 
  • NamUs will facilitate the creation of proper credentials for external importing parties. 
  • NamUs will provide a success/failure feedback mechanism to external importing parties. 
  • NamUs will provide technical parameters, including data dictionary, SQL, JSON and other files and information. 
  • NamUs will provide testing and QA for all NamUs development work, and will help facilitate testing and QA by external importing parties. 

Out of Scope for NamUs: 

  • Modification or addition of any fields or data types within the NamUs system. 
  • Any data transformation once NamUs receives the data. 
  • Any data exchange mechanisms, data is unidirectional into NamUs. 
  • Addressing data import failures which are due to non-conforming data type/field submissions. 

In Scope for External Importing Parties: 

  • Mapping of importing parties' data to appropriate fields/types in NamUs. 
  • Development resources to make any data transformation or changes needed to meet NamUs requirements. 
  • Implementing and maintaining appropriate credentials (including tokens etc…). 
  • Meeting authentication requirements. 
  • Business owners with NamUs system login credentials and sponsorships, and the maintenance of same. 
  • Scheduling of testing, deployments etc… with NamUs IT. 
Date Created: March 27, 2021