External match API - Azure
Use this API to get information on potential matches in a tenant for entities that are added to the tenant from an external file.
Use the external match API to match records stored externally in a file with entities in a Reltio tenant. To use this API, you must provide an input file that contains the records to be matched that can be stored in Azure blob storage.
The following sections provide information on the body parameters for Azure. For information on the common request API, request parameters and the input and output file formats, see topic External match API.
- Entities must be represented as a JSON array in an Azure file.
- Each entity JSON should be on a separate line of an Azure file.
Body parameters
The following body parameters are used to authorize access to Azure blob storage. You can either provide a combination of the azureStorageAccountName and azureSasToken or the azureStorageAccountName and azureStorageAccountKey.
| Parameters | Required | Description |
|---|---|---|
azureStorageContainer | Yes | The name of the Azure blob container. |
azureStorageAccountName | Yes | The name of the storage account that is used to read files from or write results to the blob. |
azureStorageAccountKey | No | The Azure storage account key that you generate or your storage account key. See Manage storage account access keys. |
azureSasToken | No | A shared Access Signature (SAS) that gives you secure delegated access to resources in your storage account. See How to create Azure SAS token. |
Example
- Example request
- Using an Azure SAS token:
POST https://your-reltio-tenant.reltio.com/reltio/api/tenant123/externalMatch Authorization: Bearer your_access_token Content-Type: application/json { "entityType": "HCP", "skipEntitiesCount": 0, "entitiesLimit": 10000, "distributed": false, "emails": "data_team@yourcompany.com", "fileFormat": "json_v2", "fileEncoding": "UTF-8", "bucket": "external-match-container", "path": "input_data/match_input.json", "pathOut": "output_data/match_output.json", "azureStorageContainer": "external-match-container", "azureStorageAccountName": "yourAzureAccount", "azureSasToken": "sv=2025-02-16&st=2025-02-16T00%3A00%3A00Z&se=2025-02-17T00%3A00%3A00Z&sp=rwl&spr=https&sig=yourGeneratedSignature", "rules": [ "configuration/entityTypes/HCP/matchGroups/MatchByMiddleName", "configuration/entityTypes/HCP/matchGroups/MatchByEmail" ], "selectAttributes": [ "configuration/entityTypes/HCP/attributes/FirstName", "configuration/entityTypes/HCP/attributes/LastName", "configuration/entityTypes/HCP/attributes/Identifiers/attributes/Type" ], "cleanse": true, "resolveLookups": false, "maxPotentialMatchesPerChunk": 50 } - Example response
{ "id": "f14b7c98-d123-4e56-890a-b1cdef234567", "status": "Completed", "createdBy": "data_team@yourcompany.com", "createdTime": 1713132034000, "currentState": { "totalNumberOfSkippedRecords": 0, "totalRecordInInputFile": 10000, "totalNumberOfMatches": 7800, "totalNumberOfNonMatches": 2200, "totalNumberOfAutoMerges": 1500, "totalNumberOfPotentialMatches": 6300, "exportUrl": "https://yourAzureAccount.blob.core.windows.net/external-match-container/output_data/match_output.json?sv=2025-02-16&st=2025-02-16T00%3A00%3A00Z&se=2025-02-17T00%3A00%3A00Z&sp=rwl&spr=https&sig=yourGeneratedSignature" } }
