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

ID check evidence holds the files submitted for a customer’s identity or address check; its submission status contributes to the parent check’s verification lifecycle.

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 customer whose ID check evidence this is..

string

Display value for Coworker.FullName..

string

Display value for Coworker.CoworkerType..

string

Display value for Coworker.CompanyName..

string

Display value for Coworker.BillingName..

integer

ID of the parent customer ID check; it determines which evidence files are required and owns the document status..

string

Display value for CoworkerIdentityCheck.Name..

string

Display value for CoworkerIdentityCheck.VerificationType..

string

Display value for CoworkerIdentityCheck.Business.Name..

string

Display value for CoworkerIdentityCheck.IdentityDocumentType..

string

Display value for CoworkerIdentityCheck.IdentityDocumentNumber..

string

Display value for CoworkerIdentityCheck.IdentityDocumentIssuedBy..

string

Display value for CoworkerIdentityCheck.IdentityDocumentExpirationDate..

string

Display value for CoworkerIdentityCheck.AddressDocumentType..

string

Required operator-facing label for this ID check evidence 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

Read-only document status: Pending, Submitted, Successful, Failed, or Cancelled; uploading evidence sets it to Submitted.. See eIdVerificationStatus enum values: 1 = Pending, 2 = Submitted, 3 = Successful, 4 = Failed, 5 = Cancelled.

string

Optional free-text reviewer notes about this ID check evidence..

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