Create CoworkerIdentityCheck

POST

api

spaces

coworkeridentitychecks

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
}
'

import requests

url = "https://spaces.nexudus.com/api/spaces/coworkeridentitychecks"

payload = {
    "BusinessId": 123,
    "CoworkerId": 123,
    "Name": "<string>",
    "IdentityCheckProvider": 123,
    "IdentityDocumentType": 123,
    "AddressDocumentType": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    BusinessId: 123,
    CoworkerId: 123,
    Name: '<string>',
    IdentityCheckProvider: 123,
    IdentityDocumentType: 123,
    AddressDocumentType: 123
  })
};

fetch('https://spaces.nexudus.com/api/spaces/coworkeridentitychecks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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:

VerificationType	Purpose
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

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

integer

required

ID of the business linked to this record.

integer

required

ID of the coworker linked to this record.

string

required

Display name for this verification check.

integer

required

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

integer

required

Type of identity document used when VerificationType is IdDocument. Defaults to eIdentityCheckDocumentType.Other.

integer

required

Type of address document used when VerificationType is Address. Defaults to eAddressCheckDocumentType.Other.

Optional Fields

string

Number or identifier on the identity document.

string

Authority or organisation that issued the identity document.

string

Expiration date of the identity document.

string

Free-text notes or details about this check.

boolean

Whether billed is enabled.

string

ID of the stripe verification session associated with this record.

integer

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

integer

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

string

The description1 value for this coworker identity check.

integer

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

integer

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

string

The description2 value for this coworker identity check.

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
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/coworkeridentitychecks',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      CoworkerId: 0,
      Name: '',
      IdentityCheckProvider: 0,
      IdentityDocumentType: 0,
      AddressDocumentType: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/spaces/coworkeridentitychecks',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'CoworkerId': 0,
        'Name': '',
        'IdentityCheckProvider': 0,
        'IdentityDocumentType': 0,
        'AddressDocumentType': 0
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the coworkeridentitycheck was created successfully.

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

string

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

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

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

string

The validation error message.

string

The name of the property that failed validation.

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
}

Update CoworkerIdentityCheckUpdate an existing CoworkerIdentityCheck record.

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
}
'

import requests

url = "https://spaces.nexudus.com/api/spaces/coworkeridentitychecks"

payload = {
    "BusinessId": 123,
    "CoworkerId": 123,
    "Name": "<string>",
    "IdentityCheckProvider": 123,
    "IdentityDocumentType": 123,
    "AddressDocumentType": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    BusinessId: 123,
    CoworkerId: 123,
    Name: '<string>',
    IdentityCheckProvider: 123,
    IdentityDocumentType: 123,
    AddressDocumentType: 123
  })
};

fetch('https://spaces.nexudus.com/api/spaces/coworkeridentitychecks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400