Skip to main content
API docs by Redocly

GridBase API Reference

Download OpenAPI specification:Download

Authentication

Refresh token

Request Body schema:

The refresh token used to acquire new access tokens.

refreshToken
string or null
email
string or null

Responses

Request samples

Content type
{
  • "refreshToken": "string",
  • "email": "string"
}

Response samples

Content type
No sample

Initializes specific integration with given request.

Request Body schema:

Authentication request

Responses

Request samples

Content type
{ }

Response samples

Content type
No sample

Endorsements

Gets a list of endorsements by system

path Parameters
integrationId
required
string
underwriterId
required
string <int32>
state
required
string

Responses

Response samples

Content type
No sample

Milestones

Completes a given milestone on an order.

path Parameters
orderId
required
string
stepId
required
string <int32>

Responses

Response samples

Content type
No sample

Returns a list of milestonesInternalApi for a given system. TODO: Depricate for integration list

path Parameters
system
required
string

Responses

Response samples

Content type
No sample

Returns a list of milestones for a given integration.

path Parameters
integrationId
required
string

Responses

Response samples

Content type
No sample

Order

Stage Order


When staging an order, property validation will take place. The two possible options for passing address validation are listed below. If both options are populated, "FullAddress" validation will be the default option.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.

id
string or null
note
string or null
Array of objects or null
object
object
object
system
string
Enum: "None" "Resware" "AtClose" "Softpro" "eAgency" "Closepin" "Encompass" "X1" "Stacx" "RamQuest" "BlackKnight" "ManualEntry" "SellerNetSheet" "Inkd"
integrationId
string or null
product
string or null

Responses

Request samples

Content type
{
  • "id": "string",
  • "note": "string",
  • "placementNotes": [
    ],
  • "orderDetails": {
    },
  • "parties": {
    },
  • "property": {
    },
  • "system": "None",
  • "integrationId": "string",
  • "product": "string"
}

Response samples

Content type
No sample

Read Order

path Parameters
orderId
required
string

The unique identifier of the Order to read.

Responses

Response samples

Content type
No sample

Reads order with decrypted NPI

path Parameters
orderId
required
string

Responses

Response samples

Content type
No sample

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"

The system the order is integrated in.

Responses

Response samples

Content type
No sample

Update Order

Request Body schema:

The Order to update.

id
string or null
note
string or null
Array of objects or null
object
object
object
system
string
Enum: "None" "Resware" "AtClose" "Softpro" "eAgency" "Closepin" "Encompass" "X1" "Stacx" "RamQuest" "BlackKnight" "ManualEntry" "SellerNetSheet" "Inkd"
integrationId
string or null
product
string or null

Responses

Request samples

Content type
{
  • "id": "string",
  • "note": "string",
  • "placementNotes": [
    ],
  • "orderDetails": {
    },
  • "parties": {
    },
  • "property": {
    },
  • "system": "None",
  • "integrationId": "string",
  • "product": "string"
}

Response samples

Content type
No sample

Cancel an order

Request Body schema:

Cancellation data, including the Order ID, reason for cancellation.

orderId
string or null
cancelReason
string or null

Responses

Request samples

Content type
{
  • "orderId": "string",
  • "cancelReason": "string"
}

Response samples

Content type
No sample

Order quick search

Request Body schema:

The criteria to find.

searchValue
string or null
searchType
string or null
maxResultCount
integer <int32>

Responses

Request samples

Content type
{
  • "searchValue": "string",
  • "searchType": "string",
  • "maxResultCount": 0
}

Response samples

Content type
No sample

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

Content type
{
  • "integrationId": "string",
  • "address": "string",
  • "clientFileNumber": "string",
  • "additionalReference": "string",
  • "loanNumber": "string",
  • "statusFilters": [
    ],
  • "pagination": {
    }
}

Response samples

Content type
No sample

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

Content type
{
  • "integrationId": "string",
  • "clientFileNumber": "string",
  • "loanNumber": "string",
  • "statusFilters": [
    ],
  • "propertyAddress": {
    },
  • "buyerSeller": {
    },
  • "dates": {
    },
  • "additionalReference": "string",
  • "pagination": {
    }
}

Response samples

Content type
No sample

Get Decrypted Buyer/Seller Social Security Number

path Parameters
id
required
string

The unique identifier of the buyer/seller.

Responses

Response samples

Content type
No sample

Get Decrypted Buyer/Seller Spouse Social Security Number

path Parameters
id
required
string

The unique identifier of the buyer/seller.

Responses

Response samples

Content type
No sample

Get Decrypted Buyer/Seller Tax Id

path Parameters
id
required
string

The unique identifier of the buyer/seller.

Responses

Response samples

Content type
No sample

Place order

path Parameters
orderId
required
string

Responses

Response samples

Content type
No sample

Get Actions

path Parameters
orderId
required
string

Order ID

Responses

Response samples

Content type
No sample

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

Content type
{
  • "identifier": "string",
  • "actionId": 0,
  • "selections": [
    ]
}

Response samples

Content type
No sample

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

Content type
{
  • "identifier": "string",
  • "actionId": 0,
  • "selections": [
    ]
}

Response samples

Content type
No sample

Reads policy curatives.

path Parameters
orderId
required
string

Order ID

Responses

Response samples

Content type
No sample

Complete policy curative

path Parameters
orderId
required
string

Order ID

policyCurativeID
required
string <int32>

Policy Curative ID

Responses

Response samples

Content type
No sample

Read pre-closing curatives

path Parameters
orderId
required
string

Order ID

Responses

Response samples

