Information Retrieval
Process Flow
Informed provides several GET endpoints with which you can retrieve information for previously registered applications.
Base URL
The table below shows the Base URL to be used with the endpoints mentioned in this guide.
| Environment | Base URL |
|---|---|
| Staging | https://api.staging.informediq-infra.com |
| Production | https://api.informediq.com |
GET List of Applications
Purpose
This endpoint allows the user to retrieve a list of applications based on the provided query parameters.
Endpoint Information
Endpoint: /v1/consumer/applications
HTTP method: GET
Parameters:
| Parameter Name | Requirement | Description |
|---|---|---|
updated_before | Optional | Applications updated before this timestamp Format: YYYY-mm-dd or YYYY-mm-ddTHH:MM:SS |
updated_after | Optional | Applications updated after this timestamp Format: YYYY-mm-dd or YYYY-mm-ddTHH:MM:SS |
limit | Optional | Maximum numbers of applications returned in one page with a hard limit of 1000 default: 25, maximum: 1000 |
application_reference_id | Optional | The specific application that has this application_reference_idIf this parameter is used, the expectation changes to only having one application returned in the list of course, since application_reference_id is a unique property. |
Example Endpoint
Basic Endpoint Example
https://api.staging.informediq-infra.com/v1/consumer/applications
Endpoint with Parameters Example
https://api.staging.informediq-infra.com/v1/consumer/applications?updated_before=2022-09-01&limit=50
GET Request Example with cURL
curl -u username:password https://api.staging.informediq-infra.com/v1/consumer/applications?updated_before=2022-09-01&limit=50
Sample Response
- Single Application Response
- Multiple Applications Response
{
"updated_after": "2022-01-09T09:11:38",
"updated_before": "2022-01-09T19:11:38",
"applications":
[
{
"application_id": "unique-Informed-app-id",
"application_reference_id": "partner reference id",
"application_date": "2022-01-09T10:11:38",
"contract_date": "2022-01-09T10:11:38"
}
]
}
{
"updated_after": "2022-01-09T09:11:38",
"updated_before": "2022-01-09T19:11:38",
"applications":
[
{
"application_id": "unique-Informed-app-id",
"application_reference_id": "partner reference id",
"application_date": "2022-01-09T10:11:38",
"contract_date": "2022-01-09T10:11:38"
},
{
"application_id": "unique-Informed-app-id",
"application_reference_id": "partner reference id",
"application_date": "2022-01-09T10:12:38",
"contract_date": "2022-01-09T10:11:38"
},
{
"application_id": "unique-Informed-app-id",
"application_reference_id": "partner reference id",
"application_date": "2022-01-09T10:13:38",
"contract_date": "2022-01-09T10:11:38"
}
]
}
GET Single Application
Purpose
This endpoint will allow the user to retrieve the application details of a specific application along with the verification results for that application. Note that it does not return the documents associated with the application - but the documents can be retrieved with a separate call.
Endpoint Information
Endpoint: /v1/consumer/applications/<unique-Informed-app-id>
The <unique-Informed-app-id> needs to be the application_id described in the synchronous response section of the app registration guide.
HTTP method: GET
Example Endpoint
Basic Endpoint Example
https://api.staging.informediq-infra.com/v1/consumer/applications/<unique-Informed-app-id>
GET Request Example with cURL
curl -u username:password https://api.staging.informediq-infra.com/v1/consumer/applications/<unique-Informed-app-id>
Sample Response
Full Sample Response
{
"application_reference_id": "your_uniqe_reference_id_here",
"application_id": "unique-Informed-app-id",
"last_updated_at": "2021-05-10T09:11:38",
"application_date": "2021-05-09T09:11:38",
"contract_date": "2021-05-09T09:11:38",
"application_status": "active",
"applicants":
{
"applicant1":
{
"first_name": "Jo",
"last_name": "Boren",
"middle_name": null,
"suffix": null,
"email": "jo.boren@gmail.com",
"phone": "9196201234",
"ssn": "681129638",
"date_of_birth": "1965-12-10",
"address_info":
[
{
"address":
{
"street_address": "8717 S 4th Ave",
"city": "Inglewood",
"state": "CA",
"zip": "90305"
},
"is_current": true,
"start_date": "2020-10-01",
"end_date": null,
"residence_type": "Rent",
"monthly_housing_cost": 1000
}
],
"employment_info":
[
{
"employment_type": "Employed",
"employer_name": "Envoy Air, Inc.",
"is_current": true,
"occupation": "Crew Member",
"income":
{
"period": "Yearly",
"amount": 74500
},
"start_date": "2018-11-01",
"end_date": null,
"business_phone": "9196571475"
}
],
"additional_incomes":
[
{
"source": "ChildSupport",
"income":
{
"period": "Yearly",
"amount": 10000
}
}
]
},
"applicant2":
{
"first_name": "Lucinda",
"last_name": "Bonadio",
"email": "lucinda.bonadio@gmail.com",
"phone": "9196202345",
"ssn": "681129443",
"date_of_birth": "1965-12-10",
"address_info":
[
{
"address":
{
"street_address": "8717 S 4th Ave",
"city": "Inglewood",
"state": "CA",
"zip": "90305"
},
"is_current": true,
"start_date": "2020-10-01",
"end_date": null,
"residence_type": "Rent",
"monthly_housing_cost": 1000
}
],
"employment_info":
[
{
"employment_type": "Employed",
"employer_name": "Informed Inc.",
"is_current": true,
"occupation": "Crew Member",
"income":
{
"period": "Yearly",
"amount": 60000
},
"start_date": "2018-11-01",
"end_date": null,
"business_phone": "9196571425"
}
]
}
},
"verifications":
{
"income":
[
{
"status": "Review",
"belongs_to": "applicant1",
"updated_at": "2022-05-18T23:56:48+00:00",
"description": "The applicant's income is in-line with what s/he stated based on the Current Paystub. We searched for a Current Paystub and found multiple in the deal jacket. The 1st Current Paystub matches the applicant's name. The 1st Current Paystub matches the applicant's employer's name. The 1st Current Paystub has YTD earnings. The 1st Current Paystub is not similar to a paystub known to be fraudulent. The 1st Current Paystub may have loan deductions, a manual review is needed. The 1st Current Paystub may have garnishments deducted, a manual review is needed. The 2nd Current Paystub matches the applicant's name. The 2nd Current Paystub matches the applicant's employer's name. The 2nd Current Paystub has YTD earnings. The 2nd Current Paystub is not similar to a paystub known to be fraudulent. The 2nd Current Paystub may have loan deductions, a manual review is needed. The 2nd Current Paystub may have garnishments deducted, a manual review is needed.",
"verification_questions":
{
"poi_income_within_threshold":
{
"question": "Is the applicant's income in-line with that what s/he stated?",
"expected": "$74,500.00",
"answer": "$74,882.88",
"status": "Pass"
},
"poi_documents_used":
{
"question": "Which document was used to calculate income?",
"expected": null,
"answer": "Current Paystub",
"status": "Pass"
},
"poi_income_from_employer":
{
"question": "What is the income from the employer?",
"expected": null,
"answer": "$74,882.88",
"status": "Pass"
}
},
"acceptable_documents":
{
"paystub":
[
{
"document_id": "68933df2-05c8-47fd-83db-716cc10721f2",
"file_ids":
[
"dfbcf7de-6899-44ee-bf5f-464f25c93599"
],
"file_reference_ids":
[
"partner file name or id"
],
"category": "Current Paystub",
"document_questions":
{
"matches_employer_name":
{
"question": "Matches the applicant's employer's name?",
"expected": "Envoy Air, Inc.",
"answer": "AMERICAN AIRLINES",
"status": "Pass"
},
"first_working_day_methodology":
{
"question": "Methodology used to calculate the first working day of the year?",
"expected": null,
"answer": "begin_of_year",
"status": "Pass"
},
"first_working_day":
{
"question": "First working day of the year?",
"expected": null,
"answer": "01/01/2021",
"status": "Pass"
},
"working_days_elapsed":
{
"question": "Working days elapsed?",
"expected": null,
"answer": 73,
"status": "Pass"
},
"is_similar_to_fraudulent_paystub":
{
"question": "Similar to a paystub known to be fraudulent?",
"expected": false,
"answer": false,
"status": "Pass"
},
"has_ytd_earnings":
{
"question": "Has YTD earnings?",
"expected": true,
"answer": true,
"status": "Pass"
},
"has_loans_deducted":
{
"question": "Loans deducted?",
"expected": "$0",
"answer": "$254.21",
"status": "Review"
},
"has_garnishments_deducted":
{
"question": "Garnishments deducted?",
"expected": "$0",
"answer": "$2,946.36",
"status": "Review"
},
"matches_applicant_name":
{
"question": "Matches the applicant's name?",
"expected": "Jo Boren",
"answer": "Jo Boren",
"status": "Pass"
},
"income_calculated_document":
{
"question": "Document used to calculate income?",
"expected": "",
"answer": "True",
"status": "Pass"
}
}
},
{
"document_id": "58c7b8d9-753a-44c4-96b6-e2cde51267cf",
"file_ids":
[
"dfbcf7de-6899-44ee-bf5f-464f25c93599"
],
"file_reference_ids":
[
"partner file name or id"
],
"category": "Current Paystub",
"document_questions":
{
"matches_employer_name":
{
"question": "Matches the applicant's employer's name?",
"expected": "Envoy Air, Inc.",
"answer": "AMERICAN AIRLINES",
"status": "Pass"
},
"is_similar_to_fraudulent_paystub":
{
"question": "Similar to a paystub known to be fraudulent?",
"expected": false,
"answer": false,
"status": "Pass"
},
"has_ytd_earnings":
{
"question": "Has YTD earnings?",
"expected": true,
"answer": true,
"status": "Pass"
},
"has_loans_deducted":
{
"question": "Loans deducted?",
"expected": "$0",
"answer": "$254.21",
"status": "Review"
},
"has_garnishments_deducted":
{
"question": "Garnishments deducted?",
"expected": "$0",
"answer": "$2,946.36",
"status": "Review"
},
"matches_applicant_name":
{
"question": "Matches the applicant's name?",
"expected": "Jo Boren",
"answer": "Jo Boren",
"status": "Pass"
}
}
}
]
}
}
]
}
}
GET Documents for Application
Purpose
This endpoint will allow the user to retrieve the associated documents for a specific application, along with the extracted information from those documents.
Endpoint Information
Endpoint: /v1/consumer/applications/<unique-Informed-app-id>/documents
The <unique-Informed-app-id> needs to be the application_id described in the synchronous response section of the app registration guide.
HTTP method: GET
Parameters:
| Parameter Name | Requirement | Description |
|---|---|---|
pages | Optional | true/false, default is false, will include pages block when this flag is true |
Example Endpoint
Basic Endpoint Example
https://api.staging.informediq-infra.com/v1/consumer/applications/<unique-Informed-app-id>/documents
Endpoint with Parameters Example
https://api.staging.informediq-infra.com/v1/consumer/applications/<unique-Informed-app-id>/documents?pages=true
GET Request Example with cURL
curl -u username:password https://api.staging.informediq-infra.com/v1/consumer/applications/<unique-Informed-app-id>/documents
danger
There is no guarantee that the file download URL's (typically AWS S3 pre-signed URL's) will remain exactly the same for all future time. Informed reserves the right to use whatever infrastructure is most secure and efficient.
If you are trying to whitelist the download URL's, at the current time, as Amazon AWS pre-signed URL's, they will have a base domain of amazonaws.com, so the most restrictive that you should make your whitelist is *.amazonaws.com.
Sample Response
Full Sample Response
{
"application_id": "unique-Informed-app-id",
"application_reference_id": "partner application id",
"documents":
{
"bank_statement":
[
{
"document_id": "7b949f5d-d3b1-4355-8cd1-04a1880b6c40",
"file_ids":
[
"dfbcf7de-6899-44ee-bf5f-464f25c93599"
],
"file_reference_ids":
[
"partner file name or id"
],
"url": "https://informed-techno-core-<env>-downloads.s3.amazonaws.com/123...",
"pages":
[
{
"file_id": "dfbcf7de-6899-44ee-bf5f-464f25c93599",
"file_page_number": 2,
"page_uri": "page s3 presigned url"
},
{
"file_id": "dfbcf7de-6899-44ee-bf5f-464f25c93599",
"file_page_number": 3,
"page_uri": "page s3 presigned url"
}
],
"extracted_data":
{
"applicants":
{
"applicant1":
{
"first_name": "Jo",
"middle_name": null,
"last_name": "Boren",
"suffix": null,
"address":
{
"street_address": "8717 South 4th Avenue",
"street2": null,
"city": "Inglewood",
"state": "CA",
"zip": "90305"
}
}
},
"bank_name": "Bank Of America",
"statement_begin_date": "2021-03-01",
"statement_end_date": "2021-03-31",
"accounts":
[
{
"account_number": "000442173571",
"account_name": null,
"bank_account_type": "Checkings",
"is_joint_account": false,
"total_deposits": 11040.45,
"beginning_balance": 17571.76,
"ending_balance": 23668.67,
"transactions":
[
{
"transaction_date": "2021-03-01",
"transaction_description": "SSI Deposits",
"transaction_amount": 800,
"transaction_type": "ATM/Cash",
"transaction_base_type": "Deposit"
}
]
}
]
}
}
],
"utility_bill":
[
{
"document_id": "f9904ca1-0391-4018-abd0-87b7f2d9365b",
"file_ids":
[
"dfbcf7de-6899-44ee-bf5f-464f25c93599"
],
"file_reference_ids":
[
"partner file name or id"
],
"url": "https://informed-techno-core-<env>-downloads.s3.amazonaws.com/123...",
"pages":
[
{
"file_id": "dfbcf7de-6899-44ee-bf5f-464f25c93599",
"file_page_number": 5,
"page_uri": "page s3 presigned url"
},
{
"file_id": "dfbcf7de-6899-44ee-bf5f-464f25c93599",
"file_page_number": 6,
"page_uri": "page s3 presigned url"
}
],
"extracted_data":
{
"applicants":
{
"applicant1":
{
"first_name": "Jo",
"middle_name": null,
"last_name": "Boren",
"suffix": null
}
},
"applicant_addresses":
{
"applicant1":
{
"street_address": "8717 South 4th Avenue",
"street2": null,
"city": "Inglewood",
"state": "CA",
"zip": "90305"
}
},
"bill_due_date": null,
"bill_issue_date": null,
"past_due_amount": null
}
}
],
"w2":
[
{
"document_id": "a082e187-8e63-473a-b865-974d795af81a",
"file_ids":
[
"dfbcf7de-6899-44ee-bf5f-464f25c93599"
],
"file_reference_ids":
[
"partner file name or id"
],
"url": "https://informed-techno-core-<env>-downloads.s3.amazonaws.com/123...",
"pages":
[
{
"file_id": "dfbcf7de-6899-44ee-bf5f-464f25c93599",
"file_page_number": 1,
"page_uri": "page s3 presigned url"
}
],
"extracted_data":
{
"applicants":
{
"applicant1":
{
"first_name": "Jo",
"middle_name": null,
"last_name": "Boren",
"suffix": null,
"address":
{
"street_address": "8717 South 4th Avenue",
"street2": null,
"city": "Inglewood",
"state": "CA",
"zip": "90305"
}
}
},
"employer_name": "AMERICAN AIRLINES",
"ssn": null,
"total_wages": 65490.12,
"state_wages": null,
"social_security_wages": 65490.12,
"medicare_wages": 65490.12,
"federal_taxes": 13458.25,
"state_taxes": null,
"social_security_taxes": 4761.42,
"medicare_taxes": 1113.56,
"tax_year": 2019
}
}
]
}
}