Checkr Partner Staging

Overview

Pre-built tooling

Pre-built integrations

Access requirements

Setup guide

Useful links

API gotchas

Pre-built tooling

✅ Authorization

Tools	Status
Pre-built authorization (OAuth)	✅
Credentials auto-refresh	✅
Pre-built authorization UI	✅
Custom authorization UI	✅
Expired credentials detection	✅

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

✅ Observability & data quality

Tools	Status
HTTP request logging	✅
End-to-type type safety	✅
Data runtime validation	✅
OpenTelemetry export	✅
Slack alerts on errors	✅
Integration status API	✅

✅ 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	Source code
account	Fetches account details for the authenticated account.	Sync	🔗 Github

Access requirements

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

Setup guide

No setup guide yet.

Need help getting started? Get help in the community.

Contribute improvements to the setup guide by editing this page

Useful links

• How to register a partner Application
• OAuth related docs
• Checkr API docs
• Checkr rate limiting

Contribute useful links by editing this page

API gotchas

• As a partner you are provided with both staging and a production account. For more details check 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
• After creating a connection, Checkr requires you to pass the access_token as Basic Authentication as follows:

        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 based on Checkr retrieve authenticated account details

Contribute API gotchas by editing this page