- 19 Jan 2022
- Updated on 19 Jan 2022
This guide will walk you through the process of setting up a company, a user, and a report via the GoodHire API.
Create a developer account
Send an email to firstname.lastname@example.org to request to speak to our integrations team. Once ready, they'll create your account issue your API key. You'll use this information as you build your integration.
The API is accessed via HTTPS, and resources are operated upon using the GET and POST methods.
There are two base endpoints for the API that all methods are appended to:
The test endpoint can be used while you are building your application, and all background checks ordered via its methods will return dummy data. When you are ready to begin ordering real background checks, change your base endpoint to the production endpoint above and work with your GoodHire partner contact to receive your production API key.
The GoodHire API uses HTTP Basic Auth. Your API key consists of a token passed in the Authorization header of your requests:
curl -i -H "Authorization: ApiKey YOUR_API_KEY" \ https://api-sandbox.goodhire.com \
Where YOUR_API_KEY is your test or production API key.