Skip to main content
PUT
/
api
/
spaces
/
coworkeridentitycheckdocuments
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}
Updates an existing CoworkerIdentityCheckDocument record. You must include the Id of the record to update along with all required fields.

​
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-Edit role.

​
Enums

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

​
Request Body

​
Required Fields

​
Id
integer
required
The Id of the CoworkerIdentityCheckDocument record to update.
​
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 PUT \
  "https://spaces.nexudus.com/api/spaces/coworkeridentitycheckdocuments" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "CoworkerId": 0,
    "CoworkerIdentityCheckId": 0,
    "Name": "",
    "Id": 87654321
}'

​
Response

​
200

​
Status
integer
HTTP status code. 200 on success.
​
Message
string
A human-readable message confirming the update.
​
Value
object
Contains the Id of the updated record.
​
WasSuccessful
boolean
true if the coworkeridentitycheckdocument was updated successfully.
​
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "CoworkerIdentityCheckDocument was successfully updated.",
  "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
}