Verato Connect supports batch processing for organizations that need to perform bulk identity operations and integrate results with downstream systems — without requiring real-time API integration for every record.
This article describes the file format requirements for each supported batch operation. Following these specifications exactly is required for successful processing; deviations in field names, capitalization, or structure may cause processing failures.
Supported Batch Operations
| Operation | File Name Prefix | Description |
|---|---|---|
| PostIdentity | post |
Submit identity records for matching and resolution |
| MergeIdentities | merge |
Merge two identity records into a single surviving record |
| DeleteIdentities | delete |
Remove an identity record from the system |
| SearchNotifications | search |
Retrieve identity event notifications within a date range |
All batch files must be in .csv format with fields separated by a pipe (|) character. Empty fields are represented as consecutive pipes (e.g., ||).
How Batch Processing Works
- Place your input file in the Ready subfolder on the Verato-hosted SFTP server.
- Verato Connect processes files as they are received — there is no fixed processing schedule.
- Once processing is complete, the output file is placed in the Completed subfolder with the same filename as the input file.
- Retrieve your output file from the Completed folder.
To obtain SFTP connection details and credentials, contact your Verato Customer Experience representative.
General File Requirements
- All files must include a header row as the first line. The field names in the header must exactly match the specifications in this article — including capitalization.
- Fields are pipe-delimited (
|). Empty fields appear as||. - Maximum supported file size is 100 MB by default. Contact Verato support if your use case requires a different limit.
- For best performance, keep files under 200,000 lines. Very large files may have extended processing times.
- The file name should be unique — for example, by including a date and time — to avoid overwriting the output file.
PostIdentity Batch File
Use this operation to submit identity records for matching and resolution in Verato MDM Cloud™.
File Naming
The filename must begin with auto or post (lowercase) and end with .csv.
Examples: post_records_2024-01-15.csv, auto_daily_load.csv
Input File Format
Each row represents a single identity record. Fields are pipe-delimited.
| Field Name | Required | Description |
|---|---|---|
customer_env |
Required | Your organization's Verato Connect URL. Must match the configured environment value for your account. |
Source Code |
Required | The source system identifier. Must match an authorized source code configured for your account. |
Native ID |
Required | The unique identifier for this record in the source system. |
MPI ID |
Optional | An external unique identifier, if applicable. |
First Name |
Required | First name of the individual. |
Middle Name |
Optional | Middle name of the individual. |
Last Name |
Required | Last name of the individual. |
Name Suffix |
Optional | Name suffix (e.g., Jr., Sr., III). |
SSN |
Optional | Social Security Number. |
DOB |
Optional | Date of birth. Format: YYYY-MM-DD
|
Gender |
Optional | Gender. |
Address Line 1 |
Optional | Primary address line. |
Address Line 2 |
Optional | Secondary address line. |
City |
Optional | City. |
State |
Optional | State (two-letter abbreviation). |
Zip Code |
Optional | 5-digit ZIP code. |
Zip Code + 4 |
Optional | ZIP+4 extension. |
Phone |
Optional | Phone number. |
Email |
Optional | Email address. |
AltID |
Optional | One or more alternate identifiers in type^value format. Separate multiple pairs with ~. Example: mrn^12345~eid^67890
|
Example input row:
customer_env|Source Code|Native ID|MPI ID|First Name|Middle Name|Last Name|Name Suffix|SSN|DOB|Gender|Address Line 1|Address Line 2|City|State|Zip Code|Zip+4|Phone|Email|AltID https://your-org.verato-connect.com|EHR|50d858e0|632|REBECCA||PARK||253531815|1945-08-22|F|7571 HIGH POINT ST.||PLEASANTON|CA|94566||(999) 832-4215||type6^val6~type7^val7
Output File Format
The output file contains all input fields, followed by the result fields appended to each row.
| Field Name | Description |
|---|---|
| (All input fields) | Returned exactly as submitted. |
LinkID |
The resolved identity ID assigned by Verato MDM Cloud™. |
SourceandNativeIDcrosswalk |
All source and native ID pairs associated with this identity, in the format source1^nativeId1~source2^nativeId2. |
eventtype |
Event type triggered by this operation, if applicable (e.g., UPDATE_SOURCE). |
eventsource(s)andID(s) |
Source and native ID pairs from any events triggered, in the same format as above. |
previousLinkId |
Previous identity IDs, delimited by ~, when a record has been updated or reassigned. |
errorMessage |
Error description, if the record failed to process. |
errortype |
Error classification: technicalError or retryableError. |
errorTimeStamp |
Timestamp of the error, if applicable. |
trackingId |
Tracking identifier provided by your system for this record. |
auditId |
Verato-managed audit identifier for this operation. |
MergeIdentities Batch File
Use this operation to merge two identity records, designating one as the surviving record and one as the retired record.
File Naming
The filename must begin with merge (lowercase) and end with .csv.
Example: merge_duplicates_2024-01-15.csv
Input File Format
| Field Name | Required | Description |
|---|---|---|
Customer_env |
Required | Your organization's Verato Connect URL. |
SurviveSource |
Required | Source system of the identity record that will survive the merge. |
SurviveNativeID |
Required | Native ID of the identity record that will survive the merge. |
RetireSource |
Required | Source system of the identity record that will be retired. |
RetireNativeID |
Required | Native ID of the identity record that will be retired. |
Output File Format
| Field Name | Description |
|---|---|
customer_env |
From the input file. |
SurviveSource |
From the input file. |
SurviveNativeID |
From the input file. |
RetireSource |
From the input file. |
RetireNativeID |
From the input file. |
linkID |
The identity ID of the surviving record after the merge. |
errorMessage |
Error description, if the merge failed. |
errortype |
Error classification: technicalError or retryableError. |
errorTimeStamp |
Timestamp of the error, if applicable. |
trackingId |
Tracking identifier provided by your system. |
auditId |
Verato-managed audit identifier for this operation. |
DeleteIdentities Batch File
Use this operation to remove an identity record from Verato MDM Cloud™.
File Naming
The filename must begin with delete (lowercase) and end with .csv.
Example: delete_records_2024-01-15.csv
Input File Format
| Field Name | Required | Description |
|---|---|---|
Customer_env |
Required | Your organization's Verato Connect URL. |
SurviveSource |
Required | Source system of the identity to be deleted. |
SurviveNativeID |
Required | Native ID of the identity to be deleted. |
Output File Format
| Field Name | Description |
|---|---|
customer_env |
From the input file. |
Source |
Source of the deleted identity (from SurviveSource in the input). |
NativeID |
Native ID of the deleted identity (from SurviveNativeID in the input). |
linkIdsDeleted |
Bracketed, comma-separated list of identity IDs that were deleted. Example: [abc123, def567]
|
linkIdsModified |
Bracketed, comma-separated list of identity IDs that were modified as a result of the deletion. Example: [abc123, def567]
|
errorMessage |
Error description, if the deletion failed. |
errorType |
Error classification: technicalError or retryableError. |
errorTimeStamp |
Timestamp of the error, if applicable. |
trackingId |
Tracking identifier provided by your system. |
auditId |
Verato-managed audit identifier for this operation. |
SearchNotifications Batch File
Use this operation to retrieve identity event notifications that occurred within a specified date and time range.
File Naming
The filename must begin with search (lowercase) and end with .csv.
Example: search_notifications_2024-01.csv
Input File Format
| Field Name | Required | Description |
|---|---|---|
customer_env |
Required | Your organization's Verato Connect URL. |
startDate |
Required | Start of the search window. Format: YYYY-MM-DDTHH:MM (e.g., 2024-01-01T08:00) |
endDate |
Required | End of the search window. Format: YYYY-MM-DDTHH:MM (e.g., 2024-01-31T20:00) |
Output File Format
| Field Name | Description |
|---|---|
customer_env |
From the input file. |
StartDTTM |
Start date/time from the input file. |
EndDTTM |
End date/time from the input file. |
customerId |
Your organization's customer ID as returned by Verato MDM Cloud™. |
TimeStampofNotificationMsg |
Timestamp of the notification event. |
UMPIService |
Name of the service that generated the notification (e.g., mergeIdentitiesService). |
BodynotificationMsg |
JSON body of the notification message. Refer to the searchNotifications API documentation for message structure details. |
errorMessage |
Error description, if the search failed. |
errorType |
Error classification: technicalError or retryableError. |
errorTimeStamp |
Timestamp of the error, if applicable. |
trackingId |
Tracking identifier provided by your system. |
auditId |
Verato-managed audit identifier for this operation. |
Handling Extra Columns in Input Files
If your input file includes columns not defined in the specification above, Verato Connect will ignore those columns without throwing an error. Only the fields defined in this article will be processed.
To add support for additional fields, contact your Verato Customer Experience representative to discuss configuration options.
Comments
0 comments
Article is closed for comments.