Instructions on how to generate a viewable report without authentication requirements
Overview
To generate a household report you need to first assign other applicants to a primary applicant. The endpoint to do this is called https://sandbox.verifast.com/api/v1/addCoapplicant
Endpoint - https://sandbox.verifast.com/api/v1/addCoapplicant
Parameter | Format | Example |
---|---|---|
Authorization | 'Authorization: Bearer [org token]' | Authorization: Bearer P7OzXBhioVC9Kndnib2PB7CvjD7nWTYdnHspEM2ofqIbZIneHHqx9IyOCFoU |
guid | 'guid=[applicant token1],[applicant token2]' | guid=hpoPQdoWb1BjZW6lCDtgJakMIDZcAKxhABQdYVzqWPIMjxEtQqtKrBw5izza,VDDpoPQdoWb1BjZW6lCDtgJakMIDZcAKxhABQdYVzqWPIMjxEtQqtKrBw5izza |
Content-Type | application/x-www-form-urlencoded | application/x-www-form-urlencoded |
https://sandbox.verifast.com/api/v1/addCoapplicant
Once request is complete you can retrieve the report using the tempurl endpoint to see the household view.
curl --location --request POST 'sandbox.verifast.com/api/v1/getTempUrl' \
--header 'Authorization: Bearer P7OzXBhioVC9Kndnib2PB7CvjD7nWTYdnHspEM2ofqIbZIneHHqx9IyOCFoU' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'guid=hpoPQdoWb1BjZW6lCDtgJakMIDZcAKxhABQdYVzqWPIMjxEtQqtKrBw5izza'
The generated report is only available for four (4) hours before expiry
The URL will lead to a captcha, which once solved will show the report