> For the complete documentation index, see [llms.txt](https://valify.gitbook.io/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://valify.gitbook.io/documentation/apis/sanction-check/sanction-shield-v2.1.0.md).

# Sanction Shield v2.1.0

<mark style="color:green;">`POST`</mark> `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<mark style="color:red;">\*</mark>   | string | application/json       |
| Authentication<mark style="color:red;">\*</mark> | string | Bearer \<access-token> |

#### Request Body

| Name                                             | Type   | Description                                                                                                                                                                                                                                                                                                                                                                                                                         |
| ------------------------------------------------ | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| document\_type<mark style="color:red;">\*</mark> | string | egy\_tax\_card                                                                                                                                                                                                                                                                                                                                                                                                                      |
| data<mark style="color:red;">\*</mark>           | object | <p>Object containing the parameters below: </p><p><code>{</code></p><p><code>"bundle\_key": \<string>,</code></p><p><code>"sanction\_lists": \[ \<string> ],</code></p><p><code>"fields": \[</code></p><p><code>{</code></p><p><code>"field\_name": \<string>,</code></p><p><code>"value": \<string>,</code></p><p><code>"cutoff\_match\_score": \<float></code></p><p><code>}</code></p><p><code>]</code></p><p><code>}</code></p> |

**Status Codes**

{% tabs %}
{% tab title="✅200 Successful" %}

```python
{
    "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>
                    }
                ]
            }
        ]
    }
}
```

{% endtab %}

{% tab title="5048 Invalid Sanction list" %}

```
{
    "message": "Invalid Sanction list.",
}
```

{% endtab %}

{% tab title="400 Missing input data" %}

```python
{
    "message": "Bad Request – invalid request received (e.g. missing Bundle key, required parameters or invalid json) | Make sure all the required parameters are included"
}
```

{% endtab %}

{% tab title="401 Invalid bundle key" %}

```python
{
    "message": "Unauthorized – your Bundle key is invalid"
}
```

{% endtab %}

{% tab title="403 Access token error" %}

```python
{
    "message": "Forbidden – specified access_token could not be found"
}
```

{% endtab %}

{% tab title="404 Check the endpoint" %}

```python
{
    "message": "Not Found"
}
```

{% endtab %}

{% tab title="415 The format should be base64" %}

```python
{
    "message": "Unsupported Media Type"
}
```

{% endtab %}

{% tab title="422 Check Valify error codes" %}

```python
{
    "message": "<error-description>",
    "error_code": <valify-error-code>
}
```

{% endtab %}

{% tab title="500 Contact us" %}

```python
{
    "message": "Internal Server Error"
}
```

{% endtab %}
{% endtabs %}

Specific error codes:

`5048` - Invalid Sanction List