Getting started
To install latest version
$ yarn add @informed-iq/verify-iq-sdk
Usage
Simplest way
1. Instantiate SDK
const viq = new VerifyIQ({
authToken: 'Basic jcA897afas91jajk2…'
environment: VerifyIQ.Staging,
actionCallbackWebhookUrl: actionNotificationEndpointUrl,
onPass: (actionObject, reason) => {},
onIncomplete: (actionObject, reason) => {},
onWaive: (actionObject, reason) => {},
onLoad: (payload) => {},
});
2. Add root DOM element in the HTML
<div id="verify-iq-root"></div>
4. Render VerifyIQ in the given DOM element
const verifyIQRoot = document.querySelector("#verify-iq-root");
viq.renderApplicationId({verifyIQRoot, applicationId, applicant, stipulation, collectedDocumentWebhookUrl});
collectedDocumentWebhookUrl - optional string parameter, if exists must be a valid URL
Constants
Environment
Accessible as VerifyIQ.<Env>
;
Env | Description |
---|---|
Staging | Set the SDK to run in the Staging/Testing environment |
Production | Set the SDK to run in the Production environment |
StipulationTypes
Accessible as VerifyIQ.StipulationTypes
;
StipulationTypes | Display Name |
---|---|
Income | Proof of Income |
Residence | Proof of Residence |
Identity | Proof of Identity |
Insurance | Proof of Insurance |
SSN | Proof of SSN |
Trade | Proof of Trade |
PaidAccount | Proof of Paid Account |
Phone | Proof of Phone |
MortgageCurrent | Proof of Mortgage |
BankruptcyDischarged | Proof of BK Discharged |
TaxLienSatisfied | Proof of Tax Lien |
Rent | Proof of Rent |
ChildSupportPaidAndCurrent | Proof of Child Support |
ArticlesOfIncorporation | Proof of Business |
ExecutedCrossCollateralDefaultAgreement | Proof of Cross Collateral |
ApplicantTypes
Accessible as VerifyIQ.ApplicantTypes
;
ApplicantTypes | Description |
---|---|
PrimaryApplicant | Set the applicant type to PrimaryApplicant |
CoApplicant | Set the applicant type to CoApplicant |
EventTypes
Accessible as VerifyIQ.<Event>
;
Event | Description |
---|---|
Loaded | Event represents VerifyIQ loaded event and will trigger on first contentful paint |
Pass | Event represents VerifyIQ pass event and will trigger on verification pass action |
Incomplete | Event represents VerifyIQ incomplete event and will trigger on verification incomplete action |
Waive | Event represents VerifyIQ waive event and will trigger on verification waive action |