Skip to main content

Uniphore Help Center Portal

Fetch Redaction Configuration Details

Return the existing tenant-language redaction configuration details.

Endpoint

Method: GET

URL: http://localhost:5001/custom_config

curl --location 'http://localhost:5001/custom_config?lang={lang-code}&tenantId={tenantid}&environment=dev' \
     --data ''
Query Parameter

Parameter Name

Data Type

Description

Required/ Optional

lang

String

Enter the language code {lang-code}.

Required

tenantId

String

Enter the id of the tenant {tenantid}.

Required

environment

String

Enter dev which is the default value for all environment.

Required

Example Response

A zip file containing the response will be downloaded. The name of the zip file will be in {lang-code}_{tenant-id}_dev format. Example: en_uss_dev. The zip file contains the following two files.

  • pii_all_custom.json include custom entities with context and regex.

  • masking_config.json contains the redaction configuration details of PII and custom entities.

    In new tenants, the credit_card, cvv_number, expiry_date and pin_number are redacted by default.

    The entity for which the replaceable parameter is set to true is allowed to be redacted. The replacement parameter should be defined as X in order to replace the original data with X.

pii_all_custom.json
{
    "recognizers": {
        "ACCOUNT_NUMBER": {
            "value": {
                "entity": "ACCOUNT_NUMBER",
                "language": "en",
                "context": [
                    "account number",
                    "account id"
                ],
                "patterns": [{
                        "name": "code-regex",
                        "regex": "(?<!-)(\\b\\d{10}\\b)",
                        "score": 0.9
                    }
                ]
            }
        },
        "ZIP_CODE": {
            "value": {
                "entity": "ZIP_CODE",
                "language": "en",
                "context": [
                    "zip code",
                    "zip number"
                ],
                "patterns": [{
                        "name": "code-regex",
                        "regex": "(?<!-)(\\b\\d{5}\\b|\\b\\d{6}\\b)",
                        "score": 0.9
                    }
                ]
            }
        }
    },
    "analyze_template": {},
    "anonymize_template": {}
}
masking_config.json
{
    "field-map": {
        "credit_card": {
            "replaceable": true,
            "replacement": "X",
            "character": true
        },
        "cvv_number": {
            "replaceable": true,
            "replacement": "X",
            "character": true
        },
        "expiry_date": {
            "replaceable": true,
            "replacement": "X",
            "character": true
        },
        "phone_number": {
            "replaceable": true,
            "replacement": "X",
            "character": true
        },
        "email_address": {
            "replaceable": true,
            "replacement": "X",
            "character": true
        },
        "pin_number": {
            "replaceable": true,
            "replacement": "X",
            "character": true
        },
        "location": {
            "replaceable": true,
            "replacement": "X",
            "character": true
        },
        "us_ssn": {
            "replaceable": true,
            "replacement": "X",
            "character": true
        },
        "domain_name": {
            "replaceable": true,
            "replacement": "X",
            "character": true
        },
        "account_number": {
            "replaceable": true,
            "replacement": "X",
            "character": true
        },
        "zip_code": {
            "replaceable": true,
            "replacement": "X",
            "character": true
        }
    },
    "allow_list": ["India", "Israel"]
}
In this section: