Checkr

Methods (6)

• listCandidates

  read

  List candidates with documented filters; sensitive response fields are redacted.

  Input schema

  {
    "type": "object",
    "properties": {
      "email": {
        "type": "string",
        "description": "Exact candidate email filter."
      },
      "fullName": {
        "type": "string",
        "description": "Candidate full-name filter."
      },
      "adjudication": {
        "type": "string",
        "description": "Adjudication filter."
      },
      "customId": {
        "type": "string",
        "description": "Customer-defined candidate ID."
      },
      "createdAfter": {
        "type": "string",
        "description": "Created-at lower bound."
      },
      "createdBefore": {
        "type": "string",
        "description": "Created-at upper bound."
      },
      "page": {
        "type": "integer",
        "minimum": 1
      },
      "perPage": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100
      }
    },
    "additionalProperties": false
  }

• getCandidate

  read

  Get a candidate by ID, optionally with redacted reports or geos.

  Required paramsid
  Input schema

  {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "description": "Checkr candidate ID."
      },
      "includeReports": {
        "type": "boolean"
      },
      "includeGeos": {
        "type": "boolean"
      }
    },
    "required": [
      "id"
    ],
    "additionalProperties": false
  }

• getReport

  read

  Get an existing report by ID with PII, documents, and links redacted.

  Required paramsid
  Input schema

  {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "description": "Checkr report ID."
      }
    },
    "required": [
      "id"
    ],
    "additionalProperties": false
  }

• listPackages

  read

  List screening packages configured for the authenticated Checkr account.

  Input schema

  {
    "type": "object",
    "properties": {
      "page": {
        "type": "integer",
        "minimum": 1
      },
      "perPage": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100
      }
    },
    "additionalProperties": false
  }

• getPackage

  read

  Retrieve one configured screening package by ID.

  Required paramsid
  Input schema

  {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "description": "Checkr package ID."
      }
    },
    "required": [
      "id"
    ],
    "additionalProperties": false
  }

• getServiceInfo

  read

  Return static Checkr connector capabilities, privacy controls, and API documentation.