Search CoworkerIdentityChecks

Search and list CoworkerIdentityCheck records with filtering, sorting, and pagination.

GET /api/spaces/coworkeridentitychecks

Search CoworkerIdentityChecks

cURL

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

200

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

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

Query Parameters

Pagination & Sorting

page · integer · default: "1"

The page number to retrieve.

size · integer · default: "25"

The number of records per page.

orderBy · string

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

dir · integer

Sort direction. 0 for ascending, 1 for descending.

Filters

CoworkerIdentityCheck_Business · integer

Filter by iD of the business linked to this record.

CoworkerIdentityCheck_Business_Name · string

Filter by name of the location (business) this check belongs to.

CoworkerIdentityCheck_Coworker · integer

Filter by iD of the coworker linked to this record.

CoworkerIdentityCheck_Coworker_FullName · string

Filter by full name of the customer being verified.

CoworkerIdentityCheck_Coworker_CoworkerType · string

Filter by type of the customer (e.g. Member, TeamMember).

CoworkerIdentityCheck_Coworker_CompanyName · string

Filter by company name of the customer being verified.

CoworkerIdentityCheck_Coworker_BillingName · string

Filter by billing name of the customer being verified.

CoworkerIdentityCheck_Name · string

Filter by display name for this verification check.

CoworkerIdentityCheck_IdentityCheckProvider · integer

Filter by how the check is performed: Manual (operator review) or StripeIdentity (Stripe-delegated).

CoworkerIdentityCheck_IdentityDocumentType · integer

Filter by type of identity document used when VerificationType is IdDocument.

CoworkerIdentityCheck_IdentityDocumentNumber · string

Filter by number or identifier on the identity document.

CoworkerIdentityCheck_IdentityDocumentIssuedBy · string

Filter by authority or organisation that issued the identity document.

CoworkerIdentityCheck_IdentityDocumentExpirationDate · string

Filter by expiration date of the identity document.

CoworkerIdentityCheck_AddressDocumentType · integer

Filter by type of address document used when VerificationType is Address.

CoworkerIdentityCheck_VerificationType · integer

Filter by whether this check verifies the customer’s identity (IdDocument) or address (Address).

CoworkerIdentityCheck_Description · string

Filter by free-text notes or details about this check.

CoworkerIdentityCheck_VerificationStatus · integer

Filter by current status of the verification (Pending, Submitted, Successful, Failed, or Cancelled).

CoworkerIdentityCheck_LastError · string

Filter by most recent error message if the check failed.

CoworkerIdentityCheck_Billed · boolean

Filter by whether billed is enabled.

CoworkerIdentityCheck_ProposalGuid · string

Filter by unique identifier (GUID) for the proposal.

CoworkerIdentityCheck_CoworkerContractGuid · string

Filter by unique identifier (GUID) for the coworker contract.

CoworkerIdentityCheck_ContractContactGuid · string

Filter by unique identifier (GUID) for the contract contact.

CoworkerIdentityCheck_StripeVerificationSessionId · string

Filter by iD of the stripe verification session associated with this record.

CoworkerIdentityCheck_IdentityCheckGroupGuid · string

Filter by unique identifier (GUID) for the identity check group.

CoworkerIdentityCheck_IdentityCheckProvider1 · integer

Filter by the identity check provider1 value for this coworker identity check.

CoworkerIdentityCheck_VerificationType1 · integer

Filter by the verification type1 value for this coworker identity check.

CoworkerIdentityCheck_Description1 · string

Filter by the description1 value for this coworker identity check.

CoworkerIdentityCheck_IdentityCheckProvider2 · integer

Filter by the identity check provider2 value for this coworker identity check.

CoworkerIdentityCheck_VerificationType2 · integer

Filter by the verification type2 value for this coworker identity check.

CoworkerIdentityCheck_Description2 · string

Filter by the description2 value for this coworker identity check.

Range Filters

from_CoworkerIdentityCheck_IdentityDocumentExpirationDate · string

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

to_CoworkerIdentityCheck_IdentityDocumentExpirationDate · string

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

from_CoworkerIdentityCheck_CreatedOn · string

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

to_CoworkerIdentityCheck_CreatedOn · string

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

from_CoworkerIdentityCheck_UpdatedOn · string

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

to_CoworkerIdentityCheck_UpdatedOn · string

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

Code Examples

Simple listing

cURL

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

Filtering by Name

cURL

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

Range filters

cURL

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"

Response

200

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

CurrentPage · integer

Current page number.

CurrentPageSize · integer

Number of records per page.

CurrentOrderField · string

The field used for sorting.

CurrentSortDirection · integer

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

FirstItem · integer

Index of the first item on the current page.

LastItem · integer

Index of the last item on the current page.

TotalItems · integer

Total number of matching records across all pages.

TotalPages · integer

Total number of pages.

HasNextPage · boolean

Whether there is a next page of results.

HasPreviousPage · 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": "[e-mail]",
      "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
}