> ## 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 CoworkerIdentityCheckDocuments

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

A **CoworkerIdentityCheckDocument** represents a document submitted as part of a `CoworkerIdentityCheck` for a customer. Each document record can hold up to three files, corresponding to different sides or aspects of the verification evidence:

| File slot  | Field prefix         | Purpose                                               |
| ---------- | -------------------- | ----------------------------------------------------- |
| Face photo | `Photo`              | A photograph of the customer's face                   |
| Front      | `Document`           | The front side of the identity or address document    |
| Back       | `AdditionalDocument` | The back side or a supplementary page of the document |

Which slots are required depends on the `VerificationType` and document type configured on the parent `CoworkerIdentityCheck`.

The `VerificationStatus` tracks the review state of this individual document through the same lifecycle used by `CoworkerIdentityCheck`: `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 **`CoworkerIdentityCheckDocument-List`** role.
</Note>

## Enums

<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="CoworkerIdentityCheckDocument_Coworker" type="integer">
  Filter by Coworker Id.
</ParamField>

<ParamField query="CoworkerIdentityCheckDocument_Coworker_FullName" type="string">
  Filter by full name of the customer this document belongs to.
</ParamField>

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

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

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

<ParamField query="CoworkerIdentityCheckDocument_CoworkerIdentityCheck" type="integer">
  Filter by Coworker Identity Check Id.
</ParamField>

<ParamField query="CoworkerIdentityCheckDocument_CoworkerIdentityCheck_Name" type="string">
  Filter by name of the parent identity or address check.
</ParamField>

<ParamField query="CoworkerIdentityCheckDocument_CoworkerIdentityCheck_VerificationType" type="string">
  Filter by verification type of the parent check (IdDocument or Address).
</ParamField>

<ParamField query="CoworkerIdentityCheckDocument_CoworkerIdentityCheck_Business_Name" type="string">
  Filter by location (business) name from the parent check.
</ParamField>

<ParamField query="CoworkerIdentityCheckDocument_CoworkerIdentityCheck_IdentityDocumentType" type="string">
  Filter by identity document type from the parent check (e.g. Passport, DriversLicense).
</ParamField>

<ParamField query="CoworkerIdentityCheckDocument_CoworkerIdentityCheck_IdentityDocumentNumber" type="string">
  Filter by document number from the parent check.
</ParamField>

<ParamField query="CoworkerIdentityCheckDocument_CoworkerIdentityCheck_IdentityDocumentIssuedBy" type="string">
  Filter by issuing authority from the parent check.
</ParamField>

<ParamField query="CoworkerIdentityCheckDocument_CoworkerIdentityCheck_IdentityDocumentExpirationDate" type="string">
  Filter by document expiration date from the parent check.
</ParamField>

<ParamField query="CoworkerIdentityCheckDocument_CoworkerIdentityCheck_AddressDocumentType" type="string">
  Filter by address document type from the parent check (e.g. LeaseRentalAgreement, VoterCard).
</ParamField>

<ParamField query="CoworkerIdentityCheckDocument_Name" type="string">
  Filter by display name for this document record.
</ParamField>

<ParamField query="CoworkerIdentityCheckDocument_PhotoFileName" type="string">
  Filter by Photo File Name.
</ParamField>

<ParamField query="CoworkerIdentityCheckDocument_NewPhotoUrl" type="string">
  Filter by New Photo Url.
</ParamField>

<ParamField query="CoworkerIdentityCheckDocument_ClearPhoto" type="boolean">
  Filter by Clear Photo File.
</ParamField>

<ParamField query="CoworkerIdentityCheckDocument_DocumentFileName" type="string">
  Filter by Document File Name.
</ParamField>

<ParamField query="CoworkerIdentityCheckDocument_NewDocumentUrl" type="string">
  Filter by New Document Url.
</ParamField>

<ParamField query="CoworkerIdentityCheckDocument_ClearDocument" type="boolean">
  Filter by Clear Document File.
</ParamField>

<ParamField query="CoworkerIdentityCheckDocument_AdditionalDocumentFileName" type="string">
  Filter by Additional Document File Name.
</ParamField>

<ParamField query="CoworkerIdentityCheckDocument_NewAdditionalDocumentUrl" type="string">
  Filter by New Additional Document Url.
</ParamField>

<ParamField query="CoworkerIdentityCheckDocument_ClearAdditionalDocument" type="boolean">
  Filter by Clear Additional Document File.
</ParamField>

<ParamField query="CoworkerIdentityCheckDocument_VerificationStatus" type="integer">
  Filter by current review status of this document (Pending, Submitted, Successful, Failed, or Cancelled).
</ParamField>

<ParamField query="CoworkerIdentityCheckDocument_Notes" type="string">
  Filter by free-text notes or reviewer comments about this document.
</ParamField>

### Range Filters

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

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

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

<ParamField query="to_CoworkerIdentityCheckDocument_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/coworkeridentitycheckdocuments?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/coworkeridentitycheckdocuments?' + 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/coworkeridentitycheckdocuments',
      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/coworkeridentitycheckdocuments?CoworkerIdentityCheckDocument_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/coworkeridentitycheckdocuments?' + new URLSearchParams({
      CoworkerIdentityCheckDocument_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/coworkeridentitycheckdocuments',
      params={
          'CoworkerIdentityCheckDocument_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/coworkeridentitycheckdocuments?from_CoworkerIdentityCheckDocument_UpdatedOn=2025-01-01T00:00&to_CoworkerIdentityCheckDocument_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/coworkeridentitycheckdocuments?' + new URLSearchParams({
      from_CoworkerIdentityCheckDocument_UpdatedOn: '2025-01-01T00:00',
      to_CoworkerIdentityCheckDocument_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/coworkeridentitycheckdocuments',
      params={
          'from_CoworkerIdentityCheckDocument_UpdatedOn': '2025-01-01T00:00',
          'to_CoworkerIdentityCheckDocument_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="CoworkerIdentityCheckDocument[]">
  The list of CoworkerIdentityCheckDocument records matching the query. See the [Get one CoworkerIdentityCheckDocument](/rest-api/spaces/get-coworkeridentitycheckdocuments-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 CoworkerIdentityCheckDocument. The following fields are **not populated** in the `Records[]` response: `Notes`.

  To get all fields, fetch the full record using the [Get one CoworkerIdentityCheckDocument](/rest-api/spaces/get-coworkeridentitycheckdocuments-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": [
    {
      "CoworkerId": 0,
      "CoworkerFullName": null,
      "CoworkerCoworkerType": null,
      "CoworkerCompanyName": null,
      "CoworkerBillingName": null,
      "CoworkerIdentityCheckId": 0,
      "CoworkerIdentityCheckName": null,
      "CoworkerIdentityCheckVerificationType": null,
      "CoworkerIdentityCheckBusinessName": null,
      "CoworkerIdentityCheckIdentityDocumentType": null,
      "CoworkerIdentityCheckIdentityDocumentNumber": null,
      "CoworkerIdentityCheckIdentityDocumentIssuedBy": null,
      "CoworkerIdentityCheckIdentityDocumentExpirationDate": null,
      "CoworkerIdentityCheckAddressDocumentType": null,
      "Name": "",
      "PhotoFileName": null,
      "NewPhotoUrl": null,
      "ClearPhotoFile": null,
      "DocumentFileName": null,
      "NewDocumentUrl": null,
      "ClearDocumentFile": null,
      "AdditionalDocumentFileName": null,
      "NewAdditionalDocumentUrl": null,
      "ClearAdditionalDocumentFile": null,
      "VerificationStatus": 0,
      "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": "CoworkerIdentityCheckDocument 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
}
```