CoworkerIdentityChecks
Create CoworkerIdentityCheck
Create a new CoworkerIdentityCheck record.
POST
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-Create 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 |
Request Body
Required Fields
Business Id.
Coworker Id.
Display name for this verification check.
Optional Fields
How the check is performed: Manual (operator review) or StripeIdentity (Stripe-delegated). Defaults to
eIdentityCheckProvider.Manual. See eIdentityCheckProvider enum above.Type of identity document used when VerificationType is IdDocument. Defaults to
eIdentityCheckDocumentType.Other. See eIdentityCheckDocumentType enum above.Number or identifier on the identity document.
Authority or organisation that issued the identity document.
Expiration date of the identity document.
Type of address document used when VerificationType is Address. Defaults to
eAddressCheckDocumentType.Other. See eAddressCheckDocumentType enum above.Free-text notes or details about this check.
Billed.
Stripe Verification Session Id.
Identity Check Provider1. See
eIdentityCheckProvider? enum above.Verification Type1. See
eIdVerificationType? enum above.Description1.
Identity Check Provider2. See
eIdentityCheckProvider? enum above.Verification Type2. See
eIdVerificationType? enum above.Description2.
Code Examples
Response
200
HTTP status code.
200 on success.A human-readable message confirming the creation.
Contains the
Id of the newly created record.true if the coworkeridentitycheck was created successfully.null on success.Example Response
400
A summary of the validation error(s), in the format
PropertyName: error message.null on validation failure.Array of validation errors.
false when the request fails validation.Example Response