Skip to main content

Overview

Using this guide, you will be able to:

  • Create an application
  • Submit documents to satisfy the verifications
  • Receive the analyses coming back from Informed

If you are coming from our legacy platform, see the next section, otherwise, please proceed to setup.

Moving from the XML API to the new API platform​

tip

This section is only relevant to those familiar with our old XML API. If you are new to our API, please proceed to setup.

Overview​

In the old API all the data was sent in with one XML payload that included the applicant info and URL's for the images. In the new API we have a new flow as you can see in the sequence diagram.

The new API​

  1. Construct the initial payload as described in the register application section. This payload includes the fields needed to create an application, including, among others:
  • Your application_reference_id
  • Applicant info (address and employment, etc.)
  • verifications (formerly known as stipulations in the XML API)
  • vehicle_info and dealer_info as appropriate
  • webhook -- no longer needs to be url-encoded

  1. Once the payload is sent, you will receive a synchronous response with an application_id indicating the successful creation of the application. You will use this to send a list of file names to be uploaded and any other relevant structured data as described in the upload documents section.

  2. Once the list of files and data is sent, you will receive a synchronous response with URL's for uploading the image files indicated. You will upload each file to it's associated URL. In contrast to the XML payload where we submit the base64 content of the image, we now upload the image file itself to the URL provided.

  3. Each successfully uploaded file will receive an extractions response to the webhook URL you provided in the initial payload webhook property. After processing all the extractions, the same webhook URL will receive a verifications response with the analysis of all the verifications (stipulations) requested in step 1 above.