Background Check API

You can find the full YAML swagger specification here

You can find the full JSON swagger specification here

Every API below requires an access token that you can retrieve using the 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

Background check API

This endpoint allows you to perform a background check

POSThttps://id.uqudo.io/api/v1/bc/rdc

Header parameters

Body

application/json

enableMonitoringboolean

If set to true it will enable continuous monitoring for the specific inquiry

fullName*string

Full name of the person

genderenum

Gender of the person

MF

dateOfBirthstring (date)

Date of birth of the person in format yyyy-MM-dd

countryCodeenum

Country of residency of the person

ADAEAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZW

trackingIdstring

Identifier for each inquiry record. You can use the identifier to retrieve the inquiry in Moody's portal.

Response

200400401403500

Background check result

Body

application/json

matchboolean

If a match was found

monitoringIdstring

When monitoring is enabled and the customer exposes a webhook where uqudo can push notifications

Request

JavaScriptCurlPython

const response = await fetch('https://id.uqudo.io/api/v1/bc/rdc', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "fullName": "text"
    }),
});
const data = await response.json();

Response

200

{
  "match": false,
  "monitoringId": "text"
}

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

Monitoring delete

This endpoint allows you to delete the monitoring associated with a specific inquiry

DELETEhttps://id.uqudo.io/api/v1/bc/rdc/monitoring/{id}

Path parameters

id*string

Header parameters

Response

204401403500

No content

Request

JavaScriptCurlPython

const response = await fetch('https://id.uqudo.io/api/v1/bc/rdc/monitoring/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "text"
    },
});
const data = await response.json();

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

POST 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*	String	Monitoring id

Request Body

Name	Type	Description
*	JSON	https://id.uqudo.io/doc/v3/grid-services-v2-swagger.json#/definitions/AlertsType