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,
  "VerificationType": 123
}
'

import requests

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

payload = {
    "BusinessId": 123,
    "CoworkerId": 123,
    "Name": "<string>",
    "IdentityCheckProvider": 123,
    "IdentityDocumentType": 123,
    "AddressDocumentType": 123,
    "VerificationType": 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,
    VerificationType: 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>"
    }
  ]
}

Customer ID checks verify a customer’s identity or address for a location through operator-reviewed documents or Stripe Identity, and track progress from pending through completion.

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
1	Manual
2	StripeIdentity

eIdentityCheckDocumentType — IdentityDocumentType values

Value	Name
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
1	Passport
2	DriversLicense
3	IdCard
4	LeaseRentalAgreement
5	InsurancePolicy
6	Mortgage
7	VehicleRegistrationCard
8	VoterCard
9	BankStatement
99	Other

eIdVerificationType — VerificationType values

Value	Name
1	IdDocument
2	Address

eIdVerificationStatus — VerificationStatus values

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

Request Body

Required Fields

integer

required

ID of the location that owns this identity check..

integer

required

ID of the customer whose identity or address is being verified..

string

required

Required operator-facing label for this verification check..

integer

required

How the check is performed: Manual for operator-reviewed documents, or StripeIdentity for a Stripe Identity session.. Defaults to eIdentityCheckProvider.Manual.

integer

required

Identity document type when VerificationType is IdDocument: Passport, DriversLicense, IdCard, UniformedServiceId, CertificateOfNaturalization, AccessCard, MatriculaConsular, ResidentCard, UniversityId, NEXUSCard, or Other.. Defaults to eIdentityCheckDocumentType.Other.

integer

required

Address document type when VerificationType is Address: Passport, DriversLicense, IdCard, LeaseRentalAgreement, InsurancePolicy, Mortgage, VehicleRegistrationCard, VoterCard, or Other.. Defaults to eAddressCheckDocumentType.Other.

integer

required

Purpose of the check: IdDocument for identity verification or Address for address verification.. Defaults to eIdVerificationType.IdDocument.

Optional Fields

string

Optional number or identifier printed on the identity document..

string

Optional authority or organization that issued the identity document..

string

Optional expiration date recorded on the identity document..

string

Optional free-text notes describing this verification check..

boolean

Internal billing-processing flag managed by the platform; do not inspect or set it..

string

Internal Stripe Identity session identifier managed by the Stripe verification integration..

integer

Optional provider for a second check created with this request: Manual or StripeIdentity; requires VerificationType1.. See eIdentityCheckProvider? enum above.

integer

Optional purpose for a second check created with this request: IdDocument or Address; requires IdentityCheckProvider1.. See eIdVerificationType? enum above.

string

Optional notes for the second check created with this request; used only with VerificationType1..

integer

Optional provider for a third check created with this request: Manual or StripeIdentity; requires VerificationType2.. See eIdentityCheckProvider? enum above.

integer

Optional purpose for a third check created with this request: IdDocument or Address; requires IdentityCheckProvider2.. See eIdVerificationType? enum above.

string

Optional notes for the third check created with this request; used only with VerificationType2..

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,
    "VerificationType": 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,
      VerificationType: 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,
        'VerificationType': 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
}

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,
  "VerificationType": 123
}
'

import requests

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

payload = {
    "BusinessId": 123,
    "CoworkerId": 123,
    "Name": "<string>",
    "IdentityCheckProvider": 123,
    "IdentityDocumentType": 123,
    "AddressDocumentType": 123,
    "VerificationType": 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,
    VerificationType: 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