> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Search CoworkerIdentityChecks

> Search and list CoworkerIdentityCheck records with filtering, sorting, and pagination.

A **CoworkerIdentityCheck** represents a manual or Stripe Identity-based verification of a customer's identity or address. Each check is linked to a `Coworker` and a `Business` (location).

The `VerificationType` determines the nature of the check:

| VerificationType | Purpose                                                                                                           |
| ---------------- | ----------------------------------------------------------------------------------------------------------------- |
| IdDocument (1)   | Verifies the customer's identity using an official document (passport, driver's license, ID card, etc.)           |
| Address (2)      | Verifies the customer's address using a supporting document (lease agreement, insurance policy, voter card, etc.) |

When `VerificationType` is `IdDocument`, use `IdentityDocumentType` to specify the document kind, along with `IdentityDocumentNumber`, `IdentityDocumentIssuedBy`, and `IdentityDocumentExpirationDate`. When `VerificationType` is `Address`, use `AddressDocumentType` instead.

`IdentityCheckProvider` controls how the check is performed: `Manual` (1) means the operator reviews documents directly, while `StripeIdentity` (2) delegates verification to Stripe Identity.

The `VerificationStatus` tracks progress through the check lifecycle: `Pending` → `Submitted` → `Successful` or `Failed` (or `Cancelled`).

## Authentication

<Note>
  This endpoint requires OAuth2 authentication. Include a valid bearer token in the `Authorization` header.
  The authenticated user must be a full unrestricted administrator or have the **`CoworkerIdentityCheck-List`** role.
</Note>

## Enums

<Accordion title="eIdentityCheckProvider — IdentityCheckProvider values">
  | Value | Name           |
  | ----- | -------------- |
  | 0     | None           |
  | 1     | Manual         |
  | 2     | StripeIdentity |
</Accordion>

<Accordion title="eIdentityCheckDocumentType — IdentityDocumentType values">
  | Value | Name                        |
  | ----- | --------------------------- |
  | 0     | None                        |
  | 1     | Passport                    |
  | 2     | DriversLicense              |
  | 3     | IdCard                      |
  | 4     | UniformedServiceId          |
  | 5     | CertificateOfNaturalization |
  | 6     | AccessCard                  |
  | 7     | MatriculaConsular           |
  | 8     | ResidentCard                |
  | 9     | UniversityId                |
  | 10    | NEXUSCard                   |
  | 99    | Other                       |
</Accordion>

<Accordion title="eAddressCheckDocumentType — AddressDocumentType values">
  | Value | Name                    |
  | ----- | ----------------------- |
  | 0     | None                    |
  | 1     | Passport                |
  | 2     | DriversLicense          |
  | 3     | IdCard                  |
  | 4     | LeaseRentalAgreement    |
  | 5     | InsurancePolicy         |
  | 6     | Mortgage                |
  | 7     | VehicleRegistrationCard |
  | 8     | VoterCard               |
  | 99    | Other                   |
</Accordion>

<Accordion title="eIdVerificationType — VerificationType values">
  | Value | Name       |
  | ----- | ---------- |
  | 0     | None       |
  | 1     | IdDocument |
  | 2     | Address    |
</Accordion>

<Accordion title="eIdVerificationStatus — VerificationStatus values">
  | Value | Name       |
  | ----- | ---------- |
  | 0     | None       |
  | 1     | Pending    |
  | 2     | Submitted  |
  | 3     | Successful |
  | 4     | Failed     |
  | 5     | Cancelled  |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField query="page" type="integer" default="1">
  The page number to retrieve.
</ParamField>

<ParamField query="size" type="integer" default="25">
  The number of records per page.
</ParamField>

<ParamField query="orderBy" type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField query="dir" type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField query="CoworkerIdentityCheck_Business" type="integer">
  Filter by Business Id.
</ParamField>

<ParamField query="CoworkerIdentityCheck_Business_Name" type="string">
  Filter by name of the location (business) this check belongs to.
</ParamField>

<ParamField query="CoworkerIdentityCheck_Coworker" type="integer">
  Filter by Coworker Id.
</ParamField>

<ParamField query="CoworkerIdentityCheck_Coworker_FullName" type="string">
  Filter by full name of the customer being verified.
</ParamField>

<ParamField query="CoworkerIdentityCheck_Coworker_CoworkerType" type="string">
  Filter by type of the customer (e.g. Member, TeamMember).
</ParamField>

<ParamField query="CoworkerIdentityCheck_Coworker_CompanyName" type="string">
  Filter by company name of the customer being verified.
</ParamField>

<ParamField query="CoworkerIdentityCheck_Coworker_BillingName" type="string">
  Filter by billing name of the customer being verified.
</ParamField>

<ParamField query="CoworkerIdentityCheck_Name" type="string">
  Filter by display name for this verification check.
</ParamField>

<ParamField query="CoworkerIdentityCheck_IdentityCheckProvider" type="integer">
  Filter by how the check is performed: Manual (operator review) or StripeIdentity (Stripe-delegated).
</ParamField>

<ParamField query="CoworkerIdentityCheck_IdentityDocumentType" type="integer">
  Filter by type of identity document used when VerificationType is IdDocument.
</ParamField>

<ParamField query="CoworkerIdentityCheck_IdentityDocumentNumber" type="string">
  Filter by number or identifier on the identity document.
</ParamField>

<ParamField query="CoworkerIdentityCheck_IdentityDocumentIssuedBy" type="string">
  Filter by authority or organisation that issued the identity document.
</ParamField>

<ParamField query="CoworkerIdentityCheck_IdentityDocumentExpirationDate" type="string">
  Filter by expiration date of the identity document.
</ParamField>

<ParamField query="CoworkerIdentityCheck_AddressDocumentType" type="integer">
  Filter by type of address document used when VerificationType is Address.
