Get one CoworkerIdentityCheckDocument

GET

api

spaces

coworkeridentitycheckdocuments

{id}

Get one CoworkerIdentityCheckDocument

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

import requests

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

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/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CoworkerId": 123,
  "CoworkerFullName": "<string>",
  "CoworkerCoworkerType": "<string>",
  "CoworkerCompanyName": "<string>",
  "CoworkerBillingName": "<string>",
  "CoworkerIdentityCheckId": 123,
  "CoworkerIdentityCheckName": "<string>",
  "CoworkerIdentityCheckVerificationType": "<string>",
  "CoworkerIdentityCheckBusinessName": "<string>",
  "CoworkerIdentityCheckIdentityDocumentType": "<string>",
  "CoworkerIdentityCheckIdentityDocumentNumber": "<string>",
  "CoworkerIdentityCheckIdentityDocumentIssuedBy": "<string>",
  "CoworkerIdentityCheckIdentityDocumentExpirationDate": "<string>",
  "CoworkerIdentityCheckAddressDocumentType": "<string>",
  "Name": "<string>",
  "PhotoFileName": "<string>",
  "NewPhotoUrl": "<string>",
  "ClearPhotoFile": true,
  "DocumentFileName": "<string>",
  "NewDocumentUrl": "<string>",
  "ClearDocumentFile": true,
  "AdditionalDocumentFileName": "<string>",
  "NewAdditionalDocumentUrl": "<string>",
  "ClearAdditionalDocumentFile": true,
  "VerificationStatus": 123,
  "Notes": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

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

Path Parameters

integer

required

The Id of the CoworkerIdentityCheckDocument record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/coworkeridentitycheckdocuments/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/coworkeridentitycheckdocuments/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/spaces/coworkeridentitycheckdocuments/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the coworker linked to this record.

string

Full name of the customer this document belongs to.

string

Type of the customer (e.g. Member, TeamMember).

string

Company name of the customer.

string

Billing name of the customer.

integer

ID of the coworker identity check linked to this record.

string

Name of the parent identity or address check.

string

Verification type of the parent check (IdDocument or Address).

string

Location (business) name from the parent check.

string

Identity document type from the parent check (e.g. Passport, DriversLicense).

string

Document number from the parent check.

string

Issuing authority from the parent check.

string

Document expiration date from the parent check.

string

Address document type from the parent check (e.g. LeaseRentalAgreement, VoterCard).

string

Display name for this document record.

string

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

string

URL of a new file to upload as the photo.

boolean

Set to true to remove the current photo file.

string

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

string

URL of a new file to upload as the document.

boolean

Set to true to remove the current document file.

string

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

string

URL of a new file to upload as the additional document.

boolean

Set to true to remove the current additional document file.

integer

Current review status of this document (Pending, Submitted, Successful, Failed, or Cancelled). See eIdVerificationStatus enum values: 0 = None, 1 = Pending, 2 = Submitted, 3 = Successful, 4 = Failed, 5 = Cancelled.

string

Free-text notes or reviewer comments about this document.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "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,
  "Notes": 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": "CoworkerIdentityCheckDocument Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get multiple CoworkerIdentityCheckDocumentsRetrieve multiple CoworkerIdentityCheckDocument records by their Ids in a single request.

Get one CoworkerIdentityCheckDocument

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

import requests

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

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/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CoworkerId": 123,
  "CoworkerFullName": "<string>",
  "CoworkerCoworkerType": "<string>",
  "CoworkerCompanyName": "<string>",
  "CoworkerBillingName": "<string>",
  "CoworkerIdentityCheckId": 123,
  "CoworkerIdentityCheckName": "<string>",
  "CoworkerIdentityCheckVerificationType": "<string>",
  "CoworkerIdentityCheckBusinessName": "<string>",
  "CoworkerIdentityCheckIdentityDocumentType": "<string>",
  "CoworkerIdentityCheckIdentityDocumentNumber": "<string>",
  "CoworkerIdentityCheckIdentityDocumentIssuedBy": "<string>",
  "CoworkerIdentityCheckIdentityDocumentExpirationDate": "<string>",
  "CoworkerIdentityCheckAddressDocumentType": "<string>",
  "Name": "<string>",
  "PhotoFileName": "<string>",
  "NewPhotoUrl": "<string>",
  "ClearPhotoFile": true,
  "DocumentFileName": "<string>",
  "NewDocumentUrl": "<string>",
  "ClearDocumentFile": true,
  "AdditionalDocumentFileName": "<string>",
  "NewAdditionalDocumentUrl": "<string>",
  "ClearAdditionalDocumentFile": true,
  "VerificationStatus": 123,
  "Notes": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Get one CoworkerIdentityCheckDocument

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200