Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Sterling Invites API
description: The Sterling API integrates background and identity screening into your platform and manages the process end to end.
version: '2.0'
contact:
name: Sterling (a First Advantage company)
url: https://www.sterlingcheck.com/services/api/
x-documentation: https://apidocs.sterlingcheck.app/
x-developer-portal: https://developer.sterlingcheck.app/
x-acquisition: First Advantage completed acquisition of Sterling Check Corp on 2024-10-31 ($2.2B).
servers:
- url: https://api.sterlingcheck.app/v2
description: Production (MODELED representative host - exact host provisioned with production credentials)
- url: https://api-sandbox.sterlingcheck.app/v2
description: Sandbox / Integration (MODELED representative host - exact host provisioned with sandbox credentials)
security:
- oAuth2ClientCredentials: []
- bearerAuth: []
tags:
- name: Invites
description: Candidate invitations to complete consent and data collection.
paths:
/screenings/{screeningId}/invite:
post:
operationId: resendInvite
tags:
- Invites
summary: Resend or retrieve a screening invite
description: '[MODELED] Resend the candidate invitation email, or retrieve the hosted invite/form link for a screening that was created with invite.method set to "link".'
parameters:
- $ref: '#/components/parameters/ScreeningId'
responses:
'200':
description: The invite details, including the hosted form URL.
content:
application/json:
schema:
$ref: '#/components/schemas/Invite'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
components:
schemas:
Error:
type: object
properties:
code:
type: string
message:
type: string
Invite:
type: object
properties:
screeningId:
type: string
method:
type: string
enum:
- email
- link
url:
type: string
format: uri
sentAt:
type: string
format: date-time
responses:
Unauthorized:
description: Missing or invalid access token.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
NotFound:
description: The requested resource was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
parameters:
ScreeningId:
name: screeningId
in: path
required: true
schema:
type: string
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
description: OAuth2 client credentials grant using your Client ID and Client Secret.
flows:
clientCredentials:
tokenUrl: https://auth.sterlingcheck.app/oauth/token
scopes: {}
bearerAuth:
type: http
scheme: bearer
description: The access token returned from the OAuth token exchange, sent as a Bearer token.