Skip to main content
POST
/
api
/
spaces
/
coworkeridentitychecks
Create CoworkerIdentityCheck
curl --request POST \
  --url https://spaces.nexudus.com/api/spaces/coworkeridentitychecks \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "CoworkerId": 123,
  "Name": "<string>",
  "IdentityCheckProvider": 123,
  "IdentityDocumentType": 123,
  "AddressDocumentType": 123
}
'
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}
A CoworkerIdentityCheck represents a manual or Stripe Identity-based verification of a customer’s identity or address. Each check is linked to a Coworker and a Business (location). The VerificationType determines the nature of the check:
VerificationTypePurpose
IdDocument (1)Verifies the customer’s identity using an official document (passport, driver’s license, ID card, etc.)
Address (2)Verifies the customer’s address using a supporting document (lease agreement, insurance policy, voter card, etc.)
When VerificationType is IdDocument, use IdentityDocumentType to specify the document kind, along with IdentityDocumentNumber, IdentityDocumentIssuedBy, and IdentityDocumentExpirationDate. When VerificationType is Address, use AddressDocumentType instead. IdentityCheckProvider controls how the check is performed: Manual (1) means the operator reviews documents directly, while StripeIdentity (2) delegates verification to Stripe Identity. The VerificationStatus tracks progress through the check lifecycle: 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 CoworkerIdentityCheck-Create role.

​
Enums

ValueName
0None
1Manual
2StripeIdentity
ValueName
0None
1Passport
2DriversLicense
3IdCard
4UniformedServiceId
5CertificateOfNaturalization
6AccessCard
7MatriculaConsular
8ResidentCard
9UniversityId
10NEXUSCard
99Other
ValueName
0None
1Passport
2DriversLicense
3IdCard
4LeaseRentalAgreement
5InsurancePolicy
6Mortgage
7VehicleRegistrationCard
8VoterCard
99Other
ValueName
0None
1IdDocument
2Address
ValueName
0None
1Pending
2Submitted
3Successful
4Failed
5Cancelled

​
Request Body

​
Required Fields

​
BusinessId
integer
required
Business Id.
​
CoworkerId
integer
required
Coworker Id.
​
Name
string
required
Display name for this verification check.
​
IdentityCheckProvider
integer
required
How the check is performed: Manual (operator review) or StripeIdentity (Stripe-delegated). Defaults to eIdentityCheckProvider.Manual.
​
IdentityDocumentType
integer
required
Type of identity document used when VerificationType is IdDocument. Defaults to eIdentityCheckDocumentType.Other.
​
AddressDocumentType
integer
required
Type of address document used when VerificationType is Address. Defaults to eAddressCheckDocumentType.Other.

​
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
Billed.
​
StripeVerificationSessionId
string
Stripe Verification Session Id.
​
IdentityCheckProvider1
integer
Identity Check Provider1. See eIdentityCheckProvider? enum above.
​
VerificationType1
integer
Verification Type1. See eIdVerificationType? enum above.
​
Description1
string
Description1.
​
IdentityCheckProvider2
integer
Identity Check Provider2. See eIdentityCheckProvider? enum above.
​
VerificationType2
integer
Verification Type2. See eIdVerificationType? enum above.
​
Description2
string
Description2.

​
Code Examples

curl -X POST \
  "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
}'

​
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 coworkeridentitycheck was created successfully.
​
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "CoworkerIdentityCheck 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
}