</ParamField>

<ParamField query="CoworkerIdentityCheck_VerificationType" type="integer">
  Filter by whether this check verifies the customer's identity (IdDocument) or address (Address).
</ParamField>

<ParamField query="CoworkerIdentityCheck_Description" type="string">
  Filter by free-text notes or details about this check.
</ParamField>

<ParamField query="CoworkerIdentityCheck_VerificationStatus" type="integer">
  Filter by current status of the verification (Pending, Submitted, Successful, Failed, or Cancelled).
</ParamField>

<ParamField query="CoworkerIdentityCheck_LastError" type="string">
  Filter by most recent error message if the check failed.
</ParamField>

<ParamField query="CoworkerIdentityCheck_Billed" type="boolean">
  Filter by Billed.
</ParamField>

<ParamField query="CoworkerIdentityCheck_ProposalGuid" type="string">
  Filter by Proposal Guid.
</ParamField>

<ParamField query="CoworkerIdentityCheck_CoworkerContractGuid" type="string">
  Filter by Coworker Contract Guid.
</ParamField>

<ParamField query="CoworkerIdentityCheck_ContractContactGuid" type="string">
  Filter by Contract Contact Guid.
</ParamField>

<ParamField query="CoworkerIdentityCheck_StripeVerificationSessionId" type="string">
  Filter by Stripe Verification Session Id.
</ParamField>

<ParamField query="CoworkerIdentityCheck_IdentityCheckGroupGuid" type="string">
  Filter by Identity Check Group Guid.
</ParamField>

<ParamField query="CoworkerIdentityCheck_IdentityCheckProvider1" type="integer">
  Filter by Identity Check Provider1.
</ParamField>

<ParamField query="CoworkerIdentityCheck_VerificationType1" type="integer">
  Filter by Verification Type1.
</ParamField>

<ParamField query="CoworkerIdentityCheck_Description1" type="string">
  Filter by Description1.
</ParamField>

<ParamField query="CoworkerIdentityCheck_IdentityCheckProvider2" type="integer">
  Filter by Identity Check Provider2.
</ParamField>

<ParamField query="CoworkerIdentityCheck_VerificationType2" type="integer">
  Filter by Verification Type2.
</ParamField>

<ParamField query="CoworkerIdentityCheck_Description2" type="string">
  Filter by Description2.
</ParamField>

### Range Filters

<ParamField query="from_CoworkerIdentityCheck_IdentityDocumentExpirationDate" type="string">
  Filter by expiration date of the identity document greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_CoworkerIdentityCheck_IdentityDocumentExpirationDate" type="string">
  Filter by expiration date of the identity document less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_CoworkerIdentityCheck_CreatedOn" type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_CoworkerIdentityCheck_CreatedOn" type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_CoworkerIdentityCheck_UpdatedOn" type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_CoworkerIdentityCheck_UpdatedOn" type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/spaces/coworkeridentitychecks?page=1&size=15&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/spaces/coworkeridentitychecks?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Name',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/spaces/coworkeridentitychecks',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Name

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/spaces/coworkeridentitychecks?CoworkerIdentityCheck_Name=example-value&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/spaces/coworkeridentitychecks?' + new URLSearchParams({
      CoworkerIdentityCheck_Name: 'example-value',
      orderBy: 'Name',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/spaces/coworkeridentitychecks',
      params={
          'CoworkerIdentityCheck_Name': 'example-value',
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/spaces/coworkeridentitychecks?from_CoworkerIdentityCheck_UpdatedOn=2025-01-01T00:00&to_CoworkerIdentityCheck_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/spaces/coworkeridentitychecks?' + new URLSearchParams({
      from_CoworkerIdentityCheck_UpdatedOn: '2025-01-01T00:00',
      to_CoworkerIdentityCheck_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/spaces/coworkeridentitychecks',
      params={
          'from_CoworkerIdentityCheck_UpdatedOn': '2025-01-01T00:00',
          'to_CoworkerIdentityCheck_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="CoworkerIdentityCheck[]">
  The list of CoworkerIdentityCheck records matching the query. See the [Get one CoworkerIdentityCheck](/rest-api/spaces/get-coworkeridentitychecks-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each CoworkerIdentityCheck. The following fields are **not populated** in the `Records[]` response: `Description`, `IdentityCheckProvider1`, `VerificationType1`, `Description1`, `IdentityCheckProvider2`, `VerificationType2`, `Description2`.

  To get all fields, fetch the full record using the [Get one CoworkerIdentityCheck](/rest-api/spaces/get-coworkeridentitychecks-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "BusinessId": 0,
      "BusinessName": null,
      "CoworkerId": 0,
      "CoworkerFullName": null,
      "CoworkerCoworkerType": null,
      "CoworkerCompanyName": null,
      "CoworkerBillingName": null,
      "Name": "",
      "IdentityCheckProvider": 0,
      "IdentityDocumentType": 0,
      "IdentityDocumentNumber": null,
      "IdentityDocumentIssuedBy": null,
      "IdentityDocumentExpirationDate": null,
      "AddressDocumentType": 0,
      "VerificationType": 0,
      "VerificationStatus": 0,
      "LastError": null,
      "Billed": false,
      "ProposalGuid": null,
      "CoworkerContractGuid": null,
      "ContractContactGuid": null,
      "StripeVerificationSessionId": null,
      "IdentityCheckGroupGuid": null,
      "Id": 87654321,
      "UpdatedOn": "2025-01-15T10:30:00Z",
      "CreatedOn": "2025-01-10T08:00:00Z",
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "UpdatedBy": "admin@example.com",
      "IsNew": false,
      "SystemId": null,
      "ToStringText": "CoworkerIdentityCheck Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```