{"items":[{"type":"link","fsPath":"index.md","metadata":{"type":"markdown"},"label":"Getting Started","link":"/","routeSlug":"/"},{"type":"link","fsPath":"testing.md","metadata":{"type":"markdown"},"label":"Testing","link":"/testing","routeSlug":"/testing"},{"type":"link","fsPath":"mcp-server.md","metadata":{"type":"markdown"},"label":"MCP","link":"/mcp-server","routeSlug":"/mcp-server"},{"type":"link","fsPath":"webhooks.md","metadata":{"type":"markdown"},"label":"Webhooks","link":"/webhooks","routeSlug":"/webhooks"},{"type":"link","fsPath":"errors.md","metadata":{"type":"markdown"},"label":"Errors","link":"/errors","routeSlug":"/errors"},{"type":"link","label":"Checkr Tenant API","link":"/v1","routeSlug":"/v1"},{"type":"separator","label":"Resources"},{"type":"group","label":"Orders","link":"/v1/orders","routeSlug":"/v1/orders","items":[{"label":"List orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/orders/get-orders","routeSlug":"/v1/orders/get-orders","metadata":{"seo":{"title":"List orders","description":"List the orders owned by your organization, newest first. The responseis paginated — see next_href / previous_href for walking throughpages. Live-mode keys see only live-mode orders; test-mode keys seeonly test-mode orders."}},"httpPath":"/orders"},{"label":"Create order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/orders/post-orders","routeSlug":"/v1/orders/post-orders","metadata":{"seo":{"title":"Create order","description":"Create a new screening order for an applicant against a property. Theproperty and the applicant can each be supplied either inline (address/ identity fields) — in which case a new record is created — or by id(property_id / applicant_id) to reuse an existing record. Provideexactly one form per side."}},"httpPath":"/orders"},{"label":"Get order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/orders/get-order","routeSlug":"/v1/orders/get-order","metadata":{"seo":{"title":"Get order","description":"Retrieve an order by its id."}},"httpPath":"/orders/{id}"}]},{"type":"group","label":"Reports","link":"/v1/reports","routeSlug":"/v1/reports","items":[{"label":"Get report for order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/reports/get-order-report","routeSlug":"/v1/reports/get-order-report","metadata":{"seo":{"title":"Get report for order","description":"Retrieve the report associated with an order. Returns 404 if theorder has not yet produced a report — typically because it is stillin waiting_for_applicant or pending status."}},"httpPath":"/orders/{id}/report"},{"label":"Get report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/reports/get-report","routeSlug":"/v1/reports/get-report","metadata":{"seo":{"title":"Get report","description":"Retrieve a report by its id."}},"httpPath":"/reports/{id}"},{"label":"Download report PDF","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/reports/get-report-pdf","routeSlug":"/v1/reports/get-report-pdf","metadata":{"seo":{"title":"Download report PDF","description":"Download the report as a PDF file. The PDF is generated and returnedsynchronously in a single response — the bytes (application/pdf)come back on the same call, with no polling or callback. Generationcan take several seconds when a fresh render is required, soconfigure your HTTP client's read timeout to at least 60 secondsfor this endpoint to avoid prematurely aborting in-progress renders."}},"httpPath":"/reports/{id}/pdf"},{"label":"Download all report documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/reports/get-report-documents-zip","routeSlug":"/v1/reports/get-report-documents-zip","metadata":{"seo":{"title":"Download all report documents","description":"Download every document collected for the report as a single ZIParchive. The bytes (application/zip) come back on the same call."}},"httpPath":"/reports/{id}/documents/zip"},{"label":"Download a report document","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/reports/get-report-document","routeSlug":"/v1/reports/get-report-document","metadata":{"seo":{"title":"Download a report document","description":"Download a single document collected for the report, in the format itwas uploaded — read Content-Type rather than assuming PDF. Returns404 if the document does not exist on this report, or is of a kindnot retrievable for its order."}},"httpPath":"/reports/{id}/documents/{document_id}/download"}]},{"type":"group","label":"Properties","link":"/v1/properties","routeSlug":"/v1/properties","items":[{"label":"List properties","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/properties/get-properties","routeSlug":"/v1/properties/get-properties","metadata":{"seo":{"title":"List properties","description":"List the properties owned by your organization, newest first. Theresponse is paginated — see next_href / previous_href for walkingthrough pages."}},"httpPath":"/properties"},{"label":"Create property","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/properties/post-properties","routeSlug":"/v1/properties/post-properties","metadata":{"seo":{"title":"Create property","description":"Create a new property record from a mailing address. Properties createddirectly via this endpoint can later be referenced by property_idwhen creating an order, instead of supplying the address inline again."}},"httpPath":"/properties"},{"label":"Get property","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/properties/get-property","routeSlug":"/v1/properties/get-property","metadata":{"seo":{"title":"Get property","description":"Retrieve a property by its id. Returns 404 if the property does not exist or belongs to another organization."}},"httpPath":"/properties/{id}"}]},{"type":"group","label":"Applicants","link":"/v1/applicants","routeSlug":"/v1/applicants","items":[{"label":"List applicants","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/applicants/get-applicants","routeSlug":"/v1/applicants/get-applicants","metadata":{"seo":{"title":"List applicants","description":"List the applicants owned by your organization, newest first. Theresponse is paginated — see next_href / previous_href for walkingthrough pages."}},"httpPath":"/applicants"},{"label":"Create applicant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/applicants/post-applicants","routeSlug":"/v1/applicants/post-applicants","metadata":{"seo":{"title":"Create applicant","description":"Create a new applicant record from identity fields. Applicants createddirectly via this endpoint can later be referenced by applicant_idwhen creating an order, instead of supplying identity fields inlineagain."}},"httpPath":"/applicants"},{"label":"Get applicant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/applicants/get-applicant","routeSlug":"/v1/applicants/get-applicant","metadata":{"seo":{"title":"Get applicant","description":"Retrieve an applicant by its id. Returns 404 if the applicant does not exist or belongs to another organization."}},"httpPath":"/applicants/{id}"}]},{"type":"separator","label":"Products"},{"type":"group","label":"Products","link":"/v1/products","routeSlug":"/v1/products","items":[{"type":"link","label":"credit-report","link":"/v1/products/credit-report","routeSlug":"/v1/products/credit-report","httpVerb":"schema"},{"type":"link","label":"criminal-history","link":"/v1/products/criminal-history","routeSlug":"/v1/products/criminal-history","httpVerb":"schema"},{"type":"link","label":"eviction-history","link":"/v1/products/eviction-history","routeSlug":"/v1/products/eviction-history","httpVerb":"schema"},{"type":"link","label":"global-watchlist","link":"/v1/products/global-watchlist","routeSlug":"/v1/products/global-watchlist","httpVerb":"schema"},{"type":"link","label":"identity-verification","link":"/v1/products/identity-verification","routeSlug":"/v1/products/identity-verification","httpVerb":"schema"},{"type":"link","label":"income-verification","link":"/v1/products/income-verification","routeSlug":"/v1/products/income-verification","httpVerb":"schema"},{"type":"link","label":"sex-offender-registry","link":"/v1/products/sex-offender-registry","routeSlug":"/v1/products/sex-offender-registry","httpVerb":"schema"}]},{"type":"separator","label":"Webhooks"},{"type":"group","label":"Webhooks","link":"/v1/webhooks","routeSlug":"/v1/webhooks","items":[{"label":"report.completed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/v1/webhooks/paths/report.completed/post","routeSlug":"/v1/webhooks/paths/report.completed/post","metadata":{"seo":{"title":"report.completed","description":"Sent when an order has finished processing and the full report isavailable. See the Webhooks guide for deliverysemantics, retry behavior, and signature verification."}},"httpPath":"report.completed"},{"label":"report.product.completed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/v1/webhooks/paths/report.product.completed/post","routeSlug":"/v1/webhooks/paths/report.product.completed/post","metadata":{"seo":{"title":"report.product.completed","description":"Sent when a product finishes processing and results are available on the report."}},"httpPath":"report.product.completed"},{"label":"order.applicant.visited","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/v1/webhooks/paths/order.applicant.visited/post","routeSlug":"/v1/webhooks/paths/order.applicant.visited/post","metadata":{"seo":{"title":"order.applicant.visited","description":"Sent when the applicant visits the apply link for an order at any time before they complete the application."}},"httpPath":"order.applicant.visited"},{"label":"order.applicant.started","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/v1/webhooks/paths/order.applicant.started/post","routeSlug":"/v1/webhooks/paths/order.applicant.started/post","metadata":{"seo":{"title":"order.applicant.started","description":"Sent when the applicant consents to and starts the screening application."}},"httpPath":"order.applicant.started"},{"label":"order.applicant.completed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/v1/webhooks/paths/order.applicant.completed/post","routeSlug":"/v1/webhooks/paths/order.applicant.completed/post","metadata":{"seo":{"title":"order.applicant.completed","description":"Sent when the applicant finishes and submits the application."}},"httpPath":"order.applicant.completed"}]}]}