GridBase API Reference
Download OpenAPI specification:Download
Stage Order
When staging an order, property validation will take place. The two possible options for passing address validation are listed below.
Populate the "FullAddress" field within the Property object for a free form address validation.
Populate "CityDesc", "StateId", "Street", "Zip" for a parsed address validation. (County will be resolved in this case)
Request Body schema:
The new Order.
integrationId | string or null |
system | string Enum: "None" "Resware" "AtClose" "Softpro" "eAgency" "Closepin" "Encompass" "X1" "Stacx" "RamQuest" "BlackKnight" "ManualEntry" "SellerNetSheet" "Inkd" "BuyerCostEstimate" |
product | string or null |
object | |
object | |
note | string or null |
object | |
Array of objects or null | |
Array of objects or null |
Responses
Request samples
- Payload
{- "integrationId": "string",
- "system": "None",
- "product": "string",
- "parties": {
- "buyers": [
- {
- "id": "string",
- "address": {
- "cityDesc": "string",
- "countyDesc": "string",
- "stateId": "string",
- "street": "string",
- "streetLine2": "string",
- "zip": "string"
}, - "businessName": "string",
- "buyerSellerType": "string",
- "buyerSellerTypeID": 0,
- "email": "string",
- "firstName": "string",
- "isPrimary": true,
- "isSameAsPropertyAddress": true,
- "isValidated": true,
- "lastName": "string",
- "maritalStatus": "string",
- "middleName": "string",
- "phone": "string",
- "prefix": "string",
- "additionalVesting": "string",
- "socialSecurityNumber": "string",
- "sourceBuyerSellerID": 0,
- "spouse": {
- "firstName": "string",
- "lastName": "string",
- "middleName": "string",
- "prefix": "string",
- "socialSecurityNumber": "string",
- "suffix": "string"
}, - "suffix": "string",
- "taxId": "string"
}
], - "isSectionStarted": true,
- "isValidated": true,
- "lender": {
- "partyTypeID": 0,
- "partyTypeDesc": "string",
- "lenderId": "string",
- "address": {
- "cityDesc": "string",
- "countyDesc": "string",
- "stateId": "string",
- "street": "string",
- "streetLine2": "string",
- "zip": "string"
}, - "companyName": "string",
- "contactName": "string",
- "email": "string",
- "isValidated": true,
- "isPrimary": true,
- "phone": "string",
- "receivingParty": true
}, - "listingAgent": {
- "partyTypeID": 0,
- "partyTypeDesc": "string",
- "lenderId": "string",
- "address": {
- "cityDesc": "string",
- "countyDesc": "string",
- "stateId": "string",
- "street": "string",
- "streetLine2": "string",
- "zip": "string"
}, - "companyName": "string",
- "contactName": "string",
- "email": "string",
- "isValidated": true,
- "isPrimary": true,
- "phone": "string",
- "receivingParty": true
}, - "mortgageBroker": {
- "partyTypeID": 0,
- "partyTypeDesc": "string",
- "lenderId": "string",
- "address": {
- "cityDesc": "string",
- "countyDesc": "string",
- "stateId": "string",
- "street": "string",
- "streetLine2": "string",
- "zip": "string"
}, - "companyName": "string",
- "contactName": "string",
- "email": "string",
- "isValidated": true,
- "isPrimary": true,
- "phone": "string",
- "receivingParty": true
}, - "secondLender": {
- "partyTypeID": 0,
- "partyTypeDesc": "string",
- "lenderId": "string",
- "address": {
- "cityDesc": "string",
- "countyDesc": "string",
- "stateId": "string",
- "street": "string",
- "streetLine2": "string",
- "zip": "string"
}, - "companyName": "string",
- "contactName": "string",
- "email": "string",
- "isValidated": true,
- "isPrimary": true,
- "phone": "string",
- "receivingParty": true
}, - "sellers": [
- {
- "id": "string",
- "address": {
- "cityDesc": "string",
- "countyDesc": "string",
- "stateId": "string",
- "street": "string",
- "streetLine2": "string",
- "zip": "string"
}, - "businessName": "string",
- "buyerSellerType": "string",
- "buyerSellerTypeID": 0,
- "email": "string",
- "firstName": "string",
- "isPrimary": true,
- "isSameAsPropertyAddress": true,
- "isValidated": true,
- "lastName": "string",
- "maritalStatus": "string",
- "middleName": "string",
- "phone": "string",
- "prefix": "string",
- "additionalVesting": "string",
- "socialSecurityNumber": "string",
- "sourceBuyerSellerID": 0,
- "spouse": {
- "firstName": "string",
- "lastName": "string",
- "middleName": "string",
- "prefix": "string",
- "socialSecurityNumber": "string",
- "suffix": "string"
}, - "suffix": "string",
- "taxId": "string"
}
], - "sellingAgent": {
- "partyTypeID": 0,
- "partyTypeDesc": "string",
- "lenderId": "string",
- "address": {
- "cityDesc": "string",
- "countyDesc": "string",
- "stateId": "string",
- "street": "string",
- "streetLine2": "string",
- "zip": "string"
}, - "companyName": "string",
- "contactName": "string",
- "email": "string",
- "isValidated": true,
- "isPrimary": true,
- "phone": "string",
- "receivingParty": true
}, - "settlementAgent": {
- "partyTypeID": 0,
- "partyTypeDesc": "string",
- "lenderId": "string",
- "address": {
- "cityDesc": "string",
- "countyDesc": "string",
- "stateId": "string",
- "street": "string",
- "streetLine2": "string",
- "zip": "string"
}, - "companyName": "string",
- "contactName": "string",
- "email": "string",
- "isValidated": true,
- "isPrimary": true,
- "phone": "string",
- "receivingParty": true
}, - "titleAgent": {
- "partyTypeID": 0,
- "partyTypeDesc": "string",
- "lenderId": "string",
- "address": {
- "cityDesc": "string",
- "countyDesc": "string",
- "stateId": "string",
- "street": "string",
- "streetLine2": "string",
- "zip": "string"
}, - "companyName": "string",
- "contactName": "string",
- "email": "string",
- "isValidated": true,
- "isPrimary": true,
- "phone": "string",
- "receivingParty": true
}, - "escrowAgent": {
- "partyTypeID": 0,
- "partyTypeDesc": "string",
- "lenderId": "string",
- "address": {
- "cityDesc": "string",
- "countyDesc": "string",
- "stateId": "string",
- "street": "string",
- "streetLine2": "string",
- "zip": "string"
}, - "companyName": "string",
- "contactName": "string",
- "email": "string",
- "isValidated": true,
- "isPrimary": true,
- "phone": "string",
- "receivingParty": true
}, - "underwriterAgent": {
- "partyTypeID": 0,
- "partyTypeDesc": "string",
- "lenderId": "string",
- "address": {
- "cityDesc": "string",
- "countyDesc": "string",
- "stateId": "string",
- "street": "string",
- "streetLine2": "string",
- "zip": "string"
}, - "companyName": "string",
- "contactName": "string",
- "email": "string",
- "isValidated": true,
- "isPrimary": true,
- "phone": "string",
- "receivingParty": true
}, - "contacts": [
- {
- "partyTypeID": 0,
- "partyTypeDesc": "string",
- "lenderId": "string",
- "address": {
- "cityDesc": "string",
- "countyDesc": "string",
- "stateId": "string",
- "street": "string",
- "streetLine2": "string",
- "zip": "string"
}, - "companyName": "string",
- "contactName": "string",
- "email": "string",
- "isValidated": true,
- "isPrimary": true,
- "phone": "string",
- "receivingParty": true
}
]
}, - "property": {
- "address": {
- "fullAddress": "string",
- "cityDesc": "string",
- "cityId": 0,
- "countyDesc": "string",
- "countyId": 0,
- "direction": "string",
- "isPropertyAddress": true,
- "landAcreage": "string",
- "legalDescription": "string",
- "number": "string",
- "stateId": "string",
- "street": "string",
- "streetLine2": "string",
- "streetName": "string",
- "suffix": "string",
- "unit": "string",
- "zip": "string",
- "parcel": "string",
- "parcel2": "string",
- "parcel3": "string",
- "parcel4": "string",
- "lot": "string",
- "block": "string",
- "subdivision": "string",
- "fips": 0
}, - "isKeyboxInfo": true,
- "isSectionStarted": true,
- "isUnincorporated": true,
- "isValidated": true,
- "keyboxInfo": "string",
- "propertyType": "string",
- "propertyUse": "string"
}, - "note": "string",
- "orderDetails": {
- "additionalAmount": 0.1,
- "earnestMoney": 0.1,
- "cashoutAmount": 0.1,
- "clientFileNumber": "string",
- "clientId": 0,
- "estimatedSettlementDate": "2019-08-24T14:15:22Z",
- "disbursementDate": "2019-08-24T14:15:22Z",
- "closedDate": "2019-08-24T14:15:22Z",
- "isAllPartiesAttending": true,
- "isSectionStarted": true,
- "isValidated": true,
- "newLoanAmount": 0.1,
- "interestRate": 0.1,
- "newLoanNumber": "string",
- "newLoanType": "string",
- "newLoanPurpose": "string",
- "newLoanDescription": "string",
- "productTypeDesc": "string",
- "productTypeId": 0,
- "salesPrice": 0.1,
- "transactionTypeDesc": "string",
- "transactionTypeId": 0,
- "additionalReference": "string"
}, - "additionalServices": [
- {
- "serviceId": "string",
- "serviceName": "string",
- "note": "string",
- "sentDate": "2019-08-24T14:15:22Z",
- "receivedDate": "2019-08-24T14:15:22Z",
- "sentStatus": 0
}
], - "placementNotes": [
- {
- "subject": "string",
- "body": "string"
}
]
}
Response samples
- 201
- 400
Read Order
path Parameters
sourceFileId required | string <int32> The unique identifier of the Order in the integrated system to read. |
system required | string Enum: "None" "Resware" "AtClose" "Softpro" "eAgency" "Closepin" "Encompass" "X1" "Stacx" "RamQuest" "BlackKnight" "ManualEntry" "SellerNetSheet" "Inkd" "BuyerCostEstimate" The system the order is integrated in. |
Responses
Response samples
- 200
- 400
Update Order
Request Body schema:
The Order to update.
id | string or null |
integrationId | string or null |
system | string Enum: "None" "Resware" "AtClose" "Softpro" "eAgency" "Closepin" "Encompass" "X1" "Stacx" "RamQuest" "BlackKnight" "ManualEntry" "SellerNetSheet" "Inkd" "BuyerCostEstimate" |
product | string or null |
object | |
object | |
note | string or null |
object | |
Array of objects or null | |
Array of objects or null |
Responses
Request samples
- Payload
{- "id": "string",
- "integrationId": "string",
- "system": "None",
- "product": "string",
- "parties": {
- "buyers": [
- {
- "id": "string",
- "address": {
- "cityDesc": "string",
- "countyDesc": "string",
- "stateId": "string",
- "street": "string",
- "streetLine2": "string",
- "zip": "string"
}, - "businessName": "string",
- "buyerSellerType": "string",
- "buyerSellerTypeID": 0,
- "email": "string",
- "firstName": "string",
- "isPrimary": true,
- "isSameAsPropertyAddress": true,
- "isValidated": true,
- "lastName": "string",
- "maritalStatus": "string",
- "middleName": "string",
- "phone": "string",
- "prefix": "string",
- "additionalVesting": "string",
- "socialSecurityNumber": "string",
- "sourceBuyerSellerID": 0,
- "spouse": {
- "firstName": "string",
- "lastName": "string",
- "middleName": "string",
- "prefix": "string",
- "socialSecurityNumber": "string",
- "suffix": "string"
}, - "suffix": "string",
- "taxId": "string"
}
], - "isSectionStarted": true,
- "isValidated": true,
- "lender": {
- "partyTypeID": 0,
- "partyTypeDesc": "string",
- "lenderId": "string",
- "address": {
- "cityDesc": "string",
- "countyDesc": "string",
- "stateId": "string",
- "street": "string",
- "streetLine2": "string",
- "zip": "string"
}, - "companyName": "string",
- "contactName": "string",
- "email": "string",
- "isValidated": true,
- "isPrimary": true,
- "phone": "string",
- "receivingParty": true
}, - "listingAgent": {
- "partyTypeID": 0,
- "partyTypeDesc": "string",
- "lenderId": "string",
- "address": {
- "cityDesc": "string",
- "countyDesc": "string",
- "stateId": "string",
- "street": "string",
- "streetLine2": "string",
- "zip": "string"
}, - "companyName": "string",
- "contactName": "string",
- "email": "string",
- "isValidated": true,
- "isPrimary": true,
- "phone": "string",
- "receivingParty": true
}, - "mortgageBroker": {
- "partyTypeID": 0,
- "partyTypeDesc": "string",
- "lenderId": "string",
- "address": {
- "cityDesc": "string",
- "countyDesc": "string",
- "stateId": "string",
- "street": "string",
- "streetLine2": "string",
- "zip": "string"
}, - "companyName": "string",
- "contactName": "string",
- "email": "string",
- "isValidated": true,
- "isPrimary": true,
- "phone": "string",
- "receivingParty": true
}, - "secondLender": {
- "partyTypeID": 0,
- "partyTypeDesc": "string",
- "lenderId": "string",
- "address": {
- "cityDesc": "string",
- "countyDesc": "string",
- "stateId": "string",
- "street": "string",
- "streetLine2": "string",
- "zip": "string"
}, - "companyName": "string",
- "contactName": "string",
- "email": "string",
- "isValidated": true,
- "isPrimary": true,
- "phone": "string",
- "receivingParty": true
}, - "sellers": [
- {
- "id": "string",
- "address": {
- "cityDesc": "string",
- "countyDesc": "string",
- "stateId": "string",
- "street": "string",
- "streetLine2": "string",
- "zip": "string"
}, - "businessName": "string",
- "buyerSellerType": "string",
- "buyerSellerTypeID": 0,
- "email": "string",
- "firstName": "string",
- "isPrimary": true,
- "isSameAsPropertyAddress": true,
- "isValidated": true,
- "lastName": "string",
- "maritalStatus": "string",
- "middleName": "string",
- "phone": "string",
- "prefix": "string",
- "additionalVesting": "string",
- "socialSecurityNumber": "string",
- "sourceBuyerSellerID": 0,
- "spouse": {
- "firstName": "string",
- "lastName": "string",
- "middleName": "string",
- "prefix": "string",
- "socialSecurityNumber": "string",
- "suffix": "string"
}, - "suffix": "string",
- "taxId": "string"
}
], - "sellingAgent": {
- "partyTypeID": 0,
- "partyTypeDesc": "string",
- "lenderId": "string",
- "address": {
- "cityDesc": "string",
- "countyDesc": "string",
- "stateId": "string",
- "street": "string",
- "streetLine2": "string",
- "zip": "string"
}, - "companyName": "string",
- "contactName": "string",
- "email": "string",
- "isValidated": true,
- "isPrimary": true,
- "phone": "string",
- "receivingParty": true
}, - "settlementAgent": {
- "partyTypeID": 0,
- "partyTypeDesc": "string",
- "lenderId": "string",
- "address": {
- "cityDesc": "string",
- "countyDesc": "string",
- "stateId": "string",
- "street": "string",
- "streetLine2": "string",
- "zip": "string"
}, - "companyName": "string",
- "contactName": "string",
- "email": "string",
- "isValidated": true,
- "isPrimary": true,
- "phone": "string",
- "receivingParty": true
}, - "titleAgent": {
- "partyTypeID": 0,
- "partyTypeDesc": "string",
- "lenderId": "string",
- "address": {
- "cityDesc": "string",
- "countyDesc": "string",
- "stateId": "string",
- "street": "string",
- "streetLine2": "string",
- "zip": "string"
}, - "companyName": "string",
- "contactName": "string",
- "email": "string",
- "isValidated": true,
- "isPrimary": true,
- "phone": "string",
- "receivingParty": true
}, - "escrowAgent": {
- "partyTypeID": 0,
- "partyTypeDesc": "string",
- "lenderId": "string",
- "address": {
- "cityDesc": "string",
- "countyDesc": "string",
- "stateId": "string",
- "street": "string",
- "streetLine2": "string",
- "zip": "string"
}, - "companyName": "string",
- "contactName": "string",
- "email": "string",
- "isValidated": true,
- "isPrimary": true,
- "phone": "string",
- "receivingParty": true
}, - "underwriterAgent": {
- "partyTypeID": 0,
- "partyTypeDesc": "string",
- "lenderId": "string",
- "address": {
- "cityDesc": "string",
- "countyDesc": "string",
- "stateId": "string",
- "street": "string",
- "streetLine2": "string",
- "zip": "string"
}, - "companyName": "string",
- "contactName": "string",
- "email": "string",
- "isValidated": true,
- "isPrimary": true,
- "phone": "string",
- "receivingParty": true
}, - "contacts": [
- {
- "partyTypeID": 0,
- "partyTypeDesc": "string",
- "lenderId": "string",
- "address": {
- "cityDesc": "string",
- "countyDesc": "string",
- "stateId": "string",
- "street": "string",
- "streetLine2": "string",
- "zip": "string"
}, - "companyName": "string",
- "contactName": "string",
- "email": "string",
- "isValidated": true,
- "isPrimary": true,
- "phone": "string",
- "receivingParty": true
}
]
}, - "property": {
- "address": {
- "fullAddress": "string",
- "cityDesc": "string",
- "cityId": 0,
- "countyDesc": "string",
- "countyId": 0,
- "direction": "string",
- "isPropertyAddress": true,
- "landAcreage": "string",
- "legalDescription": "string",
- "number": "string",
- "stateId": "string",
- "street": "string",
- "streetLine2": "string",
- "streetName": "string",
- "suffix": "string",
- "unit": "string",
- "zip": "string",
- "parcel": "string",
- "parcel2": "string",
- "parcel3": "string",
- "parcel4": "string",
- "lot": "string",
- "block": "string",
- "subdivision": "string",
- "fips": 0
}, - "isKeyboxInfo": true,
- "isSectionStarted": true,
- "isUnincorporated": true,
- "isValidated": true,
- "keyboxInfo": "string",
- "propertyType": "string",
- "propertyUse": "string"
}, - "note": "string",
- "orderDetails": {
- "additionalAmount": 0.1,
- "earnestMoney": 0.1,
- "cashoutAmount": 0.1,
- "clientFileNumber": "string",
- "clientId": 0,
- "estimatedSettlementDate": "2019-08-24T14:15:22Z",
- "disbursementDate": "2019-08-24T14:15:22Z",
- "closedDate": "2019-08-24T14:15:22Z",
- "isAllPartiesAttending": true,
- "isSectionStarted": true,
- "isValidated": true,
- "newLoanAmount": 0.1,
- "interestRate": 0.1,
- "newLoanNumber": "string",
- "newLoanType": "string",
- "newLoanPurpose": "string",
- "newLoanDescription": "string",
- "productTypeDesc": "string",
- "productTypeId": 0,
- "salesPrice": 0.1,
- "transactionTypeDesc": "string",
- "transactionTypeId": 0,
- "additionalReference": "string"
}, - "additionalServices": [
- {
- "serviceId": "string",
- "serviceName": "string",
- "note": "string",
- "sentDate": "2019-08-24T14:15:22Z",
- "receivedDate": "2019-08-24T14:15:22Z",
- "sentStatus": 0
}
], - "placementNotes": [
- {
- "subject": "string",
- "body": "string"
}
]
}
Response samples
- 200
- 400
Order quick search
Request Body schema:
The criteria to find.
searchValue | string or null |
searchType | string or null |
maxResultCount | integer <int32> |
Responses
Request samples
- Payload
{- "searchValue": "string",
- "searchType": "string",
- "maxResultCount": 0
}
Response samples
- 200
- 400
Search orders (basic)
Request Body schema:
The criteria to search GRiD151.Lib.Common.Models.Orders.Requests.BasicSearchRequest.
integrationId | string or null |
address | string or null |
clientFileNumber | string or null |
additionalReference | string or null |
loanNumber | string or null |
Array of objects or null | |
object |
Responses
Request samples
- Payload
{- "integrationId": "string",
- "address": "string",
- "clientFileNumber": "string",
- "additionalReference": "string",
- "loanNumber": "string",
- "statusFilters": [
- {
- "key": 0,
- "value": true
}
], - "pagination": {
- "pageNo": 0,
- "pageSize": 0,
- "sortBy": "string",
- "isSortAsc": true
}
}
Response samples
- 200
- 400
Search orders (advanced)
Request Body schema:
The criteria to search GRiD151.Lib.Common.Models.Orders.Requests.AdvancedSearchRequest.
integrationId | string or null |
clientFileNumber | string or null |
loanNumber | string or null |
Array of objects or null | |
object | |
object | |
object | |
additionalReference | string or null |
object |
Responses
Request samples
- Payload
{- "integrationId": "string",
- "clientFileNumber": "string",
- "loanNumber": "string",
- "statusFilters": [
- {
- "key": 0,
- "value": true
}
], - "propertyAddress": {
- "number": "string",
- "streetName": "string",
- "stateId": "string"
}, - "buyerSeller": {
- "type": 0,
- "firstName": "string",
- "lastName": "string",
- "businessName": "string"
}, - "dates": {
- "openedDateFrom": "2019-08-24T14:15:22Z",
- "openedDateTo": "2019-08-24T14:15:22Z",
- "completedDateFrom": "2019-08-24T14:15:22Z",
- "completedDateTo": "2019-08-24T14:15:22Z",
- "estimatedSettlementDateFrom": "2019-08-24T14:15:22Z",
- "estimatedSettlementDateTo": "2019-08-24T14:15:22Z"
}, - "additionalReference": "string",
- "pagination": {
- "pageNo": 0,
- "pageSize": 0,
- "sortBy": "string",
- "isSortAsc": true
}
}
Response samples
- 200
- 400
Start action
Request Body schema:
Request information containing unique identifying information for an order and action
identifier | string or null |
actionId | integer <int32> |
selections | Array of integers or null <int32> |
Responses
Request samples
- Payload
{- "identifier": "string",
- "actionId": 0,
- "selections": [
- 0
]
}
Response samples
- 200
Complete action
Request Body schema:
Request information containing unique identifying information for an order and action
identifier | string or null |
actionId | integer <int32> |
selections | Array of integers or null <int32> |
Responses
Request samples
- Payload
{- "identifier": "string",
- "actionId": 0,
- "selections": [
- 0
]
}
Response samples
- 200
- 400
Complete client action
Request Body schema:
Request information containing unique identifying information for an order and action
identifier | string or null |
actionId | integer <int32> |
selections | Array of integers or null <int32> |
Responses
Request samples
- Payload
{- "identifier": "string",
- "actionId": 0,
- "selections": [
- 0
]
}
Response samples
- 200
- 400
Start client action
Request Body schema:
Request information containing unique identifying information for an order and action
identifier | string or null |
actionId | integer <int32> |
selections | Array of integers or null <int32> |
Responses
Request samples
- Payload
{- "identifier": "string",
- "actionId": 0,
- "selections": [
- 0
]
}
Response samples
- 200
- 400
Estimate Fees
Estimates fees for a given set of parameters. Property validation will take place based on the provided request.
Populate the
GetFeesRequest
object with the necessary parameters for estimation.Provide the
integrationId
to query for estimates associated with a specific integration.
path Parameters
integrationId required | string The integration ID to query for estimates. |
Request Body schema:
The estimate parameters
transactionTypeId | integer <int32> |
productTypeId | integer <int32> |
underwriterId | integer <int32> |
city | string or null |
county | string or null |
state | string or null |
zip | string or null |
loanLienPosition | integer or null <int32> |
loanAmount | number <double> |
loanType | string or null |
salesPrice | number <double> |
originalDebtAmount | number or null <double> |
unpaidPrincipleAmount | number or null <double> |
object | |
endorsements | Array of strings or null |
settlementStatementVersion | string or null |
Responses
Request samples
- Payload
{- "transactionTypeId": 0,
- "productTypeId": 0,
- "underwriterId": 0,
- "city": "string",
- "county": "string",
- "state": "string",
- "zip": "string",
- "loanLienPosition": 0,
- "loanAmount": 0.1,
- "loanType": "string",
- "salesPrice": 0.1,
- "originalDebtAmount": 0.1,
- "unpaidPrincipleAmount": 0.1,
- "reissueData": {
- "consideration": 0.1,
- "payoff": 0.1,
- "payoffDate": "2019-08-24T14:15:22Z",
- "priorConsideration": 0.1,
- "priorDate": "2019-08-24T14:15:22Z"
}, - "endorsements": [
- "string"
], - "settlementStatementVersion": "string"
}
Response samples
- 200
- 400
Rate Quote
path Parameters
integrationId required | string The integration ID to query for estimates. |
Request Body schema:
The rate quote parameters
city | string or null |
clientFileNumber | string or null |
county | string or null |
endorsements | Array of strings or null |
gridBaseOrderId | string or null |
loanAmount | number <double> |
productTypeDesc | string or null |
productTypeId | integer <int32> |
salesPrice | number <double> |
state | string or null |
transactionTypeDesc | string or null |
transactionTypeId | integer <int32> |
underwriterId | integer <int32> |
zip | string or null |
Responses
Request samples
- Payload
{- "city": "string",
- "clientFileNumber": "string",
- "county": "string",
- "endorsements": [
- "string"
], - "gridBaseOrderId": "string",
- "loanAmount": 0.1,
- "productTypeDesc": "string",
- "productTypeId": 0,
- "salesPrice": 0.1,
- "state": "string",
- "transactionTypeDesc": "string",
- "transactionTypeId": 0,
- "underwriterId": 0,
- "zip": "string"
}
Response samples
- 200
- 400
Adds additional services to order
path Parameters
orderId required | string |
Request Body schema:
serviceId | string or null |
serviceName | string or null |
note | string or null |
sentDate | string or null <date-time> |
receivedDate | string or null <date-time> |
sentStatus | integer <int32> Enum: 0 1 |
Responses
Request samples
- Payload
[- {
- "serviceId": "string",
- "serviceName": "string",
- "note": "string",
- "sentDate": "2019-08-24T14:15:22Z",
- "receivedDate": "2019-08-24T14:15:22Z",
- "sentStatus": 0
}
]
Response samples
- 200
- 400
Add Signing
path Parameters
orderId required | string Id for the Order |
Request Body schema:
The new Signing.
name | string or null |
signingNumber | integer or null <int32> |
signingTypeDesc | string or null |
signingTypeId | integer or null <int32> |
borrowerPhone | string or null |
borrowerWorkPhone | string or null |
borrowerMobilePhone | string or null |
timeZoneId | integer or null <int32> |
timeZoneDesc | string or null |
signingDateTime | string or null <date-time> |
signingLength | integer or null <int32> |
isCompleted | boolean |
isCancelled | boolean |
isNotSigned | boolean |
locationId | integer or null <int32> |
locationDesc | string or null |
object | |
object | |
isDeliveryAddressSameAsSigning | boolean |
isEmailDocsToNotary | boolean |
isAttorneyNeeded | boolean or null |
isBilingualNotaryNeeded | boolean or null |
languageId | integer or null <int32> |
languageDesc | string or null |
specialInstructions | string or null |
closer | string or null |
createdDate | string or null <date-time> |
createdBy | string or null |
settlementCoordinator | string or null |
Array of objects or null | |
Array of objects or null | |
Array of objects or null |
Responses
Request samples
- Payload
{- "name": "string",
- "signingNumber": 0,
- "signingTypeDesc": "string",
- "signingTypeId": 0,
- "borrowerPhone": "string",
- "borrowerWorkPhone": "string",
- "borrowerMobilePhone": "string",
- "timeZoneId": 0,
- "timeZoneDesc": "string",
- "signingDateTime": "2019-08-24T14:15:22Z",
- "signingLength": 0,
- "isCompleted": true,
- "isCancelled": true,
- "isNotSigned": true,
- "locationId": 0,
- "locationDesc": "string",
- "signingAddress": {
- "fullAddress": "string",
- "cityDesc": "string",
- "cityId": 0,
- "countyDesc": "string",
- "countyId": 0,
- "direction": "string",
- "isPropertyAddress": true,
- "landAcreage": "string",
- "legalDescription": "string",
- "number": "string",
- "stateId": "string",
- "street": "string",
- "streetLine2": "string",
- "streetName": "string",
- "suffix": "string",
- "unit": "string",
- "zip": "string",
- "parcel": "string",
- "parcel2": "string",
- "parcel3": "string",
- "parcel4": "string",
- "lot": "string",
- "block": "string",
- "subdivision": "string",
- "fips": 0
}, - "documentDeliveryAddress": {
- "fullAddress": "string",
- "cityDesc": "string",
- "cityId": 0,
- "countyDesc": "string",
- "countyId": 0,
- "direction": "string",
- "isPropertyAddress": true,
- "landAcreage": "string",
- "legalDescription": "string",
- "number": "string",
- "stateId": "string",
- "street": "string",
- "streetLine2": "string",
- "streetName": "string",
- "suffix": "string",
- "unit": "string",
- "zip": "string",
- "parcel": "string",
- "parcel2": "string",
- "parcel3": "string",
- "parcel4": "string",
- "lot": "string",
- "block": "string",
- "subdivision": "string",
- "fips": 0
}, - "isDeliveryAddressSameAsSigning": true,
- "isEmailDocsToNotary": true,
- "isAttorneyNeeded": true,
- "isBilingualNotaryNeeded": true,
- "languageId": 0,
- "languageDesc": "string",
- "specialInstructions": "string",
- "closer": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "settlementCoordinator": "string",
- "parties": [
- {
- "signingPartyID": 0,
- "signingNumber": 0,
- "buyerSellerID": 0,
- "otherID": 0,
- "name": "string",
- "phone": "string"
}
], - "notes": [
- {
- "id": "string",
- "createdBy": {
- "contactInformation": {
- "cellPhoneNumber": "string",
- "emailAddress": "string",
- "faxNumber": "string",
- "homePhoneNumber": "string",
- "phoneNumber": "string",
- "preferredCommunicationMethod": "string",
- "voicemail": "string",
- "website": "string"
}, - "firstName": "string",
- "lastName": "string",
- "name": "string",
- "userID": 0
}, - "createdDate": "2019-08-24T14:15:22Z",
- "fileID": 0,
- "noteID": 0,
- "noteType": "string",
- "fileNumber": "string",
- "coordinatorTypeID": 0,
- "toCoordinatorID": 0,
- "noteSubject": "string",
- "noteBody": "string",
- "curativeID": 0,
- "documents": [
- {
- "id": "string",
- "documentTypeID": "string",
- "documentName": "string",
- "documentType": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "description": "string",
- "documentBody": "string",
- "fileName": "string",
- "extension": "string",
- "externalId": "string",
- "disbursementDate": "2019-08-24T14:15:22Z"
}
], - "fileActionsID": 0,
- "titleReviewID": 0,
- "otherID": 0
}
], - "documents": [
- {
- "id": "string",
- "description": "string",
- "documentID": 0,
- "fileName": "string"
}
]
}
Response samples
- 201
- 400
Add signing document
path Parameters
orderId required | string Id for the Order |
Request Body schema:
Signing document record
id | string or null |
object | |
createdDate | string <date-time> |
fileID | integer <int32> |
noteID | integer or null <int32> |
noteType | string or null |
fileNumber | string or null |
coordinatorTypeID | integer <int32> |
toCoordinatorID | integer <int32> |
noteSubject | string or null |
noteBody | string or null |
curativeID | integer or null <int32> |
Array of objects or null | |
fileActionsID | integer or null <int32> |
titleReviewID | integer or null <int32> |
otherID | integer or null <int32> |
Responses
Request samples
- Payload
{- "id": "string",
- "createdBy": {
- "contactInformation": {
- "cellPhoneNumber": "string",
- "emailAddress": "string",
- "faxNumber": "string",
- "homePhoneNumber": "string",
- "phoneNumber": "string",
- "preferredCommunicationMethod": "string",
- "voicemail": "string",
- "website": "string"
}, - "firstName": "string",
- "lastName": "string",
- "name": "string",
- "userID": 0
}, - "createdDate": "2019-08-24T14:15:22Z",
- "fileID": 0,
- "noteID": 0,
- "noteType": "string",
- "fileNumber": "string",
- "coordinatorTypeID": 0,
- "toCoordinatorID": 0,
- "noteSubject": "string",
- "noteBody": "string",
- "curativeID": 0,
- "documents": [
- {
- "id": "string",
- "documentTypeID": "string",
- "documentName": "string",
- "documentType": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "description": "string",
- "documentBody": "string",
- "fileName": "string",
- "extension": "string",
- "externalId": "string",
- "disbursementDate": "2019-08-24T14:15:22Z"
}
], - "fileActionsID": 0,
- "titleReviewID": 0,
- "otherID": 0
}
Response samples
- 201
- 400
Add signing party
path Parameters
orderId required | string Id for the Order |
Request Body schema:
Signing party document
signingPartyID | integer <int32> |
signingNumber | integer <int32> |
buyerSellerID | integer or null <int32> |
otherID | integer or null <int32> |
name | string or null |
phone | string or null |
Responses
Request samples
- Payload
{- "signingPartyID": 0,
- "signingNumber": 0,
- "buyerSellerID": 0,
- "otherID": 0,
- "name": "string",
- "phone": "string"
}
Response samples
- 201
- 400
Updates a signing
path Parameters
orderId required | string |
Request Body schema:
name | string or null |
signingNumber | integer or null <int32> |
signingTypeDesc | string or null |
signingTypeId | integer or null <int32> |
borrowerPhone | string or null |
borrowerWorkPhone | string or null |
borrowerMobilePhone | string or null |
timeZoneId | integer or null <int32> |
timeZoneDesc | string or null |
signingDateTime | string or null <date-time> |
signingLength | integer or null <int32> |
isCompleted | boolean |
isCancelled | boolean |
isNotSigned | boolean |
locationId | integer or null <int32> |
locationDesc | string or null |
object | |
object | |
isDeliveryAddressSameAsSigning | boolean |
isEmailDocsToNotary | boolean |
isAttorneyNeeded | boolean or null |
isBilingualNotaryNeeded | boolean or null |
languageId | integer or null <int32> |
languageDesc | string or null |
specialInstructions | string or null |
closer | string or null |
createdDate | string or null <date-time> |
createdBy | string or null |
settlementCoordinator | string or null |
Array of objects or null | |
Array of objects or null | |
Array of objects or null |
Responses
Request samples
- Payload
{- "name": "string",
- "signingNumber": 0,
- "signingTypeDesc": "string",
- "signingTypeId": 0,
- "borrowerPhone": "string",
- "borrowerWorkPhone": "string",
- "borrowerMobilePhone": "string",
- "timeZoneId": 0,
- "timeZoneDesc": "string",
- "signingDateTime": "2019-08-24T14:15:22Z",
- "signingLength": 0,
- "isCompleted": true,
- "isCancelled": true,
- "isNotSigned": true,
- "locationId": 0,
- "locationDesc": "string",
- "signingAddress": {
- "fullAddress": "string",
- "cityDesc": "string",
- "cityId": 0,
- "countyDesc": "string",
- "countyId": 0,
- "direction": "string",
- "isPropertyAddress": true,
- "landAcreage": "string",
- "legalDescription": "string",
- "number": "string",
- "stateId": "string",
- "street": "string",
- "streetLine2": "string",
- "streetName": "string",
- "suffix": "string",
- "unit": "string",
- "zip": "string",
- "parcel": "string",
- "parcel2": "string",
- "parcel3": "string",
- "parcel4": "string",
- "lot": "string",
- "block": "string",
- "subdivision": "string",
- "fips": 0
}, - "documentDeliveryAddress": {
- "fullAddress": "string",
- "cityDesc": "string",
- "cityId": 0,
- "countyDesc": "string",
- "countyId": 0,
- "direction": "string",
- "isPropertyAddress": true,
- "landAcreage": "string",
- "legalDescription": "string",
- "number": "string",
- "stateId": "string",
- "street": "string",
- "streetLine2": "string",
- "streetName": "string",
- "suffix": "string",
- "unit": "string",
- "zip": "string",
- "parcel": "string",
- "parcel2": "string",
- "parcel3": "string",
- "parcel4": "string",
- "lot": "string",
- "block": "string",
- "subdivision": "string",
- "fips": 0
}, - "isDeliveryAddressSameAsSigning": true,
- "isEmailDocsToNotary": true,
- "isAttorneyNeeded": true,
- "isBilingualNotaryNeeded": true,
- "languageId": 0,
- "languageDesc": "string",
- "specialInstructions": "string",
- "closer": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "settlementCoordinator": "string",
- "parties": [
- {
- "signingPartyID": 0,
- "signingNumber": 0,
- "buyerSellerID": 0,
- "otherID": 0,
- "name": "string",
- "phone": "string"
}
], - "notes": [
- {
- "id": "string",
- "createdBy": {
- "contactInformation": {
- "cellPhoneNumber": "string",
- "emailAddress": "string",
- "faxNumber": "string",
- "homePhoneNumber": "string",
- "phoneNumber": "string",
- "preferredCommunicationMethod": "string",
- "voicemail": "string",
- "website": "string"
}, - "firstName": "string",
- "lastName": "string",
- "name": "string",
- "userID": 0
}, - "createdDate": "2019-08-24T14:15:22Z",
- "fileID": 0,
- "noteID": 0,
- "noteType": "string",
- "fileNumber": "string",
- "coordinatorTypeID": 0,
- "toCoordinatorID": 0,
- "noteSubject": "string",
- "noteBody": "string",
- "curativeID": 0,
- "documents": [
- {
- "id": "string",
- "documentTypeID": "string",
- "documentName": "string",
- "documentType": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "description": "string",
- "documentBody": "string",
- "fileName": "string",
- "extension": "string",
- "externalId": "string",
- "disbursementDate": "2019-08-24T14:15:22Z"
}
], - "fileActionsID": 0,
- "titleReviewID": 0,
- "otherID": 0
}
], - "documents": [
- {
- "id": "string",
- "description": "string",
- "documentID": 0,
- "fileName": "string"
}
]
}
Response samples
- 200
- 400
Handles post webhook requests from external system.
Keep backwards compatibility for Encompass for now, will need to be phased out.
Reads message and headers to validate request.
path Parameters
system required | string Enum: "None" "Resware" "AtClose" "Softpro" "eAgency" "Closepin" "Encompass" "X1" "Stacx" "RamQuest" "BlackKnight" "ManualEntry" "SellerNetSheet" "Inkd" "BuyerCostEstimate" System to use (will get first integration for this system) |
Responses
Add document.
path Parameters
orderId required | string Id for the Order |
Request Body schema:
Document record
coordinatorTypeID | integer <int32> |
toCoordinatorID | integer <int32> |
noteSubject | string or null |
noteBody | string or null |
Array of objects or null |
Responses
Request samples
- Payload
{- "coordinatorTypeID": 0,
- "toCoordinatorID": 0,
- "noteSubject": "string",
- "noteBody": "string",
- "documents": [
- {
- "id": "string",
- "documentTypeID": "string",
- "documentName": "string",
- "documentType": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "description": "string",
- "documentBody": "string",
- "fileName": "string",
- "extension": "string",
- "externalId": "string",
- "disbursementDate": "2019-08-24T14:15:22Z"
}
]
}
Response samples
- 201
Adds single document to an existing order
path Parameters
orderId required | string |
Request Body schema:
noteSubject | string or null |
noteBody | string or null |
fileName | string or null |
description | string or null |
documentBody | string or null |
documentTypeID | string or null |
extension | string or null |
externalId | string or null |
Responses
Request samples
- Payload
{- "noteSubject": "string",
- "noteBody": "string",
- "fileName": "string",
- "description": "string",
- "documentBody": "string",
- "documentTypeID": "string",
- "extension": "string",
- "externalId": "string"
}
Response samples
- 201
Adds a curative document to a file.
path Parameters
orderId required | string Id for the Order |
Request Body schema:
The curative document to add.
id | string or null |
object | |
createdDate | string <date-time> |
fileID | integer <int32> |
noteID | integer or null <int32> |
noteType | string or null |
fileNumber | string or null |
coordinatorTypeID | integer <int32> |
toCoordinatorID | integer <int32> |
noteSubject | string or null |
noteBody | string or null |
curativeID | integer or null <int32> |
Array of objects or null | |
fileActionsID | integer or null <int32> |
titleReviewID | integer or null <int32> |
otherID | integer or null <int32> |
Responses
Request samples
- Payload
{- "id": "string",
- "createdBy": {
- "contactInformation": {
- "cellPhoneNumber": "string",
- "emailAddress": "string",
- "faxNumber": "string",
- "homePhoneNumber": "string",
- "phoneNumber": "string",
- "preferredCommunicationMethod": "string",
- "voicemail": "string",
- "website": "string"
}, - "firstName": "string",
- "lastName": "string",
- "name": "string",
- "userID": 0
}, - "createdDate": "2019-08-24T14:15:22Z",
- "fileID": 0,
- "noteID": 0,
- "noteType": "string",
- "fileNumber": "string",
- "coordinatorTypeID": 0,
- "toCoordinatorID": 0,
- "noteSubject": "string",
- "noteBody": "string",
- "curativeID": 0,
- "documents": [
- {
- "id": "string",
- "documentTypeID": "string",
- "documentName": "string",
- "documentType": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "description": "string",
- "documentBody": "string",
- "fileName": "string",
- "extension": "string",
- "externalId": "string",
- "disbursementDate": "2019-08-24T14:15:22Z"
}
], - "fileActionsID": 0,
- "titleReviewID": 0,
- "otherID": 0
}
Response samples
- 201
Adds a curative document to a file.
path Parameters
orderId required | string The order id. |
Request Body schema:
The curative document to add.
id | string or null |
object | |
createdDate | string <date-time> |
fileID | integer <int32> |
noteID | integer or null <int32> |
noteType | string or null |
fileNumber | string or null |
coordinatorTypeID | integer <int32> |
toCoordinatorID | integer <int32> |
noteSubject | string or null |
noteBody | string or null |
curativeID | integer or null <int32> |
Array of objects or null | |
fileActionsID | integer or null <int32> |
titleReviewID | integer or null <int32> |
otherID | integer or null <int32> |
Responses
Request samples
- Payload
{- "id": "string",
- "createdBy": {
- "contactInformation": {
- "cellPhoneNumber": "string",
- "emailAddress": "string",
- "faxNumber": "string",
- "homePhoneNumber": "string",
- "phoneNumber": "string",
- "preferredCommunicationMethod": "string",
- "voicemail": "string",
- "website": "string"
}, - "firstName": "string",
- "lastName": "string",
- "name": "string",
- "userID": 0
}, - "createdDate": "2019-08-24T14:15:22Z",
- "fileID": 0,
- "noteID": 0,
- "noteType": "string",
- "fileNumber": "string",
- "coordinatorTypeID": 0,
- "toCoordinatorID": 0,
- "noteSubject": "string",
- "noteBody": "string",
- "curativeID": 0,
- "documents": [
- {
- "id": "string",
- "documentTypeID": "string",
- "documentName": "string",
- "documentType": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "description": "string",
- "documentBody": "string",
- "fileName": "string",
- "extension": "string",
- "externalId": "string",
- "disbursementDate": "2019-08-24T14:15:22Z"
}
], - "fileActionsID": 0,
- "titleReviewID": 0,
- "otherID": 0
}
Response samples
- 201
Adds a curative document to a file.
path Parameters
orderId required | string Id for the Order |
Request Body schema:
The curative document to add.
id | string or null |
object | |
createdDate | string <date-time> |
fileID | integer <int32> |
noteID | integer or null <int32> |
noteType | string or null |
fileNumber | string or null |
coordinatorTypeID | integer <int32> |
toCoordinatorID | integer <int32> |
noteSubject | string or null |
noteBody | string or null |
curativeID | integer or null <int32> |
Array of objects or null | |
fileActionsID | integer or null <int32> |
titleReviewID | integer or null <int32> |
otherID | integer or null <int32> |
Responses
Request samples
- Payload
{- "id": "string",
- "createdBy": {
- "contactInformation": {
- "cellPhoneNumber": "string",
- "emailAddress": "string",
- "faxNumber": "string",
- "homePhoneNumber": "string",
- "phoneNumber": "string",
- "preferredCommunicationMethod": "string",
- "voicemail": "string",
- "website": "string"
}, - "firstName": "string",
- "lastName": "string",
- "name": "string",
- "userID": 0
}, - "createdDate": "2019-08-24T14:15:22Z",
- "fileID": 0,
- "noteID": 0,
- "noteType": "string",
- "fileNumber": "string",
- "coordinatorTypeID": 0,
- "toCoordinatorID": 0,
- "noteSubject": "string",
- "noteBody": "string",
- "curativeID": 0,
- "documents": [
- {
- "id": "string",
- "documentTypeID": "string",
- "documentName": "string",
- "documentType": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "description": "string",
- "documentBody": "string",
- "fileName": "string",
- "extension": "string",
- "externalId": "string",
- "disbursementDate": "2019-08-24T14:15:22Z"
}
], - "fileActionsID": 0,
- "titleReviewID": 0,
- "otherID": 0
}
Response samples
- 201