Quickstart Guide
Welcome to the Informed API
The Informed platform uses AI and ML to instantly verify income, residence, insurance, as well as other auto and credit stipulations, enabling real-time, reliable credit decisions without bias. Our models can process an extensive variety of document types and consumer-permissioned data sources, automating stipulation clearance. The Informed API allows you to programmatically harness the power of the Informed platform.
Please note that the Informed Consumer documentation is publicly viewable, but the Informed Auto documentation requires a username and password to access. If you would like access to the Informed Auto documentation, please contact your sales rep or reach out to support@informed.iq.
Getting started
Obtain an account
Your company will receive an HTTP Basic Auth username and password upon executing a Master Services Agreement (MSA) with Informed. These credentials will be used to make API calls to the Informed platform. More information can be found here.
Prepare your callback endpoint
A callback endpoint must be provided to receive the asynchronous responses containing indexed documents with extracted data and analysis.
Important aspects to consider:
- If you are going to protect your endpoint with authentication, the basic auth credentials will need to be shared with Informed to ensure secure transmission at time of setup.
- To further safeguard data, Informed will only
POSTback to your webhook using the HTTPS protocol to ensure encryption in transit. - Please ensure your HTTP servers do not time out quickly and that you have the appropriate logging implemented.
When you are first getting started, if you want a quick way to test the callback responses, you can use a free online tool like RequestBin, to set up a temporary webhook to receive and view the callback responses from Informed.
Send your application information
You will need to supply the application information along with the supporting images of the application documents to Informed. The required information and details for the different Informed flows can be found in the table below:
| Informed Flow | Sequence Diagram | Application Registration | Uploads |
|---|---|---|---|
| Informed Income | diagram | registration | uploads |
| Informed Consumer | diagram | registration | uploads |
| Informed Auto | diagram | registration | uploads |
Some important things to consider:
- You should configure the HTTP keep-alive headers to a minimum of 30 seconds when making requests to the Informed API endpoint.
- Images that are pushed should not exceed 80 MB in size.
Process the callback responses
Once the supporting documentation has been classified, and the data has been extracted and analyzed in the context of the application and your configured policies, Informed will POST the relevant JSON payloads to your supplied callback endpoint via HTTPS. More details on the callback responses for the different Informed flows can be found in the table below:
| Informed Flow | Callback Responses |
|---|---|
| Informed Income | callbacks |
| Informed Consumer | callbacks |
| Informed Auto | callbacks |
Support
Professional Services
If you still have questions about integrating with the Informed API, you can reach out to the Informed Professional Services team for support at support@informed.iq.
Sample Documents
Informed has made available various sample documents for initial testing of our API's.