Related article: Manage API keys and webhooks
Select a question below to learn more.
To receive live API keys, you must complete the API Development Kickoff module. In this module, the API Onboarding team will guide you through the necessary steps to gain production authorization for your API integration.
Request a Checkr staging account via the following link: Development Environment Request.
In your Checkr Staging Dashboard, select the ‘Logs’ tab. Here, you can view all API/webhook calls that have been made. If you click on an individual call, it will show you detailed information regarding the payload.
You can continue to use your Checkr staging account after your API integration goes live in production. If you need to test new features or enhancements, you can continue testing with your Checkr staging account.
For specific field requirements, refer to the Checkr API Integration Guidance document. Please note that the field requirements will differ for API customers using the Checkr Hosted Flow compared to the Client Hosted Flow.
We require all our API customers using the Checkr Hosted Flow to include the work location on both candidate and invitation API calls. We want to ensure that all of our customers are set up to order international checks in the future. Although passing the work location in the candidate object is not strictly required architecturally, we do require it for authorization purposes.