Skip to content

Checkmate REST API (1.0.0)

Checkmate API for launching background checks from your side using Checkmate.

Contact

Download OpenAPI description
api.json
api.yaml
Languages
Servers
Mock server
https://docs.checkmate.tech/_mock/api
Staging
https://staging-api.checkmate.tech/partners/v1
Production
https://api.checkmate.tech/partners/v1

OAuth

OAuth token authorization

Basic Authorization

If you are not planning to build a multi-tenant integration then, we encorauge you to skip OAuth authentication and use your Checkmate account token instead. You can grab it from your Partner's page under "Account API"

Remember to store it safely!

Basic Authorization

placeholder

Operations

Oauth token

Request

  • Authorization code: Exchange code for access_token and refresh_token.
  • Refresh: Use refresh_token to get a new access_token (access tokens expire after 5 minutes). Send body as application/x-www-form-urlencoded.
Bodyapplication/x-www-form-urlencodedrequired
client_idstringrequired
Example: "3468d2767c98565c"
client_secretstringrequired
Example: "aee0fc19fhgxf37ccfa853dd93b134836"
grant_typestringrequired
Enum"authorization_code""refresh_token"
Example: "authorization_code"
redirect_uristring

Required for authorization_code

Example: "https://myloginpage.domain.com"
codestring

Required for authorization_code

Example: "aee0fc19fhgxf37ccskfdn9af238bnqwe8w03n93r8bb98r23b"
refresh_tokenstring

Required for refresh_token

Example: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJfaWQiOjY5NywiY29tcGFueV9pZCI6MTI0MywicGFydG5lciI6MTAsInZlcnNpb24iOjN9fQ.3I0rhYhH7Wyfw-_HodPByRFdmVZygg8VB_77X7JCw"
curl -i -X POST \
  https://docs.checkmate.tech/_mock/api/oauth/token \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d client_id=3468d2767c98565c \
  -d client_secret=aee0fc19fhgxf37ccfa853dd93b134836 \
  -d grant_type=authorization_code \
  -d redirect_uri=https://myloginpage.domain.com \
  -d code=aee0fc19fhgxf37ccskfdn9af238bnqwe8w03n93r8bb98r23b \
  -d refresh_token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJfaWQiOjY5NywiY29tcGFueV9pZCI6MTI0MywicGFydG5lciI6MTAsInZlcnNpb24iOjN9fQ.3I0rhYhH7Wyfw-_HodPByRFdmVZygg8VB_77X7JCw

Responses

Token response

Bodyapplication/json
access_tokenstring
Example: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJfaWQiOjY5NywiY29tcGFueV9pZCI6MTI0MywicGFydG5lciI6MTAsInZlcnNpb24iOjN9fQ.3I0rhYhH7Wyfw-_HodPByRFdmVZygg8VB_77X7JCw"
refresh_tokenstring
Example: "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IlJqaEROemRDUlVKRVEwTTVSVFE0TmtZME9UZzVNVEpDTlVJNFJqRTBPREExTmpZMk1qazFPQSJ9.eyJodHRwOi8vbWF0dHIvdGVuYW50LWlkIjoiNTcwYTcyOGEt"
Response
application/json
{
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJfaWQiOjY5NywiY29tcGFueV9pZCI6MTI0MywicGFydG5lciI6MTAsInZlcnNpb24iOjN9fQ.3I0rhYhH7Wyfw-_HodPByRFdmVZygg8VB_77X7JCw",
  "refresh_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IlJqaEROemRDUlVKRVEwTTVSVFE0TmtZME9UZzVNVEpDTlVJNFJqRTBPREExTmpZMk1qazFPQSJ9.eyJodHRwOi8vbWF0dHIvdGVuYW50LWlkIjoiNTcwYTcyOGEt"
}

Brands

Company branding

Operations

Check Types

Available check types

Operations

Bundles

Pre-configured check bundles

Operations

Candidates

Candidate management

Operations

Checks

Candidate checks

Operations

Sub-checks

Sub-check results

Operations

Referees

Reference check referees

Operations

Companies

Company details

Operations

Company Checks

Company-enabled checks

Operations

Forms

Forms (reference, questionnaire, etc.)

Operations

Uploads

File uploads

Operations

Webhooks

Webhooks are unique per partner and company!

Only one webhook can exists for a partner and company. You will only get updates notifications on candidates created under this context.

E.g. If you subscribe to a webhook using your Account API token you won't be get notified about updates on candidates created directly on the web application or other partners.

:global parameter

:global parameter is the only exception to the above. If global=true you will get notifications on all candidates created through the API. You still won't get notifications on candidates created from the web application as they don't belog to the API.

Operations