Create CoworkerIdentityCheckDocument

Create a new CoworkerIdentityCheckDocument record.

POST /api/spaces/coworkeridentitycheckdocuments

Create CoworkerIdentityCheckDocument

cURL

curl --request POST \
  --url https://spaces.nexudus.com/api/spaces/coworkeridentitycheckdocuments \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "CoworkerId": 123,
  "CoworkerIdentityCheckId": 123,
  "Name": "<string>"
}
'

200

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<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-Create role.

Enums

eIdVerificationStatus — VerificationStatus values

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

Request Body

Required Fields

CoworkerId · integer · required

ID of the coworker linked to this record.

CoworkerIdentityCheckId · integer · required

ID of the coworker identity check linked to this record.

Name · string · required

Display name for this document record.

Optional Fields

NewPhotoUrl · string

URL of a new file to upload as the photo.

ClearPhotoFile · boolean

Set to true to remove the current photo file.

NewDocumentUrl · string

URL of a new file to upload as the document.

ClearDocumentFile · boolean

Set to true to remove the current document file.

NewAdditionalDocumentUrl · string

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

ClearAdditionalDocumentFile · boolean

Set to true to remove the current additional document file.

Notes · string

Free-text notes or reviewer comments about this document.

Code Examples

cURL

curl -X POST \
  "https://spaces.nexudus.com/api/spaces/coworkeridentitycheckdocuments" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "CoworkerId": 0,
    "CoworkerIdentityCheckId": 0,
    "Name": ""
}'

Response

200

Status · integer

HTTP status code. 200 on success.

Message · string

A human-readable message confirming the creation.

Value · object

Contains the Id of the newly created record.

WasSuccessful · boolean

true if the coworkeridentitycheckdocument was created successfully.

Errors · array

null on success.

Example Response

{
  "Status": 200,
  "Message": "CoworkerIdentityCheckDocument was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "[e-mail]",
  "Errors": null,
  "WasSuccessful": true
}

400

Message · string

A summary of the validation error(s), in the format PropertyName: error message.

Value · any

null on validation failure.

Errors · object[]

Array of validation errors.

Show child attributes

AttemptedValue · any

The value that was submitted for the field, or null if missing.

Message · string

The validation error message.

PropertyName · string

The name of the property that failed validation.

WasSuccessful · boolean

false when the request fails validation.

Example Response

{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}