Postman

Overview

Sometimes we need to quickly check the functionality of an api endpoint without writing a bunch of code. Postman is a tool that gives us that capability. This section provides the necessary info to quickly get going with the Informed API using the Postman utility.

We will complete the following:

1. Create an application with the following applicant-level verifications (sometimes referred to as stipulations):
   • residence
   • identity
2. Submit a driver's license image file to satisfy the verifications above
3. Receive the analyses back from Informed

Checklist

tip

The accompanying zip file can be accessed here.

Prepare your callback endpoint

To receive the full asynchronous responses from Informed, follow the instructions to create a callback endpoint.

Create a new Postman collection

In the top level of the collection, under the Authorization tab, choose Type: Basic Auth and fill in the values for username and password with those provided by Informed.

Step 1: Create Application

Create a POST request for creating an application

1. Under the Authorization tab, select Inherit auth from parent
2. The request url is: https://api.staging.informediq-infra.com/v1/auto/applications

Under Body, select raw and JSON from the dropdown.

Copy and paste the payload below and replace the following two values:

1. Replace the <uuid> in the application_reference_id with a unique value
2. Update the value of the webhook with the callback endpoint you created

Once all the above steps are completed and the payload is set, press Send

Copy the application_id from the synchronous response. We will use it in the next step

JSON payload for creating an application

{
    "application_reference_id": "Phase1_appid_001_<uuid>",
    "application_date": "2021-07-20T00:00:00",
    "contract_date": "2021-08-02T00:00:00",
    "contract_type": "Paper",
    "applicants": {
        "applicant1": {
            "first_name": "Jo",
            "middle_name": "M",
            "last_name": "Boren",
            "suffix": "JR",
            "phone": "919-123-3456",
            "ssn": "123445678",
            "date_of_birth": "1972-04-11",
            "address_info": [
                {
                    "address": {
                        "street_address": "8717 S 4th Ave",
                        "city": "Inglewood",
                        "state": "CA",
                        "zip": "90305"
                    },
                    "start_date": "2019-11-21",
                    "is_current": true
                }
            ],
            "employment_info": [
                {
                    "employment_type": "Employed",
                    "employer_name": "Home Depot",
                    "occupation": "Stocker",
                    "income": {
                        "period": "Monthly",
                        "amount": 4000.0
                    },
                    "start_date": "2018-04-13",
                    "is_current": true
                }
            ],
            "additional_incomes": [
                {
                    "source": "Other",
                    "income": {
                        "period": "Monthly",
                        "amount": 300.0
                    }
                }
            ]
        }
    },
    "verifications": {
        "residence": [
            {
                "belongs_to": "applicant1"
            }
        ],
        "identity": [
            {
                "belongs_to": "applicant1"
            }
        ]
    },
    "services": [
        "extract",
        "verify"
    ],
    "webhook": "https://your.callback.com/here"
}

Step 2: Send File Names

Create another POST request for sending the list of file names

1. Under the Authorization tab, select Inherit auth from parent
2. The request url is: https://api.staging.informediq-infra.com/v1/auto/applications/<app_id_received_in_step_1>/documents
3. Replace <app_id_received_in_step_1> in the url above with the application_id you received in step 1.
4. Under Body, select raw and JSON from the dropdown.

Copy and paste the payload below in the body of the request

Once all the above steps are completed, press Send

Copy the url from the synchronous response. We will use it in the next step

JSON payload for sending the file names

{
    "image_files": [
        "DriversLicense.png",
    ],
    "structured_data": []
}

Step 3: Upload Files

Create a PUT request for uploading the file

1. Under the Authorization tab, select No Auth
2. The url is the one received in the response in step 2 (make sure to copy and paste the entire url)
3. Under Body, select binary and press Select File
4. Find the image file under: <local_directory>/implementation_guide_phases/phase1/test_images/appid_001
5. Select the DriversLicense.png image file

Once all the above steps are completed, press Send

Wait a couple minutes and check your webhook for the full responses.

Review the Results

We did the following:

1. Submitted the payload to Informed and received an app_id from Informed in the synchronous response
2. Used this app_id to send the filename to Informed and received a URL
3. Uploaded the file to the URL received
4. Asynchronous responses were sent to the webhook provided
5. The webhook received one extractions response and one verifications response once the file was classified, extracted and verified by Informed
6. To verify the results, see the responses received at the provided webhook