Sanction Shield v2.1.0

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

Supported fields are:

• document_number

• full_name

• first_name

• middle_name

• last_name

• nationality

• gender

• known_address

• birth_date_day

• birth_date_month

• birth_date_year

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
Authentication*	string	Bearer <access-token>

Request Body

Name	Type	Description
document_type*	string	egy_tax_card
data*	object	Object containing the parameters below: { "bundle_key": <string>, "sanction_lists": [ <string> ], "fields": [ { "field_name": <string>, "value": <string>, "cutoff_match_score": <float> } ] }

Status Codes

✅200 Successful

{
    "transaction_id": <string>,
    "trials_remaining": <int>,
    "result": {
        "status": <string>,
        "is_match": <bool>,
        "matched_records": [
            {
                "data": {
                    "document_number": <string>,
                    "full_name": <string>,
                    "first_name": <string>,
                    "middle_name": <string>,
                    "last_name": <string>,
                    "nationality": <string>,
                    "gender": <string>,
                    "known_address": <string>,
                    "birth_date_day": <int>,
                    "birth_date_month": <int>,
                    "birth_date_year": <int>,
                    "language": <string>,
                    "remarks": <string>
                },
                "sanction_list": <string>,
                "matched_fields": [
                    {
                        "field_name": <string>,
                        "match_score": <float>
                    }
                ]
            }
        ]
    }
}

5048 Invalid Sanction list

400 Missing input data

401 Invalid bundle key

403 Access token error

404 Check the endpoint

415 The format should be base64

422 Check Valify error codes

500 Contact us

Specific error codes:

5048 - Invalid Sanction List