API Reference

Create vID Quick Invite

post
https://api.cerebrum.com/v1/vid/quick-invite

Generate a vID quick invite and return the redirect URL immediately.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The id of the package used for the order

string | null

The ID of the organization for the invite. If not provided, the organization from the package will be used.

string

The id of the pass type used for the invite

string

The URL that webhooks will be sent to when an order is completed

metadata
object

Additional metadata to include in the invite request. Can be any valid JSON Object

contactInformation
object
required

Applicant email address & phone number

string
enum
required

The Delivery method used to send an invite to the applicant

Allowed:
boolean
Defaults to false

This boolean indicates whether to create a web invite or app invite. Default: false

string

The url where the user will be redirected after submitting their vID order

boolean
Defaults to false

Always create a new invite instead of reusing an existing pending invite or voucher.

string
enum

The platform that originated this voucher.

Allowed:
Responses

Updated 5 days ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 days ago