GoodHire

Methods (6)

• getEmployer

  read

  Retrieve an employer by its partner employer ID.

  Required paramspartnerEmployerId
  Input schema

  {
    "type": "object",
    "properties": {
      "partnerEmployerId": {
        "type": "string",
        "description": "Partner employer ID."
      }
    },
    "required": [
      "partnerEmployerId"
    ],
    "additionalProperties": false
  }

• getRequestor

  read

  Retrieve a requestor/customer under a partner employer.

  Required paramspartnerEmployerIdpartnerCustomerId
  Input schema

  {
    "type": "object",
    "properties": {
      "partnerEmployerId": {
        "type": "string",
        "description": "Partner employer ID."
      },
      "partnerCustomerId": {
        "type": "string",
        "description": "Partner customer ID."
      }
    },
    "required": [
      "partnerEmployerId",
      "partnerCustomerId"
    ],
    "additionalProperties": false
  }

• listProductBundles

  read

  List GoodHire product bundles available to a requestor.

  Required paramspartnerEmployerIdpartnerCustomerId
  Input schema

  {
    "type": "object",
    "properties": {
      "partnerEmployerId": {
        "type": "string",
        "description": "Partner employer ID."
      },
      "partnerCustomerId": {
        "type": "string",
        "description": "Partner customer ID."
      }
    },
    "required": [
      "partnerEmployerId",
      "partnerCustomerId"
    ],
    "additionalProperties": false
  }

• getReportStatus

  read

  Retrieve an existing report/order status without including report data.

  Required paramspartnerEmployerIdpartnerCustomerIdpartnerOrderId
  Input schema

  {
    "type": "object",
    "properties": {
      "partnerEmployerId": {
        "type": "string",
        "description": "Partner employer ID."
      },
      "partnerCustomerId": {
        "type": "string",
        "description": "Partner customer ID."
      },
      "partnerOrderId": {
        "type": "string",
        "description": "Partner order ID."
      }
    },
    "required": [
      "partnerEmployerId",
      "partnerCustomerId",
      "partnerOrderId"
    ],
    "additionalProperties": false
  }

• getReportData

  read

  Get report data with PII, documents, and privileged links redacted.

  Required paramspartnerEmployerIdpartnerCustomerIdpartnerOrderId
  Input schema

  {
    "type": "object",
    "properties": {
      "partnerEmployerId": {
        "type": "string",
        "description": "Partner employer ID."
      },
      "partnerCustomerId": {
        "type": "string",
        "description": "Partner customer ID."
      },
      "partnerOrderId": {
        "type": "string",
        "description": "Partner order ID."
      }
    },
    "required": [
      "partnerEmployerId",
      "partnerCustomerId",
      "partnerOrderId"
    ],
    "additionalProperties": false
  }

• getServiceInfo

  read

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