{"openapi":"3.0.1","info":{"title":"Uqudo ID API","contact":{"email":"hello@uqu.do"},"version":"1.0"},"servers":[{"url":"https://id.uqudo.io"}],"tags":[{"name":"backgroundCheck","description":"Background check API"}],"paths":{"/api/v1/bc/rdc":{"post":{"tags":["backgroundCheck"],"summary":"Background check API","description":"This endpoint allows you to perform a background check","operationId":"rdc","parameters":[{"name":"Authorization","in":"header","description":"Bearer token","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackgroundCheckInput"}}},"required":true},"responses":{"200":{"description":"Background check result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackgroundCheckOutput"}}}},"400":{"description":"Bad Request: Missing required input or invalid format"},"401":{"description":"Unauthorized: No valid access token has been provided"},"403":{"description":"Forbidden: Access token doesn't have permission to use the requested feature"},"500":{"description":"Internal Server Error: Unexpected error"}}}},"/api/v1/bc/rdc/monitoring/{id}":{"delete":{"tags":["backgroundCheck"],"summary":"Monitoring delete","description":"This endpoint allows you to delete the monitoring associated with a specific inquiry","operationId":"rdcMonitoringDelete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No content"},"401":{"description":"Unauthorized: No valid access token has been provided"},"403":{"description":"Forbidden: Access token doesn't have permission to use the requested feature"},"500":{"description":"Internal Server Error: Unexpected error"}}}}},"components":{"schemas":{"BackgroundCheckInput":{"required":["fullName"],"type":"object","properties":{"enableMonitoring":{"type":"boolean","description":"If set to true it will enable continuous monitoring for the specific inquiry","default":false},"fullName":{"minLength":1,"type":"string","description":"Full name of the person"},"gender":{"type":"string","description":"Gender of the person","enum":["M","F"]},"dateOfBirth":{"type":"string","description":"Date of birth of the person in format yyyy-MM-dd","format":"date"},"countryCode":{"type":"string","description":"Country of residency of the person","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},"trackingId":{"type":"string","description":"Identifier for each inquiry record. You can use the identifier to retrieve the inquiry in Moody's portal."}}},"BackgroundCheckOutput":{"type":"object","properties":{"match":{"type":"boolean","description":"If a match was found"},"content":{"$ref":"https://id.uqudo.io/doc/v3/grid-services-v2-swagger.json#/definitions/AlertsType"},"monitoringId":{"type":"string","description":"When monitoring is enabled and the customer exposes a webhook where uqudo can push notifications"}}}}}}