- Updated on 15 Jul 2019
- 2 minutes to read
Customer API Overview
The GoodHire API is a web service that allows customers to order employment background checks on candidates and view the results of these ordered checks.
There are two types of integrations in the GoodHire API, each with its own getting started guide:
- Customer - If you are a single company that will be ordering background reports directly from GoodHire use our customer guide below.
- Partner - If you are a HR platform that will act as a partner to GoodHire and allow the employers on your platform to order GoodHire background reports, see our partner guide.
This guide will walk you through the process of setting up the GoodHire API and running a background report as a single employer (ATS and partner integrations, please refer to the Partner API Documentation).
Create a developer account
Send an email to firstname.lastname@example.org to begin the process. The first step will be to work with the GoodHire sales team to determine product needs and pricing. Once that conversation has been started, they'll help get your Sandbox access granted. Once the account has been created, you’ll see your test API key displayed on the developer dashboard. Use this value in your API calls 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 contact email@example.com to receive a 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.
Create a report - Reports