> ## Documentation Index
> Fetch the complete documentation index at: https://nango.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Checkr Partner

## Overview

<CardGroup cols={3}>
  <Card title="Pre-built tooling" icon="screwdriver-wrench" href="#pre-built-tooling" />

  <Card title="Pre-built integrations" icon="square-check" href="#pre-built-integrations" />

  <Card title="Access requirements" icon="triangle-exclamation" href="#access-requirements" />

  <Card title="Setup guide" icon="rocket" href="#setup-guide" />

  <Card title="Useful links" icon="circle-info" href="#useful-links" />

  <Card title="API gotchas" icon="biohazard" href="#api-gotchas" />
</CardGroup>

## Pre-built tooling

<AccordionGroup>
  <Accordion title="✅ Authorization">
    | Tools                           | Status |
    | ------------------------------- | ------ |
    | Pre-built authorization (OAuth) | ✅      |
    | Credentials auto-refresh        | ✅      |
    | Pre-built authorization UI      | ✅      |
    | Custom authorization UI         | ✅      |
    | Expired credentials detection   | ✅      |
  </Accordion>

  <Accordion title="✅ Read & write data">
    | Tools                                     | Status |
    | ----------------------------------------- | ------ |
    | Pre-built integrations                    | ✅      |
    | API unification                           | ✅      |
    | 2-way sync                                | ✅      |
    | Webhooks from Nango on data modifications | ✅      |
    | Real-time webhooks from 3rd-party API     | ✅      |
    | Proxy requests                            | ✅      |
  </Accordion>

  <Accordion title="✅ Observability & data quality">
    | Tools                   | Status |
    | ----------------------- | ------ |
    | HTTP request logging    | ✅      |
    | End-to-end type safety  | ✅      |
    | Data runtime validation | ✅      |
    | OpenTelemetry export    | ✅      |
    | Slack alerts on errors  | ✅      |
    | Integration status API  | ✅      |
  </Accordion>

  <Accordion title="✅ Customization">
    | Tools                              | Status                         |
    | ---------------------------------- | ------------------------------ |
    | Create or customize use-cases      | ✅                              |
    | Pre-configured pagination          | 🚫 (time to contribute: \<48h) |
    | Pre-configured rate-limit handling | ✅                              |
    | Per-customer configurations        | ✅                              |
  </Accordion>
</AccordionGroup>

### Others

| Function name                 | Description                                                           | Type                                           | Source code                                                                                                                                |
| ----------------------------- | --------------------------------------------------------------------- | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| `background-check-parameters` | Fetch the parameters required to trigger a background check           | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/checkr-partner/actions/background-check-parameters.ts) |
| `background-check-services`   | Fetch the possible services that Checkr offers for a background check | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/checkr-partner/actions/background-check-services.ts)   |
| `create-candidate`            | Create a candidate                                                    | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/checkr-partner/actions/create-candidate.ts)            |
| `trigger-background-check`    | Trigger a background check                                            | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/checkr-partner/actions/trigger-background-check.ts)    |
| `background-checks`           | Fetch all the background checks                                       | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/checkr-partner/syncs/background-checks.ts)             |

## Access requirements

| Pre-Requisites    | Status | Comment |
| ----------------- | ------ | ------- |
| Paid dev account  | ❓      |         |
| Paid test account | ❓      |         |
| Partnership       | ❓      |         |
| App review        | ❓      |         |
| Security audit    | ❓      |         |

## Setup guide

*No setup guide yet.*

<Tip>Need help getting started? Get help in the [community](https://nango.dev/slack).</Tip>

<Note>Contribute improvements to the setup guide by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/checkr-partner.mdx)</Note>

## Useful links

* [How to register a partner Application](https://docs.checkr.com/partners/#section/Getting-Started/Create-a-Partner-Application-for-your-Checkr-account)
* [OAuth related docs](https://docs.checkr.com/partners/#section/Getting-Started/Connect-your-customers-to-Checkr)
* [Checkr API docs](https://docs.checkr.com/)
* [Checkr rate limiting](https://docs.checkr.com/#section/Reference/Rate-limiting)

<Note>Contribute useful links by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/checkr-partner.mdx)</Note>

## API gotchas

* As a partner you are provided with both staging and a production account. For more details check [staging vs production accounts](https://docs.checkr.com/partners/#section/Getting-Started/Staging-vs-Production-accounts)
* The `access_token` generated are long lived, until revoked and don't need to be refreshed.
* Checkr requires partners to comply with a quick integration review so as to make the integration production ready. For more details check [production approval process](https://docs.checkr.com/partners/#section/Production-Approval-Process)
* After creating a connection, Checkr requires you to pass the `access_token` as Basic Authentication as follows:

```js theme={null}
        const connection = await nango.getConnection();
        let access_token: string;
        if ('access_token' in connection.credentials) {
            access_token = connection.credentials.access_token;
        } else {
            throw new nango.ActionError({
                message: `access_token is missing`
            });
        }
        const config = {
            endpoint: '/v1/account',
            headers: {
                Authorization: 'Basic ' + Buffer.from(access_token + ':').toString('base64')
            }
        }

        const response = await nango.get(config);
```

* You can have a look at the [pre-built integrations](#pre-built-integrations) based on [Checkr retrieve authenticated account details](https://docs.checkr.com/#tag/Account)

<Note>Contribute API gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/checkr-partner.mdx)</Note>