v1

latestOpenAPI 3.1.0Apache 2.02026-07-24196597.7 KB
invites

Send Invite

Send Vouched Now invite.

post/api/invites

Request body

type'idv' | 'id' | 'selfie-verification'

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

emailstring

Email address to send to.

phonestring

10 digit phone number. US +1 UK +44

contact'email' | 'phone'

Contact method to use.

firstNamestring

First Name.

lastNamestring

Last Name.

templateEmailstring

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

titleEmailstring

The title of the email.

templateTextstring

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

callbackURLstring

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

sendboolean

Send a message via the contact method.

internalIdstring

Application Internal Id.

dobstring

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

ial2CrossCheckIdstring

Reference ID for NIST IAL2 compliance verification.

enableCrossCheckboolean

Used to enable/disable crosscheck.

enableDarkWebboolean

Used to enable/disable darkweb.

enableIPAddressboolean

Used to enable/disable ip address search.

enablePhysicalAddressboolean

Used to enable/disable address search.

Example request

{
  "phone": "000-111-2222"
}

Response

Send an invite to use Vouched