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

post

This endpoint allows you to perform a background check

Header parameters

AuthorizationstringRequired

Bearer token

Body

application/json

enableMonitoringbooleanOptional

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

Default: false

fullNamestring · min: 1Required

Full name of the person

genderstring · enumOptional

Gender of the person

Possible values:

dateOfBirthstring · dateOptional

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

countryCodestring · enumOptional

Country of residency of the person

Possible values:

trackingIdstringOptional

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

Responses

200

Background check result

application/json

400

Bad Request: Missing required input or invalid format

401

Unauthorized: No valid access token has been provided

403

Forbidden: Access token doesn't have permission to use the requested feature

500

Internal Server Error: Unexpected error

post

/api/v1/bc/rdc

HTTPcURLJavaScriptPython

POST /api/v1/bc/rdc HTTP/1.1
Host: id.uqudo.io
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 123

{
  "enableMonitoring": false,
  "fullName": "text",
  "gender": "M",
  "dateOfBirth": "2025-12-12",
  "countryCode": "AD",
  "trackingId": "text"
}

{
  "match": true,
  "content": {
    "alertDt": "2025-12-12T20:47:50.671Z",
    "alertEntity": [
      {
        "matchScore": 1,
        "riskScore": 1,
        "cvip": "text",
        "entityId": 1,
        "entityTyp": "text",
        "entityName": "text",
        "source": {
          "sourceName": "text",
          "sourceURL": "text",
          "entityDt": "1955-01-30",
          "format": "text",
          "headline": "text",
          "publicationSource": "text",
          "publisher": "text",
          "sourceKy": "text"
        },
        "event": [
          {
            "category": {
              "categoryCode": "text",
              "categoryDesc": "text"
            },
            "eventDesc": "text",
            "eventDt": "1955-01-30",
            "subCategory": {
              "categoryCode": "text",
              "categoryDesc": "text"
            },
            "source": {
              "sourceName": "text",
              "sourceURL": "text",
              "entityDt": "1955-01-30",
              "format": "text",
              "headline": "text",
              "publicationSource": "text",
              "publisher": "text",
              "sourceKy": "text"
            }
          }
        ],
        "postAddr": [
          {
            "locatorTyp": "text",
            "addr1": "text",
            "addr2": "text",
            "city": "text",
            "stateProv": "text",
            "postalCode": "text",
            "countryCode": {
              "countryCodeValue": "text"
            },
            "fromDt": "1955-01-30",
            "toDt": "1955-01-30"
          }
        ],
        "birthDt": "1955-01-30",
        "attribute": [
          {
            "attCode": "text",
            "attDesc": "text",
            "attVal": "text"
          }
        ],
        "alertNote": "text",
        "sysId": "text",
        "rdcURL": "text",
        "alias": [
          {
            "aliasTyp": "text",
            "aliasName": "text",
            "bestMatch": false
          }
        ],
        "sources": {
          "source": [
            {
              "sourceName": "text",
              "sourceURL": "text",
              "entityDt": "1955-01-30",
              "format": "text",
              "headline": "text",
              "publicationSource": "text",
              "publisher": "text",
              "sourceKy": "text"
            }
          ]
        },
        "fullPositions": {
          "fullPosition": [
            {
              "position": "text",
              "fromDate": "1955-01-30",
              "toDate": "1955-01-30"
            }
          ]
        },
        "pepTypes": {
          "pepType": [
            {
              "type": "text",
              "level": 1,
              "position": "text",
              "fromDate": "1955-01-30",
              "toDate": "1955-01-30"
            }
          ]
        },
        "rels": {
          "rel": [
            {
              "relDir": "text",
              "relTyp": "text",
              "sysId": "text",
              "entityName": "text"
            }
          ]
        },
        "alertConfidence": 1
      }
    ],
    "nonReviewedAlertEntity": [
      {
        "matchScore": 1,
        "riskScore": 1,
        "cvip": "text",
        "entityId": 1,
        "entityTyp": "text",
        "entityName": "text",
        "source": {
          "sourceName": "text",
          "sourceURL": "text",
          "entityDt": "1955-01-30",
          "format": "text",
          "headline": "text",
          "publicationSource": "text",
          "publisher": "text",
          "sourceKy": "text"
        },
        "event": [
          {
            "category": {
              "categoryCode": "text",
              "categoryDesc": "text"
            },
            "eventDesc": "text",
            "eventDt": "1955-01-30",
            "subCategory": {
              "categoryCode": "text",
              "categoryDesc": "text"
            },
            "source": {
              "sourceName": "text",
              "sourceURL": "text",
              "entityDt": "1955-01-30",
              "format": "text",
              "headline": "text",
              "publicationSource": "text",
              "publisher": "text",
              "sourceKy": "text"
            }
          }
        ],
        "postAddr": [
          {
            "locatorTyp": "text",
            "addr1": "text",
            "addr2": "text",
            "city": "text",
            "stateProv": "text",
            "postalCode": "text",
            "countryCode": {
              "countryCodeValue": "text"
            },
            "fromDt": "1955-01-30",
            "toDt": "1955-01-30"
          }
        ],
        "birthDt": "1955-01-30",
        "attribute": [
          {
            "attCode": "text",
            "attDesc": "text",
            "attVal": "text"
          }
        ],
        "alertNote": "text",
        "sysId": "text",
        "rdcURL": "text",
        "alias": [
          {
            "aliasTyp": "text",
            "aliasName": "text",
            "bestMatch": false
          }
        ],
        "sources": {
          "source": [
            {
              "sourceName": "text",
              "sourceURL": "text",
              "entityDt": "1955-01-30",
              "format": "text",
              "headline": "text",
              "publicationSource": "text",
              "publisher": "text",
              "sourceKy": "text"
            }
          ]
        },
        "fullPositions": {
          "fullPosition": [
            {
              "position": "text",
              "fromDate": "1955-01-30",
              "toDate": "1955-01-30"
            }
          ]
        },
        "pepTypes": {
          "pepType": [
            {
              "type": "text",
              "level": 1,
              "position": "text",
              "fromDate": "1955-01-30",
              "toDate": "1955-01-30"
            }
          ]
        },
        "rels": {
          "rel": [
            {
              "relDir": "text",
              "relTyp": "text",
              "sysId": "text",
              "entityName": "text"
            }
          ]
        },
        "alertConfidence": 1
      }
    ],
    "clientDecisionedAlertEntity": [
      {
        "matchScore": 1,
        "riskScore": 1,
        "cvip": "text",
        "entityId": 1,
        "entityTyp": "text",
        "entityName": "text",
        "source": {
          "sourceName": "text",
          "sourceURL": "text",
          "entityDt": "1955-01-30",
          "format": "text",
          "headline": "text",
          "publicationSource": "text",
          "publisher": "text",
          "sourceKy": "text"
        },
        "event": [
          {
            "category": {
              "categoryCode": "text",
              "categoryDesc": "text"
            },
            "eventDesc": "text",
            "eventDt": "1955-01-30",
            "subCategory": {
              "categoryCode": "text",
              "categoryDesc": "text"
            },
            "source": {
              "sourceName": "text",
              "sourceURL": "text",
              "entityDt": "1955-01-30",
              "format": "text",
              "headline": "text",
              "publicationSource": "text",
              "publisher": "text",
              "sourceKy": "text"
            }
          }
        ],
        "postAddr": [
          {
            "locatorTyp": "text",
            "addr1": "text",
            "addr2": "text",
            "city": "text",
            "stateProv": "text",
            "postalCode": "text",
            "countryCode": {
              "countryCodeValue": "text"
            },
            "fromDt": "1955-01-30",
            "toDt": "1955-01-30"
          }
        ],
        "birthDt": "1955-01-30",
        "attribute": [
          {
            "attCode": "text",
            "attDesc": "text",
            "attVal": "text"
          }
        ],
        "alertNote": "text",
        "sysId": "text",
        "rdcURL": "text",
        "alias": [
          {
            "aliasTyp": "text",
            "aliasName": "text",
            "bestMatch": false
          }
        ],
        "sources": {
          "source": [
            {
              "sourceName": "text",
              "sourceURL": "text",
              "entityDt": "1955-01-30",
              "format": "text",
              "headline": "text",
              "publicationSource": "text",
              "publisher": "text",
              "sourceKy": "text"
            }
          ]
        },
        "fullPositions": {
          "fullPosition": [
            {
              "position": "text",
              "fromDate": "1955-01-30",
              "toDate": "1955-01-30"
            }
          ]
        },
        "pepTypes": {
          "pepType": [
            {
              "type": "text",
              "level": 1,
              "position": "text",
              "fromDate": "1955-01-30",
              "toDate": "1955-01-30"
            }
          ]
        },
        "rels": {
          "rel": [
            {
              "relDir": "text",
              "relTyp": "text",
              "sysId": "text",
              "entityName": "text"
            }
          ]
        },
        "alertConfidence": 1,
        "identifications": [
          {
            "idNumber": "text",
            "idType": "text",
            "location": "text",
            "country": "text",
            "issueDt": "1955-01-30",
            "expDt": "2025-12-12T20:47:50.671Z"
          }
        ],
        "bestMatch": false,
        "clientDecisioningReason": {
          "reasonCode": "text",
          "reasonDescription": "text"
        }
      }
    ],
    "alertIlistEntry": [
      {
        "matchScore": 1,
        "personIlistInfo": {
          "ilistTrackingId": "text",
          "ilistEntryId": 1,
          "ilist": {
            "ilistId": 1,
            "name": "text",
            "description": "text",
            "source": [
              {
                "sourceName": "text",
                "sourceURL": "text",
                "entityDt": "1955-01-30",
                "format": "text",
                "headline": "text",
                "publicationSource": "text",
                "publisher": "text",
                "sourceKy": "text"
              }
            ]
          },
          "ilistEvent": {
            "category": {
              "categoryCode": "text",
              "categoryDesc": "text"
            },
            "eventDesc": "text",
            "eventDt": "1955-01-30",
            "subCategory": {
              "categoryCode": "text",
              "categoryDesc": "text"
            },
            "source": {
              "sourceName": "text",
              "sourceURL": "text",
              "entityDt": "1955-01-30",
              "format": "text",
              "headline": "text",
              "publicationSource": "text",
              "publisher": "text",
              "sourceKy": "text"
            },
            "endDate": "1955-01-30"
          },
          "alertNote": "text",
          "alias": [
            {
              "aliasTyp": "text",
              "aliasName": "text",
              "bestMatch": false
            }
          ],
          "rdcId": [
            {
              "rdcIdTyp": "text",
              "rdcIdVal": "text"
            }
          ],
          "additionalInfo": [
            {
              "info": "text"
            }
          ],
          "entryRule": [
            {
              "entryRuleDescription": "text"
            }
          ],
          "postAddr": [
            {
              "locatorTyp": "text",
              "addr1": "text",
              "addr2": "text",
              "city": "text",
              "stateProv": "text",
              "postalCode": "text",
              "countryCode": {
                "countryCodeValue": "text"
              },
              "fromDt": "1955-01-30",
              "toDt": "1955-01-30"
            }
          ],
          "birthDt": "1955-01-30",
          "personId": [
            {
              "driversLicenseOrPassportOrGenericPersonId": [
                {}
              ]
            }
          ],
          "personName": {
            "fullName": "text",
            "familyName": "text",
            "givenName": "text",
            "middleName": "text"
          }
        },
        "orgIlistInfo": {
          "ilistTrackingId": "text",
          "ilistEntryId": 1,
          "ilist": {
            "ilistId": 1,
            "name": "text",
            "description": "text",
            "source": [
              {
                "sourceName": "text",
                "sourceURL": "text",
                "entityDt": "1955-01-30",
                "format": "text",
                "headline": "text",
                "publicationSource": "text",
                "publisher": "text",
                "sourceKy": "text"
              }
            ]
          },
          "ilistEvent": {
            "category": {
              "categoryCode": "text",
              "categoryDesc": "text"
            },
            "eventDesc": "text",
            "eventDt": "1955-01-30",
            "subCategory": {
              "categoryCode": "text",
              "categoryDesc": "text"
            },
            "source": {
              "sourceName": "text",
              "sourceURL": "text",
              "entityDt": "1955-01-30",
              "format": "text",
              "headline": "text",
              "publicationSource": "text",
              "publisher": "text",
              "sourceKy": "text"
            },
            "endDate": "1955-01-30"
          },
          "alertNote": "text",
          "alias": [
            {
              "aliasTyp": "text",
              "aliasName": "text",
              "bestMatch": false
            }
          ],
          "rdcId": [
            {
              "rdcIdTyp": "text",
              "rdcIdVal": "text"
            }
          ],
          "additionalInfo": [
            {
              "info": "text"
            }
          ],
          "entryRule": [
            {
              "entryRuleDescription": "text"
            }
          ],
          "postAddr": [
            {
              "locatorTyp": "text",
              "addr1": "text",
              "addr2": "text",
              "city": "text",
              "stateProv": "text",
              "postalCode": "text",
              "countryCode": {
                "countryCodeValue": "text"
              },
              "fromDt": "1955-01-30",
              "toDt": "1955-01-30"
            }
          ],
          "orgId": [
            {
              "genericOrgId": [
                {
                  "genericIdNbr": "text",
                  "genericIdTyp": "SSN",
                  "genericIdIssueDt": "1955-01-30",
                  "genericIdExpDt": "1955-01-30",
                  "genericIdCountryCode": {
                    "countryCodeValue": "text"
                  }
                }
              ]
            }
          ],
          "name": "text"
        },
        "countryIlistInfo": {
          "ilistTrackingId": "text",
          "ilistEntryId": 1,
          "ilist": {
            "ilistId": 1,
            "name": "text",
            "description": "text",
            "source": [
              {
                "sourceName": "text",
                "sourceURL": "text",
                "entityDt": "1955-01-30",
                "format": "text",
                "headline": "text",
                "publicationSource": "text",
                "publisher": "text",
                "sourceKy": "text"
              }
            ]
          },
          "ilistEvent": {
            "category": {
              "categoryCode": "text",
              "categoryDesc": "text"
            },
            "eventDesc": "text",
            "eventDt": "1955-01-30",
            "subCategory": {
              "categoryCode": "text",
              "categoryDesc": "text"
            },
            "source": {
              "sourceName": "text",
              "sourceURL": "text",
              "entityDt": "1955-01-30",
              "format": "text",
              "headline": "text",
              "publicationSource": "text",
              "publisher": "text",
              "sourceKy": "text"
            },
            "endDate": "1955-01-30"
          },
          "alertNote": "text",
          "alias": [
            {
              "aliasTyp": "text",
              "aliasName": "text",
              "bestMatch": false
            }
          ],
          "rdcId": [
            {
              "rdcIdTyp": "text",
              "rdcIdVal": "text"
            }
          ],
          "additionalInfo": [
            {
              "info": "text"
            }
          ],
          "entryRule": [
            {
              "entryRuleDescription": "text"
            }
          ],
          "name": "text",
          "shortName": "text",
          "city": "text",
          "stateProv": "text",
          "postalCode": "text"
        }
      }
    ],
    "clientDecisionedAlertIlistEntry": [
      {
        "matchScore": 1,
        "personIlistInfo": {
          "ilistTrackingId": "text",
          "ilistEntryId": 1,
          "ilist": {
            "ilistId": 1,
            "name": "text",
            "description": "text",
            "source": [
              {
                "sourceName": "text",
                "sourceURL": "text",
                "entityDt": "1955-01-30",
                "format": "text",
                "headline": "text",
                "publicationSource": "text",
                "publisher": "text",
                "sourceKy": "text"
              }
            ]
          },
          "ilistEvent": {
            "category": {
              "categoryCode": "text",
              "categoryDesc": "text"
            },
            "eventDesc": "text",
            "eventDt": "1955-01-30",
            "subCategory": {
              "categoryCode": "text",
              "categoryDesc": "text"
            },
            "source": {
              "sourceName": "text",
              "sourceURL": "text",
              "entityDt": "1955-01-30",
              "format": "text",
              "headline": "text",
              "publicationSource": "text",
              "publisher": "text",
              "sourceKy": "text"
            },
            "endDate": "1955-01-30"
          },
          "alertNote": "text",
          "alias": [
            {
              "aliasTyp": "text",
              "aliasName": "text",
              "bestMatch": false
            }
          ],
          "rdcId": [
            {
              "rdcIdTyp": "text",
              "rdcIdVal": "text"
            }
          ],
          "additionalInfo": [
            {
              "info": "text"
            }
          ],
          "entryRule": [
            {
              "entryRuleDescription": "text"
            }
          ],
          "postAddr": [
            {
              "locatorTyp": "text",
              "addr1": "text",
              "addr2": "text",
              "city": "text",
              "stateProv": "text",
              "postalCode": "text",
              "countryCode": {
                "countryCodeValue": "text"
              },
              "fromDt": "1955-01-30",
              "toDt": "1955-01-30"
            }
          ],
          "birthDt": "1955-01-30",
          "personId": [
            {
              "driversLicenseOrPassportOrGenericPersonId": [
                {}
              ]
            }
          ],
          "personName": {
            "fullName": "text",
            "familyName": "text",
            "givenName": "text",
            "middleName": "text"
          }
        },
        "orgIlistInfo": {
          "ilistTrackingId": "text",
          "ilistEntryId": 1,
          "ilist": {
            "ilistId": 1,
            "name": "text",
            "description": "text",
            "source": [
              {
                "sourceName": "text",
                "sourceURL": "text",
                "entityDt": "1955-01-30",
                "format": "text",
                "headline": "text",
                "publicationSource": "text",
                "publisher": "text",
                "sourceKy": "text"
              }
            ]
          },
          "ilistEvent": {
            "category": {
              "categoryCode": "text",
              "categoryDesc": "text"
            },
            "eventDesc": "text",
            "eventDt": "1955-01-30",
            "subCategory": {
              "categoryCode": "text",
              "categoryDesc": "text"
            },
            "source": {
              "sourceName": "text",
              "sourceURL": "text",
              "entityDt": "1955-01-30",
              "format": "text",
              "headline": "text",
              "publicationSource": "text",
              "publisher": "text",
              "sourceKy": "text"
            },
            "endDate": "1955-01-30"
          },
          "alertNote": "text",
          "alias": [
            {
              "aliasTyp": "text",
              "aliasName": "text",
              "bestMatch": false
            }
          ],
          "rdcId": [
            {
              "rdcIdTyp": "text",
              "rdcIdVal": "text"
            }
          ],
          "additionalInfo": [
            {
              "info": "text"
            }
          ],
          "entryRule": [
            {
              "entryRuleDescription": "text"
            }
          ],
          "postAddr": [
            {
              "locatorTyp": "text",
              "addr1": "text",
              "addr2": "text",
              "city": "text",
              "stateProv": "text",
              "postalCode": "text",
              "countryCode": {
                "countryCodeValue": "text"
              },
              "fromDt": "1955-01-30",
              "toDt": "1955-01-30"
            }
          ],
          "orgId": [
            {
              "genericOrgId": [
                {
                  "genericIdNbr": "text",
                  "genericIdTyp": "SSN",
                  "genericIdIssueDt": "1955-01-30",
                  "genericIdExpDt": "1955-01-30",
                  "genericIdCountryCode": {
                    "countryCodeValue": "text"
                  }
                }
              ]
            }
          ],
          "name": "text"
        },
        "countryIlistInfo": {
          "ilistTrackingId": "text",
          "ilistEntryId": 1,
          "ilist": {
            "ilistId": 1,
            "name": "text",
            "description": "text",
            "source": [
              {
                "sourceName": "text",
                "sourceURL": "text",
                "entityDt": "1955-01-30",
                "format": "text",
                "headline": "text",
                "publicationSource": "text",
                "publisher": "text",
                "sourceKy": "text"
              }
            ]
          },
          "ilistEvent": {
            "category": {
              "categoryCode": "text",
              "categoryDesc": "text"
            },
            "eventDesc": "text",
            "eventDt": "1955-01-30",
            "subCategory": {
              "categoryCode": "text",
              "categoryDesc": "text"
            },
            "source": {
              "sourceName": "text",
              "sourceURL": "text",
              "entityDt": "1955-01-30",
              "format": "text",
              "headline": "text",
              "publicationSource": "text",
              "publisher": "text",
              "sourceKy": "text"
            },
            "endDate": "1955-01-30"
          },
          "alertNote": "text",
          "alias": [
            {
              "aliasTyp": "text",
              "aliasName": "text",
              "bestMatch": false
            }
          ],
          "rdcId": [
            {
              "rdcIdTyp": "text",
              "rdcIdVal": "text"
            }
          ],
          "additionalInfo": [
            {
              "info": "text"
            }
          ],
          "entryRule": [
            {
              "entryRuleDescription": "text"
            }
          ],
          "name": "text",
          "shortName": "text",
          "city": "text",
          "stateProv": "text",
          "postalCode": "text"
        },
        "clientDecisioningReason": {
          "reasonCode": "text",
          "reasonDescription": "text"
        }
      }
    ],
    "nonReviewedAlertIlistEntry": [
      {
        "matchScore": 1,
        "personIlistInfo": {
          "ilistTrackingId": "text",
          "ilistEntryId": 1,
          "ilist": {
            "ilistId": 1,
            "name": "text",
            "description": "text",
            "source": [
              {
                "sourceName": "text",
                "sourceURL": "text",
                "entityDt": "1955-01-30",
                "format": "text",
                "headline": "text",
                "publicationSource": "text",
                "publisher": "text",
                "sourceKy": "text"
              }
            ]
          },
          "ilistEvent": {
            "category": {
              "categoryCode": "text",
              "categoryDesc": "text"
            },
            "eventDesc": "text",
            "eventDt": "1955-01-30",
            "subCategory": {
              "categoryCode": "text",
              "categoryDesc": "text"
            },
            "source": {
              "sourceName": "text",
              "sourceURL": "text",
              "entityDt": "1955-01-30",
              "format": "text",
              "headline": "text",
              "publicationSource": "text",
              "publisher": "text",
              "sourceKy": "text"
            },
            "endDate": "1955-01-30"
          },
          "alertNote": "text",
          "alias": [
            {
              "aliasTyp": "text",
              "aliasName": "text",
              "bestMatch": false
            }
          ],
          "rdcId": [
            {
              "rdcIdTyp": "text",
              "rdcIdVal": "text"
            }
          ],
          "additionalInfo": [
            {
              "info": "text"
            }
          ],
          "entryRule": [
            {
              "entryRuleDescription": "text"
            }
          ],
          "postAddr": [
            {
              "locatorTyp": "text",
              "addr1": "text",
              "addr2": "text",
              "city": "text",
              "stateProv": "text",
              "postalCode": "text",
              "countryCode": {
                "countryCodeValue": "text"
              },
              "fromDt": "1955-01-30",
              "toDt": "1955-01-30"
            }
          ],
          "birthDt": "1955-01-30",
          "personId": [
            {
              "driversLicenseOrPassportOrGenericPersonId": [
                {}
              ]
            }
          ],
          "personName": {
            "fullName": "text",
            "familyName": "text",
            "givenName": "text",
            "middleName": "text"
          }
        },
        "orgIlistInfo": {
          "ilistTrackingId": "text",
          "ilistEntryId": 1,
          "ilist": {
            "ilistId": 1,
            "name": "text",
            "description": "text",
            "source": [
              {
                "sourceName": "text",
                "sourceURL": "text",
                "entityDt": "1955-01-30",
                "format": "text",
                "headline": "text",
                "publicationSource": "text",
                "publisher": "text",
                "sourceKy": "text"
              }
            ]
          },
          "ilistEvent": {
            "category": {
              "categoryCode": "text",
              "categoryDesc": "text"
            },
            "eventDesc": "text",
            "eventDt": "1955-01-30",
            "subCategory": {
              "categoryCode": "text",
              "categoryDesc": "text"
            },
            "source": {
              "sourceName": "text",
              "sourceURL": "text",
              "entityDt": "1955-01-30",
              "format": "text",
              "headline": "text",
              "publicationSource": "text",
              "publisher": "text",
              "sourceKy": "text"
            },
            "endDate": "1955-01-30"
          },
          "alertNote": "text",
          "alias": [
            {
              "aliasTyp": "text",
              "aliasName": "text",
              "bestMatch": false
            }
          ],
          "rdcId": [
            {
              "rdcIdTyp": "text",
              "rdcIdVal": "text"
            }
          ],
          "additionalInfo": [
            {
              "info": "text"
            }
          ],
          "entryRule": [
            {
              "entryRuleDescription": "text"
            }
          ],
          "postAddr": [
            {
              "locatorTyp": "text",
              "addr1": "text",
              "addr2": "text",
              "city": "text",
              "stateProv": "text",
              "postalCode": "text",
              "countryCode": {
                "countryCodeValue": "text"
              },
              "fromDt": "1955-01-30",
              "toDt": "1955-01-30"
            }
          ],
          "orgId": [
            {
              "genericOrgId": [
                {
                  "genericIdNbr": "text",
                  "genericIdTyp": "SSN",
                  "genericIdIssueDt": "1955-01-30",
                  "genericIdExpDt": "1955-01-30",
                  "genericIdCountryCode": {
                    "countryCodeValue": "text"
                  }
                }
              ]
            }
          ],
          "name": "text"
        },
        "countryIlistInfo": {
          "ilistTrackingId": "text",
          "ilistEntryId": 1,
          "ilist": {
            "ilistId": 1,
            "name": "text",
            "description": "text",
            "source": [
              {
                "sourceName": "text",
                "sourceURL": "text",
                "entityDt": "1955-01-30",
                "format": "text",
                "headline": "text",
                "publicationSource": "text",
                "publisher": "text",
                "sourceKy": "text"
              }
            ]
          },
          "ilistEvent": {
            "category": {
              "categoryCode": "text",
              "categoryDesc": "text"
            },
            "eventDesc": "text",
            "eventDt": "1955-01-30",
            "subCategory": {
              "categoryCode": "text",
              "categoryDesc": "text"
            },
            "source": {
              "sourceName": "text",
              "sourceURL": "text",
              "entityDt": "1955-01-30",
              "format": "text",
              "headline": "text",
              "publicationSource": "text",
              "publisher": "text",
              "sourceKy": "text"
            },
            "endDate": "1955-01-30"
          },
          "alertNote": "text",
          "alias": [
            {
              "aliasTyp": "text",
              "aliasName": "text",
              "bestMatch": false
            }
          ],
          "rdcId": [
            {
              "rdcIdTyp": "text",
              "rdcIdVal": "text"
            }
          ],
          "additionalInfo": [
            {
              "info": "text"
            }
          ],
          "entryRule": [
            {
              "entryRuleDescription": "text"
            }
          ],
          "name": "text",
          "shortName": "text",
          "city": "text",
          "stateProv": "text",
          "postalCode": "text"
        }
      }
    ],
    "portfolioMonitoringAlert": 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

delete

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

Path parameters

idstringRequired

Header parameters

AuthorizationstringRequired

Bearer token

Responses

204

No content

401

Unauthorized: No valid access token has been provided

403

Forbidden: Access token doesn't have permission to use the requested feature

500

Internal Server Error: Unexpected error

delete

/api/v1/bc/rdc/monitoring/{id}

HTTPcURLJavaScriptPython

DELETE /api/v1/bc/rdc/monitoring/{id} HTTP/1.1
Host: id.uqudo.io
Authorization: text
Accept: */*

No content

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