Invite

Invites are the entry point for ID verification orders. An invite is a unique link you can send to users via email. When clicked, users can immediately begin the verification process without additional friction.

Creating Invites

You can create invites through three methods:

API — Use the Create vID Invite endpoint
Dashboard — Log in to Cognition and use the Create Invite form as described here.
Self-Service — Enable user self-registration (available upon request)

📘
If a user already has a pending invite, creating a new invite will return the existing one instead. To generate a new invite for the same user, you must first cancel the existing pending invite.

Invite Types

vID App Invite Prompts users to download the vID mobile app (iOS/Android) to complete verification.
vID Web Invite Allows users to complete verification directly in their web browser.

Invite Categories

Standard Invite Requires users to log in and verify their email before proceeding with ID verification.
One and Done Invite Provides a streamlined experience where users can begin verification immediately upon opening the invite.

Invite Statuses

PENDING - User has not started the verification flow
ACCEPTED - User has accepted the invite via app or web
COMPLETE - User has completed verification and placed an order
CANCELED - Organization has canceled the invite (no longer reusable)
OPT_OUT - User has opted out of verification by declining biometrics or required disclosures

Expiration

Invites expire after a configurable period (default: 30 days). After expiration, the invite cannot be used. Expiration settings are controlled at the Package level.

Metadata

Attach custom data to invites using key-value pairs for system reconciliation. Common use cases include storing internal user IDs, order identifiers, or other reference data from your system.

Metadata is:

Included in webhook payloads
Returned by the invite details endpoint
Automatically copied to order created from the invite
Available in order related webhooks

This enables seamless reconciliation between our system and yours when processing webhook callbacks.

For detailed information about Metadata, see the Attaching Custom Data to Orders documentation.

Webhooks

Configure a postback URL when creating an invite to receive real-time notifications about invite status changes.

Supported Events

VOUCHER_REDEEMED — Triggered when a user accepts the invite (status changes to ACCEPTED)
VOUCHER_EXPIRED — Triggered when an invite expires

For detailed information about webhook payloads and security, see the Webhooks documentation.

Common Operations

Canceling an Invite

Use the Cancel vID Invite endpoint to cancel an invite. Once canceled, the invite becomes unusable and users cannot start the verification flow.

Resending an Invite

Resend invites through:

API — Use the Resend vID Invite endpoint
Cognition — Navigate to the invite details page and click the resend button as described here

📘
By default, resending an invite resets its expiration date, giving users additional time to complete verification. This behavior is configurable in Package settings.