---
updatedAt: 2025-05-21T20:31:24.000Z
agentTools:
  projectIndex: https://developers.keka.com/llms.txt
---

# Get all checks

Get all bgv checks of an bgv vendor

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Core Hr",
    "version": "v1"
  },
  "servers": [
    {
      "url": "https://{company}.{environment}.com/api/v1",
      "description": "Production server (uses live data)",
      "variables": {
        "environment": {
          "default": "keka",
          "enum": [
            "keka",
            "kekademo"
          ]
        }
      }
    }
  ],
  "paths": {
    "/hris/bgv/vendors/{bgvId}/checks": {
      "get": {
        "tags": [
          "BackgroundVerification"
        ],
        "summary": "Get all checks",
        "description": "Get all bgv checks of an bgv vendor",
        "parameters": [
          {
            "name": "bgvId",
            "in": "path",
            "description": "The BGV identifier.",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "pageNumber",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "pageSize",
            "in": "query",
            "description": "Represents how many results you'd like to retrieve per request (page). Default is 100. Max is 200",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BGVChecksDTOPagedResponse"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/BGVChecksDTOPagedResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          },
          "404": {
            "description": "Not Found"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "BGVChecksDTO": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "nullable": true
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "vendorCheckId": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "BGVChecksDTOPagedResponse": {
        "type": "object",
        "properties": {
          "succeeded": {
            "type": "boolean",
            "description": "Gets or sets a value indicating whether this Keka.API.Web.Core.Response`1 is succeeded."
          },
          "message": {
            "type": "string",
            "description": "Gets or sets the message.",
            "nullable": true
          },
          "errors": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Gets or sets the errors.",
            "nullable": true
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BGVChecksDTO"
            },
            "description": "Gets or sets the data.",
            "nullable": true
          },
          "pageNumber": {
            "type": "integer",
            "description": "Gets or sets the page number.",
            "format": "int32"
          },
          "pageSize": {
            "type": "integer",
            "description": "Gets or sets the size of the page.",
            "format": "int32"
          },
          "firstPage": {
            "type": "string",
            "description": "Gets or sets the first page.",
            "format": "uri",
            "nullable": true
          },
          "lastPage": {
            "type": "string",
            "description": "Gets or sets the last page.",
            "format": "uri",
            "nullable": true
          },
          "totalPages": {
            "type": "integer",
            "description": "Gets or sets the total pages.",
            "format": "int32"
          },
          "totalRecords": {
            "type": "integer",
            "description": "Gets or sets the total records.",
            "format": "int32"
          },
          "nextPage": {
            "type": "string",
            "description": "Gets or sets the next page.",
            "format": "uri",
            "nullable": true
          },
          "previousPage": {
            "type": "string",
            "description": "Gets or sets the previous page.",
            "format": "uri",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "class represents paged response."
      }
    },
    "securitySchemes": {
      "oauth2": {
        "type": "oauth2",
        "flows": {
          "implicit": {
            "authorizationUrl": "https://login.keka.com/connect/authorize",
            "scopes": {
              "kekaapi": "Keka API"
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "oauth2": []
    }
  ]
}
```