API Reference

Generate a unique guid, which is tied to a verification session. Is also used as the identifier for the session.

ParameterDescriptionData
applicationidThe applications identification tokenstring
firstnameApplicant's first namestring
lastnameApplicant's last namestring
emailApplicant's emailstring
dayApplicant's birth dayint
monthApplicant's birth monthint
yearApplicant's birth yearint
street_numberApplicant's street numberint
street_nameApplicant's street namestring
street_line2Line two for addressstring
cityApplicant's citystring
postal_codeApplicant's postal OR zip codestring
countryApplicant's country of residenceUS, CA
externalidThe application's external identification codestring
tagThe application's tagstring
secondinvite0(no), 1(yes)
iframe0(no), 1(yes)
stateStates for tax purposesstate code
override_bank_verify_enabledEnable bank verification0(no), 1(yes)
override_id_verify_enabledEnable ID verification0(no), 1(yes)
override_employee_verify_enabledEnable employee verification0(no), 1(yes)
override_credit_verify_enabledEnable credit verification0(no), 1(yes)
override_prequalify_questions_enabledEnable the prequalifying questions step0(no), 1(yes)
manual_uploadEnable manual document upload0(no), 1(yes)
enable_hidden_id_viewHides everything in the background when doing ID0(no), 1(yes)

Response

{
    "security_key": "9f673a27-43f6-408e-a5d1-eb6f9cf0078b",
    "applicant_email": "[email protected]",
    "request_guid": "LDj2I1HbbGqkSEki167L6b44GksR6mhismubai1I70ZmMobP2iqYBYKzETbX",
    "form_url": "https://sandbox.verifast.com/login?guid=LDj2I1HbbGqkSEki167L6b44GksR6mhismubai1I70ZmMobP2iqYBYKzETbX",
    "status": "sent",
    "message": ""
}

The 'security_key' line refers to a matching key that will be sent with all webhooks. This can be used as an additional level of secure ingestion of your webhooks.