CoworkerIdentityChecks
Search CoworkerIdentityChecks
Search and list CoworkerIdentityCheck records with filtering, sorting, and pagination.
GET
A CoworkerIdentityCheck represents a manual or Stripe Identity-based verification of a customer’s identity or address. Each check is linked to a
When
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.) |
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
eIdentityCheckProvider — IdentityCheckProvider values
| Value | Name |
|---|---|
| 0 | None |
| 1 | Manual |
| 2 | StripeIdentity |
eIdentityCheckDocumentType — IdentityDocumentType values
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
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
eIdVerificationType — VerificationType values
| Value | Name |
|---|---|
| 0 | None |
| 1 | IdDocument |
| 2 | Address |
eIdVerificationStatus — VerificationStatus values
eIdVerificationStatus — VerificationStatus values
| Value | Name |
|---|---|
| 0 | None |
| 1 | Pending |
| 2 | Submitted |
| 3 | Successful |
| 4 | Failed |
| 5 | Cancelled |
Query Parameters
Pagination & Sorting
The page number to retrieve.
The number of records per page.
The property name to sort results by (e.g.
Name, CreatedOn).Sort direction.
1 for ascending, -1 for descending.Filters
Filter by Business Id.
Filter by name of the location (business) this check belongs to.
Filter by Coworker Id.
Filter by full name of the customer being verified.
Filter by type of the customer (e.g. Member, TeamMember).
Filter by company name of the customer being verified.
Filter by billing name of the customer being verified.
Filter by display name for this verification check.
Filter by how the check is performed: Manual (operator review) or StripeIdentity (Stripe-delegated).
Filter by type of identity document used when VerificationType is IdDocument.
Filter by number or identifier on the identity document.
Filter by authority or organisation that issued the identity document.
Filter by expiration date of the identity document.
Filter by type of address document used when VerificationType is Address.
Filter by whether this check verifies the customer’s identity (IdDocument) or address (Address).
Filter by free-text notes or details about this check.
Filter by current status of the verification (Pending, Submitted, Successful, Failed, or Cancelled).
Filter by most recent error message if the check failed.
Filter by Billed.
Filter by Proposal Guid.
Filter by Coworker Contract Guid.
Filter by Contract Contact Guid.
Filter by Stripe Verification Session Id.
Filter by Identity Check Group Guid.
Filter by Identity Check Provider1.
Filter by Verification Type1.
Filter by Description1.
Filter by Identity Check Provider2.
Filter by Verification Type2.
Filter by Description2.
Range Filters
Filter by expiration date of the identity document greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by expiration date of the identity document less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by Name
Range filters
Response
200
The list of CoworkerIdentityCheck records matching the query. See the Get one CoworkerIdentityCheck endpoint for the full list of properties returned for each record.
Current page number.
Number of records per page.
The field used for sorting.
The sort direction (
1 = ascending, -1 = descending).Index of the first item on the current page.
Index of the last item on the current page.
Total number of matching records across all pages.
Total number of pages.
Whether there is a next page of results.
Whether there is a previous page of results.
Example Response