> **Documentation Index:** Fetch the complete configuration index at https://yandex.com/dev/safebrowsing/doc/en/llms.txt

# Lookup. URL-based check

You can use this request type to check URLs against Yandex-hosted [Safe Browsing lists](https://yandex.com/dev/safebrowsing/doc/en/concepts/safebrowsing-lists.md#sb-lists). If the URL of the resource is found on one or more lists, the request returns data about the threat posed by the resource.

You can use one request to check multiple URLs.

## Request format {#request-format}
```
POST https://sba.yandex.net/v4/threatMatches:find
  ? [key](*key)=<API key>
```



#|
||
##key##[*](*requiredParam)
|

[API key](https://yandex.com/dev/safebrowsing/doc/en/concepts/restricts.md) value.

||
|#

\* Required

### Request body {#request-body}

```json
{
  "[client](*client)": {
    "[clientId](*clientId)": "{string}",
    "[clientVersion](*clientVersion)": "{string}"
  },
  "[threatInfo](*threatInfo)": {
    "[threatTypes](*threatTypes)": ["{enum}"],
    "[platformTypes](*platformTypes)": ["{enum}"],
    "[threatEntryTypes](*threatEntryTypes)": ["{enum}"],
    "[threatEntries](*threatEntries)": [
      {"[url](*url)": "{string}"}
    ]
  }
}
```

{% include notitle [client](../_includes/params.md#client) %}

{% include notitle [threatInfo](../_includes/params.md#threatInfo) %}

 
:   {% include notitle [threatTypes](../_includes/params.md#threatTypes) %}

    {% include notitle [platformTypes](../_includes/params.md#platformTypes) %}
    
    {% include notitle [threatEntryTypes](../_includes/params.md#threatEntryTypes) %}
    
    {% include notitle [threatEntries](../_includes/params.md#threatEntries) %}
    
     
    :   {% include notitle [url](../_includes/params.md#url) %}

\* Required

{% include [request-format-response-format](../_includes/concepts/safebrowsing-lists/id-request-format/response-format.md) %}


## Response format {#response-body}

If none of the checked URLs are found on the Safe Browsing lists, the empty response body is returned. If matches are found, the response contains detailed information about the danger posed by each of the resources found.

```json
{
  "[matches](*matches)": [
    {
      "[threatType](*threatType)": "{еnum}",
      "[platformType](*platformType)": "{еnum}",
      "[threatEntryType](*threatEntryType)": "{еnum}",
      "[threat](*threat)": {
        "[url](*url)": "{string}"
      },
      "[cacheDuration](*cacheDuration)": "{string}"
    }
  ]
}
```

{% include notitle [matches](../_includes/params.md#matches) %}

 
:   {% include notitle [threatType](../_includes/params.md#threatType) %}

    {% include notitle [platformType](../_includes/params.md#platformType) %}
    
    {% include notitle [threatEntryType](../_includes/params.md#threatEntryType) %}
    
    {% include notitle [threat](../_includes/params.md#threat) %}

     
    :   {% include notitle [url_2](../_includes/params.md#url_2) %}

    {% include notitle [cacheDuration](../_includes/params.md#cacheDuration) %}

\* Required

## Example {#example}

Request URL:

```
https://sba.yandex.net/v4/threatMatches:find?key=2f8...8ea
```

Request body:

```json
{
  "[client](*client)": {
    "[clientId](*clientId)": "{client_name}",
    "[clientVersion](*clientVersion)": "{1.1.1}"
  },
  "[threatInfo](*threatInfo)": {
    "[threatTypes](*threatTypes)": ["MALWARE", "SOCIAL_ENGINEERING"],
    "[platformTypes](*platformTypes)": ["WINDOWS"],
    "[threatEntryTypes](*threatEntryTypes)": ["URL"],
    "[threatEntries](*threatEntries)": [
      {"[url](*url)": "http://malware-driveby.test.safebrowsing.yandex"}
    ]
  }
}
```

Response:

```json
{
  "[matches](*matches)": [
    {
      "[threatType](*threatType)": "MALWARE",
      "[threatEntryType](*threatEntryType)": "URL",
      "[platformType](*platformType)": "WINDOWS",
      "[threat](*threat)": {
        "[url](*url)": "http://malware-driveby.test.safebrowsing.yandex"
      },
      "[cacheDuration](*cacheDuration)": "1200.00s"
    }
  ]
}
```
{% include notitle [table-style-none.md](../_includes/table-style-none.md) %}

[*key]: [API key](https://yandex.com/dev/safebrowsing/doc/en/concepts/restricts.md) value.

[*requiredParam]: \* Required

[*client]:
    {% include notitle [client](../_includes/popups.md#client) %}

[*clientId]:
    {% include notitle [clientId](../_includes/popups.md#clientId) %}

[*clientVersion]:
    {% include notitle [clientVersion](../_includes/popups.md#clientVersion) %}

[*threatInfo]:
    {% include notitle [threatInfo](../_includes/popups.md#threatInfo) %}

[*threatTypes]:
    {% include notitle [threatTypes](../_includes/popups.md#threatTypes) %}

[*platformTypes]:
    {% include notitle [platformTypes](../_includes/popups.md#platformTypes) %}

[*threatEntryTypes]:
    {% include notitle [threatEntryTypes](../_includes/popups.md#threatEntryTypes) %}

[*threatEntries]:
    {% include notitle [threatEntries](../_includes/popups.md#threatEntries) %}

[*threatType]:
    {% include notitle [threatType](../_includes/popups.md#threatType) %}

[*platformType]:
    {% include notitle [platformType](../_includes/popups.md#platformType) %}

[*threatEntryType]:
    {% include notitle [threatEntryType](../_includes/popups.md#threatEntryType) %}

[*threat]:
    {% include notitle [threat](../_includes/popups.md#threat) %}

[*url]:
    {% include notitle [url](../_includes/popups.md#url) %}

[*cacheDuration]:
    {% include notitle [cacheDuration](../_includes/popups.md#cacheDuration) %}

[*matches]:
    {% include notitle [matches](../_includes/popups.md#matches) %}
