Send Invite

post

https://verify.vouched.id/api/invites

Send Vouched Now invite.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

type

string

enum

Defaults to idv

idv - id with selfie verification, id - id only, selfie-verification - selfie verification only.

Allowed:

string

Email address to send to.

phone

string

10 digit phone number. US +1 UK +44

contact

string

enum

Contact method to use.

Allowed:

firstName

string

First Name.

lastName

string

Last Name.

accountGroupSid

string

The account group to create the invite under. Returns a 400 when the group does not exist. Defaults to the group of the authenticated key or user.

templateEmail

string

The template to use for emails with variables $FIRST_NAME $LINK.

titleEmail

string

The title of the email.

templateText

string

The template to use for text messages with variables $FIRST_NAME $LINK.

callbackURL

string

Upon the job's completion, Vouched will POST the job results to the defined webhook .

properties

array of objects

List of arbitrary customer supplied properties, echoed back on the job response and webhook under request.properties so the result can be attributed in your own system.

properties

send

boolean

Defaults to true

Send a message via the contact method.

internalId

string

Application Internal Id.

dob

string

The user's date of birth (MM/DD/YYYY) to verify.

ial2CrossCheckId

string

Reference ID for NIST IAL2 compliance verification.

enableCrossCheck

boolean

Used to enable/disable crosscheck.

enableDarkWeb

boolean

Used to enable/disable darkweb.

enableIPAddress

boolean

Used to enable/disable ip address search.

enablePhysicalAddress

boolean

Used to enable/disable address search.

enableDriversLicenseValidation

boolean

Used to enable/disable driver's license validation.

enableAAMVA

boolean

deprecated

Still accepted for backwards compatibility but has no effect. Use enableDriversLicenseValidation.

Responses

201The newly created invite.

400InvalidRequestError - The request is invalid. An aborted or oversized request is answered with this status and an empty body instead of the envelope below.

401The request could not be authenticated. Credential rejection returns an AuthenticationError envelope; a malformed or expired bearer token is rejected earlier by the JWT middleware and returns { "error": "Token expired" } or { "error": "Token malformed" } instead.

404NotFoundError - The requested resource does not exist.

500UnknownSystemError - A unknown system error occurred.