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

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-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 location that owns this identity check..

string

Display value for Business.Name..

integer

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

string

Display value for Coworker.FullName..

string

Display value for Coworker.CoworkerType..

string

Display value for Coworker.CompanyName..

string

Display value for Coworker.BillingName..

string

Required operator-facing label for this verification check..

integer

How the check is performed: Manual for operator-reviewed documents, or StripeIdentity for a Stripe Identity session.. See eIdentityCheckProvider enum values: 1 = Manual, 2 = StripeIdentity.

integer

Identity document type when VerificationType is IdDocument: Passport, DriversLicense, IdCard, UniformedServiceId, CertificateOfNaturalization, AccessCard, MatriculaConsular, ResidentCard, UniversityId, NEXUSCard, or Other.. See eIdentityCheckDocumentType enum values: 1 = Passport, 2 = DriversLicense, 3 = IdCard, 4 = UniformedServiceId, 5 = CertificateOfNaturalization, 6 = AccessCard, 7 = MatriculaConsular, 8 = ResidentCard, 9 = UniversityId, 10 = NEXUSCard, 99 = Other.

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..

integer

Address document type when VerificationType is Address: Passport, DriversLicense, IdCard, LeaseRentalAgreement, InsurancePolicy, Mortgage, VehicleRegistrationCard, VoterCard, or Other.. See eAddressCheckDocumentType enum values: 1 = Passport, 2 = DriversLicense, 3 = IdCard, 4 = LeaseRentalAgreement, 5 = InsurancePolicy, 6 = Mortgage, 7 = VehicleRegistrationCard, 8 = VoterCard, 9 = BankStatement, 99 = Other.

integer

Purpose of the check: IdDocument for identity verification or Address for address verification.. See eIdVerificationType enum values: 1 = IdDocument, 2 = Address.

string

Optional free-text notes describing this verification check..

integer

Read-only verification lifecycle status: Pending, Submitted, Successful, Failed, or Cancelled; manual checks derive it from their document records.. See eIdVerificationStatus enum values: 1 = Pending, 2 = Submitted, 3 = Successful, 4 = Failed, 5 = Cancelled.

string

Read-only most recent error message reported when the verification fails..

boolean

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

string

Internal GUID linking this check to the proposal that created it; managed by proposal automation..

string

Internal GUID linking this check to the contract that created it; managed by contract workflows..

string

Internal GUID identifying the contract contact being verified; managed by contract workflows..

string

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

string

Internal GUID that groups checks generated from one multi-check creation request..

integer

Optional provider for a second check created with this request: Manual or StripeIdentity; requires VerificationType1..

integer

Optional purpose for a second check created with this request: IdDocument or Address; requires IdentityCheckProvider1..

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..

integer

Optional purpose for a third check created with this request: IdDocument or Address; requires IdentityCheckProvider2..

string

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

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