Skip to main content
POST
/
api
/
spaces
/
coworkeridentitycheckdocuments
Create CoworkerIdentityCheckDocument
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>"
}
'
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt

Use this file to discover all available pages before exploring further.

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

​
Enums

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

​
Request Body

​
Required Fields

​
CoworkerId
integer
required
Coworker Id.
​
CoworkerIdentityCheckId
integer
required
Coworker Identity Check Id.
​
Name
string
required
Display name for this document record.

​
Optional Fields

​
NewPhotoUrl
string
New Photo Url.
​
ClearPhotoFile
boolean
Clear Photo File.
​
NewDocumentUrl
string
New Document Url.
​
ClearDocumentFile
boolean
Clear Document File.
​
NewAdditionalDocumentUrl
string
New Additional Document Url.
​
ClearAdditionalDocumentFile
boolean
Clear Additional Document File.
​
Notes
string
Free-text notes or reviewer comments about this document.

​
Code Examples

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": "admin@example.com",
  "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.
​
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
}