Sanction Shield

Sanction Shield

POST https://valifystage.com/api/v2.1/sanction-shield/search/

Supported fields are:

• document_number : Passport number or National ID number

• full_name: Complete name as single field

In searching, no validation of the input is done other than checking if the input is a string.

Headers

Name	Type	Description
Content-Type	string	application/json
Authorization	string	Bearer <access-token>

Request Body

Name	Type	Description
data	object	Object containing the parameters below: { "bundle_key": <string>, "sanction_lists": [ <string> ] //MLCU_UNSC, "fields": [ { "field_name": <string>, "value": <string>, "cutoff_match_score": <float> } ], "match_all_fields": <boolean>, //optional "transliterate": <boolean> //optional }

Parameters breakdown:

Sanction lists:

A list containing all the sanctions list that a person will be sanctioned against.

Field name:

The name of the field from the supported fields that you want to be used.

Value:

The value of the field that you chose in the field name.

Cut-off match score:

The cut-off score is float number ranges from 0 to 1, it determines the sensitivity of your sanctions screening. It's the threshold that decides whether a potential match requires further review.

Recommended Cut-off Score: 0.8 (80%)

Based on extensive testing and global compliance standards, 80% is the optimal cut-off score for most organizations.

Why 80% Works Best

Perfect Compliance Detection

• 100% exact match rate ensures no sanctioned entities are missed

• Meets all regulatory requirements across EU, UN, OFAC, and DFAT lists

Status Codes

✅200 Success

{
    "transaction_id": <string>,
    "trials_remaining": <int>,
    "result": {
        "status": <string>,
        "is_match": <bool>,
        "matched_records": [
            {
                "data": {
                    "document_number": <string>,
                    "full_name": <string>,
                },
                "sanction_list": <string>,
                "matched_fields": [
                    {
                        "field_name": <string>,
                        "match_score": <float>
                    }
                ]
            }
        ]
    }
}

5048 - Invalid Sanction List

400 Missing input data