{"id":36753119,"url":"https://github.com/checkr/oauth-reference-integration","last_synced_at":"2026-01-12T12:46:56.002Z","repository":{"id":55552537,"uuid":"503892516","full_name":"checkr/oauth-reference-integration","owner":"checkr","description":"Open source Checkr integration","archived":false,"fork":false,"pushed_at":"2024-05-08T19:15:20.000Z","size":21050,"stargazers_count":2,"open_issues_count":1,"forks_count":4,"subscribers_count":8,"default_branch":"main","last_synced_at":"2024-05-09T19:46:12.095Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/checkr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-06-15T19:12:22.000Z","updated_at":"2024-05-08T19:15:24.000Z","dependencies_parsed_at":"2024-05-08T19:44:11.915Z","dependency_job_id":"c8aefdd3-e8c9-4ea8-a282-6f5a575cef51","html_url":"https://github.com/checkr/oauth-reference-integration","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/checkr/oauth-reference-integration","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checkr%2Foauth-reference-integration","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checkr%2Foauth-reference-integration/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checkr%2Foauth-reference-integration/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checkr%2Foauth-reference-integration/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/checkr","download_url":"https://codeload.github.com/checkr/oauth-reference-integration/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checkr%2Foauth-reference-integration/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28338983,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-12T12:22:26.515Z","status":"ssl_error","status_checked_at":"2026-01-12T12:22:10.856Z","response_time":98,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-12T12:46:55.918Z","updated_at":"2026-01-12T12:46:55.991Z","avatar_url":"https://github.com/checkr.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Reference Integration\n\n![Build status](https://github.com/checkr/oauth-reference-integration/actions/workflows/main.js.yml/badge.svg?branch=main)\n\nThis is a sample application demonstrating an end to end Checkr integration. It\noutlines best practices and patterns we see Checkr integrations adopt, and will\nhelp you develop a Checkr certified integration. It focuses on two use-cases:\n\n- How to use the\n  [Checkr-Hosted Signup flow](https://docs.checkr.com/partners/#section/Getting-Started/Connect-your-customers-to-Checkr)\n  to connect your customers to Checkr.\n- How to order background checks and report results using\n  [Checkr Embeds](https://docs.checkr.com/embeds).\n\nYou can refer to this application if you are building either one or both\nuse-cases.\n\n\u003cbr /\u003e\n\n![Demo](docs/images/demo-v1.gif)\n\n\u003cbr /\u003e\n\n# Contents\n\n- [Use case: Connecting customers](#use-case-connecting-customers)\n- [Use case: Using Embeds to order background checks](#use-case-using-embeds-to-order-background-checks)\n- [Live Sandbox](#live-sandbox)\n- [Technical Documentation](#technical-documentation)\n- [Running it locally](#running-it-locally)\n- [Got feedback?](#got-feedback)\n\n## Use case: Connecting customers\n\nWith Checkr OAuth, your customers can easily connect their Checkr account with\nyour product. It gives your product the ability to make API calls on behalf of\nyour customers. This described in more detail in our\n[partner guide](https://docs.checkr.com/partners/#section/Getting-Started/Connect-your-customers-to-Checkr).\n\n**Checklist**\n* [x] Signing up for a new Checkr account, or connecting an existing account.\n* [x] Waiting for account credentialing.\n* [x] Disconnecting a customer account from a partner. \n\n#### Application components\n\n| Component                                                                                                                                  | Responsibility                      | Code walkthrough                                                                                                        |\n| ------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |\n| [oauth.js](https://github.com/checkr/oauth-reference-integration/blob/main/routes/oauth.js)                                                | Handles OAuth and Webhooks          | [walkthrough](https://checkr-oauth-integration.checkr-sandbox.com/docs/routes/oauth.html)                                    |\n| [CheckrConnectLink.js](https://github.com/checkr/oauth-reference-integration/blob/main/client/src/components/account/CheckrConnectLink.js) | Link to connect account with Checkr | [walkthrough](https://checkr-oauth-integration.checkr-sandbox.com/docs/client/src/components/account/CheckrConnectLink.html) |\n\n```mermaid\nsequenceDiagram\n  autonumber\n\n    Note right of App Frontend: CheckrConnectLink pressed\n    Note right of Partner customer signup flow: Checkr Account created\n\n    App Frontend-\u003e\u003e+Partner customer signup flow: Navigate to Checkr Sign-Up Flow URL\n    Partner customer signup flow-\u003e\u003e+oauth.js: Navigate to redirect URL\n    oauth.js-\u003e\u003e+Checkr: Request OAuth Access token\n    Checkr-\u003e\u003e+oauth.js: Respond with OAuth Access token\n    oauth.js-\u003e\u003e+App Database: Persist and encrypt OAuth Access token in App Database\n    oauth.js-\u003e\u003e+App Frontend: Redirect to App Frontend\n\n    Note right of App Frontend: Account is waiting credentialing\n    Checkr-\u003e\u003e+oauth.js: Send account.credentialed webhook\n    oauth.js-\u003e\u003e+App Database: Update Checkr account state\n    Note right of App Frontend: Account is credentialed\n\n    App Frontend-\u003e\u003e+Checkr: POST /oauth/deauthorize\n    Checkr-\u003e\u003e+oauth.js: HTTP 200\n    Note right of Checkr: Token has been deauthorized\n    oauth.js-\u003e\u003e+App Frontend: HTTP 204\n    Checkr-\u003e\u003e+oauth.js: Send token.deauthorized webhook\n    oauth.js-\u003e\u003e+App Database: Delete access token from database\n    Note right of App Frontend: Account is disconnected\n\n```\n\n## Use case: Using Embeds to order background checks\n\nEmbeds provide Javascript and React components to quickly build an experience to\norder background checks and view results. Read more about it\n[here](https://docs.checkr.com/embeds/).\n\n**Checklist**\n* [x] Acquiring session tokens from Checkr to authenticate embeds.\n\n#### Application components\n\n| Component                                                                                                                   | Responsibility                                 | Code walkthrough                                                                                     | Diagram                                                                |\n| --------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |\n| [embeds-session-tokens.js](https://github.com/checkr/oauth-reference-integration/blob/main/routes/embeds-session-tokens.js) | Handles requesting a Session token from Checkr | [walkthrough](https://checkr-oauth-integration.checkr-sandbox.com/docs/routes/embeds-session-tokens.html) | [diagram](https://docs.checkr.com/embeds/#section/Getting-Started/Add-authentication) |\n\n## Live sandbox\n\nAn instance of this application is hosted at\n[checkr-oauth-integration.checkr-sandbox.com](https://checkr-oauth-integration.checkr-sandbox.com/).\nIt is connected to a demo staging Checkr account which does not run real\nbackground checks.\n\nYou can also deploy this using your own Heroku account, and connect it to your\nCheckr account.\n\n[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)\n\n## Technical Documentation\n\n- [API docs](https://docs.checkr.com)\n- [Partner Guide](https://docs.checkr.com/partners)\n- [Embeds docs](https://docs.checkr.com/embeds)\n\n## Running it locally\n\nView the [development page](docs/Developing.md) to run this project locally.\n\n## Got feedback?\n\n[Open an issue](https://github.com/checkr/oauth-reference-integration/issues) in\nthis repository to ask a question or give us feedback.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcheckr%2Foauth-reference-integration","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcheckr%2Foauth-reference-integration","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcheckr%2Foauth-reference-integration/lists"}