# Background Check API

You can find the full YAML swagger specification [here](https://id.uqudo.io/doc/v3/id-api.yaml/backgroundCheck)

You can find the full JSON swagger specification [here](https://id.uqudo.io/doc/v3/id-api/backgroundCheck)

Every API below requires an access token that you can retrieve using the [Authorisation](https://docs.uqudo.com/docs/kyc/uqudo-api/authorisation) API

### Background check API

The following API allows you to trigger a background check based on the data passed in the body request

\
**Note**: the uqudo SDK provides an integrated step for background check that returns the same output in the final result. If you use our SDK we recommend to enable background check directly in the SDK and don't use this API

**Note**: If you have ICAD (Alert Decisioning) enabled, the **content** property in the result will always be null even if **match** property is true. ICAD requires a manual review on the RDC portal

**Note**: There is a bug in the visualization below for the response body. Please refer to the swagger definition above

{% openapi src="<https://id.uqudo.io/doc/v3/id-api/backgroundCheck>" path="/api/v1/bc/rdc" method="post" %}
<https://id.uqudo.io/doc/v3/id-api/backgroundCheck>
{% endopenapi %}

### Background check monitoring delete API

This endpoint allows you to delete the monitoring associated with a specific inquiry and based on the monitoring id returned in response of the same inquiry

{% openapi src="<https://id.uqudo.io/doc/v3/id-api/backgroundCheck>" path="/api/v1/bc/rdc/monitoring/{id}" method="delete" %}
<https://id.uqudo.io/doc/v3/id-api/backgroundCheck>
{% endopenapi %}

### Background check monitoring notification API (customer webhook)

This endpoint must be exposed by your system. Uqudo will push an update every time there is a change to a specific inquiry identified by the monitoring id. The endpoint can be open, protected by basic authentication or by custom headers.

## Customer webhook

<mark style="color:green;">`POST`</mark> `https://your_api_base_url/path`

Uqudo will push a json object in the request body. You can see the swagger definition here <https://id.uqudo.io/doc/v3/grid-services-v2-swagger.json#/definitions/AlertsType>

#### Query Parameters

| Name                                           | Type   | Description   |
| ---------------------------------------------- | ------ | ------------- |
| monitoringId<mark style="color:red;">\*</mark> | String | Monitoring id |

#### Request Body

| Name                               | Type | Description                                                                        |
| ---------------------------------- | ---- | ---------------------------------------------------------------------------------- |
| <mark style="color:red;">\*</mark> | JSON | <https://id.uqudo.io/doc/v3/grid-services-v2-swagger.json#/definitions/AlertsType> |