Manage API keys and webhooks

The "Developer settings" tab of the account settings in the Checkr Dashboard provides access to your account’s API keys and webhooks. API keys enable API access to the Checkr service for customized interfaces. Webhooks provide account-level webhooks to which Checkr-generated events post.

API and webhook logs appear in the Logs page of the Checkr Dashboard.

For more information, refer to Webhooks in the Checkr API documentation.

Manage API keys

The "API keys" section lists active API keys for the account.

You can create both secret and publishable keys for your account. Use the secret keys in your staging and production environments. Keep your secret keys confidential, and store them only on your own servers.

For more information, refer to API keys in the Checkr API documentation.

Before you can access production keys, Checkr must credential your account for production API access. After credentialing, create and manage your API keys in the Developer settings tab.

To create a new key, select "Create key."

For existing keys, you can take two actions:

• Select the eye to show and hide the password.
• Select Expire to set an expiration date for the selected key.

Add a new webhook

Use account webhooks to receive updates for objects created with the API. To get status updates, you must create webhook endpoints and add them in the Checkr Dashboard. Webhook endpoints have a limit of 2. If you try to create more than 2 endpoints in either environment, a "Quota limit exceeded" error appears.

For more information, refer to Webhooks in the Checkr API documentation.

The "Configured webhooks" section lists existing webhooks. Use the "New webhook" section to create a new webhook.

To add a new webhook for your account, use the steps below:

1. In the "New webhook" section of the Account page, enter a URL that meets the requirements below:
   • HTTP, HTTPS, and AWS SNS protocols are supported.
   • Use HTTP only for test environment webhooks.
   • HTTP and HTTPS endpoints must be publicly accessible.
   • AWS SNS endpoint must follow the format:
     `sns://<key_id>:<access_key>@<region>/<topic_owner>/<topic_name>`
2. Select the Live environment.
3. Select a jurisdiction: US or CA.
4. Select the "Include related object in payload" checkbox if you want to.
5. Select Add to create the new webhook.

To acknowledge receipt of a webhook, your endpoint should return a 2xx HTTP status code. Other information returned in the response header or response body is ignored.

If a webhook isn't received, Checkr continues trying to send it every minute for 10 minutes, then every hour for 24 hours.

Monitor webhook logs in the Logs page.

After you create webhooks, you can subscribe to the updates you want.

For more information about available subscriptions, refer to Webhooks in the Checkr API documentation.