Employments
Background Checks

Show Background Check

Changed on

Show Background Check details for a given employment and background check request.

Authentication

This endpoint requires the following token type:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage employments (employments)View background checks (background_check:read)-
get/v1/employments/{employment_id}/background-checks/{background_check_id}

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/employments/{employment_id}/background-checks/{background_check_id}
  • Auth: OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, background_check:read, employments, all:write, all:read)

Path parameters

employment_idstring uuid required

A unique identifier in UUID v4 format.

Example:663e0b79-c893-45ff-a1b2-f6dcabc098b5

Employment Id

background_check_idstring uuid required

A unique identifier in UUID v4 format.

Example:663e0b79-c893-45ff-a1b2-f6dcabc098b5

Background Check Id

Response

Success

Example response

{
  "data": {
    "background_check": {
      "background_check_request_items": [
        {
          "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "status": "in_progress",
          "title": "Criminal Record Check",
          "type": "criminal"
        }
      ],
      "created_at": "2024-01-15T10:30:00Z",
      "employment_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "id": "31b8e49b-aa1c-47af-849c-3d0a53e20e0d",
      "status": "in_progress"
    }
  }
}

Changes

  • e3ced68fa36fRevision changes
    • warning

      added the new submission_failed enum value to the // response property for the response status