Search CoworkerIdentityChecks

GET

api

spaces

coworkeridentitychecks

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

import requests

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

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', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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

Query Parameters

Pagination & Sorting

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

The property name to sort results by (e.g. Name, CreatedOn).

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by iD of the location that owns this identity check..

string

Filter by display value for Business.Name..

integer

Filter by iD of the customer whose identity or address is being verified..

string

Filter by display value for Coworker.FullName..

string

Filter by display value for Coworker.CoworkerType..

string

Filter by display value for Coworker.CompanyName..

string

Filter by display value for Coworker.BillingName..

string

Filter by required operator-facing label for this verification check..

integer

Filter by how the check is performed: Manual for operator-reviewed documents, or StripeIdentity for a Stripe Identity session..

integer

Filter by identity document type when VerificationType is IdDocument: Passport, DriversLicense, IdCard, UniformedServiceId, CertificateOfNaturalization, AccessCard, MatriculaConsular, ResidentCard, UniversityId, NEXUSCard, or Other..

string

Filter by optional number or identifier printed on the identity document..

string

Filter by optional authority or organization that issued the identity document..

string

Filter by optional expiration date recorded on the identity document..

integer

Filter by address document type when VerificationType is Address: Passport, DriversLicense, IdCard, LeaseRentalAgreement, InsurancePolicy, Mortgage, VehicleRegistrationCard, VoterCard, or Other..

integer

Filter by purpose of the check: IdDocument for identity verification or Address for address verification..

string

Filter by optional free-text notes describing this verification check..

integer

Filter by read-only verification lifecycle status: Pending, Submitted, Successful, Failed, or Cancelled; manual checks derive it from their document records..

string

Filter by read-only most recent error message reported when the verification fails..

boolean

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

string

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

string

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

string

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

string

Filter by internal Stripe Identity session identifier managed by the Stripe verification integration..

string

Filter by internal GUID that groups checks generated from one multi-check creation request..

integer

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

integer

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

string

Filter by optional notes for the second check created with this request; used only with VerificationType1..

integer

Filter by optional provider for a third check created with this request: Manual or StripeIdentity; requires VerificationType2..

integer

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

string

Filter by optional notes for the third check created with this request; used only with VerificationType2..

Range Filters

string

Filter by optional expiration date recorded on the identity document. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional expiration date recorded on the identity document. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/coworkeridentitychecks?page=1&size=15&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/coworkeridentitychecks?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'Name',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/spaces/coworkeridentitychecks',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by Name

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/coworkeridentitychecks?CoworkerIdentityCheck_Name=example-value&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/coworkeridentitychecks?' + new URLSearchParams({
    CoworkerIdentityCheck_Name: 'example-value',
    orderBy: 'Name',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/spaces/coworkeridentitychecks',
    params={
        'CoworkerIdentityCheck_Name': 'example-value',
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/coworkeridentitychecks?from_CoworkerIdentityCheck_UpdatedOn=2025-01-01T00:00&to_CoworkerIdentityCheck_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/coworkeridentitychecks?' + new URLSearchParams({
    from_CoworkerIdentityCheck_UpdatedOn: '2025-01-01T00:00',
    to_CoworkerIdentityCheck_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/spaces/coworkeridentitychecks',
    params={
        'from_CoworkerIdentityCheck_UpdatedOn': '2025-01-01T00:00',
        'to_CoworkerIdentityCheck_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

CoworkerIdentityCheck[]

The list of CoworkerIdentityCheck records matching the query. See the Get one CoworkerIdentityCheck endpoint for the full list of properties returned for each record.

Partial records — The listing endpoint returns a summary representation of each CoworkerIdentityCheck. The following fields are not populated in the Records[] response: Description, IdentityCheckProvider1, VerificationType1, Description1, IdentityCheckProvider2, VerificationType2, Description2.To get all fields, fetch the full record using the Get one CoworkerIdentityCheck endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

The sort direction (0 = ascending, 1 = descending).

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "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,
      "VerificationStatus": 0,
      "LastError": null,
      "Billed": false,
      "ProposalGuid": null,
      "CoworkerContractGuid": null,
      "ContractContactGuid": null,
      "StripeVerificationSessionId": null,
      "IdentityCheckGroupGuid": 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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Search CoworkerIdentityChecks

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

import requests

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

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', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Search CoworkerIdentityChecks

Authentication

Enums

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Name

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200