{"openapi":"3.1.0","info":{"title":"Checkr (BYOK) API","version":"0.1.0","description":"Checkr (BYOK) lets an AI assistant read your own Checkr data through the Checkr API with a key you supply (Checkr secret API key (production, not the publishable key)). Read-only: 9 tools (get_account, list_candidates, get_candidate, get_report, get_report_eta, list_invitations, get_invitation, list_packages, list_geos). The BYOK key travels with each request, is used for that one call only and...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-checkr.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-checkr/docs"},"termsOfService":"https://connectorbay.com/byok-checkr/terms"},"servers":[{"url":"https://byok-checkr.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-checkr/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/get_account":{"post":{"operationId":"get_account","summary":"Show the Checkr account the key belongs to: name, whether it is authorized for API use, purpose and the screenings it ca","description":"Show the Checkr account the key belongs to: name, whether it is authorized for API use, purpose and the screenings it can order. Use for \"Is my Checkr account authorized for API use and which screenings can it order\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_accountArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_candidates":{"post":{"operationId":"list_candidates","summary":"List Checkr candidates with their custom id, adjudication decision and the ids of their reports. Names, contact details ","description":"List Checkr candidates with their custom id, adjudication decision and the ids of their reports. Names, contact details and identity numbers are left out. Does not return candidates with non-US work locations. Use for \"Which Checkr candidates are waiting for an adjudication decision\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"adjudication":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only candidates with this adjudication value (for example engaged or post_adverse_action).","title":"Adjudication"},"custom_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only the candidate with this custom id you assigned.","title":"Custom Id"},"created_after":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only candidates created after this ISO 8601 time, for example 2026-01-01T00:00:00Z.","title":"Created After"},"created_before":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only candidates created before this ISO 8601 time.","title":"Created Before"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many results to return per page (default 25; the docs state no maximum, so keep it at 100 or less).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"title":"list_candidatesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_candidate":{"post":{"operationId":"get_candidate","summary":"Get one Checkr candidate by id: custom id, adjudication and the ids of their reports (no name, contact or identity data)","description":"Get one Checkr candidate by id: custom id, adjudication and the ids of their reports (no name, contact or identity data). Use for \"What reports does Checkr candidate e44aa283528e6fde7d542194 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"id":{"description":"Checkr candidate id.","maxLength":60,"title":"Id","type":"string"}},"required":["id"],"title":"get_candidateArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_report":{"post":{"operationId":"get_report","summary":"Get the status of one Checkr background check report: status, overall result, package, adjudication, assessment and key ","description":"Get the status of one Checkr background check report: status, overall result, package, adjudication, assessment and key dates. Individual search findings are not included. Use for \"Is Checkr report 4722c07dd9a10c3985ae432a complete and what is the result\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"id":{"description":"Checkr report id.","maxLength":60,"title":"Id","type":"string"}},"required":["id"],"title":"get_reportArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_report_eta":{"post":{"operationId":"get_report_eta","summary":"Get the estimated completion time of a pending Checkr report. Use for \"When will Checkr report 4722c07dd9a10c3985ae432a ","description":"Get the estimated completion time of a pending Checkr report. Use for \"When will Checkr report 4722c07dd9a10c3985ae432a be finished\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"report_id":{"description":"Checkr report id (take it from a candidate's report_ids).","maxLength":60,"title":"Report Id","type":"string"}},"required":["report_id"],"title":"get_report_etaArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_invitations":{"post":{"operationId":"list_invitations","summary":"List Checkr invitations (requests sent to candidates to start a background check) by status or candidate. Does not retur","description":"List Checkr invitations (requests sent to candidates to start a background check) by status or candidate. Does not return invitations with non-US work locations; the invitation link is left out. Use for \"Which Checkr invitations are still pending\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"status":{"anyOf":[{"enum":["pending","completed","expired"],"type":"string"},{"type":"null"}],"default":null,"description":"Only invitations with this status.","title":"Status"},"candidate_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only invitations sent to this candidate id.","title":"Candidate Id"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many results to return per page (default 25; the docs state no maximum, so keep it at 100 or less).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"title":"list_invitationsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_invitation":{"post":{"operationId":"get_invitation","summary":"Get one Checkr invitation by id with status, package, candidate, report id and dates (no invitation link). Use for \"Has ","description":"Get one Checkr invitation by id with status, package, candidate, report id and dates (no invitation link). Use for \"Has Checkr invitation 3c0a0ca94caaab6ca9634f76 been completed\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"id":{"description":"Checkr invitation id.","maxLength":60,"title":"Id","type":"string"}},"required":["id"],"title":"get_invitationArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_packages":{"post":{"operationId":"list_packages","summary":"List the Checkr screening packages of the account with name, slug, price in cents and the screenings each includes. Use ","description":"List the Checkr screening packages of the account with name, slug, price in cents and the screenings each includes. Use for \"Which background check packages can I order in Checkr\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many results to return per page (default 25; the docs state no maximum, so keep it at 100 or less).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"title":"list_packagesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_geos":{"post":{"operationId":"list_geos","summary":"List the Checkr geos (work locations) set up for the account, optionally filtered by name or state. Use for \"Which work ","description":"List the Checkr geos (work locations) set up for the account, optionally filtered by name or state. Use for \"Which work location geos are configured in Checkr\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only geos with this name.","title":"Name"},"state":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only geos in this state.","title":"State"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many results to return per page (default 25; the docs state no maximum, so keep it at 100 or less).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"title":"list_geosArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}