Skip to main content
GET
/
api
/
spaces
/
coworkeridentitycheckdocuments
/
{id}
{
  "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 slotField prefixPurpose
Face photoPhotoA photograph of the customer’s face
FrontDocumentThe front side of the identity or address document
BackAdditionalDocumentThe 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

​
id
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"

​
Response

​
200

​
CoworkerId
integer
Coworker Id.
​
CoworkerFullName
string
Full name of the customer this document belongs to.
​
CoworkerCoworkerType
string
Type of the customer (e.g. Member, TeamMember).
​
CoworkerCompanyName
string
Company name of the customer.
​
CoworkerBillingName
string
Billing name of the customer.
​
CoworkerIdentityCheckId
integer
Coworker Identity Check Id.
​
CoworkerIdentityCheckName
string
Name of the parent identity or address check.
​
CoworkerIdentityCheckVerificationType
string
Verification type of the parent check (IdDocument or Address).
​
CoworkerIdentityCheckBusinessName
string
Location (business) name from the parent check.
​
CoworkerIdentityCheckIdentityDocumentType
string
Identity document type from the parent check (e.g. Passport, DriversLicense).
​
CoworkerIdentityCheckIdentityDocumentNumber
string
Document number from the parent check.
​
CoworkerIdentityCheckIdentityDocumentIssuedBy
string
Issuing authority from the parent check.
​
CoworkerIdentityCheckIdentityDocumentExpirationDate
string
Document expiration date from the parent check.
​
CoworkerIdentityCheckAddressDocumentType
string
Address document type from the parent check (e.g. LeaseRentalAgreement, VoterCard).
​
Name
string
Display name for this document record.
​
PhotoFileName
string
Photo File Name.
​
NewPhotoUrl
string
New Photo Url.
​
ClearPhotoFile
boolean
Clear Photo File.
​
DocumentFileName
string
Document File Name.
​
NewDocumentUrl
string
New Document Url.
​
ClearDocumentFile
boolean
Clear Document File.
​
AdditionalDocumentFileName
string
Additional Document File Name.
​
NewAdditionalDocumentUrl
string
New Additional Document Url.
​
ClearAdditionalDocumentFile
boolean
Clear Additional Document File.
​
VerificationStatus
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.
​
Notes
string
Free-text notes or reviewer comments about this document.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
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
}