{"id":16508,"date":"2026-06-03T14:35:53","date_gmt":"2026-06-03T04:35:53","guid":{"rendered":"https:\/\/workerchecks.com\/?post_type=docs&#038;p=16508"},"modified":"2026-06-03T14:37:17","modified_gmt":"2026-06-03T04:37:17","password":"","slug":"16508","status":"publish","type":"docs","link":"https:\/\/workerchecks.com\/ne\/docs\/16508\/","title":{"rendered":"Worker Checks Business API \u2014 Overview"},"content":{"rendered":"<!DOCTYPE html>\n<html lang=\"en\">\n<head>\n  <meta charset=\"UTF-8\">\n  <title>WorkerChecks Business API \u2014 Overview<\/title>\n  <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">\n  <style>\n    * { box-sizing: border-box; margin: 0; padding: 0; }\n    body {\n      font-family: 'Helvetica Neue', Helvetica, Arial, sans-serif;\n      background: #F4F7FB;\n      color: #0B1D3A;\n      font-size: 15px;\n      line-height: 1.7;\n    }\n    .container {\n      max-width: 780px;\n      margin: 40px auto;\n      padding: 0 20px 60px;\n    }\n\n    \/* Breadcrumb *\/\n    .breadcrumb {\n      font-size: 13px;\n      color: #64748b;\n      margin-bottom: 20px;\n    }\n    .breadcrumb a {\n      color: #005bab;\n      text-decoration: none;\n    }\n    .breadcrumb a:hover { text-decoration: underline; }\n    .breadcrumb span { margin: 0 6px; }\n\n    \/* Title *\/\n    h1 {\n      font-size: 26px;\n      font-weight: 700;\n      color: #0B1D3A;\n      margin-bottom: 6px;\n      line-height: 1.3;\n    }\n    .article-meta {\n      font-size: 13px;\n      color: #64748b;\n      margin-bottom: 28px;\n      padding-bottom: 20px;\n      border-bottom: 1px solid #E2E8F0;\n    }\n\n    \/* Headings *\/\n    h2 {\n      font-size: 18px;\n      font-weight: 700;\n      color: #005bab;\n      margin: 36px 0 12px;\n    }\n    h3 {\n      font-size: 15px;\n      font-weight: 700;\n      color: #0B1D3A;\n      margin: 24px 0 8px;\n    }\n\n    p { margin-bottom: 14px; color: #334155; }\n\n    \/* Callout boxes *\/\n    .callout {\n      background: #e3f3fc;\n      border-left: 4px solid #005bab;\n      border-radius: 0 6px 6px 0;\n      padding: 14px 18px;\n      margin: 20px 0;\n      font-size: 14px;\n      color: #0B1D3A;\n    }\n    .callout strong { color: #005bab; }\n\n    .callout-tip {\n      background: #f0fdf4;\n      border-left: 4px solid #16a34a;\n      border-radius: 0 6px 6px 0;\n      padding: 14px 18px;\n      margin: 20px 0;\n      font-size: 14px;\n      color: #14532d;\n    }\n\n    \/* Table *\/\n    table {\n      width: 100%;\n      border-collapse: collapse;\n      margin: 16px 0 24px;\n      font-size: 14px;\n    }\n    thead tr {\n      background: #005bab;\n      color: #fff;\n    }\n    thead th {\n      padding: 10px 14px;\n      text-align: left;\n      font-weight: 600;\n    }\n    tbody tr:nth-child(even) { background: #F4F7FB; }\n    tbody tr:nth-child(odd) { background: #fff; }\n    tbody td {\n      padding: 10px 14px;\n      border-bottom: 1px solid #E2E8F0;\n      color: #334155;\n      vertical-align: top;\n    }\n\n    \/* Lists *\/\n    ul {\n      margin: 8px 0 16px 20px;\n      color: #334155;\n    }\n    ul li { margin-bottom: 6px; }\n\n    \/* Divider *\/\n    hr {\n      border: none;\n      border-top: 1px solid #E2E8F0;\n      margin: 36px 0;\n    }\n\n    \/* CTA strip *\/\n    .cta-strip {\n      background: #005bab;\n      border-radius: 8px;\n      padding: 22px 24px;\n      margin: 32px 0;\n      display: flex;\n      align-items: center;\n      justify-content: space-between;\n      gap: 16px;\n      flex-wrap: wrap;\n    }\n    .cta-strip p {\n      color: #fff;\n      margin: 0;\n      font-size: 15px;\n      font-weight: 600;\n    }\n    .cta-strip small {\n      display: block;\n      color: #bde4f7;\n      font-size: 13px;\n      font-weight: 400;\n      margin-top: 2px;\n    }\n    .cta-btn {\n      background: #fff;\n      color: #005bab;\n      text-decoration: none;\n      font-weight: 700;\n      font-size: 14px;\n      padding: 10px 20px;\n      border-radius: 6px;\n      white-space: nowrap;\n      display: inline-block;\n    }\n    .cta-btn:hover { background: #bde4f7; }\n\n    \/* Help strip footer *\/\n    .help-strip {\n      background: #e3f3fc;\n      border-radius: 8px;\n      padding: 18px 22px;\n      margin-top: 40px;\n      font-size: 14px;\n      color: #0B1D3A;\n      text-align: center;\n    }\n    .help-strip p { color: #0B1D3A; margin-bottom: 10px; }\n    .help-strip a {\n      color: #005bab;\n      text-decoration: none;\n      font-weight: 600;\n      margin: 0 8px;\n    }\n    .help-strip a:hover { text-decoration: underline; }\n    .help-strip .sep { color: #94a3b8; }\n  <\/style>\n<\/head>\n<body>\n<div class=\"container\">\n\n  <!-- Breadcrumb -->\n  <div class=\"breadcrumb\">\n    <a href=\"https:\/\/workerchecks.com\/ne\/%e0%a4%ae%e0%a4%a6%e0%a5%8d%e0%a4%a6%e0%a4%a4-%e0%a4%95%e0%a5%87%e0%a4%a8%e0%a5%8d%e0%a4%a6%e0%a5%8d%e0%a4%b0\/\">\u092e\u0926\u094d\u0926\u0924 \u0915\u0947\u0928\u094d\u0926\u094d\u0930<\/a>\n    <span>\u203a<\/span>\n    <a href=\"#\">\u092c\u093f\u091c\u0928\u0947\u0938\u0939\u092c<\/a>\n    <span>\u203a<\/span>\n    Business API Overview\n  <\/div>\n\n  <!-- Title -->\n  <h1>WorkerChecks Business API \u2014 Overview<\/h1>\n  <div class=\"article-meta\">For BusinessHub customers &nbsp;\u00b7&nbsp; API &amp; Integrations<\/div>\n\n  <!-- Intro -->\n  <div class=\"callout\">\n    <strong>What is the Business API?<\/strong><br>\n    The WorkerChecks Business API lets your internal systems connect directly to Worker Checks \u2014 so you can automate check invitations, track progress, and retrieve results without logging into the portal manually.\n  <\/div>\n\n  <!-- Who is this for -->\n  <h2>Who is this for?<\/h2>\n  <p>The API is designed for <strong>BusinessHub customers<\/strong> who want to integrate background check workflows into their own software \u2014 such as an HR platform, onboarding system, or applicant tracking tool.<\/p>\n  <p>You will need a developer or technical resource to build and maintain the integration.<\/p>\n\n  <!-- What can the API do -->\n  <h2>What can the API do?<\/h2>\n  <p>The API currently supports four core actions:<\/p>\n\n  <table>\n    <thead>\n      <tr>\n        <th>\u090f\u0915\u094d\u0938\u0928<\/th>\n        <th>What it does<\/th>\n      <\/tr>\n    <\/thead>\n    <tbody>\n      <tr>\n        <td><strong>Create a check invitation<\/strong><\/td>\n        <td>Send a check request for a worker directly from your system<\/td>\n      <\/tr>\n      <tr>\n        <td><strong>Cancel an invitation<\/strong><\/td>\n        <td>Cancel a pending check before it has been submitted<\/td>\n      <\/tr>\n      <tr>\n        <td><strong>Get a result summary<\/strong><\/td>\n        <td>Retrieve the current status and outcome of a completed check<\/td>\n      <\/tr>\n      <tr>\n        <td><strong>Authenticate<\/strong><\/td>\n        <td>Generate a secure access token to authorise your requests<\/td>\n      <\/tr>\n    <\/tbody>\n  <\/table>\n\n  <!-- Authentication -->\n  <h2>How does authentication work?<\/h2>\n  <p>The API uses short-lived <strong>bearer tokens<\/strong> for security. Your system calls the authentication endpoint using your Widget Secret (available in your BusinessHub account settings) and receives a token valid for <strong>24 hours<\/strong>. That token is included in the header of every subsequent API request.<\/p>\n\n  <div class=\"callout\">\n    <strong>\u0928\u094b\u091f:<\/strong> Tokens expire after 24 hours and must be refreshed. Build token refresh logic into your integration from the start.\n  <\/div>\n\n  <!-- What comes back -->\n  <h2>What information comes back from a check?<\/h2>\n  <p>Once a check is complete, the result endpoint returns:<\/p>\n  <ul>\n    <li><strong>\u0938\u094d\u0925\u093f\u0924\u093f<\/strong> \u2014 Pending, In Progress, Completed, or Cancelled<\/li>\n    <li><strong>Result<\/strong> \u2014 Clear, Attention Required, or Refer (null if not yet complete)<\/li>\n    <li><strong>Release date<\/strong> \u2014 when the result was finalised<\/li>\n    <li><strong>Certificate URL<\/strong> \u2014 a secure link to view the full result certificate<\/li>\n  <\/ul>\n\n  <div class=\"callout-tip\">\n    <strong>Turnaround times:<\/strong> Around 80% of checks return within 1\u20133 minutes. The remaining ~20% are referred for manual review by ACIC and may take 1\u201315 business days.\n  <\/div>\n\n  <!-- What you need -->\n  <h2>What do I need to get started?<\/h2>\n  <p>To use the API you will need:<\/p>\n  <ul>\n    <li>An active BusinessHub account with Worker Checks<\/li>\n    <li>Contact Worker Checks to activate your API access<\/li>\n    <li>A developer to build and maintain the integration<\/li>\n    <li>Your product ID for the check type you want to submit (we will provide this)<\/li>\n  <\/ul>\n\n  <!-- Rate limits -->\n  <h2>Rate limits<\/h2>\n  <p>The result endpoint supports up to <strong>30 requests per minute<\/strong> per account. If you exceed this, requests will return an HTTP 429 error \u2014 wait 60 seconds before retrying.<\/p>\n\n  <hr>\n\n  <!-- CTA -->\n  <div class=\"cta-strip\">\n    <p>\n      Ready to integrate?\n      <small>Contact our team to activate your API access and receive your credentials.<\/small>\n    <\/p>\n    <a class=\"cta-btn\" href=\"mailto:support@workerchecks.com\">Email us to get started<\/a>\n  <\/div>\n\n  <!-- Help strip -->\n  <div class=\"help-strip\">\n    <p>Need help with something else?<\/p>\n    <div>\n      <a href=\"mailto:support@workerchecks.com\">Email support<\/a>\n      <span class=\"sep\">\u00b7<\/span>\n      <a href=\"https:\/\/workerchecks.com\/ne\/%e0%a4%ae%e0%a4%a6%e0%a5%8d%e0%a4%a6%e0%a4%a4-%e0%a4%95%e0%a5%87%e0%a4%a8%e0%a5%8d%e0%a4%a6%e0%a5%8d%e0%a4%b0\/\">Back to Help Hub<\/a>\n    <\/div>\n  <\/div>\n\n<\/div>\n<\/body>\n<\/html>","protected":false},"excerpt":{"rendered":"<p>WorkerChecks Business API \u2014 Overview Help Hub \u203a BusinessHub \u203a Business API Overview WorkerChecks Business API \u2014 Overview For BusinessHub customers &nbsp;\u00b7&nbsp; API &amp; Integrations What is the Business API? The WorkerChecks Business API lets your internal systems connect directly to Worker Checks \u2014 so you can automate check invitations, track progress, and retrieve results&#8230;<\/p>","protected":false},"author":196713191,"featured_media":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"_kadence_starter_templates_imported_post":false,"_kad_post_transparent":"","_kad_post_title":"","_kad_post_layout":"","_kad_post_sidebar_id":"","_kad_post_content_style":"","_kad_post_vertical_padding":"","_kad_post_feature":"","_kad_post_feature_position":"","_kad_post_header":false,"_kad_post_footer":false,"_kad_post_classname":"","footnotes":""},"doc_category":[1353603],"doc_tag":[],"class_list":["post-16508","docs","type-docs","status-publish","hentry","doc_category-business-portal"],"year_month":"2026-06","word_count":768,"total_views":0,"reactions":{"happy":0,"normal":0,"sad":0},"author_info":{"name":"\u0915\u093e\u092e\u0926\u093e\u0930 \u091c\u093e\u0901\u091a\u0939\u0930\u0942","author_nicename":"workerchecks","author_url":"https:\/\/workerchecks.com\/ne\/author\/workerchecks\/"},"doc_category_info":[{"term_name":"Business Portal","term_url":"https:\/\/workerchecks.com\/ne\/docs-category\/business-portal\/"}],"doc_tag_info":[],"knowledge_base_info":[],"knowledge_base_slug":[],"_links":{"self":[{"href":"https:\/\/workerchecks.com\/ne\/wp-json\/wp\/v2\/docs\/16508","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/workerchecks.com\/ne\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/workerchecks.com\/ne\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/workerchecks.com\/ne\/wp-json\/wp\/v2\/users\/196713191"}],"replies":[{"embeddable":true,"href":"https:\/\/workerchecks.com\/ne\/wp-json\/wp\/v2\/comments?post=16508"}],"version-history":[{"count":0,"href":"https:\/\/workerchecks.com\/ne\/wp-json\/wp\/v2\/docs\/16508\/revisions"}],"wp:attachment":[{"href":"https:\/\/workerchecks.com\/ne\/wp-json\/wp\/v2\/media?parent=16508"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/workerchecks.com\/ne\/wp-json\/wp\/v2\/doc_category?post=16508"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/workerchecks.com\/ne\/wp-json\/wp\/v2\/doc_tag?post=16508"}],"curies":[{"name":"\u0921\u092c\u094d\u0932\u094d\u092f\u0942\u092a\u0940","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}