Search CoworkerIdentityCheckDocuments

GET

api

spaces

coworkeridentitycheckdocuments

curl --request GET \
  --url https://spaces.nexudus.com/api/spaces/coworkeridentitycheckdocuments \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/spaces/coworkeridentitycheckdocuments"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/spaces/coworkeridentitycheckdocuments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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

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.

Enums

eIdVerificationStatus — VerificationStatus values

Value	Name
0	None
1	Pending
2	Submitted
3	Successful
4	Failed
5	Cancelled

Query Parameters

Pagination & Sorting

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

The property name to sort results by (e.g. Name, CreatedOn).

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by iD of the coworker linked to this record.

string

Filter by full name of the customer this document belongs to.

string

Filter by type of the customer (e.g. Member, TeamMember).

string

Filter by company name of the customer.

string

Filter by billing name of the customer.

integer

Filter by iD of the coworker identity check linked to this record.

string

Filter by name of the parent identity or address check.

string

Filter by verification type of the parent check (IdDocument or Address).

string

Filter by location (business) name from the parent check.

string

Filter by identity document type from the parent check (e.g. Passport, DriversLicense).

string

Filter by document number from the parent check.

string

Filter by issuing authority from the parent check.

string

Filter by document expiration date from the parent check.

string

Filter by address document type from the parent check (e.g. LeaseRentalAgreement, VoterCard).

string

Filter by display name for this document record.

string

Filter by current file name of the photo (read-only; upload via the corresponding URL field).

string

Filter by uRL of a new file to upload as the photo.

boolean

Filter by set to true to remove the current photo file.

string

Filter by current file name of the document (read-only; upload via the corresponding URL field).

string

Filter by uRL of a new file to upload as the document.

boolean

Filter by set to true to remove the current document file.

string

Filter by current file name of the additional document (read-only; upload via the corresponding URL field).

string

Filter by uRL of a new file to upload as the additional document.

boolean

Filter by set to true to remove the current additional document file.

integer

Filter by current review status of this document (Pending, Submitted, Successful, Failed, or Cancelled).

string

Filter by free-text notes or reviewer comments about this document.

Range Filters

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/coworkeridentitycheckdocuments?page=1&size=15&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

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();

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()

Filtering by Name

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/coworkeridentitycheckdocuments?CoworkerIdentityCheckDocument_Name=example-value&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

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();

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()

Range filters

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"

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();

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()

Response

200

CoworkerIdentityCheckDocument[]

The list of CoworkerIdentityCheckDocument records matching the query. See the Get one CoworkerIdentityCheckDocument endpoint for the full list of properties returned for each record.

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 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.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

The sort direction (0 = ascending, 1 = descending).

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

boolean

Whether there is a previous page of results.

Example Response

{
  "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
}

Get one CoworkerIdentityCheckDocumentRetrieve a single CoworkerIdentityCheckDocument record by its Id.

Search CoworkerIdentityCheckDocuments

curl --request GET \
  --url https://spaces.nexudus.com/api/spaces/coworkeridentitycheckdocuments \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/spaces/coworkeridentitycheckdocuments"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/spaces/coworkeridentitycheckdocuments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Search CoworkerIdentityCheckDocuments

Authentication

Enums

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Name

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200