API Reference

Email an applicant a link into the Snappt identity flow

post
https://enterprise-api.snappt.com/id-verification/send-idv-email

Creates no verification session. The applicant's click starts one, so the returned applicantDetailId is the handle for this invite; results arrive on the IDV_REPORT_READY webhook carrying the metadata supplied here.

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

Optional, will be auto-filled from the applicant's provided ID if left blank.

string

Optional, will be auto-filled from the applicant's provided ID if left blank.

string
required

Applicant email address (required).

string

Optional. Your per-applicant identifier (e.g. a PMS applicant/prospect id). Once the applicant has opened an earlier invite at this property, a re-invite with the same integrationId returns the same applicantDetailId. Until then, each invite returns a new one.

metadata
object

Optional

string
enum
Allowed:
Responses

Updated 13 days ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 13 days ago

Did this page help you?