Accurate Background Candidates API

openapi: 3.0.3
info:
  title: Accurate Background Adjudication Candidates API
  description: 'The Accurate API (v3) lets platforms embed employment background screening into their own web and mobile applications. Integrators create candidates, order preset or custom screening packages, track order status and estimated completion time, attach documents, adjudicate results, and retrieve completed reports. A free developer account and a sandbox environment are available for testing; production access is provisioned under a screening services agreement.


    This OpenAPI document was authored by API Evangelist from Accurate''s published developer documentation (developer.accuratebackground.com and accurate.readme.io). Paths and HTTP methods reflect the documented endpoints; request and response schemas are summarized rather than exhaustively modeled. Verify the authoritative contract in Accurate''s own API reference.'
  version: '3.0'
  contact:
    name: Accurate Background
    url: https://developer.accuratebackground.com/
servers:
- url: https://api.accuratebackground.com/v3
  description: Production
security:
- oauth2ClientCredentials: []
tags:
- name: Candidates
  description: Screening subjects that background checks are run against.
paths:
  /candidates:
    get:
      tags:
      - Candidates
      summary: Retrieve all candidates
      description: Retrieve all candidates for the authenticated company account.
      responses:
        '200':
          description: A list of candidates.
  /candidate:
    post:
      tags:
      - Candidates
      summary: Create candidate
      description: Creates a candidate that can then be submitted within an order-creation payload.
      responses:
        '201':
          description: Candidate created.
    put:
      tags:
      - Candidates
      summary: Update candidate
      description: Updates an existing candidate. Changes apply to future orders only.
      responses:
        '200':
          description: Candidate updated.
  /candidate/{id}:
    get:
      tags:
      - Candidates
      summary: Retrieve candidate by ID
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The requested candidate.
components:
  securitySchemes:
    oauth2ClientCredentials:
      type: oauth2
      description: Accurate API credentials are a ClientID / ClientSecret pair obtained from the Accurate developer portal. Credentials are exchanged (HTTP Basic) for an access token that authorizes subsequent requests.
      flows:
        clientCredentials:
          tokenUrl: https://api.accuratebackground.com/v3/oauth/token
          scopes: {}