API Reference

POST to sandbox.verifast.com/api/v1/getTempUrl

Generate a temporary report that can be accessed via a link without any required authorization. Can be customized with what sections appear. You can use this call to generate a unique report URL that can be embedded in your application.

The generated report is for the applicant guid provided. However, if householdView is enabled, it will default to the Household page, with navigation links for all other members of the household.

📘

The generated report is only available for four (4) hours before expiry

ParameterDescriptionData
guidApplicant session identifierguid
photoIDDisplays applicant's identification photo

If photoID or photoSelfie is enabled, no other sections will appear.
0(no),1(yes)
photoSelfieDisplays applicant's selfie photo

If photoID or photoSelfie is enabled, no other sections will appear.
0(no),1(yes)
householdViewEnables household view0(no),1(yes)
approvalCenterApproval center with scoring0(no),1(yes)
bankInfoBank information with balance and income graphs0(no),1(yes)
applicantIdentityID verification section0(no),1(yes)
employmentInfoEmployment verification section0(no),1(yes)
preQuestionsPre-qual and custom questions and applicant answers section0(no),1(yes)
debtAnalysisDebts and repayments0(no),1(yes)
insightsMetricsUseful datapoints and aggregates0(no),1(yes)
transactionDetailsCategorized and filterable list of all applicants transactions0(no),1(yes)
financialAnalysisTransaction module for brokers/underwriters0(no),1(yes)
activityMessaginglogging and internal data0(no),1(yes)
reportSummaryKey data points to appear at top of report0(no),1(yes)
creditCheckCredit check information section0(no),1(yes)
incomeSourceIncome source module section0(no),1(yes)
householdViewWhen on, generates a household temp report of all members of the households0(no),1(yes)

Response

{
    "url": "https://sandbox.verifast.com/applicantv1/report/DhEpiNQRTFFdmRY45XTLRGEcFPlEHp0o5CsRKz1YQg79irOpkrxneYr0UiDV?activityMessaging=0&applicantIdentity=1&approvalCenter=0&bankInfo=0&debtAnalysis=0&employmentInfo=0&expires=1671208180&financialAnalysis=0&incomeSource=0&insightsMetrics=0&photoID=0&photoSelfie=0&preQuestions=0&reportOverview=0&reportSummary=0&transactionDetails=0&signature=13e0398b354fe5c9f93cffa8a6f1d77bea3c5efb4a7feff3282739d84079b085"
}