Get one CoworkerIdentityCheck

GET

api

spaces

coworkeridentitychecks

{id}

Get one CoworkerIdentityCheck

curl --request GET \
  --url https://spaces.nexudus.com/api/spaces/coworkeridentitychecks/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

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

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

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

{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "CoworkerId": 123,
  "CoworkerFullName": "<string>",
  "CoworkerCoworkerType": "<string>",
  "CoworkerCompanyName": "<string>",
  "CoworkerBillingName": "<string>",
  "Name": "<string>",
  "IdentityCheckProvider": 123,
  "IdentityDocumentType": 123,
  "IdentityDocumentNumber": "<string>",
  "IdentityDocumentIssuedBy": "<string>",
  "IdentityDocumentExpirationDate": "<string>",
  "AddressDocumentType": 123,
  "VerificationType": 123,
  "Description": "<string>",
  "VerificationStatus": 123,
  "LastError": "<string>",
  "Billed": true,
  "ProposalGuid": "<string>",
  "CoworkerContractGuid": "<string>",
  "ContractContactGuid": "<string>",
  "StripeVerificationSessionId": "<string>",
  "IdentityCheckGroupGuid": "<string>",
  "IdentityCheckProvider1": 123,
  "VerificationType1": 123,
  "Description1": "<string>",
  "IdentityCheckProvider2": 123,
  "VerificationType2": 123,
  "Description2": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<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-Read role.

Path Parameters

integer

required

The Id of the CoworkerIdentityCheck record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/coworkeridentitychecks/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/coworkeridentitychecks/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/spaces/coworkeridentitychecks/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the business linked to this record.

string

Name of the location (business) this check belongs to.

integer

ID of the coworker linked to this record.

string

Full name of the customer being verified.

string

Type of the customer (e.g. Member, TeamMember).

string

Company name of the customer being verified.

string

Billing name of the customer being verified.

string

Display name for this verification check.

integer

How the check is performed: Manual (operator review) or StripeIdentity (Stripe-delegated). See eIdentityCheckProvider enum values: 0 = None, 1 = Manual, 2 = StripeIdentity.

integer

Type of identity document used when VerificationType is IdDocument. See eIdentityCheckDocumentType enum values: 0 = None, 1 = Passport, 2 = DriversLicense, 3 = IdCard, 4 = UniformedServiceId, 5 = CertificateOfNaturalization, 6 = AccessCard, 7 = MatriculaConsular, 8 = ResidentCard, 9 = UniversityId, 10 = NEXUSCard, 99 = Other.

string

Number or identifier on the identity document.

string

Authority or organisation that issued the identity document.

string

Expiration date of the identity document.

integer

Type of address document used when VerificationType is Address. See eAddressCheckDocumentType enum values: 0 = None, 1 = Passport, 2 = DriversLicense, 3 = IdCard, 4 = LeaseRentalAgreement, 5 = InsurancePolicy, 6 = Mortgage, 7 = VehicleRegistrationCard, 8 = VoterCard, 99 = Other.

integer

Whether this check verifies the customer’s identity (IdDocument) or address (Address). See eIdVerificationType enum values: 0 = None, 1 = IdDocument, 2 = Address.

string

Free-text notes or details about this check.

integer

Current status of the verification (Pending, Submitted, Successful, Failed, or Cancelled). See eIdVerificationStatus enum values: 0 = None, 1 = Pending, 2 = Submitted, 3 = Successful, 4 = Failed, 5 = Cancelled.

string

Most recent error message if the check failed.

boolean

Whether billed is enabled.

string

Unique identifier (GUID) for the proposal.

string

Unique identifier (GUID) for the coworker contract.

string

Unique identifier (GUID) for the contract contact.

string

ID of the stripe verification session associated with this record.

string

Unique identifier (GUID) for the identity check group.

integer

The identity check provider1 value for this coworker identity check.

integer

The verification type1 value for this coworker identity check.

string

The description1 value for this coworker identity check.

integer

The identity check provider2 value for this coworker identity check.

integer

The verification type2 value for this coworker identity check.

string

The description2 value for this coworker identity check.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "BusinessId": 0,
  "BusinessName": null,
  "CoworkerId": 0,
  "CoworkerFullName": null,
  "CoworkerCoworkerType": null,
  "CoworkerCompanyName": null,
  "CoworkerBillingName": null,
  "Name": "",
  "IdentityCheckProvider": 0,
  "IdentityDocumentType": 0,
  "IdentityDocumentNumber": null,
  "IdentityDocumentIssuedBy": null,
  "IdentityDocumentExpirationDate": null,
  "AddressDocumentType": 0,
  "VerificationType": 0,
  "Description": null,
  "VerificationStatus": 0,
  "LastError": null,
  "Billed": false,
  "ProposalGuid": null,
  "CoworkerContractGuid": null,
  "ContractContactGuid": null,
  "StripeVerificationSessionId": null,
  "IdentityCheckGroupGuid": null,
  "IdentityCheckProvider1": 0,
  "VerificationType1": 0,
  "Description1": null,
  "IdentityCheckProvider2": 0,
  "VerificationType2": 0,
  "Description2": null,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "CoworkerIdentityCheck Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get multiple CoworkerIdentityChecksRetrieve multiple CoworkerIdentityCheck records by their Ids in a single request.

Get one CoworkerIdentityCheck

curl --request GET \
  --url https://spaces.nexudus.com/api/spaces/coworkeridentitychecks/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

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

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

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

{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "CoworkerId": 123,
  "CoworkerFullName": "<string>",
  "CoworkerCoworkerType": "<string>",
  "CoworkerCompanyName": "<string>",
  "CoworkerBillingName": "<string>",
  "Name": "<string>",
  "IdentityCheckProvider": 123,
  "IdentityDocumentType": 123,
  "IdentityDocumentNumber": "<string>",
  "IdentityDocumentIssuedBy": "<string>",
  "IdentityDocumentExpirationDate": "<string>",
  "AddressDocumentType": 123,
  "VerificationType": 123,
  "Description": "<string>",
  "VerificationStatus": 123,
  "LastError": "<string>",
  "Billed": true,
  "ProposalGuid": "<string>",
  "CoworkerContractGuid": "<string>",
  "ContractContactGuid": "<string>",
  "StripeVerificationSessionId": "<string>",
  "IdentityCheckGroupGuid": "<string>",
  "IdentityCheckProvider1": 123,
  "VerificationType1": 123,
  "Description1": "<string>",
  "IdentityCheckProvider2": 123,
  "VerificationType2": 123,
  "Description2": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Get one CoworkerIdentityCheck

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200