CoworkerIdentityCheckDocuments
Search CoworkerIdentityCheckDocuments
Search and list CoworkerIdentityCheckDocument records with filtering, sorting, and pagination.
GET
A CoworkerIdentityCheckDocument represents a document submitted as part of a
Which slots are required depends on the
CoworkerIdentityCheck for a customer. Each document record can hold up to three files, corresponding to different sides or aspects of the verification evidence:
| File slot | Field prefix | Purpose |
|---|---|---|
| Face photo | Photo | A photograph of the customer’s face |
| Front | Document | The front side of the identity or address document |
| Back | AdditionalDocument | The back side or a supplementary page of the document |
VerificationType and document type configured on the parent CoworkerIdentityCheck.
The VerificationStatus tracks the review state of this individual document through the same lifecycle used by CoworkerIdentityCheck: 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 CoworkerIdentityCheckDocument-List role.Enums
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 Coworker Id.
Filter by full name of the customer this document belongs to.
Filter by type of the customer (e.g. Member, TeamMember).
Filter by company name of the customer.
Filter by billing name of the customer.
Filter by Coworker Identity Check Id.
Filter by name of the parent identity or address check.
Filter by verification type of the parent check (IdDocument or Address).
Filter by location (business) name from the parent check.
Filter by identity document type from the parent check (e.g. Passport, DriversLicense).
Filter by document number from the parent check.
Filter by issuing authority from the parent check.
Filter by document expiration date from the parent check.
Filter by address document type from the parent check (e.g. LeaseRentalAgreement, VoterCard).
Filter by display name for this document record.
Filter by Photo File Name.
Filter by New Photo Url.
Filter by Clear Photo File.
Filter by Document File Name.
Filter by New Document Url.
Filter by Clear Document File.
Filter by Additional Document File Name.
Filter by New Additional Document Url.
Filter by Clear Additional Document File.
Filter by current review status of this document (Pending, Submitted, Successful, Failed, or Cancelled).
Filter by free-text notes or reviewer comments about this document.
Range Filters
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 CoworkerIdentityCheckDocument records matching the query. See the Get one CoworkerIdentityCheckDocument 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