Content type
No sample

Complete pre-closing curative.

path Parameters
orderId
required
string

Order ID

preClosingCurativeID
required
string <int32>

Pre-closing Curative ID

Responses

Response samples

Content type
No sample

Get analytics

path Parameters
integrationId
required
string

Responses

Response samples

Content type
No sample

Get actions associated with user

Responses

Response samples

Content type
No sample

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

Content type
{
  • "identifier": "string",
  • "actionId": 0,
  • "selections": [
    ]
}

Response samples

Content type
No sample

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

Content type
{
  • "identifier": "string",
  • "actionId": 0,
  • "selections": [
    ]
}

Response samples

Content type
No sample

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

Content type
{
  • "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": {
    },
  • "endorsements": [
    ],
  • "settlementStatementVersion": "string"
}

Response samples

Content type
No sample

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

Content type
{
  • "city": "string",
  • "clientFileNumber": "string",
  • "county": "string",
  • "endorsements": [
    ],
  • "gridBaseOrderId": "string",
  • "loanAmount": 0.1,
  • "productTypeDesc": "string",
  • "productTypeId": 0,
  • "salesPrice": 0.1,
  • "state": "string",
  • "transactionTypeDesc": "string",
  • "transactionTypeId": 0,
  • "underwriterId": 0,
  • "zip": "string"
}

Response samples

Content type
No sample

Rate quote read by id

path Parameters
quoteId
required
string

The unique identifier of the Quote to read.

Responses

Response samples

Content type
No sample

Rate quote search

Request Body schema:

The search parameters

clientFileNumber
string or null
object

Responses

Request samples

Content type
{
  • "clientFileNumber": "string",
  • "pagination": {
    }
}

Response samples

Content type
No sample

Signing

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

Content type
{
  • "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": {
    },
  • "documentDeliveryAddress": {
    },
  • "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": [
    ],
  • "notes": [
    ],
  • "documents": [
    ]
}

Response samples

Content type
No sample

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

Content type
{
  • "id": "string",
  • "createdBy": {
    },
  • "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": [
    ],
  • "fileActionsID": 0,
  • "titleReviewID": 0,
  • "otherID": 0
}

Response samples

Content type
No sample

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

Content type
{
  • "signingPartyID": 0,
  • "signingNumber": 0,
  • "buyerSellerID": 0,
  • "otherID": 0,
  • "name": "string",
  • "phone": "string"
}

Response samples

Content type
No sample

Reads an array of signings

path Parameters
orderId
required
string

Responses

Response samples

Content type
No sample

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

Content type
{
  • "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": {
    },
  • "documentDeliveryAddress": {
    },
  • "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": [
    ],
  • "notes": [
    ],
  • "documents": [
    ]
}

Response samples

Content type
No sample

Removes a signing party

path Parameters
orderId
required
string
signingNumber
required
string <int32>
signingPartyId
required
string <int32>

Responses

Response samples

Content type
No sample

Initiates a signing process flow.

path Parameters
integrationId
required
string

The signing process integration ID.

Responses

TypeMappings

Retrieve type mappings.

path Parameters
system
required
string

Responses

Response samples

Content type
No sample

Retrieve type mappings.

path Parameters
integrationId
required
string

Integration ID

Responses

Response samples

Content type
No sample

Webhook

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"

System to use (will get first integration for this system)

Responses

Handles post webhook requests from external system.

Reads message and headers to validate request.

path Parameters
integrationId
required
string

Responses

Handles post webhook requests from external system authorized by APIKey.

Reads message and headers to validate request.

path Parameters
integrationId
required
string

Responses

Documents

Gets a file's documents.

path Parameters
orderId
required
string

Id for the Order

Responses

Response samples

Content type
No sample

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

Content type
{
  • "coordinatorTypeID": 0,
  • "toCoordinatorID": 0,
  • "noteSubject": "string",
  • "noteBody": "string",
  • "documents": [
    ]
}

Response samples

Content type
No sample

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

Content type
{
  • "noteSubject": "string",
  • "noteBody": "string",
  • "fileName": "string",
  • "description": "string",
  • "documentBody": "string",
  • "documentTypeID": "string",
  • "extension": "string",
  • "externalId": "string"
}

Response samples

Content type
No sample

Gets a list of documents

path Parameters
orderId
required
string

Responses

Response samples

Content type
No sample

Downloads a document

path Parameters
orderId
required
string
documentId
required
string

Responses

Response samples

Content type
No sample

Gets document types.

path Parameters
integrationId
required
string

Responses

Response samples

Content type
No sample

Gets document types.

Responses

Response samples

Content type
No sample

Gets document information.

path Parameters
orderId
required
string

Id for the Order

documentId
required
string

Id for the Document

Responses

Response samples

Content type
No sample

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

Content type
{
  • "id": "string",
  • "createdBy": {
    },
  • "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": [
    ],
  • "fileActionsID": 0,
  • "titleReviewID": 0,
  • "otherID": 0
}

Response samples

Content type
No sample

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

Content type
{
  • "id": "string",
  • "createdBy": {
    },
  • "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": [
    ],
  • "fileActionsID": 0,
  • "titleReviewID": 0,
  • "otherID": 0
}

Response samples

Content type
No sample

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

Content type
{
  • "id": "string",
  • "createdBy": {
    },
  • "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": [
    ],
  • "fileActionsID": 0,
  • "titleReviewID": 0,
  • "otherID": 0
}

Response samples

Content type
No sample

Initiates a document process flow.

path Parameters
integrationId
required
string

The curative document to add.

Responses