Quickstart

Get your first identity verification running in 5 minutes. This guide walks you through:

1. Creating an invite
2. Sending it to a user
3. Retrieving the verification results

By the end, you'll have successfully verified a test identity using the Cerebrum API.

Prerequisites

Before you begin, make sure you have:

• Cerebrum API key - see Authentication
• A valid Package ID - contact Cerebrum Support if you don’t have access yet.
• An email address to receive the test invite
• A tool to make API requests (cURL, Postman, or your preferred language)

Step 1: Send a Verification Invite

Send an invite to a user's email address. The user will receive an email with a link to download the vID app and complete verification.

Request

Endpoint: POST /v1/vid/invites - Doc

curl --request POST \
     --url https://api.cerebrum.com/v1/vid/invites \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'apikey: YOUR_API_KEY' \
     --data '{
  "contactInformation": {
    "email": "YOUR_EMAIL",
    "phoneNumber": "YOUR_NUMBER"
  },
  "deliveryMethod": "EMAIL",
  "packageId": "PACKAGE_ID"
}'

Request Parameters

✅

Success!

An email has been sent to the user with instructions to download the vID app and complete verification.

Step 2: User Completes Verification

After you send the invite, here's what happens:

The User Experience

1. Receives Email - User gets an email with the verification invite

2. Downloads App - User clicks the link and downloads the vID mobile app (iOS or Android)

3. Completes Verification - User follows the in-app flow:

   • Completes facial verification with liveness detection
   • Takes a photo of their ID (driver's license, passport, etc.)
   • Submits verification

4. Verification Complete - An order is automatically created with the results

📱

Mobile App Links

Users must download the vID mobile app to complete verification. The app is available on the App Store and Google Play.

Step 3: Retrieve Verification Orders

Once users complete verification, retrieve their results using the List Orders endpoint.

Request

Endpoint: GET /v1/orders - Doc

curl --request GET \
     --url 'https://api.cerebrum.com/v1/orders?packageId=YOUR_PACKAGE_ID' \
     --header 'accept: application/json' \
     --header 'apikey: YOUR_API_KEY'

Congratulations! 🎉 You've completed your first identity verification flow.