Package
A Package is a configurable template that defines verification settings and requirements for your ID verification workflow. Organizations can create multiple packages with distinct configurations to address different use cases, for example, a comprehensive package for high-risk scenarios with face matching and liveness detection, alongside a streamlined package for low-risk workflows requiring only basic document verification.
In the API, a package is a package set. List Package Sets returns the packages your organization can use.
Package identifiers and ownership
| Field returned by List Package Sets | Meaning | Where you use it |
|---|---|---|
id | The package ID, a UUID such as 81eb7401-8ff0-4404-8450-4d7508482c19 | Send it as packageId to Create vID Invite and to Create Standard Order, or as the packageId filter of List Orders. Invites report it as packageSetId. |
organizationId | The organization that owns the package | Ownership only. It is not the organization that owns invites or orders created with the package. |
shortName, name | Labels for people | Do not send them as identifiers. |
A package is available to your organization when your organization owns it or when its owner has shared it with your organization. A CRA shares a package through CRA Package Access. List Package Sets returns only active packages that have an owning organization.
When you create an invite with a package owned by another organization, set organizationId on the request to choose which organization owns the invite. When you omit it, the invite belongs to the package's owner.
Configurable Options
The following sections detail the various configuration options available for packages:
Search Types
Define which verification checks are performed:
- ID Verification - Standard identity document verification
- NatCrim - National criminal background check
- AAMVA - American Association of Motor Vehicle Administrators database verification
Allowed ID Types
Specify which identity documents are accepted:
US Documents
- State ID
- Passport Booklet
- Passport Card
- Tribal ID
- Military ID
International Documents
- ID Card
- Passport Booklet
Verification Settings
Control the behavior and features of your verification flow:
- One and done invite - Allow users to start verification without email confirmation
- Allow International Address - Accept addresses outside the US
- Show disclosures - Display legal disclosures and terms during verification
- Collect SSN - Request Social Security Number
- Allow Alias Name - Accept alternative names or aliases
- Allow Additional Address - Accept multiple addresses
- Skip Name Verification - Bypass name verification step
- Skip IP Check - Disable IP address validation and fraud checks
- Always Verify ID - Require ID verification regardless of other checks
- Bypass Liveness Detection - Skip liveness detection
- Screen Match Check - Detect if ID was captured from a screen to prevent fraud
Report Settings
Control what information appears in verification reports:
- Include Biometrics in vID Report - Add biometric data to reports
- Redact Date of Birth - Mask date of birth for privacy
- Mask Identification Details - Obscure sensitive ID information
Invite Configuration
- Expiration time - The number of days an invite remains valid. The default is 30 days; each package can set its own period. The expiry is set when the invite is created and renewed when an existing pending invite is reused for the same applicant.
- Send invite reminders - Enable automatic reminder notifications
An invite's status does not change when it expires. Check its inviteExpiry value instead.
ID Expiry Validation
Configure how expired identification documents are handled:
- Set Expiry Period - Define a time period for ID validity
- Set Expiry Date - Set a specific expiration date for validation