> ## 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

> [card] [Pre-built tooling](#pre-built-tooling)

> [card] [Pre-built integrations](#pre-built-integrations)

> [card] [Access requirements](#access-requirements)

> [card] [Setup guide](#setup-guide)

> [card] [Useful links](#useful-links)

> [card] [API gotchas](#api-gotchas)

## Pre-built tooling

> [accordion] ✅ Authorization
>
> | Tools | Status |
> | - | - |
> | Pre-built authorization (OAuth) | ✅ |
> | Credentials auto-refresh | ✅ |
> | Pre-built authorization UI | ✅ |
> | Custom authorization UI | ✅ |
> | Expired credentials detection | ✅ |

> [accordion] ✅ 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] ✅ 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] ✅ Customization
>
> | Tools | Status |
> | - | - |
> | Create or customize use-cases | ✅ |
> | Pre-configured pagination | 🚫 (time to contribute: \<48h) |
> | Pre-configured rate-limit handling | ✅ |
> | Per-customer configurations | ✅ |

### Others

| Function name | Description | Type |
| - | - | - |
| `background-check-parameters` | Fetch the parameters required to trigger a background check | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `background-check-services` | Fetch the possible services that Checkr offers for a background check | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-candidate` | Create a candidate | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `trigger-background-check` | Trigger a background check | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `background-checks` | Fetch all the background checks | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |

## 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).

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

## 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)

## 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)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.