Batch files enable you to submit a large number of records at once, in a single file. You then receive your match results in an updated version of your submission file.
To avoid processing delays, batch files must be submitted with the correct parameters. You can submit files through a Managed File Transfer (MFT) process or Kount 360.
The Initial Screening Response is typically returned in a few hours, but depends on system load, file size, and data quality. The maximum window to return an Initial Screening Response is 24 hours.
If you subscribe to our analyst review, a Final Screening Response is delivered at a later time with a secure file transfer.
You can submit multiple batch files at once, provided that each file uses a different name.
A batch file can be submitted in two ways: with a secure file transfer with Managed File Transfer (MFT) or uploading the file directly with Kount 360.
The following diagrams provide a high-level description of the data flow between submission and response.
Large batch files—up to three million records—must be sent using secure file transfer.
Note
You must set up your Managed File Transfer (MFT) and batch file configurations before submitting a file. Contact support@kount.com for more information.
The following diagram provides a high-level description of the data flow for batch file submissions.
-
The customer submits the batch file through MFT.
-
MFT encrypts the file and sends it to the AML Compliance match engine in Google Cloud.
-
The match engine compares the data and creates match results and alerts.
-
Depending on the customer configuration, the match engine:
-
Sends the Initial Screening Response file to the customer through the preferred delivery channel and MFT.
-
Sends the Initial Screening Response file to the analyst review service.
Note
This action only occurs if the customer subscribes to the analyst review service.
-
-
The analyst review service completes the review, creates a Final Screening Response file, and then sends the file to MFT.
-
The Initial Screening Response or Final Screening Response files are delivered to the customer by MFT.
The batch file flow when uploading in Kount 360 follows the same path as the standard API request and response.
The following diagram provides a high-level workflow of the batch file upload process.
-
The user authenticates with Okta to establish a secure connection.
-
The user uploads the batch file (up to 1000 records) in Kount 360.
-
The batch file moves from the endpoints to the screening service.
-
The match engine compares the data and creates match results and alerts.
-
Depending on the user configuration, the match engine:
-
Sends the Initial Screening Response file to the customer via the preferred delivery channel.
-
Sends the Initial Screening Response file to the analyst review service.
Note
This action only occurs if the user subscribes to the analyst review service.
-
-
The analyst review service completes the review and creates an Final Screening Response file.
-
The Initial Screening Response or Final Screening Response file is delivered to the customer through the preferred delivery channel.
Use the file name convention to prevent errors when submitting your batch file. The limitations are:
-
64 characters
-
Each file name must be unique
When naming your batch file, use the following structure:
amlcs_<clientid>_<yyyymmdd>_<hhmmss>.json
File name components:
-
amlcs: The product name.
-
clientid: Your unique client ID number from Equifax. You can find your client ID in Kount 360.
-
yyyymmdd: Submission date stamp in year, month, and day.
-
hhmmss: Submission timestamp in hour, minute, and second.
AML Compliance Solutions batch files must be constructed by using newline-delimited JSON (ndJSON or JSONL). You can use all of the attributes from the screening API when constructing the file. Go to AML Compliance Solutions request parameters for a complete list of attributes, enumerations, and required fields. If you prefer to view the swagger file, go to AML Compliance Solutions Screening API.
File size limits
-
You can submit up to three million records per file when submitting via MFT.
-
You can submit up to 1000 records per file when submitting via Kount 360.
-
The maximum line length is 2^31 - 1.
Each record must have one of the following processing actions:
-
screen_only: Only screen the record, no action for the portfolio. -
load_only: Only insert and update (UPSERT) into the portfolio, no screening. -
delete_only: Only delete from the portfolio, no screening. -
undefined: Screening and portfolio UPSERT.
Example 12. Batch input file layout example
{"metadata":{"monitoring":{"processingAction":"screen_only","monitoringId":"b55af2b2-e5b5-4016-aa69-0458bc861a1b"}},"context":{"customerUse":{"uniqueId":"335241718085132","organization":"cn1rqq5e4f0gep5a19tg"}},"businessMatch":{"name":"Kount Inc","addresses":[{"line1":"520 Alvarez Way Katherineside MD 91498","countryName":"Senegal"}],"countryOfRegistration":"JPN"}}
{"metadata":{"monitoring":{"processingAction":"screen_only","monitoringId":"070bc4cd-41f9-4eab-aea2-7fb118bb6eb2"}},"context":{"customerUse":{"uniqueId":"335243718054198","organization":"cn1rqq5e4f0gep5a19tg"}},"personMatch":{"name":{"first":"Jane","middle":"","last":"Doe","prefix":"","suffix":""},"addresses":[{"line1":"Compañia 1131","city":"Santiago","region":"Metropolitana","countryName":"Chile"}],"dateOfBirth":{"year":1955,"month":11,"day":30},"countryOfResidency":"CHL","countryOfNationality":"ZMB","governmentIds":[{"type":"passport_number","value":"A11112222"}]}}
{"metadata":{"monitoring":{"processingAction":"screen_only","monitoringId":"070bc4cd-41f9-4eab-aea2-7fb118bb6ec1"}},"context":{"customerUse":{"uniqueId":"335242718041895","organization":"cn1rqq5e4f0gep5a19tg"}},"personMatch":{"name":{"first":"John","middle":"","last":"Doe","prefix":"","suffix":""},"addresses":[{"line1":"78087 Vega Isle Suite 521East Leah, FL 13355","city":"Stokesland","region":"Delaware","postalCode":"35129","countryName":"Korea"}],"dateOfBirth":{"year":1950,"month":12,"day":10},"countryOfNationality":"FLK","governmentIds":[{"type":"passport_number","value":"E05555555"}]}}
{"metadata":{"monitoring":{"processingAction":"screen_only","monitoringId":"068d30e2-d6a8-4707-807e-1ed6cdabfc2a"}},"context":{"customerUse":{"uniqueId":"335247718032894","organization":"cn1rqq5e4f0gep5a19tg"}},"businessMatch":{"name":"Equifax","addresses":[{"line1":"778 Christopher Glens Suite 856 Nicholasburgh AR 03507","countryName":"Brunei;Burkina Faso;Martinique"}],"countryOfRegistration":"EST"}}
To prevent errors in the submission process, AML Compliance Solutions performs a validation of the file. Files that do not follow the layout requirements fail to process and return an Initial Screening Response with error details. This file has a file extension of .rej.
After a batch file has been processed by the match engine, the screening response is returned as an Initial Screening Response file.
If the customer subscribes to the analyst review service, they receive an Initial Screening Response file, followed later by a Final Screening Response file.
After a batch file has been processed by the match engine, an Initial Screening Response file is returned to the submitter. This file is delivered through the channel selected by the customer in their batch configuration. The file uses the same filename as the original submission, but adds _init.
You also receive an error file if any errors were found in your submission. For example, a record is missing a required data element. This file is returned with the same filename as the Initial Screening Response file, but with a .rej extension.
Example 13. Example of the initial submission and Initial Screening Response filenames
-
Submitted file: amlcs_1258478565_20260210_062123.json
-
Initial Screening Response file: amlcs_1258478565_20260210_062123_init.json
-
Error file: amlcs_1258478565_20260210_062123.rej
If a customer subscribes to the analyst review service, the service receives a copy of the Initial Screening Response file that is returned to the customer. The service analyzes the Initial Screening Response and then returns the results to the customer through the selected channel. This new file is called the Final Screening Response file. The Final Screening Response file uses the same filename as the initial submission, but adds _final.
Example 14. Example of initial submission and Final Screening Response filenames
-
Submitted file: amlcs_1258478565_20260210_062123.json
-
Final Screening Response file: amlcs_1258478565_20260211_084512_final.json
Comments
0 comments
Article is closed for comments.