Update CoworkerIdentityCheck

Update an existing CoworkerIdentityCheck record.

PUT /api/spaces/coworkeridentitychecks

Update CoworkerIdentityCheck

cURL

curl --request PUT \
  --url https://spaces.nexudus.com/api/spaces/coworkeridentitychecks \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "BusinessId": 123,
  "CoworkerId": 123,
  "Name": "<string>",
  "IdentityCheckProvider": 123,
  "IdentityDocumentType": 123,
  "AddressDocumentType": 123
}
'

200

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Updates an existing CoworkerIdentityCheck 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 CoworkerIdentityCheck-Edit role.

Enums

eIdentityCheckProvider — IdentityCheckProvider values

Value	Name
0	None
1	Manual
2	StripeIdentity

eIdentityCheckDocumentType — IdentityDocumentType values

Value	Name
0	None
1	Passport
2	DriversLicense
3	IdCard
4	UniformedServiceId
5	CertificateOfNaturalization
6	AccessCard
7	MatriculaConsular
8	ResidentCard
9	UniversityId
10	NEXUSCard
99	Other

eAddressCheckDocumentType — AddressDocumentType values

Value	Name
0	None
1	Passport
2	DriversLicense
3	IdCard
4	LeaseRentalAgreement
5	InsurancePolicy
6	Mortgage
7	VehicleRegistrationCard
8	VoterCard
99	Other

eIdVerificationType — VerificationType values

Value	Name
0	None
1	IdDocument
2	Address

eIdVerificationStatus — VerificationStatus values

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

Request Body

Required Fields

Id · integer · required

The Id of the CoworkerIdentityCheck record to update.

BusinessId · integer · required

ID of the business linked to this record.

CoworkerId · integer · required

ID of the coworker linked to this record.

Name · string · required

Display name for this verification check.

IdentityCheckProvider · integer · required

How the check is performed: Manual (operator review) or StripeIdentity (Stripe-delegated).

IdentityDocumentType · integer · required

Type of identity document used when VerificationType is IdDocument.

AddressDocumentType · integer · required

Type of address document used when VerificationType is Address.

Optional Fields

IdentityDocumentNumber · string

Number or identifier on the identity document.

IdentityDocumentIssuedBy · string

Authority or organisation that issued the identity document.

IdentityDocumentExpirationDate · string

Expiration date of the identity document.

Description · string

Free-text notes or details about this check.

Billed · boolean

Whether billed is enabled.

StripeVerificationSessionId · string

ID of the stripe verification session associated with this record.

IdentityCheckProvider1 · integer

The identity check provider1 value for this coworker identity check. See eIdentityCheckProvider? enum above.

VerificationType1 · integer

The verification type1 value for this coworker identity check. See eIdVerificationType? enum above.

Description1 · string

The description1 value for this coworker identity check.

IdentityCheckProvider2 · integer

The identity check provider2 value for this coworker identity check. See eIdentityCheckProvider? enum above.

VerificationType2 · integer

The verification type2 value for this coworker identity check. See eIdVerificationType? enum above.

Description2 · string

The description2 value for this coworker identity check.

Code Examples

cURL

curl -X PUT \
  "https://spaces.nexudus.com/api/spaces/coworkeridentitychecks" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "CoworkerId": 0,
    "Name": "",
    "IdentityCheckProvider": 0,
    "IdentityDocumentType": 0,
    "AddressDocumentType": 0,
    "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 coworkeridentitycheck was updated successfully.

Errors · array

null on success.

Example Response

{
  "Status": 200,
  "Message": "CoworkerIdentityCheck was successfully updated.",
  "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
}