Sanction Shield v2.1.0

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.

URL: api/v2.1/sanction-shield/search/ (POST)
Headers:
{
  "Authorization": "bearer <access-token>"
  "Content-Type": "application/json"
}
Body:
{
  "bundle_key": <string>,
  "sanction_lists": [ <string> ],
  "fields": [
    {
      "field_name": <string>,
      "value": <string>,
      "cutoff_match_score": <float>
    }
  ]
}

Successful Response

Status Code: 200
{
    "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>
                    }
                ]
            }
        ]
    }
}

Specific error codes:

5048 - Invalid Sanction List