Instant Decision Reports
GridBase Instant Decision Reports (powered by X1 Analytics) allows lenders to close more quickly and determine the title condition (including "Clear to Close").
API Guide
Before you begin, make sure you already have a GridBase sandbox account for development and testing purposes. You'll need to log in and acquire your access token as described in the introduction.
Step 1: Stage and Place an Order
To stage a new order, submit an HTTP POST request to /v1/orders/stage using the stage example. This will return a 201 (created) response with the order object you submitted, with the order ID in the id property. Fields include:
| Field Name | Field Description | Required |
|---|---|---|
IntegrationId | Integration ID | ✓ |
orderDetails.clientFileNumber | The client's file number (must be unique) | ✓ |
orderDetails.newLoanAmount | The loan amount | ✓ |
orderDetails.newLoanNumber | A unique identifier for the new loan | ✓ |
orderDetails.cashoutAmount | Cashout Amount | ✓ |
orderDetails.transactionTypeDesc | Description of the type of transaction | ✓ |
parties.buyers[].buyerSellerTypeID | Type ID for buyer or seller | ✓ |
parties.buyers[].firstName | Buyer's First Name | ✓ |
parties.buyers[].lastName | Buyer's Last Name | ✓ |
parties.buyers[].address.street | Street Address of Buyer | ✓ |
parties.buyers[].address.cityDesc | City of Buyer | ✓ |
parties.buyers[].address.stateId | State of Buyer | ✓ |
parties.buyers[].address.zip | Zip code of Buyer | ✓ |
parties.lender.lenderId | ID for the lender | |
parties.lender.companyName | Lender Company Name | |
property.address.street | Property Address 1 | ✓ |
property.address.cityDesc | Property City/Locality Description | ✓ |
property.address.stateId | Property State | ✓ |
property.address.zip | Property Zip/Postal Code | ✓ |
property.propertyType | Type of Property | ✓ |
system | System being used (e.g., X1) | ✓ |
product | Type of product (e.g., order) | ✓ |
Once the order is staged, you may then submit a PUT request to /v1/orders/place/{id} (where {id} is replaced with the order ID returned from the previous request). Note that order placement may take some time to complete
Product Types:
| Product Type | Description |
|---|---|
| decision-report | For submitting a decision report |
| decision-report-resubmit | For resubmitting a decision report |
| decision-report-update | For updating a decision report |
Transaction Types Supported:
| Transaction Type | Description |
|---|---|
| 'EquityNC' | Equity - No Credit pull |
| 'EquityLV' | Equity - Legal and Vesting |
| 'Refinance' | Refinance |
| 'Equity' | Equity |
| 'EquityPR' | Equity - Property Report |
Buyer/Borrower Type Values:
| Buyer/Borrower Type | Description |
|---|---|
| Individual | An individual person |
| Corporation | A corporate entity |
| Partnership | A business partnership |
| LLC | Limited Liability Company |
Property Type Values:
| Property Type | Description |
|---|---|
| Single Family | Single-family home |
| SFR | Single-family residence |
| PUD | Planned Unit Development |
| Condominium | Condominium |
| Condo | Condominium (short form) |
| 2-4 Plex | Property with 2-4 units |
| Cooperative | Co-op housing |
| Unimproved | Unimproved land |
| Vacant Land | Empty land |
| Multiple Family Residence | Property with multiple families |
| Commercial | Commercial property |
| Mobile Homes | Mobile homes |
| Apartment | Apartment building |
| Agriculture | Agricultural land |
| Indian Land | Land designated as Indian land |
| Leased Land | Land that is leased |
| Gov't Land | Government-owned land |
| Other | Other types of property |
Step 2: Retrieve the Report
Once order placement has completed, you may submit a POST request to /v1/core/reports/generate with the following request body to generate a report:
{
"orderId": "{id}",
"reportId": "6324d73af55f885d0d71b6a4",
"reportFormat": "pdf"
}
Report Ids
Different types of reports may be generated by passing the corresponding ReportId value, including:
6324d73af55f885d0d71b6a4- Lender Decision Report6324d851f55f885d0d71b6a9- Title Decision Report
Report Format
Supported formats include pdf and xml.
xml- provides raw report data as an XML document, which may be used to implement process automation.pdf- provides a pre-formatted, print-friendly PDF document.
Step 3 (optional): Order Updates or Corrections
To update an existing order, submit an HTTP POST request to /v1/orders/update using the example request where the main difference between the stage is the ID field is populated. This will return a 200 (successful) response with the order object you submitted.
Once the order has been updated, you may then submit a PUT request to /v1/orders/place/{id} (where {id} is the order ID). Note that order placement may take some time to complete
Finally step 2 can be repeated for an updated report.