Set Cleanse Functions Configuration

Learn how to configure cleanse functions.

Use this operation to configure cleanse functions.

Note: This operation overrides the cleanse section in your tenant's physical configuration.

Request:

PUT {{applicationURL}}/tenants/{{tenantID}}/cleanse

Example:

PUT https://dev.reltio.com/reltio/tenants/hX777YXpWGBFUlh/cleanse

Table 1. Parameters
Name		Required	Description
Headers	`Content-Type`	Yes	`Content-Type: application/json`
Headers	`Authorization`	Yes	Access token in format "Bearer `<accessToken>`". See Auth API.
Body		Yes	JSON object with Cleanse Functions specification.

Response

If the cleanse functions specification is applied successfully, then the response contains a JSON object the same specification.

Example Request

PUT {{applicationURL}}/tenants/{{tenantID}}/cleanse
Body:
[
    {
        "cleanseFunction": "Loqate",
        "options": {
            "returnUnverifiedStatus": "true",

            "loqateDefaultCountry": "USA",
            "loqateLicensedCountry": "US;United States;USA;Canada;CA;Australia;AU"
        }
    },
    {
        "cleanseFunction": "VerificationStatusCleanser",
        "type": "S3File",
        "options": {
            "bucket": "cleanse-files",
            "path": "Sample/test.txt"
        }
    },
    {
        "cleanseFunction": "HttpStatusCleanser",
        "type": "Http",
        "options": {
            "url": "",
            "method": "GET",
            "lqtkey": "EEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEE",
            "p": "v+g",
            "opts": "DefaultCountry=RUS"
        }
    },
    {
        "cleanseFunction": "UppercaseCleanser",
        "type": "com.reltio.cleanse.sample.UppercaseCleanser",
        "module": "cleanse-files/Sample/UppercaseCleanserEx.jar"
    },
    {
        "cleanseFunction": "MECleanser",
        "type": "com.reltio.cleanse.sample.MECleanser",
        "module": "cleanse-files/Sample/UppercaseCleanserEx.jar"
    },
    {
        "cleanseFunction": "NPICleanser",
        "type": "com.reltio.cleanse.sample.NPICleanser",
        "module": "cleanse-files/Sample/UppercaseCleanserEx.jar"
    }
]

Here is a description of each function in the example. For details on our OOTB functions, see Out-of-the-box Cleanse Functions.

Table 2. cleanseFunction details
cleanseFunction	Description
`Loqate`	Integrates with the Loqate service to validate and standardize address information.
`VerificationStatusCleanser`	Uses a file from an S3 bucket to verify and cleanse data based on predefined rules.
`HttpStatusCleanser`	Simple HTTP cleanser. For more details, see topic HTTP Cleanse Function. Note: You cannot post or send any security headers through `HttpStatusCleanser` function.
`UppercaseCleanser`	Converts text data to uppercase to ensure consistency.
`MECleanser`	A custom cleanser designed for specific cleansing requirements.
`NPICleanser`	A custom cleanser tailored for National Provider Identifier (NPI) data cleansing.

Example Response

[
    {
        "cleanseFunction": "Loqate",
        "options": {
            "returnUnverifiedStatus": "true",
            "loqateDefaultCountry": "USA",
            "loqateLicensedCountry": "US;United States;USA;Canada;CA;Australia;AU"
        }
    },
    {
        "cleanseFunction": "VerificationStatusCleanser",
        "type": "S3File",
        "options": {
            "bucket": "cleanse-files",
            "path": "Sample/test.txt"
        }
    },
    {
        "cleanseFunction": "HttpStatusCleanser",
        "type": "Http",
        "options": {
            "url": "",
            "method": "GET",
            "lqtkey": "EEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEE",
            "p": "v+g",
            "opts": "DefaultCountry=RUS"
        }
    },
    {
        "cleanseFunction": "UppercaseCleanser",
        "type": "com.reltio.cleanse.sample.UppercaseCleanser",
        "module": "cleanse-files/Sample/UppercaseCleanserEx.jar"
    },
    {
        "cleanseFunction": "MECleanser",
        "type": "com.reltio.cleanse.sample.MECleanser",
        "module": "cleanse-files/Sample/UppercaseCleanserEx.jar"
    },
    {
        "cleanseFunction": "NPICleanser",
        "type": "com.reltio.cleanse.sample.NPICleanser",
        "module": "cleanse-files/Sample/UppercaseCleanserEx.jar"
    }
]

Unify and manage your data

Set Cleanse Functions Configuration

Footer