API Account

Please sign in to your Mortgage Automator account for a customized documentation.

OpenAPI 3.0 Schema (May open it using Swagger Editor)

Authentication #

Each Lender API account has a lender_id and an api key.

The api key is a shared secret between the Mortgage Automator server and the requesting client. It is never directly transmitted. Instead, the key is used to compute a validation token that further authenticates each web request.

Each request contains an entity and an action. The authentication token, or API-AUTH is an SHA1 digest of the ACCOUNT-ID, the api key, entity/action combo and an hourly timestamp.

A timestamp uses the YYYY-MM-DD-HH format, where HH is the 24-hour representation of the hour. The time components are not zero-padded.

For example, March 5, 2019 at 7:20pm is written as 2019-03-05-19. The logical timezone is UTC.

Each part of the token calculation is separated by a hyphen ("-").

For example, an API account 123 with an API key of "abc" computes the token on March 5, 2019 at 7:20am:

API-AUTH = SHA1 (123-abc-quotes-2019-03-05-07) = 9501d9ac23b3eb78cdc6116427f4d66636fc8504

Both ACCOUNT-ID and API-AUTH are sent through the HTTP request header.

Version #

Current Version: 1

Supported Versions: 1, 2

To specify a newer version 2 other than the current version 1: {ENDPOINT}/v2/loans/get

When the version is not specified or the specified version is not supported, version is set to the current version. For example, {ENDPOINT}/loans/list uses the current version 1

Filtering, Sorting and Pagination #

Use these URL parameters to filter, sort and pagination in some entity-actions. For example, loans/list

  • Filter

    • Range using lte and gte

      Filter loan_id that is great than or equal to 500 and less than 1000: /loans/list/?loan_id[lte]=1000&loan_id[gte]=500

    • In a list

      Filter loan_id that is in a list of 345 and 567: /loans/list/?loan_id[]=345&loan_id[]=567

  • Sort by

    Sort loan_id in ascending order: /loans/list/?sort_by=+loan_id which is the default and it is equivalent to /loans/list/?sort_by=loan_id

    Sort loan_id in descending order: /loans/list/?sort_by=-loan_id

    Sort closing_date in descending order and loan_id in descending order: /loans/list/?sort_by=-closing_date,-loan_id

  • Pagination: start

    API will return the first 50 records. In the response, there is a next field indicates the next batch should start with

    e.g. The response after this request: /loans/list

    { "next": 50, "result": { "loans": [ {...loan#1}, {...loan#2}, ... ] } }

    To get the next 50 loans: /loans/list/?start=50

    If next does not exist in the response, it means there is no next page.

Recently Updated or Created Entities #

To get recently updated loans: /updated_loans/list

An acknowledged token will be given in the response. e.g.

{ "count": 2, "acknowledged": "token", "result": { "loans": [{"loan_id": 111}, {"loan_id": 222}] } }

You have to follow this by an acknowledge request to tell MA that the updated / created loans are recognized by you. e.g.

URL: /updated_loans/ack with the JSON POST request body:

{"acknowledge": "token"}

The response looks like:

{ "count": 0, "acknowledged": 41, "result": { "loans": [] } }

Updated / Created entity items that are not acknowledged by the lender beyond 48 hours will be purged.

This List and Acknowledge mechanism provides a way for lenders to synchronize changes from MA to other platforms.

The following entities support this feature

Legacy method to get recently updated or created entities

Use URL parameter filter=updated or filter=created to list recently updated or created items. For example, /loans/list?filter=updated

An acknowledged token will be given in the response. e.g.

{ "count": 2, "acknowledged": "token", "result": { "loans": [{...loan#1}, {...loan#2}] } }

You have to make another List - Acknowledge request using the previously given acknowledge token to tell MA that the updated / created loans are recognized by you. e.g.

URL: /loans/list with the JSON POST request body:

{"acknowledge": "token"}

The response looks like:

{ "count": 0, "acknowledged": 41, "result": { "loans": [] } }

The following entities support this feature

  • Loans - List API
Deferred Data Loading #

Deferred Data Loading (defer_link and defer_params)

Some parts of a returned record can contain a very large number of fields (for example, Loans).

To keep responses lightweight and performant, our API uses a deferred loading mechanism.

Instead of returning all possible fields for these subnodes in the main response, the API includes only a subset of commonly used fields

Alongside these, we provide special pair of properties called defer_link and defer_params

How defer_link and defer_params work

● When you query an endpoint, you will see certain subnodes represented in two parts:

      a.Inline fields: A limited set of key properties that are immediately useful.

      b.defer_link: A URL you can call while passing defer_params in the request body, to retrieve the full details for that subnode, including:

          ▪ All inline fields (for consistency).

          ▪ Additional fields that are not included in the main mortgage response.

This design keeps the initial payload small while giving you the flexibility to fetch detailed information only when you need it.

Loans
get

POST: {ENDPOINT}/loans/get

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
Numeric
No
No
response_field_whitelist
 
Response Field Whitelist
If defined, the loan will be returned with those fields only.
Array
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
Numeric
No
No
loan_seq_id
 
Loan Sequence ID
Numeric
No
No
x_loan_id
 
External Loan ID
Text
No
Yes
gsid
 
GS ID
Numeric
No
No
loan_title
 
Loan Title
Text
No
No
loan_title_x
 
Loan Title Reference
Loan title from the original import source
Text
No
Yes
status
 
Loan Status
0 - In Progress
1 - Funded
2 - Discharged
3 - Terminated
Enum
No
No
substatus
 
Loan Substatus
Choose a loan substatus in Settings > Loan Substatuses.
Enum
No
Yes
purpose
 
Loan Type under Commitment Details
0 - Refinance/ETO
1 - Purchase
Enum
No
No
purpose_text
 
Loan Purpose Description
Text
No
No
creation_date
 
Loan Creation Date
Unix timestamp integer: number of seconds since Jan 01, 1970 in GMT/UTC timezone
Timestamp
No
No
closing_date
 
Date of Advance
Unix timestamp integer: number of seconds since Jan 01, 1970 in GMT/UTC timezone
Timestamp
No
Yes
deadline_to_accept_date
 
Deadline to Accept Loan Date
Unix timestamp integer: number of seconds since Jan 01, 1970 in GMT/UTC timezone
Timestamp
No
Yes
property
 
Main Property
Refer to Properties->get
Properties
No
No
other_properties
 
Other Properties
Refer to Properties->list()
List-Properties
No
No
mortgage
 
Mortgage/Loan Info
Refer to Mortgages->get
Mortgages
No
No
existing_mortgages
 
Existing Mortgages
Refer to ExistingMortgages->list()
List-Existing Mortgages
No
No
borrowers
 
Borrowers
Refer to Borrowers->list
List-Borrowers
No
No
investors
 
Investors
Refer to Investors->list
List-Investors
No
No
roles
 
Roles
Refer to Roles->list
List-Roles
No
No
servicer
 
Servicers
Refer to Investors->list
Investors
No
No
down_payments
 
Down Payment Sources
Refer to Downpayments->list
List-Downpayments
No
No
multi_pieces
 
List of Multi-pieces
Refer to Multipieces->list
List-Multi Pieces
No
No
broker_staff
 
Broker Staff
Refer to Brokerstaff->get
Broker Staff
No
No
importedbrokeroriginalxml
 
Broker Original Imported XML
Text
No
No
broker_staff_cheque
 
Broker Staff Cheque
Refer to Brokerstaffcheque->get
Broker Staff Cheques
No
No
eft_name
 
PAD > Account Name
Text
No
No
eft_transit
 
PAD > Branch / Transit
Text
No
Yes
eft_account
 
PAD > Account
Text
No
Yes
eft_account_type
 
PAD > Account Type
0 - Checking
1 - Savings
2 - Loan Account
For US only. Default 0 (Checking).
0: Checking
1: Savings
Enum
No
No
eft_bank_id
 
PAD > Institution
Not applicable for US
Numeric
No
Yes
eft_target
 
Deposit to
Payment Method > PAD form to be signed > Deposit To
Numeric
No
Yes
property_tax_lender_pays
 
Whether lender pays the main property's property tax
1: Lender pays; 0: otherwise
Numeric
No
Yes
condo_fees_lender_pays
 
Whether lender pays the main property's condo fee
1: Lender pays; 0: otherwise
Numeric
No
Yes
site_inspection_mode
 
Site Inspection Mode
Site inspection mode for main property. Default Company Settings > Valuation Mode.
0: n/a
1: Inspection
2: Appraisal
3: Both
Numeric
No
No
site_inspection_fee
 
Site Inspection Fee
When Site Inspection Mode is Inspection (1)
Numeric
No
No
site_inspection_no_charge_to_borrower
 
Whether site inspection fee charges to borrower
Numeric
No
No
appraisal_type
 
Appraisal Type
0 - Appraisal
1 - Municipal Assessment
2 - Contract of Purchase and Sale
4 - Internal
3 - Other
Site Inspection / Appraisal > Primary property > Appraisal > Valuation Type
Enum
No
Yes
appraisal_fee
 
Appraisal Fee
When Site Inspection Mode is Appraisal (2)
Numeric
No
No
appraisal_no_charge_to_borrower
 
Whether appraisal fee charges to borrower
Numeric
No
No
municipal_assessment_year
 
Year of Assessment
When Site Inspection Mode is Appraisal (2), and Appraisal Type is Municipal Assessment (1)
Text
No
Yes
other_valuation_description
 
Other Valuation Description
When Site Inspection Mode is Appraisal (2), and Appraisal Type is Other (3)
Text
No
Yes
valuation_current_date
 
Appraisal Current as of Date
When Site Inspection Mode is Appraisal (2)
Numeric
No
Yes
investor_funding_mode
 
Investor Funding Mode
When Loan Type is Construction (1) or Fix & Flip (3), Investors > Funding Mode can be specified
0: investors contribute to each advance/draw
1: investors contribute to total facility upfront
Numeric
No
No
projected_value
 
Projected Value
When Loan Type is Construction (1)
Numeric
No
Yes
repair_cost
 
Repair Cost
When Loan Type is Fix & Flip (3)
Numeric
No
Yes
land_value
 
Land Value
When Loan Type is Construction (1)
Numeric
No
Yes
closing_costs
 
Closing Costs
Numeric
No
No
closing_direct
 
Closing Costs: Borrower pays directly
Numeric
No
No
deposit_fee
 
Fees > Deposit
Numeric
No
Yes
deposit_collect_date
 
Deposit fee Collect Date
When alphamodule Payment out of Closing is not enabled
Timestamp
No
Yes
seller_name
 
Seller Name
Text
No
Yes
title_company_number
 
GF Number
Text
No
Yes
title_company
 
Title Company
Title Companies
No
No
title_company_staff
 
Title Company Staff
Title Company Staff
No
No
pay_directly_to_investor
 
Payment Method is Post-dated cheques > Paid directly to investor
Default 0.
0: Not paid directly to investor
1: Paid directly to investor
Numeric
No
No
lawyer_fee_lender
 
Lender Lawyer Fee
Numeric
No
No
propertyjurisdiction
 
Jurisdiction
Text
No
Yes
subdivision_subsection
 
Property Subdivision / Sub section
Text
No
Yes
lawyer_staff_lender
 
Lender Lawyer Staff
Lawyer Staff
No
No
lawyer_staff_borrower
 
Borrower Lawyer Staff
Lawyer Staff
No
No
appraiser_staff
 
Appraiser Staff
Appraiser Staff
No
No
conditions
 
Conditions
List-Loan Conditions
No
No
accompanying_documents
 
Accompanying Documents
List-Document Categories
No
No
document_categories
 
Document Categories
List-Document Categories
No
No
notes
 
Notes
List-Loan Note
No
No
custom_fields
 
Custom Fields
Array
No
No
propertylronum
 
Property LRO Number
Numeric
No
Yes
propertypin
 
Property Pin Head
Text
No
Yes
propertypintail
 
Property Pin Tail
Text
No
Yes
stdchargetermsfilenumber
 
Standard Charge Terms File Number
Text
No
Yes
propertyestate
 
Property Estate
Numeric
No
Yes
xpropertyid
 
External Property ID
Text
No
Yes
loaninterestadjustmentdate
 
Interest Adjustment Date
Numeric
No
Yes
loanlastpaymentdate
 
Last Payment Date
Numeric
No
Yes
loanpaymentamountpercycle
 
Payment Amount Cycle
Numeric
No
Yes
report_fields
 
Report Fields
Array
No
No
dry_run
 
Dry Run
Field used for debugging purposes internally.
Numeric
No
Yes
debug
 
debug
internal purpose
Text
No
No
propertytaxid
 
Property Tax ID
Text
No
Yes
document_upload_url
 
Document Upload Portal URL
A pre-generated link redirecting the user to the secure document upload portal.
Text
No
Yes
propertyisnewhomewarranty
 
Property is New Home Warranty
Numeric
No
Yes
create

POST: {ENDPOINT}/loans/create

Borrower Deduplication

  • A borrower is considered a duplicate if any of the following conditions is met:

    1. SIN and Date of Birth are the same.
    2. Email, First Name and Last Name are the same.
    3. External Borrower ID x_borrower_id is the same
    4. Borrower Corporation Name corpname is the same and Borrower is a corporation iscorporation is greater than 0.

  • If a borrower is a duplicate,

    • The provided borrower will not be created again.
    • The existing borrower will be associated with the newly created loan.
    • The existing borrower will not be updated.

Title Company and Title Company Staff Deduplication

  • A title company staff is considered a duplicate if any of the following conditions is met:

    1. External Title Company Staff ID x_staff_id is the same.
    2. Title Company Name Title Companies->name, Title Company Staff's Email email, First Name first_name and Last Name last_name are the same.

  • If a Title Company Staff is a duplicate,

    • The provided Title Company and Title Company Staff will not be created again.
    • The existing Title Company Staff will be associated with the newly created loan.
    • The existing Title Company and Title Company Staff will not be updated
Field
Description
Type
Required
Nullable
response_field_whitelist
 
Response Field Whitelist
If defined, the created loan will be returned with those fields only.
Array
No
Yes
loan_id
 
Loan ID
Numeric
No
No
loan_seq_id
 
Loan Sequence ID
Numeric
No
No
x_loan_id
 
External Loan ID
Text
No
Yes
gsid
 
GS ID
Numeric
No
No
loan_title
 
Loan Title
Text
No
No
loan_title_x
 
Loan Title Reference
Loan title from the original import source
Text
No
Yes
status
 
Loan Status
0 - In Progress
1 - Funded
2 - Discharged
3 - Terminated
Enum
No
No
substatus
 
Loan Substatus
Choose a loan substatus in Settings > Loan Substatuses.
Enum
No
Yes
purpose
 
Loan Type under Commitment Details
0 - Refinance/ETO
1 - Purchase
Enum
No
No
purpose_text
 
Loan Purpose Description
Text
No
No
creation_date
 
Loan Creation Date
Unix timestamp integer: number of seconds since Jan 01, 1970 in GMT/UTC timezone
Timestamp
No
No
closing_date
 
Date of Advance
Unix timestamp integer: number of seconds since Jan 01, 1970 in GMT/UTC timezone
Timestamp
No
Yes
deadline_to_accept_date
 
Deadline to Accept Loan Date
Unix timestamp integer: number of seconds since Jan 01, 1970 in GMT/UTC timezone
Timestamp
No
Yes
property
 
Main Property
Refer to Properties->get
Properties
No
No
other_properties
 
Other Properties
Refer to Properties->list()
List-Properties
No
No
mortgage
 
Mortgage/Loan Info
Refer to Mortgages->get
Mortgages
No
No
existing_mortgages
 
Existing Mortgages
Refer to ExistingMortgages->list()
List-Existing Mortgages
No
No
borrowers
 
Borrowers
Refer to Borrowers->list
List-Borrowers
No
No
investors
 
Investors
Refer to Investors->list
List-Investors
No
No
roles
 
Roles
Refer to Roles->list
List-Roles
No
No
down_payments
 
Down Payment Sources
Refer to Downpayments->list
List-Downpayments
No
No
multi_pieces
 
List of Multi-pieces
Refer to Multipieces->list
List-Multi Pieces
No
No
broker_staff
 
Broker Staff
Refer to Brokerstaff->get
Broker Staff
No
No
importedbrokeroriginalxml
 
Broker Original Imported XML
Text
No
No
broker_staff_cheque
 
Broker Staff Cheque
Refer to Brokerstaffcheque->get
Broker Staff Cheques
No
No
eft_name
 
PAD > Account Name
Text
No
No
eft_transit
 
PAD > Branch / Transit
Text
No
Yes
eft_account
 
PAD > Account
Text
No
Yes
eft_account_type
 
PAD > Account Type
0 - Checking
1 - Savings
2 - Loan Account
For US only. Default 0 (Checking).
0: Checking
1: Savings
Enum
No
No
eft_bank_id
 
PAD > Institution
Not applicable for US
Numeric
No
Yes
eft_target
 
Deposit to
Payment Method > PAD form to be signed > Deposit To
Numeric
No
Yes
property_tax_lender_pays
 
Whether lender pays the main property's property tax
1: Lender pays; 0: otherwise
Numeric
No
Yes
condo_fees_lender_pays
 
Whether lender pays the main property's condo fee
1: Lender pays; 0: otherwise
Numeric
No
Yes
site_inspection_mode
 
Site Inspection Mode
Site inspection mode for main property. Default Company Settings > Valuation Mode.
0: n/a
1: Inspection
2: Appraisal
3: Both
Numeric
No
No
site_inspection_fee
 
Site Inspection Fee
When Site Inspection Mode is Inspection (1)
Numeric
No
No
site_inspection_no_charge_to_borrower
 
Whether site inspection fee charges to borrower
Numeric
No
No
appraisal_type
 
Appraisal Type
0 - Appraisal
1 - Municipal Assessment
2 - Contract of Purchase and Sale
4 - Internal
3 - Other
Site Inspection / Appraisal > Primary property > Appraisal > Valuation Type
Enum
No
Yes
appraisal_fee
 
Appraisal Fee
When Site Inspection Mode is Appraisal (2)
Numeric
No
No
appraisal_no_charge_to_borrower
 
Whether appraisal fee charges to borrower
Numeric
No
No
municipal_assessment_year
 
Year of Assessment
When Site Inspection Mode is Appraisal (2), and Appraisal Type is Municipal Assessment (1)
Text
No
Yes
other_valuation_description
 
Other Valuation Description
When Site Inspection Mode is Appraisal (2), and Appraisal Type is Other (3)
Text
No
Yes
valuation_current_date
 
Appraisal Current as of Date
When Site Inspection Mode is Appraisal (2)
Numeric
No
Yes
investor_funding_mode
 
Investor Funding Mode
When Loan Type is Construction (1) or Fix & Flip (3), Investors > Funding Mode can be specified
0: investors contribute to each advance/draw
1: investors contribute to total facility upfront
Numeric
No
No
projected_value
 
Projected Value
When Loan Type is Construction (1)
Numeric
No
Yes
repair_cost
 
Repair Cost
When Loan Type is Fix & Flip (3)
Numeric
No
Yes
land_value
 
Land Value
When Loan Type is Construction (1)
Numeric
No
Yes
closing_costs
 
Closing Costs
Numeric
No
No
closing_direct
 
Closing Costs: Borrower pays directly
Numeric
No
No
deposit_fee
 
Fees > Deposit
Numeric
No
Yes
deposit_collect_date
 
Deposit fee Collect Date
When alphamodule Payment out of Closing is not enabled
Timestamp
No
Yes
seller_name
 
Seller Name
Text
No
Yes
title_company_number
 
GF Number
Text
No
Yes
title_company
 
Title Company
Title Companies
No
No
title_company_staff
 
Title Company Staff
Title Company Staff
No
No
pay_directly_to_investor
 
Payment Method is Post-dated cheques > Paid directly to investor
Default 0.
0: Not paid directly to investor
1: Paid directly to investor
Numeric
No
No
lawyer_fee_lender
 
Lender Lawyer Fee
Numeric
No
No
propertyjurisdiction
 
Jurisdiction
Text
No
Yes
subdivision_subsection
 
Property Subdivision / Sub section
Text
No
Yes
lawyer_staff_lender
 
Lender Lawyer Staff
Lawyer Staff
No
No
appraiser_staff
 
Appraiser Staff
Appraiser Staff
No
No
conditions
 
Conditions
List-Loan Conditions
No
No
accompanying_documents
 
Accompanying Documents
List-Document Categories
No
No
document_categories
 
Document Categories
List-Document Categories
No
No
notes
 
Notes
List-Loan Note
No
No
custom_fields
 
Custom Fields
Array
No
No
propertylronum
 
Property LRO Number
Numeric
No
Yes
propertypin
 
Property Pin Head
Text
No
Yes
propertypintail
 
Property Pin Tail
Text
No
Yes
stdchargetermsfilenumber
 
Standard Charge Terms File Number
Text
No
Yes
propertyestate
 
Property Estate
Numeric
No
Yes
xpropertyid
 
External Property ID
Text
No
Yes
loaninterestadjustmentdate
 
Interest Adjustment Date
Numeric
No
Yes
loanlastpaymentdate
 
Last Payment Date
Numeric
No
Yes
loanpaymentamountpercycle
 
Payment Amount Cycle
Numeric
No
Yes
dry_run
 
Dry Run
Field used for debugging purposes internally.
Numeric
No
Yes
debug
 
debug
internal purpose
Text
No
No
propertytaxid
 
Property Tax ID
Text
No
Yes
document_upload_url
 
Document Upload Portal URL
A pre-generated link redirecting the user to the secure document upload portal.
Text
No
Yes
propertyisnewhomewarranty
 
Property is New Home Warranty
Numeric
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
loan
 
The newly created loan
Refer to Loans->get
Loans
No
No
list

POST: {ENDPOINT}/loans/list

Changes

  • Version 2

    • Return Loan ID's only.

      e.g. { "count": 2, "result": { "loans": [{"loan_id": 111}, {"loan_id": 222}] } }

      Use /loans/get to get full information of a loan.

  • Version 1

    • Return Loans with full sub entities e.g. Borrowers in full detail
Field
Description
Type
Required
Nullable
acknowledge
 
Acknowledge Token
If provided, the changes of previously returned loans (using filter=updated|created) are acknowledged. No loan will be returned
Text
No
No
response_field_whitelist
 
Response Field Whitelist
If defined, the loan will be returned with those fields only.
Array
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
loans
 
List of loans
Refer to Loans->get
List-Loans
No
No
attach

POST: {ENDPOINT}/loans/attach

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
Numeric
No
No
borrower_loan
 
Borrower Loan Relation
If provided, the borrower will be attached to the loan
Borrower Loans
No
No
broker_staff_loan
 
Broker Staff Loan Relation
If provided, the Broker Staff will be attached to the loan
Broker Staff Loans
No
No
file_loan
 
File Loan
If provided, the loan file will be attached to the loan
File Loans
No
No
investor_loan
 
Investor Loan Relation
If provided, the investor will be attached to the loan
Investor Loans
No
No

Response Fields

Field
Description
Type
Required
Nullable
loan
 
The updated loan
Refer to Loan->get
Loans
No
No
update

POST: {ENDPOINT}/loans/update

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
Numeric
No
No
loan_seq_id
 
Loan Sequence ID
Numeric
No
No
x_loan_id
 
External Loan ID
Text
No
Yes
gsid
 
GS ID
Numeric
No
No
loan_title
 
Loan Title
Text
No
No
loan_title_x
 
Loan Title Reference
Loan title from the original import source
Text
No
Yes
substatus
 
Loan Substatus
Choose a loan substatus in Settings > Loan Substatuses.
Enum
No
Yes
purpose
 
Loan Type under Commitment Details
0 - Refinance/ETO
1 - Purchase
Enum
No
No
purpose_text
 
Loan Purpose Description
Text
No
No
creation_date
 
Loan Creation Date
Unix timestamp integer: number of seconds since Jan 01, 1970 in GMT/UTC timezone
Timestamp
No
No
closing_date
 
Date of Advance
Unix timestamp integer: number of seconds since Jan 01, 1970 in GMT/UTC timezone
Timestamp
No
Yes
deadline_to_accept_date
 
Deadline to Accept Loan Date
Unix timestamp integer: number of seconds since Jan 01, 1970 in GMT/UTC timezone
Timestamp
No
Yes
down_payments
 
Down Payment Sources
Refer to Downpayments->list
List-Downpayments
No
No
eft_name
 
PAD > Account Name
Text
No
No
eft_transit
 
PAD > Branch / Transit
Text
No
Yes
eft_account
 
PAD > Account
Text
No
Yes
eft_account_type
 
PAD > Account Type
0 - Checking
1 - Savings
2 - Loan Account
For US only. Default 0 (Checking).
0: Checking
1: Savings
Enum
No
No
eft_bank_id
 
PAD > Institution
Not applicable for US
Numeric
No
Yes
eft_target
 
Deposit to
Payment Method > PAD form to be signed > Deposit To
Numeric
No
Yes
property_tax_lender_pays
 
Whether lender pays the main property's property tax
1: Lender pays; 0: otherwise
Numeric
No
Yes
condo_fees_lender_pays
 
Whether lender pays the main property's condo fee
1: Lender pays; 0: otherwise
Numeric
No
Yes
site_inspection_mode
 
Site Inspection Mode
Site inspection mode for main property. Default Company Settings > Valuation Mode.
0: n/a
1: Inspection
2: Appraisal
3: Both
Numeric
No
No
site_inspection_fee
 
Site Inspection Fee
When Site Inspection Mode is Inspection (1)
Numeric
No
No
site_inspection_no_charge_to_borrower
 
Whether site inspection fee charges to borrower
Numeric
No
No
appraisal_type
 
Appraisal Type
0 - Appraisal
1 - Municipal Assessment
2 - Contract of Purchase and Sale
4 - Internal
3 - Other
Site Inspection / Appraisal > Primary property > Appraisal > Valuation Type
Enum
No
Yes
appraisal_fee
 
Appraisal Fee
When Site Inspection Mode is Appraisal (2)
Numeric
No
No
appraisal_no_charge_to_borrower
 
Whether appraisal fee charges to borrower
Numeric
No
No
municipal_assessment_year
 
Year of Assessment
When Site Inspection Mode is Appraisal (2), and Appraisal Type is Municipal Assessment (1)
Text
No
Yes
other_valuation_description
 
Other Valuation Description
When Site Inspection Mode is Appraisal (2), and Appraisal Type is Other (3)
Text
No
Yes
valuation_current_date
 
Appraisal Current as of Date
When Site Inspection Mode is Appraisal (2)
Numeric
No
Yes
investor_funding_mode
 
Investor Funding Mode
When Loan Type is Construction (1) or Fix & Flip (3), Investors > Funding Mode can be specified
0: investors contribute to each advance/draw
1: investors contribute to total facility upfront
Numeric
No
No
projected_value
 
Projected Value
When Loan Type is Construction (1)
Numeric
No
Yes
repair_cost
 
Repair Cost
When Loan Type is Fix & Flip (3)
Numeric
No
Yes
land_value
 
Land Value
When Loan Type is Construction (1)
Numeric
No
Yes
closing_costs
 
Closing Costs
Numeric
No
No
closing_direct
 
Closing Costs: Borrower pays directly
Numeric
No
No
deposit_fee
 
Fees > Deposit
Numeric
No
Yes
deposit_collect_date
 
Deposit fee Collect Date
When alphamodule Payment out of Closing is not enabled
Timestamp
No
Yes
seller_name
 
Seller Name
Text
No
Yes
title_company_number
 
GF Number
Text
No
Yes
pay_directly_to_investor
 
Payment Method is Post-dated cheques > Paid directly to investor
Default 0.
0: Not paid directly to investor
1: Paid directly to investor
Numeric
No
No
lawyer_fee_lender
 
Lender Lawyer Fee
Numeric
No
No
propertyjurisdiction
 
Jurisdiction
Text
No
Yes
subdivision_subsection
 
Property Subdivision / Sub section
Text
No
Yes
document_categories
 
Document Categories
List-Document Categories
No
No
notes
 
Notes
List-Loan Note
No
No
property
 
Main Property for Loan Update
Main Property for Loan Update
No
No
other_properties
 
Other Property for Loan Update
List-Other Properties
No
No
loan_note_for_loan_update
 
A list of loan notes for Loan Update
List-Loan Note for Loan Update
No
No
mortgage
 
Mortgage/Loan Info/Term Sheet/Commitment Details
Mortgage for Loan Update
No
No
custom_fields
 
Custom Fields
Array
No
No
propertylronum
 
Property LRO Number
Numeric
No
Yes
propertypin
 
Property Pin Head
Text
No
Yes
propertypintail
 
Property Pin Tail
Text
No
Yes
stdchargetermsfilenumber
 
Standard Charge Terms File Number
Text
No
Yes
propertyestate
 
Property Estate
Numeric
No
Yes
xpropertyid
 
External Property ID
Text
No
Yes
loaninterestadjustmentdate
 
Interest Adjustment Date
Numeric
No
Yes
loanlastpaymentdate
 
Last Payment Date
Numeric
No
Yes
loanpaymentamountpercycle
 
Payment Amount Cycle
Numeric
No
Yes
dry_run
 
Dry Run
Field used for debugging purposes internally.
Numeric
No
Yes
debug
 
debug
internal purpose
Text
No
No
propertytaxid
 
Property Tax ID
Text
No
Yes
document_upload_url
 
Document Upload Portal URL
A pre-generated link redirecting the user to the secure document upload portal.
Text
No
Yes
propertyisnewhomewarranty
 
Property is New Home Warranty
Numeric
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
loan
 
The updated loan
Refer to Loan->get
Loans
No
No
Updated Loans
get

POST: {ENDPOINT}/updated_loans/get

Gives one loan per request until there's no left loan has changed. Request params can have either

  • substatus_changed_to field alone, which returns loans that have changed to a given Substatus

  • updated_field field alone or updated_field & updated_to fields together. updated_field corresponds to the field name e.g. status. updated_to field corresponds to the value of the field it has been updated to.

Field
Description
Type
Required
Nullable
updated_field
 
Updated Field
The Recently Updated Loan(s) filtered out by the loan changes for the field specified on this request field.For eg - substatus gives all recent loans whose substatus has be update/changed.
Text
No
Yes
updated_to
 
Updated To
The Recently Updated Loan(s) filtered out by the loan changes for the field value specified on this request field.(Note - to be used along with the updated_field request parameter)
Text
No
Yes
_zap_static_hook_code
 
Zap Static Hook Code
This is a field for recording static hook code from Zapier triggers.
Text
No
Yes
substatus_changed_to
 
substatus changed to
The Recently Updated Loan(s) whose substatus has been changed to the provided value.
Text
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
Recently Updated Loan
Numeric
No
No
timestamp
 
Timestamp
Numeric
No
No
list

POST: {ENDPOINT}/updated_loans/list

Field
Description
Type
Required
Nullable

Response Fields

Field
Description
Type
Required
Nullable
loans
 
List of updated loans
Refer to Loans->get
List-Updated Loans
No
No
ack

POST: {ENDPOINT}/updated_loans/ack

Field
Description
Type
Required
Nullable
acknowledge
 
Acknowledge Token
Recently updated loans specified in the token will be acknowledged. No loan will be returned
Text
No
No

Response Fields

Field
Description
Type
Required
Nullable
loans
 
List of updated loans
Refer to Loans->get
List-Updated Loans
No
No
Created Loans
get

POST: {ENDPOINT}/created_loans/get

Field
Description
Type
Required
Nullable

Response Fields

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
Numeric
No
No
list

POST: {ENDPOINT}/created_loans/list

Field
Description
Type
Required
Nullable

Response Fields

Field
Description
Type
Required
Nullable
loans
 
List of created loans
Refer to Loans->get
List-Created Loans
No
No
ack

POST: {ENDPOINT}/created_loans/ack

Field
Description
Type
Required
Nullable
acknowledge
 
Acknowledge Token
Recently created loans specified in the token will be acknowledged. No loan will be returned
Text
No
No

Response Fields

Field
Description
Type
Required
Nullable
loans
 
List of updated loans
Refer to Loans->get
List-Created Loans
No
No
Borrower Loans
get

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable

Response Fields

Field
Description
Type
Required
Nullable
borrower_id
 
Borrower ID
Numeric
No
No
loan_id
 
Loan ID
Numeric
No
No
is_guarantor
 
Borrower is a guarantor of a loan
0: Borrower, 1: Guarantor
Numeric
No
No
is_main_client
 
Borrower is the main borrower of a loan
0: Not Main, 1: Main
Numeric
No
No
Broker Staff Loans
get

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable

Response Fields

Field
Description
Type
Required
Nullable
broker_staff_id
 
Broker Staff ID
Numeric
No
No
cheque_id
 
Broker Staff Cheque ID
Broker Staff cheque ID of Brokerstaff
Numeric
No
No
File Loans
get

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable

Response Fields

Field
Description
Type
Required
Nullable
url
 
Loan File URL
Publicly accessible URL of the loan file to be uploaded
Text
No
No
document_category_id
 
Document Category ID
Document Category ID associated to Loan File
Numeric
No
No
Investor Loans
get

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable

Response Fields

Field
Description
Type
Required
Nullable
account_id
 
Investorcheck ID
Payment account ID of the Investor
Numeric
No
No
amount
 
Investment Amount
Numeric
No
No
rate_type
 
Rate Type

0 - Full variable rate
1 - Partial variable rate
2 - Fixed rate
Numeric
No
No
interest
 
Interest Rate
Numeric
No
No
rate_delta
 
Rate Delta
Numeric
No
No
min_rate
 
Minimum Interest Rate
Numeric
No
No
standby_amount
 
Standby Amount
Numeric
No
No
rest_rate
 
Investment Rest Rate
Numeric
No
No
enable_escalating_rate
 
Enable Escalating Rate
If escalating rate is enabled or not
Numeric
No
No
escalating_cycles
 
Escalating Cycles
Number of months after which escalating rate applies.
Numeric
No
No
escalating_rate
 
Escalating Rate
Numeric
No
No
on_title
 
On Title
Numeric
No
No
enable_withhold_tax
 
Enable Withold Tax
Numeric
No
No
withhold_tax
 
Withold Tax
Numeric
No
No
iad_style
 
Investor Iad Style
Enum
No
Yes
interest_method
 
Investor Interest Method
0 - equal amount
1 - per-diem based
2 - 31/360
3 - 360/365
4 - actual/360
6 - 30/360 Special
7 - 30/360 US
5 - decide on a loan by loan basis
Enum
No
No
is_residual
 
Is Residual
Numeric
No
No
Properties
get

POST: {ENDPOINT}/properties/get

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
If provided, response is the loan's main property
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
property_id
 
Property ID
Property ID (Only available for other properties)
Numeric
No
No
address
 
Address
Refer to Addresses->get
Addresses
No
No
otherexpenses
 
Other expenses
Refer to Otherexpenses->list .NB- Applicable only for Other Properties
List-Other Expenses
No
No
positions
 
Positions
Refer to Positions->list .NB- Applicable only for Other Properties
List-Positions
No
No
value
 
Property value
Numeric
No
Yes
insurances
 
Insurances
Refer to Insurances->list
List-Insurances
No
No
property_tax
 
Property annual tax amount
Numeric
No
Yes
property_tax_monthly
 
Property tax recurring top-up amount
Numeric
No
Yes
property_tax_holdback
 
Property tax initial holdback/reserve amount - legacy
Numeric
No
No
property_tax_monthly_holdback
 
Property Tax Top-up Prepayment/Reserve per loan
Numeric
No
Yes
property_tax_url
 
Property tax URL
Text
No
Yes
property_tax_id
 
Property tax ID
Text
No
Yes
condo_fees
 
Property monthly condo fee amount
Numeric
No
Yes
heating_fees
 
Property monthly heating fee amount
Numeric
No
No
property_built_date
 
Property built on this date
Unix timestamp integer: number of seconds since Jan 01, 1970 in GMT/UTC timezone
Timestamp
No
Yes
lot_size
 
Property Lot Size
Text
No
No
lot_size_unit
 
Property Lot Size Unit
0 - Sq Feet
1 - Ac
2 - Sq Meters
Enum
No
Yes
living_space
 
Property Living Space
Text
No
Yes
living_space_unit
 
Property Living Space Unit
0 - Sq Feet
1 - Ac
2 - Sq Meters
Enum
No
Yes
rental_income
 
Property Monthly Rental Income
Numeric
No
Yes
legal
 
Property Legal Description
Text
No
Yes
occupancy
 
Property Occupancy Type
0 -
1 - Owner-Occupied
2 - Rental
3 - Owner-Occupied/Tenanted
4 - Second Home
5 - Vacant
Enum
No
No
tenure
 
Property Tenure Type
0 -
1 - Freehold
2 - Leasehold
3 - Condo
4 - Co-Op
Enum
No
No
property_type
 
Property Type
1 - Detached
2 - Semi-Detached
3 - Row/Town House
9 - Apartment
7 - Mobile
8 - Stacked
4 - Commercial
6 - Land
11 - Condo
0 - Other
Enum
No
Yes
property_type_other_description
 
Other Property Type Description
Text
No
No
property_entry_details
 
Property Entry Details
Text
No
Yes
municipal_assessment_year
 
Municipal Assessment Year
Text
No
Yes
propertyjurisdiction
 
Jurisdiction
Text
No
Yes
subdivision_subsection
 
Subdivision/Subsection
Text
No
Yes
propertylronum
 
Property LRO Number
Numeric
No
Yes
propertypin
 
Property Pin Head
Text
No
Yes
propertypintail
 
Property Pin Tail
Text
No
Yes
propertyestate
 
Property Estate
Numeric
No
Yes
xpropertyid
 
External Property ID
Numeric
No
Yes
purchase_price
 
Property Purchase Price
Numeric
No
Yes
repair_cost
 
Property Repair Cost
Numeric
No
Yes
appraised_date
 
Property Appraised Date
Unix timestamp integer: number of seconds since Jan 01, 1970 in GMT/UTC timezone
Numeric
No
Yes
layout
 
Property Layout Type
0 - Empty. For loan types: Standard (0), Construction (1), Commercial (2), Fix & Flip (3), Personal (4)
1 - Single Family. For loan types: Standard (0), Construction (1), Fix & Flip (3), Personal (4)
6 - Multi Family
2 - Duplex. For loan types: Standard (0), Construction (1), Fix & Flip (3), Personal (4)
3 - Tri Plex. For loan types: Standard (0), Construction (1), Fix & Flip (3), Personal (4)
4 - Four Plex. For loan types: Standard (0), Construction (1), Fix & Flip (3), Personal (4)
5 - Modular. For loan types: Standard (0), Construction (1), Fix & Flip (3), Personal (4)
11 - Retail. For loan types: Commercial (2)
12 - Hospitality. For loan types: Commercial (2)
13 - Multi Family. For loan types: Standard (0), Construction (1), Fix & Flip (3)
14 - Mixed use. For loan types: Commercial (2)
15 - Office. For loan types: Commercial (2)
16 - Assisted living. For loan types: Commercial (2)
17 - Medical. For loan types: Commercial (2)
18 - Light Industrial. For loan types: Commercial (2)
19 - Storage. For loan types: Commercial (2)
20 - Special purpose. For loan types: Commercial (2)
21 - Restaurant. For loan types: Commercial (2)
22 - Land. For loan types: Commercial (2)
23 - Other (fill in Property Description). For loan types: Commercial (2)
Enum
No
Yes
is_blanket
 
Property is blanket
Numeric
No
Yes
amenities
 
Amenities
List-Loan Amenity
No
No
tax_payment_schedules
 
Tax Payment Schedules
List-Tax Payment Schedule
No
No
propertyowners
 
Property Owners
Refer to Property Owners->list
List-Property Owners
No
No
custom_fields
 
Custom Fields
Array
No
No
propertyisnewhomewarranty
 
Property is New Home Warranty
Numeric
No
Yes
list

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
If provided, response is the loan's other properties
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
other_properties
 
List of other properties
Refer to Properties->get
List-Properties
No
No
Mortgages
get

POST: {ENDPOINT}/mortgages/get

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
If provided, response is the loan's mortgage
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
id
 
Mortgage ID
Numeric
No
No
type
 
Loan Type
0 - Standard
1 - Construction
2 - Commercial
3 - Fix & Flip
4 - Personal
Enum
No
No
application_type
 
Application Type
0 - Mortgage
1 - LOC
2 - Bridge
3 - Deed of Trust
4 - Promissory Note
Enum
No
Yes
total
 
Total Facility for Construction Loan Type, Credit Limit for Standard Loan Type with Application Type = Mortgage (1), Total Loan for Fix & Flip Loan Type
Numeric
No
Yes
amount
 
Loan Amount / Initial Advance / Advance at Closing
Loan Amount for Standard Loan Type. Initial Advance for Construction Loan Type or Standard Loan Type with Mortgage Application Type. Advance at Closing for Fix & Flip Loan Type.
Numeric
No
Yes
construction_lien_holdback
 
Lien Holdback Amount for Construction Loan Type
Numeric
No
Yes
construction_lien_holdback_days
 
Lien Holdback Days for Construction Loan Type
Numeric
No
No
standby_interest
 
Standby Interest
Number in percentage e.g. 10.99 stands for 10.99%. Standby Interest for Construction Loan Type. Standby Interest for Fix & Flip Loan Type is set to Interest Rate if 'Construction, Fix & Flip Loans: Charge Interest on Total Facility/Total Loan' is enabled under Company Settings > Optional Loan Fields > Commitment Fields
Numeric
No
Yes
enable_variable_rate
 
Enable Variable Rate
1 to enable, 0 to disable.
Numeric
No
Yes
enable_escalating_rate
 
Initial escalating rate is enabled
1 to enable, 0 to disable.
Numeric
No
No
escalating_rate_starts_in
 
Initial escalating rate starts in how many payment cycles
Numeric
No
No
escalating_rate
 
Initial Escalating Rate
Number in percentage e.g. 10.99 stands for 10.99%.
Numeric
No
Yes
interest
 
Interest Rate
Number in percentage e.g. 10.99 stands for 10.99%. If variable rate is enabled, the interest rate = Primate Rate + {prime_delta} >= {minimum_rate}.
Numeric
No
Yes
rate_index
 
Rate Index
0 - N/A
1 - MCAP
2 - TD
3 - CIBC
4 - RBC
5 - WSJ Prime
8 - Custom CA 2 Enabled
9 - TEST
10 - GG
14 - TEST
15 - TEST2
16 - TEST
18 - SRL TD
19 - Test
21 - Prime Rate
22 - My NEw Index
24 - Capstone Custom
25 - Test Custom Index
26 - RBC
28 - gio's rate
29 - gio's second rate
31 - Custom Index
32 - SOFR
36 - Lan Look Back
38 - BMO
40 - Houze
42 - TEST2
47 - National Bank
51 - WY Test
52 - WSJ
57 - GCMIC Prime
58 - SOFR TEST
65 - Test
66 - DMIC TD Index
67 - Custom
68 - new
70 - yup
71 - no
72 - Adam Custom
73 - EQB
76 - MDV-52646
80 - Custom Index
82 - Custom Decrease
88 - TC
89 - SOFR
90 - Custom Index 2
92 - WSJ Prime
94 - SOFR
95 - Custom Index 2022
97 - Shirkhan's Rate
98 - SOFR
103 - Daria Test
104 - SOFR
105 - Custom
107 - bmo
108 - DONT DELETE !!! Variable rate test class
109 - DONT DELETE !!! Variable rate test class 2
123 - TD (1st of Month)
130 - MyIndex
134 - Camila_test_index
135 - RTIndex
137 - 2 nd cycle
139 - 2 nd cycle and discharge
143 - val_testing
145 - val_testing_2
149 - MDV-22108 Index
150 - Eli's rate
155 - Index 2
157 - Robert Cheung
160 - Gio's index
161 - Gagan
162 - SOFR
163 - Gio's Index
164 - CCC
165 - Hell yeah
167 - BMO
168 - New Index
217 - ABCP- BMO
Enum
No
No
minimum_rate
 
Minimum Rate for Variable Rate Interest
Number in percentage e.g. 10.99 stands for 10.99%.
Numeric
No
Yes
prime_delta
 
Prime Delta for Variable Rate Interest
Number in percentage e.g. 10.99 stands for 10.99%. Default 0 for non-variable-rate interest. Default the same as {interest} rate for variable-rate interest.
Numeric
No
Yes
term_mode
 
Early Termination Type
0 - Fully Closed
1 - Closed Variable
2 - Closed, Then Open
3 - Fully Open
4 - Minimum, Then Open
Not available for Personal Loan Type
Enum
No
No
defaulted_rate
 
Defaulted Rate
Number in percentage e.g. 10.99 stands for 10.99%.
Numeric
No
Yes
interest_method
 
Interest Method
0 - equal amount
1 - per-diem based
2 - 31/360
3 - 360/365
4 - actual/360
6 - 30/360 Special
7 - 30/360 US
5 - decide on a loan by loan basis
Enum
No
Yes
down_payment
 
Total Down Payment Amount
For Loan Purpose = Purchase (1)
Numeric
No
Yes
position
 
Loan Position
1 - First
2 - Second
3 - Third
4 - Fourth
5 - Fifth
6 - Sixth
7 - Seventh
Enum
No
No
term
 
Term Length in months
Numeric
No
No
holdback_amount
 
Holdback / PPI Amount
Default 0.
Numeric
No
Yes
holdback_app_mode
 
Holdback / PPI Deduction Mode
0 - Apply upfront (deferred payments)
1 - Spread evenly
2 - Apply at the end
Enum
No
No
holdback_app_cycle
 
Months to spread holdback over
Months count to spread holdback evenly over.
Cannot be empty if holdback_app_mode = 1 (spread evenly)
Cannot be > 0 if holdback_app_mode != 1 (any other than “spread evenly”)
Numeric
No
Yes
holdback_start_at
 
Holdback starting month
Starting from month number from which holdback over. (Applies only (and only allowed) when holdback_app_mode is 0).
Cannot be empty if holdback_app_mode = 0 (Apply Upfront).
Cannot be > 0 if holdback_app_mode != 0 (any other than “Apply Upfront”).
Numeric
No
Yes
repay_mode
 
Repayment Type
0 - Interest Only / Interest Only Deferred
1 - Principal + Interest
2 - Capitalizing Interest
Default 0.
Enum
No
No
defer_int_pay
 
Defer Interest Payment
Default 0. 1 to defer interest payment.
Numeric
No
No
main_defer_int_pay
 
Defer interest payments until the next advance
Default 0.

0: When {holdback_amount} is specified, “Interest Schedule > charge interest at monthly payment” is enabled. Otherwise, “Interest Schedule > holdback / PPI” is enabled.

1: “Interest Schedule > defer interest payments until the next advance” is enabled.
Numeric
No
No
amort_in_years
 
Amortization in Years
Default 25 in years. If {repay_mode} is Principal Interest (1) and {amort_in_years} is not provided, {amort_yearmonth_years} and {amort_yearmonth_months} combined in years will be the default.
Numeric
No
Yes
amort_yearmonth_years
 
Amortization Years Part in Years/Months
To combine with {amort_yearmonth_months}.
Numeric
No
Yes
amort_yearmonth_months
 
Amortization Months Part in Years/Months
To combine with {amort_yearmonth_years}.
Numeric
No
Yes
amort_compounding
 
Compounding
52 - Weekly
26 - Bi-Weekly
24 - Semi-Monthly
12 - Monthly
4 - Quarterly
2 - Semi-Annually
1 - Annually
Enum
No
No
frequency
 
Payment Frequency
0 - Monthly
1 - Semi-Monthly
2 - Weekly
3 - Bi-Weekly
7 - Quarterly
Default is 0 (Monthly)
Enum
No
Yes
accelerate_payment
 
Accelerate Payment
Default 0. 1 is to enable accelerate payment for {frequency} is Weekly (2) or Bi-Weekly (3)
Numeric
No
No
funding_date
 
Deposit / Funding Date
Timestamp
No
Yes
first_payment_date
 
First Payment Date
Timestamp
No
Yes
closing_date
 
Closing Date
The field is shown if this is enabled: Company Settings > Optional Loan Fields > Investor Section > Different Closing vs. Payout Dates. It's greater than or equal to {funding_date}.
Timestamp
No
Yes
doc_date
 
Doc Date
The field is shown if this is enabled: Company Settings > Optional Loan Fields > Investor Section > Custom Maturity Date.
Timestamp
No
Yes
maturity_date
 
Maturity Date
This field is shown for loans which have been funded and is impacted by any form of extension/renewal
Timestamp
No
Yes
pay_day
 
Borrower Pays on This Day
1 is Day 1. Default is 1.
Timestamp
No
No
pay_day_type
 
Borrower Pay Day Type
0 (default) or 1. 0 means start of each month or from quarterly start. 1 means before month end or from quarter end.

0: Day {pay_day} from quarter start for {frequency} is Quarterly (7)
0: Day {pay_day} of each month for {frequency} is not Quarterly (7)

1: Day {pay_day} from quarter end for {frequency} is Quarterly (7)
1: Day {pay_day} before month end for {frequency} is not Quarterly (7)
Numeric
No
Yes
investor_payout_day
 
Investors Get Paid on: This Day
Default Company Settings > Default Investor Payout Day, {payday} if > 0, or 1
Numeric
No
Yes
investor_payout_day_2
 
Investors Get Paid on: Day {investor_payout_day} and this day
Default {investor_payout_day}. It's shown when {investor_payout_type} is start of quarter/month (0) and {frequency} is Semi-Monthly (1)
Numeric
No
Yes
investor_payout_type
 
Investors Get Paid on Type
Default 0. Investors get paid on 0: Day from start of quarter/month, 1: Day from end of quarter/month, 2: Day from borrower payment date.

0: Day {investor_payout_day} and {investor_payout_day_2} of month following end of quarter for {frequency} is Quarterly (7)
0: Day {investor_payout_day} and {investor_payout_day_2} of each month for {frequency} is not Quarterly (7)

1: Day {investor_payout_day} and {investor_payout_day_2} before month end of month following end of the quarter for {frequency} is Quarterly (7)
1: Day {investor_payout_day} and {investor_payout_day_2} before month end for {frequency} is not Quarterly (7)

2: Day {investor_payout_day} and {investor_payout_day_2} from borrower payment date
Numeric
No
Yes
pay_method
 
Payment Method
0 - PAD
1 - Cheque
3 - Debit
5 - Wire Transfer
9 - Cash
4 - Email Money Transfer
2 - Credit Card
Default 0.
Enum
No
No
early_term_penalty_in_months
 
Early Term. Penalty in Months
Default is Company Settings > Default Settings & Rates > Early Termination Penalty in months. Shown when {term_mode} is Fully Closed (0) and {type} is not Personal (4)
Numeric
No
Yes
early_term_penalty_first_months
 
Early Term. Penalty For the first (in months)
Default 0. Early Term. Type: {term_mode}. For the first {early_term_penalty_first_months} month(s), the penalty will be {early_term_penalty_first_months_amount} month(s)
Numeric
No
Yes
early_term_penalty_first_months_amount
 
Amount for Early Term. Penalty For the first (in months)
Default 0. Early Term. Type: {term_mode}. For the first {early_term_penalty_first_months} month(s), the penalty will be {early_term_penalty_first_months_amount} month(s)
Numeric
No
Yes
early_term_penalty_min_months_then_open
 
Minimum number of month(s) interest earned
for Early Term. Type {term_mode} is 'Minimum, Then Open' (4)
Numeric
No
Yes
early_term_penalty_min_amount_then_open
 
Minimum amount
for Early Term. Type {term_mode} is 'Minimum, Then Open' (4)
Numeric
No
Yes
early_term_penalty_closed_variable_after_months
 
Afterwards, the penalty will be x month(s)
for Early Term. Type {term_mode} is 'Closed Variable' (1)
Numeric
No
Yes
fees
 
Fees
Refer to Fees->get
Fees
No
No
custom_fees
 
Custom Fees
Refer to CustomFees->list
List-Custom Fees
No
No
iad
 
IAD
IAD
Numeric
No
Yes
previewcyclepaymentamount
 
Preview Cycle Payment Amount
Preview Cycle Payment Amount
Numeric
No
Yes
defer_link
 
Defer Link
Public URL to fetch deferred fields (see Defer Params)
Text
No
Yes
defer_params
 
Defer Params
Refer to Defer Params
Array
No
No
Existing Mortgages
get

POST: {ENDPOINT}/existingmortgages/get

Field
Description
Type
Required
Nullable
id
 
Existing Mortgage ID
Numeric
No
No
response_field_whitelist
 
Response Field Whitelist
If defined, the existing mortgage will be returned with those fields only.
Array
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
id
 
Existing Mortgage ID
Numeric
No
No
loan_id
 
Loan ID
Numeric
No
No
type
 
Position / Order
1 - First
2 - Second
3 - Third
4 - Fourth
5 - Fifth
6 - Sixth
7 - Seventh
Enum
No
Yes
holder
 
Holder Name
Text
No
Yes
face_value
 
Face Value
Numeric
No
Yes
balance
 
Balance
Numeric
No
Yes
payment
 
Payment Amount
Numeric
No
No
frequency
 
Payment Frequency
1 - Weekly
2 - Biweekly
0 - Monthly
Enum
No
Yes
maturity_date
 
Maturity Date
Timestamp
No
Yes
rate_type
 
Rate Type
0 -
1 - Fixed
2 - Variable
3 - Adjustable
4 - Capped Variable
5 - Buydown
Enum
No
Yes
term_type
 
Term Type
0 - Fully Closed
1 - Closed Variable
2 - Closed, Then Open
3 - Fully Open
4 - Minimum, Then Open
Enum
No
Yes
interest_rate
 
Interest Rate
Numeric
No
Yes
prepayment_penalty
 
Prepayment Penalty
Numeric
No
Yes
custom_fields
 
Custom Fields
Array
No
No
create

POST: {ENDPOINT}/existingmortgages/create

Field
Description
Type
Required
Nullable
id
 
Existing Mortgage ID
Numeric
No
No
loan_id
 
Loan ID
Numeric
No
No
type
 
Position / Order
1 - First
2 - Second
3 - Third
4 - Fourth
5 - Fifth
6 - Sixth
7 - Seventh
Enum
No
Yes
holder
 
Holder Name
Text
No
Yes
face_value
 
Face Value
Numeric
No
Yes
balance
 
Balance
Numeric
No
Yes
payment
 
Payment Amount
Numeric
No
No
frequency
 
Payment Frequency
1 - Weekly
2 - Biweekly
0 - Monthly
Enum
No
Yes
maturity_date
 
Maturity Date
Timestamp
No
Yes
rate_type
 
Rate Type
0 -
1 - Fixed
2 - Variable
3 - Adjustable
4 - Capped Variable
5 - Buydown
Enum
No
Yes
term_type
 
Term Type
0 - Fully Closed
1 - Closed Variable
2 - Closed, Then Open
3 - Fully Open
4 - Minimum, Then Open
Enum
No
Yes
interest_rate
 
Interest Rate
Numeric
No
Yes
prepayment_penalty
 
Prepayment Penalty
Numeric
No
Yes
custom_fields
 
Custom Fields
Array
No
No

Response Fields

Field
Description
Type
Required
Nullable
existing_mortgage
 
The created ExistingMortgage
Existing Mortgages
No
No
list

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
If provided, response is the loan's existing mortgages
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
existing_mortgages
 
List of existing mortgages
Refer to ExistingMortgages->get
List-Existing Mortgages
No
No
update

POST: {ENDPOINT}/existingmortgages/update

Field
Description
Type
Required
Nullable
id
 
Existing Mortgage ID
Numeric
No
No
loan_id
 
Loan ID
Numeric
No
No
type
 
Position / Order
1 - First
2 - Second
3 - Third
4 - Fourth
5 - Fifth
6 - Sixth
7 - Seventh
Enum
No
Yes
holder
 
Holder Name
Text
No
Yes
face_value
 
Face Value
Numeric
No
Yes
balance
 
Balance
Numeric
No
Yes
payment
 
Payment Amount
Numeric
No
No
frequency
 
Payment Frequency
1 - Weekly
2 - Biweekly
0 - Monthly
Enum
No
Yes
maturity_date
 
Maturity Date
Timestamp
No
Yes
rate_type
 
Rate Type
0 -
1 - Fixed
2 - Variable
3 - Adjustable
4 - Capped Variable
5 - Buydown
Enum
No
Yes
term_type
 
Term Type
0 - Fully Closed
1 - Closed Variable
2 - Closed, Then Open
3 - Fully Open
4 - Minimum, Then Open
Enum
No
Yes
interest_rate
 
Interest Rate
Numeric
No
Yes
prepayment_penalty
 
Prepayment Penalty
Numeric
No
Yes
custom_fields
 
Custom Fields
Array
No
No

Response Fields

Field
Description
Type
Required
Nullable
existingmortgage
 
The updated existing mortgage
Refer to ExistingMortgages->get
Existing Mortgages
No
No
Downpayments
get

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
down_payment_id
 
Down Payment ID
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
down_payment_id
 
Down Payment ID
Numeric
No
No
loan_id
 
Loan ID
Numeric
No
No
amount
 
Down payment amount
Numeric
No
Yes
source
 
Down payment source name
Text
No
Yes
description
 
Down payment source description
Text
No
Yes
list

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
Return the loan's down payment sources
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
down_payments
 
List of downpayments
List-Downpayments
No
No
update

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
down_payment_id
 
Down Payment ID
Numeric
No
No
loan_id
 
Loan ID
Numeric
No
No
amount
 
Down payment amount
Numeric
No
Yes
source
 
Down payment source name
Text
No
Yes
description
 
Down payment source description
Text
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
down_payment
 
The updated down payment source
Refer to Downpayments->get
Downpayments
No
No
create

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
Numeric
No
No
amount
 
Down payment amount
Numeric
No
Yes
source
 
Down payment source name
Text
No
Yes
description
 
Down payment source description
Text
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
down_payment
 
The created down payment source
Refer to Downpayments->get
Downpayments
No
No
Multi Pieces
get

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
multi_piece_id
 
Multi-piece ID
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
multi_piece_id
 
Multi-piece ID
Numeric
No
No
loan_id
 
Loan ID
Numeric
No
Yes
piece
 
1 for A-piece, 2 for B-piece
Numeric
No
Yes
amount
 
Multi-piece amount
Numeric
No
Yes
rate
 
Multi-piece rate
Numeric
No
Yes
minimum_rate
 
Multi-piece minimum rate
Numeric
No
Yes
rate_delta
 
Multi-piece rate difference
Numeric
No
Yes
list

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
If provided, response is the loan's multi-pieces
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
multi_pieces
 
List of multi-pieces
Refer to MultiPieces->get
List-Multi Pieces
No
No
Debts
get

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
id
 
Debt ID
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
id
 
Debt ID
Numeric
No
No
borrower_id
 
Borrower ID
Numeric
No
No
loan_id
 
Loan ID
Numeric
No
No
creditor
 
Creditor Name
Text
No
No
amount
 
Balance / Amount
Numeric
No
Yes
limit
 
limit
Numeric
No
Yes
payment
 
Monthly Payment
Numeric
No
Yes
credit_report
 
Imported from a credit report
Default 0. 0: False, 1: True.
Numeric
No
Yes
date
 
Created Date
Timestamp
No
Yes
from_loan_id
 
From Loan Id
It will be one if the debt is created from a loan otherwise 0.
Numeric
No
No
rt
 
RT Code
Text
No
Yes
payout
 
Whether to payout
Default 0. 0: False, 1: True.
Numeric
No
No
close
 
Whether to close
Default 0. 0: False, 1: True.
Numeric
No
No
prior
 
Whether to payout prior to advance
Default 0. 0: False, 1: True.
Numeric
No
No
loan_bridge
 
Whether to attach to a loan
Default 0. 0: False, 1: True.
Numeric
No
Yes
list

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
If provided, response is the loan's debts
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
debts
 
List of debts
Refer to Debts->get()
List-Debts
No
No
all_debts
 
List of the borrower's all debts
Refer to Debts->get()
List-Debts
No
No
update

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
id
 
Debt ID
Numeric
No
No
creditor
 
Creditor Name
Text
No
No
amount
 
Balance / Amount
Numeric
No
Yes
limit
 
limit
Numeric
No
Yes
payment
 
Monthly Payment
Numeric
No
Yes
rt
 
RT Code
Text
No
Yes
payout
 
Whether to payout
Default 0. 0: False, 1: True.
Numeric
No
No
close
 
Whether to close
Default 0. 0: False, 1: True.
Numeric
No
No
prior
 
Whether to payout prior to advance
Default 0. 0: False, 1: True.
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
debt
 
The updated Debt
Refer to Debt->get
Debts
No
No
create

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
borrower_id
 
Borrower ID
Numeric
No
No
loan_id
 
Loan ID
Numeric
No
No
creditor
 
Creditor Name
Text
No
No
amount
 
Balance / Amount
Numeric
No
Yes
limit
 
limit
Numeric
No
Yes
payment
 
Monthly Payment
Numeric
No
Yes
credit_report
 
Imported from a credit report
Default 0. 0: False, 1: True.
Numeric
No
Yes
rt
 
RT Code
Text
No
Yes
payout
 
Whether to payout
Default 0. 0: False, 1: True.
Numeric
No
No
close
 
Whether to close
Default 0. 0: False, 1: True.
Numeric
No
No
prior
 
Whether to payout prior to advance
Default 0. 0: False, 1: True.
Numeric
No
No
loan_bridge
 
Whether to attach to a loan
Default 0. 0: False, 1: True.
Numeric
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
debt
 
The created Debt
Refer to Debt->get
Debts
No
No
Borrowers
get

POST: {ENDPOINT}/borrowers/get

Field
Description
Type
Required
Nullable
borrower_id
 
Borrower ID
If provided, response is the borrower details.
Numeric
No
No
response_field_whitelist
 
Response Field Whitelist
If defined, the borrower will be returned with those fields only.
Array
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
borrower_id
 
Borrower ID
Numeric
No
No
x_borrower_id
 
External Borrower ID
Text
No
Yes
borrower_loan_id
 
Borrower Loan Relation ID
Numeric
No
No
first_name
 
First Name
Text
No
No
middle_name
 
Middle Name
Text
No
Yes
last_name
 
Last Name
Text
No
No
name_prefix
 
Name Prefix
0 -
1 - Mr
2 - Miss
3 - Mrs
4 - Ms
5 - Dr
6 - Rev
7 - Judge
8 - Madam
9 - Sir
Enum
No
Yes
name_suffix
 
Name Suffix
0 -
1 - Jr
2 - Sr
3 - II
4 - III
5 - IV
Enum
No
Yes
vesting_name
 
Vesting Name
Text
No
No
dob
 
Date of Birth
Timestamp
No
Yes
ssn
 
SSN
Text
No
Yes
marital
 
Marital Status
Text
No
No
credit_score
 
Credit Score
Numeric
No
Yes
email
 
Client Email
Text
No
No
homephone
 
Home Phone
Text
No
No
mobile
 
Cell Phone
Text
No
Yes
workphone
 
Work Phone
Text
No
Yes
address
 
Address
Refer to Addresses->get
Addresses
No
No
residential_status
 
Residential Status
0 -
1 - Own
2 - Rent
3 - Live with Parents
Enum
No
Yes
residence_start_date
 
Residence Start Date
Timestamp
No
Yes
employments
 
Employments
Refer to Employments->get
List-Employments
No
No
incomes
 
Incomes
Refer to Incomes->get
List-Incomes
No
No
debts
 
Debts
Refer to Debts->get()
List-Debts
No
No
all_debts
 
All Debts
Refer to Debts->get()
List-Debts
No
No
assets
 
Assets
Refer to Assets->get
List-Assets
No
No
shareholders
 
Shareholders
Refer to Shareholders->get
List-Shareholders
No
No
borrower_loans
 
Loans the borrower is directly associated with (as borrower or guarantor)
List-Borrower Loans
No
No
companies
 
Borrower corporations/companies the borrower is associated with
Returns Borrower IDs only
List-Borrowers
No
No
custom_fields
 
Custom Fields
Array
No
No
clientnote
 
Notes
Text
No
Yes
eftname
 
Client EFT Name
Text
No
No
eftbankid
 
Client EFT Bankid
Numeric
No
Yes
efttransit
 
Client EFT Transit
Text
No
Yes
eftaccount
 
Client EFT Account
Text
No
Yes
eftaccounttype
 
Client EFT Account Type
0 - Checking
1 - Savings
2 - Loan Account
Enum
No
No
businessnumber
 
Client Business Number
Text
No
Yes
iscorporation
 
Client is corporation status
Default 0. 0: Individual. 1: Corporation
Numeric
No
Yes
corptype
 
Corporation Type
0 - Individual
1 - Corporation
2 - General Partnership
3 - LLC - Member Managed
4 - LLC - Manager Managed
5 - Limited Partnership
7 - PLLC
9 - Trust
12 - Inc
Enum
No
Yes
corpname
 
Client corporation name
Text
No
Yes
l_is_guarantor
 
Borrower is a guarantor of a loan
0: Borrower, 1: Guarantor
Numeric
No
No
l_is_main_client
 
Borrower is the main borrower of a loan
0: Not Main, 1: Main
Numeric
No
No
consentingspousefname
 
Consenting Spouse First Name
Consenting Spouse First Name
Text
No
No
consentingspousemname
 
Consenting Spouse Middle Name
Consenting Spouse Middle Name
Text
No
No
consentingspouselname
 
Consenting Spouse Last Name
Consenting Spouse Last Name
Text
No
No
dry_run
 
Dry Run
Field used for debugging purposes internally.
Numeric
No
Yes
list

POST: {ENDPOINT}/borrowers/list

  • Return Borrower ID's only: 
    			
{
    "count": 2,
    "result": {
        "borrowers": [
            {"borrower_id": 111},
            {"borrower_id": 222}
        ]
    }
}
Field
Description
Type
Required
Nullable

Response Fields

Field
Description
Type
Required
Nullable
borrowers
 
List of borrowers
Refer to Borrowers->get
List-Borrowers
No
No
create

POST: {ENDPOINT}/borrowers/create

Field
Description
Type
Required
Nullable
duplication_mode
 
Duplication Mode
0 - No record will be created and the returned record is the first found duplicate. When Duplication Action is Rejection, this mode is always used.
1 - The record will be created even though the new record will create a duplicate. When Duplication Action is Rejection, this mode is ignored.
Given that Company Settings > Duplication are setup for the entity, and the provided record has duplicate(s):
If not specified, 0 will be the default.
If Duplication Action is Rejection, 0 is always used.
Enum
No
No
x_borrower_id
 
External Borrower ID
Text
No
Yes
first_name
 
First Name
Text
No
No
middle_name
 
Middle Name
Text
No
Yes
last_name
 
Last Name
Text
No
No
name_prefix
 
Name Prefix
0 -
1 - Mr
2 - Miss
3 - Mrs
4 - Ms
5 - Dr
6 - Rev
7 - Judge
8 - Madam
9 - Sir
Enum
No
Yes
name_suffix
 
Name Suffix
0 -
1 - Jr
2 - Sr
3 - II
4 - III
5 - IV
Enum
No
Yes
vesting_name
 
Vesting Name
Text
No
No
dob
 
Date of Birth
Timestamp
No
Yes
ssn
 
SSN
Text
No
Yes
marital
 
Marital Status
Text
No
No
credit_score
 
Credit Score
Numeric
No
Yes
email
 
Client Email
Text
No
No
homephone
 
Home Phone
Text
No
No
mobile
 
Cell Phone
Text
No
Yes
workphone
 
Work Phone
Text
No
Yes
address
 
Address
Refer to Addresses->get
Addresses
No
No
residential_status
 
Residential Status
0 -
1 - Own
2 - Rent
3 - Live with Parents
Enum
No
Yes
residence_start_date
 
Residence Start Date
Timestamp
No
Yes
employments
 
Employments
Refer to Employments->get
List-Employments
No
No
incomes
 
Incomes
Refer to Incomes->get
List-Incomes
No
No
debts
 
Debts
Refer to Debts->get()
List-Debts
No
No
all_debts
 
All Debts
Refer to Debts->get()
List-Debts
No
No
assets
 
Assets
Refer to Assets->get
List-Assets
No
No
shareholders
 
Shareholders
Refer to Shareholders->get
List-Shareholders
No
No
custom_fields
 
Custom Fields
Array
No
No
clientnote
 
Notes
Text
No
Yes
eftname
 
Client EFT Name
Text
No
No
eftbankid
 
Client EFT Bankid
Numeric
No
Yes
efttransit
 
Client EFT Transit
Text
No
Yes
eftaccount
 
Client EFT Account
Text
No
Yes
eftaccounttype
 
Client EFT Account Type
0 - Checking
1 - Savings
2 - Loan Account
Enum
No
No
businessnumber
 
Client Business Number
Text
No
Yes
iscorporation
 
Client is corporation status
Default 0. 0: Individual. 1: Corporation
Numeric
No
Yes
corptype
 
Corporation Type
0 - Individual
1 - Corporation
2 - General Partnership
3 - LLC - Member Managed
4 - LLC - Manager Managed
5 - Limited Partnership
7 - PLLC
9 - Trust
12 - Inc
Enum
No
Yes
corpname
 
Client corporation name
Text
No
Yes
l_is_guarantor
 
Borrower is a guarantor of a loan
0: Borrower, 1: Guarantor
Numeric
No
No
l_is_main_client
 
Borrower is the main borrower of a loan
0: Not Main, 1: Main
Numeric
No
No
consentingspousefname
 
Consenting Spouse First Name
Consenting Spouse First Name
Text
No
No
consentingspousemname
 
Consenting Spouse Middle Name
Consenting Spouse Middle Name
Text
No
No
consentingspouselname
 
Consenting Spouse Last Name
Consenting Spouse Last Name
Text
No
No
dry_run
 
Dry Run
Field used for debugging purposes internally.
Numeric
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
borrower
 
The created borrower
Refer to Borrower->get
Borrowers
No
No
update

POST: {ENDPOINT}/borrowers/update

Field
Description
Type
Required
Nullable
borrower_id
 
Borrower ID
Numeric
No
No
x_borrower_id
 
External Borrower ID
Text
No
Yes
first_name
 
First Name
Text
No
No
middle_name
 
Middle Name
Text
No
Yes
last_name
 
Last Name
Text
No
No
name_prefix
 
Name Prefix
0 -
1 - Mr
2 - Miss
3 - Mrs
4 - Ms
5 - Dr
6 - Rev
7 - Judge
8 - Madam
9 - Sir
Enum
No
Yes
name_suffix
 
Name Suffix
0 -
1 - Jr
2 - Sr
3 - II
4 - III
5 - IV
Enum
No
Yes
vesting_name
 
Vesting Name
Text
No
No
dob
 
Date of Birth
Timestamp
No
Yes
ssn
 
SSN
Text
No
Yes
marital
 
Marital Status
Text
No
No
credit_score
 
Credit Score
Numeric
No
Yes
email
 
Client Email
Text
No
No
homephone
 
Home Phone
Text
No
No
mobile
 
Cell Phone
Text
No
Yes
workphone
 
Work Phone
Text
No
Yes
address
 
Address
Refer to Addresses->get
Addresses
No
No
residential_status
 
Residential Status
0 -
1 - Own
2 - Rent
3 - Live with Parents
Enum
No
Yes
residence_start_date
 
Residence Start Date
Timestamp
No
Yes
employments
 
Employments
Refer to Employments->get
List-Employments
No
No
incomes
 
Incomes
Refer to Incomes->get
List-Incomes
No
No
debts
 
Debts
Refer to Debts->get()
List-Debts
No
No
all_debts
 
All Debts
Refer to Debts->get()
List-Debts
No
No
assets
 
Assets
Refer to Assets->get
List-Assets
No
No
custom_fields
 
Custom Fields
Array
No
No
clientnote
 
Notes
Text
No
Yes
eftname
 
Client EFT Name
Text
No
No
eftbankid
 
Client EFT Bankid
Numeric
No
Yes
efttransit
 
Client EFT Transit
Text
No
Yes
eftaccount
 
Client EFT Account
Text
No
Yes
eftaccounttype
 
Client EFT Account Type
0 - Checking
1 - Savings
2 - Loan Account
Enum
No
No
businessnumber
 
Client Business Number
Text
No
Yes
corptype
 
Corporation Type
0 - Individual
1 - Corporation
2 - General Partnership
3 - LLC - Member Managed
4 - LLC - Manager Managed
5 - Limited Partnership
7 - PLLC
9 - Trust
12 - Inc
Enum
No
Yes
corpname
 
Client corporation name
Text
No
Yes
l_is_guarantor
 
Borrower is a guarantor of a loan
0: Borrower, 1: Guarantor
Numeric
No
No
l_is_main_client
 
Borrower is the main borrower of a loan
0: Not Main, 1: Main
Numeric
No
No
consentingspousefname
 
Consenting Spouse First Name
Consenting Spouse First Name
Text
No
No
consentingspousemname
 
Consenting Spouse Middle Name
Consenting Spouse Middle Name
Text
No
No
consentingspouselname
 
Consenting Spouse Last Name
Consenting Spouse Last Name
Text
No
No
dry_run
 
Dry Run
Field used for debugging purposes internally.
Numeric
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
borrower
 
The updated borrower
Refer to Borrower->get
Borrowers
No
No
attach

POST: {ENDPOINT}/borrowers/attach

Field
Description
Type
Required
Nullable
borrower_id
 
Borrower ID
Numeric
No
No
shareholder
 
Shareholder
If shareholder is provided, the shareholder will be attached to the borrower
Shareholders
No
No

Response Fields

Field
Description
Type
Required
Nullable
borrower
 
The updated borrower
Refer to Borrower->get
Borrowers
No
No
Shareholders
get

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
If provided, response is the loan's borrower shareholders if any
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
borrowerid
 
Borrower Id
Numeric
No
No
type
 
Type
0 -
1 - Director
2 - Co-director
3 - Shareholder
4 - Guarantor
5 - Signing Officer
6 - Manager
7 - Member
16 - Member/Manager
8 - Authorized Manager
9 - Authorized Member
10 - President
11 - Vice President
12 - President and CEO
13 - Trustee
14 - Secretary
15 - Treasurer
17 - Partner
18 - GeneralPartner
19 - LimitedPartner
Enum
No
No
percentage
 
Percentage
Numeric
No
No
iscustomsigner
 
'Whether the shareholder is a custom signer
Numeric
No
Yes
borrower
 
Borrower
Refer to Borrowers->get
Borrowers
No
No
list

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
If provided, response is the Shareholders if any
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
shareholders
 
List of Shareholders
Refer to Shareholders->get
List-Shareholders
No
No
Loan Conditions
get

POST: {ENDPOINT}/conditions/get

Field
Description
Type
Required
Nullable
condition_id
 
Condition ID
If provided, response is a condition
Numeric
No
No
condition_property_id
 
Condition Property ID
If provided along with Condition ID, response is a loan condition for the property
Numeric
No
No
condition_type
 
Condition Type
0 - Single Condition
1 - Condition Per Property
Enum
No
No

Response Fields

Field
Description
Type
Required
Nullable
condition_id
 
Condition ID
Numeric
No
No
condition_property_id
 
Condition Property ID
Property ID for which the loan condition relates to if any else 0
Numeric
No
No
condition_type
 
Condition Type
0 - Single Condition
1 - Condition Per Property
Enum
No
No
condition_name
 
Condition Name
Text
No
Yes
condition_text
 
Condition Text
Text
No
Yes
borrowerlinktext
 
Borrowerlinktext
Text
No
Yes
additional_description
 
Additional Description
Property address for which the loan condition relates to if any
Text
No
Yes
status
 
Status
1 - Satisfied
0 - Unsatisfied
Enum
No
No
condition_status
 
Condition Status
0 - Active , 1 - Inactive
Enum
No
No
fulfiller
 
Fulfiller
Numeric
No
No
document_category
 
Accompanying Document Category
Refer to DocumentCategories->get
Document Categories
No
No
list

POST: {ENDPOINT}/conditions/list

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
conditions
 
List of conditions
List-Loan Conditions
No
No
update

POST: {ENDPOINT}/conditions/update

Field
Description
Type
Required
Nullable
condition_id
 
Condition ID
Numeric
No
No
condition_property_id
 
Condition Property ID
Property ID for which the loan condition relates to if any else 0
Numeric
No
No
condition_type
 
Condition Type
0 - Single Condition
1 - Condition Per Property
Enum
No
No
condition_name
 
Condition Name
Text
No
Yes
condition_text
 
Condition Text
Text
No
Yes
borrowerlinktext
 
Borrowerlinktext
Text
No
Yes
additional_description
 
Additional Description
Property address for which the loan condition relates to if any
Text
No
Yes
status
 
Status
1 - Satisfied
0 - Unsatisfied
Enum
No
No
condition_status
 
Condition Status
0 - Active , 1 - Inactive
Enum
No
No
fulfiller
 
Fulfiller
Numeric
No
No
document_category
 
Accompanying Document Category
Refer to DocumentCategories->get
Document Categories
No
No

Response Fields

Field
Description
Type
Required
Nullable
condition
 
The updated loan condition
Refer to Condition->get
Loan Conditions
No
No
Document Categories
get

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
category_id
 
Category ID
If provided, response is a document category
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
category_id
 
Category ID
Numeric
No
No
category_name
 
Category Name
Text
No
Yes
files
 
Files
Refer to Loanfiles->get
List-Loan Files
No
No
list

POST: {ENDPOINT}/documentcategories/list

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
Numeric
No
No
mode
 
Mode
0 - Default. List files under a document category
1 - No files are listed under a document category
Default 0.
Enum
No
No

Response Fields

Field
Description
Type
Required
Nullable
documentcategories
 
List of Document Categories
Refer to DocumentCategories->get
List-Document Categories
No
No
Loan Files
get

POST: {ENDPOINT}/loanfiles/get

Field
Description
Type
Required
Nullable
file_id
 
File ID
If provided, response is a file
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
file_id
 
File ID
Numeric
No
No
dispfile_name
 
Display File Name
Text
No
Yes
file_name
 
File Name
Text
No
Yes
file_date
 
File Date
Timestamp
No
Yes
file_status
 
File Status
1 - Existing File
2 - Waiting for Review
3 - Reviewing
4 - Changes Required
5 - Rejected
6 - Accepted
99 - Processing
Enum
No
Yes
rejected_reason
 
Rejected Reason
Text
No
Yes
additional_description
 
Additional Description
Text
No
Yes
sys_file_ref
 
System File Reference
Text
No
Yes
url
 
URL
Text
No
Yes
list

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
loanfiles
 
List of loanfiles
List-Loan Files
No
No
Fees
get

POST: {ENDPOINT}/fees/get

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
If provided, response are the fees of the loan's mortgage
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
broker_fee
 
Broker Fee
Default 0
Numeric
No
No
new_account_fee
 
Account Setup Fee
Default is Company Settings > Account Setup Fee or 0
Numeric
No
Yes
lender_fee
 
Lender Fee
Default 0.
Numeric
No
Yes
lender_fee_pay_mode
 
Lender Fee Pay Mode
Default 0. 0: Pay at funding, 1: Pay over {lender_fee_n_months}
Numeric
No
No
lender_fee_n_months
 
Pay Lender Fee Over Number of Months
Default 1. Used when {lender_fee_pay_mode} is Pay over (1)
Numeric
No
No
admin_fee
 
Admin Fee
Default 0.
Numeric
No
Yes
admin_fee_pay_mode
 
Admin Fee Pay Mode
Default 0. 0: Pay at funding, 1: Pay over {admin_fee_n_months}
Numeric
No
No
admin_fee_n_months
 
Pay Admin Fee Over Number of Months
Default 1. Used when {admin_fee_pay_mode} is Pay over (1)
Numeric
No
No
placement_fee
 
Placement Fee
Default 0.
Numeric
No
No
placement_fee_pay_mode
 
Placement Fee Pay Mode
Default 0. 0: Pay at funding, 1: Pay over {admin_fee_n_months}
Numeric
No
No
placement_fee_n_months
 
Pay Placement Fee Over Number of Months
Default 1. Used when {placement_fee_pay_mode} is Pay over (1)
Numeric
No
No
est_title_fee
 
Est. Title Fee
Default 0.Company Settings > Optional Loan Fields > Commitment Fields > Enable Est. Title Fee for Fix & Flips.
Numeric
No
No
est_title_fee_pay_mode
 
Est. Title Fee Pay Mode
Default 0. Company Settings > Optional Loan Fields > Commitment Fields > Enable Est. Title Fee for Fix & Flips.
0: Pay at funding
1: Pay over {est_title_fee_n_months}.
Numeric
No
No
est_title_fee_n_months
 
Pay Est. Title Fee Over Number of Months
Default 1. Used when {est_title_fee_pay_mode} is Pay over (1). Company Settings > Optional Loan Fields > Commitment Fields > Enable Est. Title Fee for Fix & Flips.
Numeric
No
No
est_title_fee_direct
 
Whether Borrower pays Est. Title Fee Directly
Default 0. 0: Borrower doesn't pay directly, 1: Borrower pays directly. Company Settings > Optional Loan Fields > Commitment Fields > Enable Est. Title Fee for Fix & Flips.
Numeric
No
No
discharge_fee
 
Discharge Fee
Default Company Settings > Discharge Fee or 0
Numeric
No
No
renewal_fee
 
Auto Renewal Fee
Default Company Settings > Renewal Fee or 0
Numeric
No
Yes
title_company_fee
 
Title Company Fee
Default 0.
Numeric
No
Yes
statement_prep_fee
 
Statement Prep Fee (Stmt. Prep Fee)
Default 0.
Numeric
No
No
update

POST: {ENDPOINT}/fees/update

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
Numeric
No
No
broker_fee
 
Broker Fee
Default 0
Numeric
No
No
new_account_fee
 
Account Setup Fee
Default is Company Settings > Account Setup Fee or 0
Numeric
No
Yes
lender_fee
 
Lender Fee
Default 0.
Numeric
No
Yes
lender_fee_pay_mode
 
Lender Fee Pay Mode
Default 0. 0: Pay at funding, 1: Pay over {lender_fee_n_months}
Numeric
No
No
lender_fee_n_months
 
Pay Lender Fee Over Number of Months
Default 1. Used when {lender_fee_pay_mode} is Pay over (1)
Numeric
No
No
admin_fee
 
Admin Fee
Default 0.
Numeric
No
Yes
admin_fee_pay_mode
 
Admin Fee Pay Mode
Default 0. 0: Pay at funding, 1: Pay over {admin_fee_n_months}
Numeric
No
No
admin_fee_n_months
 
Pay Admin Fee Over Number of Months
Default 1. Used when {admin_fee_pay_mode} is Pay over (1)
Numeric
No
No
placement_fee
 
Placement Fee
Default 0.
Numeric
No
No
placement_fee_pay_mode
 
Placement Fee Pay Mode
Default 0. 0: Pay at funding, 1: Pay over {admin_fee_n_months}
Numeric
No
No
placement_fee_n_months
 
Pay Placement Fee Over Number of Months
Default 1. Used when {placement_fee_pay_mode} is Pay over (1)
Numeric
No
No
est_title_fee
 
Est. Title Fee
Default 0.Company Settings > Optional Loan Fields > Commitment Fields > Enable Est. Title Fee for Fix & Flips.
Numeric
No
No
est_title_fee_pay_mode
 
Est. Title Fee Pay Mode
Default 0. Company Settings > Optional Loan Fields > Commitment Fields > Enable Est. Title Fee for Fix & Flips.
0: Pay at funding
1: Pay over {est_title_fee_n_months}.
Numeric
No
No
est_title_fee_n_months
 
Pay Est. Title Fee Over Number of Months
Default 1. Used when {est_title_fee_pay_mode} is Pay over (1). Company Settings > Optional Loan Fields > Commitment Fields > Enable Est. Title Fee for Fix & Flips.
Numeric
No
No
est_title_fee_direct
 
Whether Borrower pays Est. Title Fee Directly
Default 0. 0: Borrower doesn't pay directly, 1: Borrower pays directly. Company Settings > Optional Loan Fields > Commitment Fields > Enable Est. Title Fee for Fix & Flips.
Numeric
No
No
discharge_fee
 
Discharge Fee
Default Company Settings > Discharge Fee or 0
Numeric
No
No
renewal_fee
 
Auto Renewal Fee
Default Company Settings > Renewal Fee or 0
Numeric
No
Yes
title_company_fee
 
Title Company Fee
Default 0.
Numeric
No
Yes
statement_prep_fee
 
Statement Prep Fee (Stmt. Prep Fee)
Default 0.
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
fee
 
The updated fee
Fees
No
No
Custom Fees
get

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
id
 
Custom Fee ID
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
id
 
Custom Fee ID
Numeric
No
No
title
 
Custom Fee Title
Text
No
No
amount
 
Custom Fee Amount
Default 0.
Numeric
No
No
amount_total
 
Custom Fee Total Amount
Default 0.
Numeric
No
No
estimate
 
Estimate
Default 0. 0: false, 1: true.
Numeric
No
No
per_property
 
Per Property
Default 0. 0: false, 1: true.
Numeric
No
No
list

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
If provided, response is the loan's custom fees
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
custom_fees
 
List of custom fees
Refer to CustomFees->get()
List-Custom Fees
No
No
update

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
id
 
Custom Fee ID
Numeric
No
No
loan_id
 
Loan ID
Numeric
No
No
title
 
Custom Fee Title
Text
No
No
amount
 
Custom Fee Amount
Default 0.
Numeric
No
No
estimate
 
Estimate
Default 0. 0: false, 1: true.
Numeric
No
No
per_property
 
Per Property
Default 0. 0: false, 1: true.
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
fee
 
The updated fee
Custom Fees
No
No
Addresses
get

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
If provided, response is the loan's main property address
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
street
 
Street
e.g. 123 Main St.
Text
No
Yes
city
 
City
Text
No
Yes
prov
 
Province
Text
No
Yes
zip
 
Postal Code
e.g. A1A 2A3 or 6 digits US Zip code
Text
No
Yes
county
 
County
Only applies to US address
Text
No
Yes
suburb
 
Suburb
Only applies to New Zealand address
Text
No
Yes
country
 
Country
Text
No
Yes
update

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
street
 
Street
e.g. 123 Main St.
Text
No
Yes
city
 
City
Text
No
Yes
prov
 
Province
Text
No
Yes
zip
 
Postal Code
e.g. A1A 2A3 or 6 digits US Zip code
Text
No
Yes
county
 
County
Only applies to US address
Text
No
Yes
suburb
 
Suburb
Only applies to New Zealand address
Text
No
Yes
country
 
Country
Text
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
address
 
Address
Addresses
No
No
Insurances
get

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
insurance_id
 
Insurance ID
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
insurance_id
 
Insurance ID
Numeric
No
No
insured_name
 
Insured's Name
Text
No
Yes
policy_type
 
Policy Type
0 - None
1 - Vacancy
2 - Builders Risk
3 - Flood
4 - Windstorm
5 - Tenant Dwelling
6 - Homeowner
7 - Strata
8 - Commercial
9 - General liability/Umbrella liability
10 - Sewer Back-Up
11 - Water
12 - Earthquake
13 - Equipment breakdown
14 - Property
15 - Fire
Enum
No
Yes
policy_num
 
Policy Number
Text
No
Yes
company
 
Insurance Company
Text
No
Yes
coverage_amount
 
Coverage amount
Numeric
No
Yes
annual_cost
 
Annual cost
Numeric
No
Yes
holdback
 
Reserve / Holdback
Numeric
No
Yes
monthly_payment
 
Monthly payment
Numeric
No
Yes
pay_for_borrower
 
Whether to pay on behalf of borrower
0 or 1. 1 is to pay on behalf of borrower
Numeric
No
Yes
expiry_date
 
Expiry date
Unix timestamp integer: number of seconds since Jan 01, 1970 in GMT/UTC timezone
Timestamp
No
Yes
policy_issue_date
 
Policy issue date
Unix timestamp integer: number of seconds since Jan 01, 1970 in GMT/UTC timezone
Timestamp
No
Yes
effective_date
 
Effective date
Unix timestamp integer: number of seconds since Jan 01, 1970 in GMT/UTC timezone
Timestamp
No
Yes
deductible
 
deductible
Numeric
No
Yes
insurance_limit
 
Insurance Limit
Numeric
No
Yes
insurancepolicyguaranteedreplacementcoverage
 
Whether it guarantees replacement coverage
0 or 1. 1 guarantees replacement coverage
Numeric
No
Yes
stated_amount
 
Stated Amount
Numeric
No
Yes
payment_date
 
Payment date
Unix timestamp integer: number of seconds since Jan 01, 1970 in GMT/UTC timezone
Timestamp
No
Yes
agent
 
Insurance Agent
Refer to InsuranceAgents->get
Insurance Agents
No
No
list

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
Numeric
No
No
property_id
 
Property ID
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
insurances
 
List of insurances
List-Insurances
No
No
update

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
insurance_id
 
Insurance ID
Numeric
No
No
insured_name
 
Insured's Name
Text
No
Yes
policy_type
 
Policy Type
0 - None
1 - Vacancy
2 - Builders Risk
3 - Flood
4 - Windstorm
5 - Tenant Dwelling
6 - Homeowner
7 - Strata
8 - Commercial
9 - General liability/Umbrella liability
10 - Sewer Back-Up
11 - Water
12 - Earthquake
13 - Equipment breakdown
14 - Property
15 - Fire
Enum
No
Yes
policy_num
 
Policy Number
Text
No
Yes
company
 
Insurance Company
Text
No
Yes
coverage_amount
 
Coverage amount
Numeric
No
Yes
annual_cost
 
Annual cost
Numeric
No
Yes
holdback
 
Reserve / Holdback
Numeric
No
Yes
monthly_payment
 
Monthly payment
Numeric
No
Yes
pay_for_borrower
 
Whether to pay on behalf of borrower
0 or 1. 1 is to pay on behalf of borrower
Numeric
No
Yes
expiry_date
 
Expiry date
Unix timestamp integer: number of seconds since Jan 01, 1970 in GMT/UTC timezone
Timestamp
No
Yes
policy_issue_date
 
Policy issue date
Unix timestamp integer: number of seconds since Jan 01, 1970 in GMT/UTC timezone
Timestamp
No
Yes
effective_date
 
Effective date
Unix timestamp integer: number of seconds since Jan 01, 1970 in GMT/UTC timezone
Timestamp
No
Yes
deductible
 
deductible
Numeric
No
Yes
insurance_limit
 
Insurance Limit
Numeric
No
Yes
insurancepolicyguaranteedreplacementcoverage
 
Whether it guarantees replacement coverage
0 or 1. 1 guarantees replacement coverage
Numeric
No
Yes
stated_amount
 
Stated Amount
Numeric
No
Yes
payment_date
 
Payment date
Unix timestamp integer: number of seconds since Jan 01, 1970 in GMT/UTC timezone
Timestamp
No
Yes
agent
 
Insurance Agent
Refer to InsuranceAgents->get
Insurance Agents
No
No

Response Fields

Field
Description
Type
Required
Nullable
insurance
 
The updated Insurance
Refer to Insurance->get
Insurances
No
No
Insurance Agents
get

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
insurance_id
 
Insurance ID
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
name
 
Agent Name
Text
No
Yes
phone
 
Agent Phone
Text
No
Yes
email
 
Agent Email
Text
No
Yes
fax
 
Agent Fax
Text
No
Yes
company
 
Agent Company
Text
No
Yes
company_address
 
Agent Company Address
Text
No
Yes
agent_number
 
Agent Number
Text
No
Yes
clamllcinsuranceagentcompanystreetnumber
 
CLAM LLC Insurance Agent Company Street Number
Text
No
Yes
clamllcinsuranceagentcompanyaddress
 
CLAM LLC Insurance Agent Company Address
Text
No
Yes
clamllcinsuranceagentcompanycity
 
CLAM LLC Insurance Agent Company City
Text
No
Yes
clamllcinsuranceagentcompanyprovince
 
CLAM LLC Insurance Agent Company Province
Text
No
Yes
clamllcinsuranceagentcompanyzip
 
CLAM LLC Insurance Agent Company Zip
Text
No
Yes
update

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
name
 
Agent Name
Text
No
Yes
phone
 
Agent Phone
Text
No
Yes
email
 
Agent Email
Text
No
Yes
fax
 
Agent Fax
Text
No
Yes
company
 
Agent Company
Text
No
Yes
company_address
 
Agent Company Address
Text
No
Yes
agent_number
 
Agent Number
Text
No
Yes
clamllcinsuranceagentcompanystreetnumber
 
CLAM LLC Insurance Agent Company Street Number
Text
No
Yes
clamllcinsuranceagentcompanyaddress
 
CLAM LLC Insurance Agent Company Address
Text
No
Yes
clamllcinsuranceagentcompanycity
 
CLAM LLC Insurance Agent Company City
Text
No
Yes
clamllcinsuranceagentcompanyprovince
 
CLAM LLC Insurance Agent Company Province
Text
No
Yes
clamllcinsuranceagentcompanyzip
 
CLAM LLC Insurance Agent Company Zip
Text
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
agent
 
The Updated insurance agent
Refer to InsuranceAgents->get
Insurance Agents
No
No
Parent Brokers
get

POST: {ENDPOINT}/parentbrokers/get

Field
Description
Type
Required
Nullable
id
 
Parent Broker ID
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
id
 
Parent Broker ID
Numeric
No
No
gsid
 
GS ID
Numeric
No
No
name
 
Parent Broker Name
Text
No
No
create

POST: {ENDPOINT}/parentbrokers/create

Field
Description
Type
Required
Nullable
id
 
Parent Broker ID
Numeric
No
No
gsid
 
GS ID
Numeric
No
No
name
 
Parent Broker Name
Text
No
No

Response Fields

Field
Description
Type
Required
Nullable
parent_broker
 
The created Parent Broker
Refer to ParentBroker->get
Parent Brokers
No
No
Brokers
get

POST: {ENDPOINT}/brokers/get

Field
Description
Type
Required
Nullable
broker_id
 
Broker ID
Numeric
No
No
loan_id
 
Loan ID
If provided, return the loan's broker staff's broker.
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
broker_id
 
Broker ID
Numeric
No
No
gsid
 
GS ID
Numeric
No
No
x_broker_id
 
External Broker ID
Text
No
Yes
parent_broker
 
Parent Broker
Parent Brokers
No
No
importsource
 
Import Source ID
Numeric
No
Yes
name
 
Broker Name
Text
No
Yes
address
 
Address
Text
No
No
city
 
City
Text
No
No
suburb
 
Suburb
Text
No
No
county
 
County
Text
No
No
province
 
Province
Text
No
No
zip
 
ZIP
Text
No
No
phone
 
Phone
Text
No
No
fax
 
Fax
Text
No
No
cheque
 
Cheque
Text
No
No
cheque_use_eft
 
Whether cheque is used for EFT
Numeric
No
Yes
cheque_eft_name
 
Account Name
Text
No
No
cheque_eft_bank_id
 
Institution Number
0 - N/A
1 - BMO
2 - Scotia
3 - RBC
4 - TD
6 - National
10 - CIBC
16 - HSBC
30 - Canadian Western Bank / Western Union
39 - Laurentian
117 - Government
177 - Bank of Canada
219 - ATB
241 - Bank of America
260 - Citi
275 - KEB Hana
307 - Industrial and Commercial Bank of China (Canada)
308 - Bank of China
309 - Citizens
318 - U.S. Bank National Association
320 - PC Financial
321 - Habib Canadian Bank
326 - Simplii Financial
340 - ICICI Bank of Canada
352 - Digital Commerce Bank
370 - Wealth One Bank of Canada
374 - Motus Bank
383 - Peoples Bank of Canada
509 - The Canadian Trust Company
532 - Effort Trust Company
540 - Manulife Bank
568 - Peace Hills Trust Company
608 - Banque Alterna
614 - ING / Tangerine
621 - Peoples Trust Company
623 - Equitable Bank
703 - Wealthsimple Investments Inc.
809 - Central 1 Credit Union BC
815 - Desjardins
819 - La Fédération des caisses populaires du Manitoba Inc.
828 - Central 1 Credit Union Ontario
829 - La Fédération des caisses populaires de l'Ontario Inc.
837 - Meridian Credit Union
839 - Central 1 Credit Union Atlantic
842 - Alterna Savings
849 - Bayview Credit Union
853 - Concentra Financial Services
865 - UNI Financial Coop
879 - Co-op Credit Society of Manitoba
889 - Credit Union Central of Saskatchewan
890 - Alliance des caisses populaires de l'Ontario Limitée
899 - Credit Union Alberta
Only for Canada.
Enum
No
Yes
cheque_eft_transit
 
Branch Number / Transit Number / Routing Number
Text
No
No
cheque_eft_account
 
Account Number
Text
No
No
cheque_eft_account_type
 
Account Type
0 - Checking
1 - Savings
2 - Loan Account
Only for US.
Enum
No
No
licence
 
Licence
Text
No
Yes
note
 
Note
Text
No
Yes
broker_staff_list
 
List of broker staff
List-Broker Staff
No
No
custom_fields
 
Custom Fields
Array
No
No
update

POST: {ENDPOINT}/brokers/update

Field
Description
Type
Required
Nullable
broker_id
 
Broker ID
Numeric
No
No
gsid
 
GS ID
Numeric
No
No
x_broker_id
 
External Broker ID
Text
No
Yes
parent_broker
 
Parent Broker
Parent Brokers
No
No
name
 
Broker Name
Text
No
Yes
address
 
Address
Text
No
No
city
 
City
Text
No
No
suburb
 
Suburb
Text
No
No
county
 
County
Text
No
No
province
 
Province
Text
No
No
zip
 
ZIP
Text
No
No
phone
 
Phone
Text
No
No
fax
 
Fax
Text
No
No
cheque
 
Cheque
Text
No
No
cheque_use_eft
 
Whether cheque is used for EFT
Numeric
No
Yes
cheque_eft_name
 
Account Name
Text
No
No
cheque_eft_bank_id
 
Institution Number
0 - N/A
1 - BMO
2 - Scotia
3 - RBC
4 - TD
6 - National
10 - CIBC
16 - HSBC
30 - Canadian Western Bank / Western Union
39 - Laurentian
117 - Government
177 - Bank of Canada
219 - ATB
241 - Bank of America
260 - Citi
275 - KEB Hana
307 - Industrial and Commercial Bank of China (Canada)
308 - Bank of China
309 - Citizens
318 - U.S. Bank National Association
320 - PC Financial
321 - Habib Canadian Bank
326 - Simplii Financial
340 - ICICI Bank of Canada
352 - Digital Commerce Bank
370 - Wealth One Bank of Canada
374 - Motus Bank
383 - Peoples Bank of Canada
509 - The Canadian Trust Company
532 - Effort Trust Company
540 - Manulife Bank
568 - Peace Hills Trust Company
608 - Banque Alterna
614 - ING / Tangerine
621 - Peoples Trust Company
623 - Equitable Bank
703 - Wealthsimple Investments Inc.
809 - Central 1 Credit Union BC
815 - Desjardins
819 - La Fédération des caisses populaires du Manitoba Inc.
828 - Central 1 Credit Union Ontario
829 - La Fédération des caisses populaires de l'Ontario Inc.
837 - Meridian Credit Union
839 - Central 1 Credit Union Atlantic
842 - Alterna Savings
849 - Bayview Credit Union
853 - Concentra Financial Services
865 - UNI Financial Coop
879 - Co-op Credit Society of Manitoba
889 - Credit Union Central of Saskatchewan
890 - Alliance des caisses populaires de l'Ontario Limitée
899 - Credit Union Alberta
Only for Canada.
Enum
No
Yes
cheque_eft_transit
 
Branch Number / Transit Number / Routing Number
Text
No
No
cheque_eft_account
 
Account Number
Text
No
No
cheque_eft_account_type
 
Account Type
0 - Checking
1 - Savings
2 - Loan Account
Only for US.
Enum
No
No
licence
 
Licence
Text
No
Yes
note
 
Note
Text
No
Yes
broker_staff_list
 
List of broker staff
List-Broker Staff
No
No
custom_fields
 
Custom Fields
Array
No
No

Response Fields

Field
Description
Type
Required
Nullable
broker
 
The updated broker
Refer to Broker->get
Brokers
No
No
create

POST: {ENDPOINT}/brokers/create

Field
Description
Type
Required
Nullable
duplication_mode
 
Duplication Mode
0 - No record will be created and the returned record is the first found duplicate. When Duplication Action is Rejection, this mode is always used.
1 - The record will be created even though the new record will create a duplicate. When Duplication Action is Rejection, this mode is ignored.
Given that Company Settings > Duplication are setup for the entity, and the provided record has duplicate(s):
If not specified, 0 will be the default.
If Duplication Action is Rejection, 0 is always used.
Enum
No
No
x_broker_id
 
External Broker ID
Text
No
Yes
parent_broker
 
Parent Broker
Parent Brokers
No
No
name
 
Broker Name
Text
No
Yes
address
 
Address
Text
No
No
city
 
City
Text
No
No
suburb
 
Suburb
Text
No
No
county
 
County
Text
No
No
province
 
Province
Text
No
No
zip
 
ZIP
Text
No
No
phone
 
Phone
Text
No
No
fax
 
Fax
Text
No
No
cheque
 
Cheque
Text
No
No
cheque_use_eft
 
Whether cheque is used for EFT
Numeric
No
Yes
cheque_eft_name
 
Account Name
Text
No
No
cheque_eft_bank_id
 
Institution Number
0 - N/A
1 - BMO
2 - Scotia
3 - RBC
4 - TD
6 - National
10 - CIBC
16 - HSBC
30 - Canadian Western Bank / Western Union
39 - Laurentian
117 - Government
177 - Bank of Canada
219 - ATB
241 - Bank of America
260 - Citi
275 - KEB Hana
307 - Industrial and Commercial Bank of China (Canada)
308 - Bank of China
309 - Citizens
318 - U.S. Bank National Association
320 - PC Financial
321 - Habib Canadian Bank
326 - Simplii Financial
340 - ICICI Bank of Canada
352 - Digital Commerce Bank
370 - Wealth One Bank of Canada
374 - Motus Bank
383 - Peoples Bank of Canada
509 - The Canadian Trust Company
532 - Effort Trust Company
540 - Manulife Bank
568 - Peace Hills Trust Company
608 - Banque Alterna
614 - ING / Tangerine
621 - Peoples Trust Company
623 - Equitable Bank
703 - Wealthsimple Investments Inc.
809 - Central 1 Credit Union BC
815 - Desjardins
819 - La Fédération des caisses populaires du Manitoba Inc.
828 - Central 1 Credit Union Ontario
829 - La Fédération des caisses populaires de l'Ontario Inc.
837 - Meridian Credit Union
839 - Central 1 Credit Union Atlantic
842 - Alterna Savings
849 - Bayview Credit Union
853 - Concentra Financial Services
865 - UNI Financial Coop
879 - Co-op Credit Society of Manitoba
889 - Credit Union Central of Saskatchewan
890 - Alliance des caisses populaires de l'Ontario Limitée
899 - Credit Union Alberta
Only for Canada.
Enum
No
Yes
cheque_eft_transit
 
Branch Number / Transit Number / Routing Number
Text
No
No
cheque_eft_account
 
Account Number
Text
No
No
cheque_eft_account_type
 
Account Type
0 - Checking
1 - Savings
2 - Loan Account
Only for US.
Enum
No
No
licence
 
Licence
Text
No
Yes
note
 
Note
Text
No
Yes
broker_staff_list
 
List of broker staff
List-Broker Staff
No
No
custom_fields
 
Custom Fields
Array
No
No

Response Fields

Field
Description
Type
Required
Nullable
broker
 
The created broker
Refer to Broker->get
Brokers
No
No
delete

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
broker_id
 
Broker ID
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
broker
 
The deleted broker
Refer to Broker->get
Brokers
No
No
Broker Staff
get

POST: {ENDPOINT}/brokerstaff/get

Field
Description
Type
Required
Nullable
broker_staff_id
 
Broker Staff ID
Numeric
No
No
loan_id
 
Loan ID
If provided, return the loan's broker staff.
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
broker_staff_id
 
Broker Staff ID
Numeric
No
No
broker_id
 
Broker ID
Numeric
No
No
x_broker_staff_id
 
External Broker Staff ID
Text
No
Yes
import_source
 
Import Source ID
Numeric
No
Yes
inactive
 
Inactive
Default 0. 0: false, 1: true.
Numeric
No
No
type
 
Broker Staff Type
0 - Partner
1 - Broker
2 - Assistant
Enum
No
No
first_name
 
First Name
Text
No
No
last_name
 
Last Name
Text
No
No
phone
 
Phone
Text
No
No
email
 
Email
Text
No
No
licence
 
Licence Number
Text
No
Yes
licence_type
 
Licence Type
Text
No
Yes
licence_expiry
 
Licence Expiry
Timestamp
No
Yes
broker
 
Broker
Refer to Broker->get()
Brokers
No
No
cheques
 
Broker Staff Cheques
Refer to Brokerstaffcheque->list()
List-Broker Staff Cheques
No
No
custom_fields
 
Custom Fields
Array
No
No
list

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
If provided, response is the loan's broker staff
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
broker_staff_list
 
List of Broker Staff
Refer to BrokerStaff->get
List-Broker Staff
No
No
create

POST: {ENDPOINT}/brokerstaff/create

Field
Description
Type
Required
Nullable
duplication_mode
 
Duplication Mode
0 - No record will be created and the returned record is the first found duplicate. When Duplication Action is Rejection, this mode is always used.
1 - The record will be created even though the new record will create a duplicate. When Duplication Action is Rejection, this mode is ignored.
Given that Company Settings > Duplication are setup for the entity, and the provided record has duplicate(s):
If not specified, 0 will be the default.
If Duplication Action is Rejection, 0 is always used.
Enum
No
No
broker_staff_id
 
Broker Staff ID
Numeric
No
No
broker_id
 
Broker ID
Numeric
No
No
x_broker_staff_id
 
External Broker Staff ID
Text
No
Yes
inactive
 
Inactive
Default 0. 0: false, 1: true.
Numeric
No
No
type
 
Broker Staff Type
0 - Partner
1 - Broker
2 - Assistant
Enum
No
No
first_name
 
First Name
Text
No
No
last_name
 
Last Name
Text
No
No
phone
 
Phone
Text
No
No
email
 
Email
Text
No
No
licence
 
Licence Number
Text
No
Yes
licence_type
 
Licence Type
Text
No
Yes
licence_expiry
 
Licence Expiry
Timestamp
No
Yes
cheques
 
Broker Staff Cheques
Refer to Brokerstaffcheque->list()
List-Broker Staff Cheques
No
No
custom_fields
 
Custom Fields
Array
No
No

Response Fields

Field
Description
Type
Required
Nullable
broker_staff
 
The created Broker Staff
Refer to BrokerStaff->get
Broker Staff
No
No
update

POST: {ENDPOINT}/brokerstaff/update

Field
Description
Type
Required
Nullable
broker_staff_id
 
Broker Staff ID
Numeric
No
No
broker_id
 
Broker ID
Numeric
No
No
x_broker_staff_id
 
External Broker Staff ID
Text
No
Yes
inactive
 
Inactive
Default 0. 0: false, 1: true.
Numeric
No
No
first_name
 
First Name
Text
No
No
last_name
 
Last Name
Text
No
No
phone
 
Phone
Text
No
No
email
 
Email
Text
No
No
licence
 
Licence Number
Text
No
Yes
licence_type
 
Licence Type
Text
No
Yes
licence_expiry
 
Licence Expiry
Timestamp
No
Yes
broker
 
Broker
Refer to Broker->get()
Brokers
No
No
cheques
 
Broker Staff Cheques
Refer to Brokerstaffcheque->list()
List-Broker Staff Cheques
No
No
custom_fields
 
Custom Fields
Array
No
No

Response Fields

Field
Description
Type
Required
Nullable
broker_staff
 
The updated broker staff
Refer to BrokerStaff->get
Broker Staff
No
No
Broker Staff Cheques
get

POST: {ENDPOINT}/brokerstaffcheques/get

Field
Description
Type
Required
Nullable
broker_staff_cheque_id
 
Broker Staff Cheque ID
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
broker_staff_cheque_id
 
Broker Staff Cheque ID
Numeric
No
No
broker_staff_id
 
Broker Staff ID
Numeric
No
No
parent_cheque_id
 
Parent Cheque ID
Numeric
No
Yes
cheque_name
 
Cheque
Text
No
No
cheque_use_eft
 
Whether cheque is used for EFT
Numeric
No
No
cheque_eft_name
 
Account Name
Text
No
No
cheque_eft_bank_id
 
Institution Number
0 - N/A
1 - BMO
2 - Scotia
3 - RBC
4 - TD
6 - National
10 - CIBC
16 - HSBC
30 - Canadian Western Bank / Western Union
39 - Laurentian
117 - Government
177 - Bank of Canada
219 - ATB
241 - Bank of America
260 - Citi
275 - KEB Hana
307 - Industrial and Commercial Bank of China (Canada)
308 - Bank of China
309 - Citizens
318 - U.S. Bank National Association
320 - PC Financial
321 - Habib Canadian Bank
326 - Simplii Financial
340 - ICICI Bank of Canada
352 - Digital Commerce Bank
370 - Wealth One Bank of Canada
374 - Motus Bank
383 - Peoples Bank of Canada
509 - The Canadian Trust Company
532 - Effort Trust Company
540 - Manulife Bank
568 - Peace Hills Trust Company
608 - Banque Alterna
614 - ING / Tangerine
621 - Peoples Trust Company
623 - Equitable Bank
703 - Wealthsimple Investments Inc.
809 - Central 1 Credit Union BC
815 - Desjardins
819 - La Fédération des caisses populaires du Manitoba Inc.
828 - Central 1 Credit Union Ontario
829 - La Fédération des caisses populaires de l'Ontario Inc.
837 - Meridian Credit Union
839 - Central 1 Credit Union Atlantic
842 - Alterna Savings
849 - Bayview Credit Union
853 - Concentra Financial Services
865 - UNI Financial Coop
879 - Co-op Credit Society of Manitoba
889 - Credit Union Central of Saskatchewan
890 - Alliance des caisses populaires de l'Ontario Limitée
899 - Credit Union Alberta
Only for Canada.
Enum
No
Yes
cheque_eft_transit
 
Branch Number / Transit Number / Routing Number
Text
No
No
cheque_eft_account
 
Account Number
Text
No
No
cheque_eft_account_type
 
Account Type
0 - Checking
1 - Savings
2 - Loan Account
US only
Enum
No
No
list

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
broker_staff_id
 
Broker Staff ID
If provided, return the broker staff's cheques
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
cheques
 
List of Broker Staff Cheques
Refer to Brokerstaffcheque->get
List-Broker Staff Cheques
No
No
create

POST: {ENDPOINT}/brokerstaffcheques/create

Field
Description
Type
Required
Nullable
broker_staff_cheque_id
 
Broker Staff Cheque ID
Numeric
No
No
broker_staff_id
 
Broker Staff ID
Numeric
No
No
cheque_name
 
Cheque
Text
No
No
cheque_use_eft
 
Whether cheque is used for EFT
Numeric
No
No
cheque_eft_name
 
Account Name
Text
No
No
cheque_eft_bank_id
 
Institution Number
0 - N/A
1 - BMO
2 - Scotia
3 - RBC
4 - TD
6 - National
10 - CIBC
16 - HSBC
30 - Canadian Western Bank / Western Union
39 - Laurentian
117 - Government
177 - Bank of Canada
219 - ATB
241 - Bank of America
260 - Citi
275 - KEB Hana
307 - Industrial and Commercial Bank of China (Canada)
308 - Bank of China
309 - Citizens
318 - U.S. Bank National Association
320 - PC Financial
321 - Habib Canadian Bank
326 - Simplii Financial
340 - ICICI Bank of Canada
352 - Digital Commerce Bank
370 - Wealth One Bank of Canada
374 - Motus Bank
383 - Peoples Bank of Canada
509 - The Canadian Trust Company
532 - Effort Trust Company
540 - Manulife Bank
568 - Peace Hills Trust Company
608 - Banque Alterna
614 - ING / Tangerine
621 - Peoples Trust Company
623 - Equitable Bank
703 - Wealthsimple Investments Inc.
809 - Central 1 Credit Union BC
815 - Desjardins
819 - La Fédération des caisses populaires du Manitoba Inc.
828 - Central 1 Credit Union Ontario
829 - La Fédération des caisses populaires de l'Ontario Inc.
837 - Meridian Credit Union
839 - Central 1 Credit Union Atlantic
842 - Alterna Savings
849 - Bayview Credit Union
853 - Concentra Financial Services
865 - UNI Financial Coop
879 - Co-op Credit Society of Manitoba
889 - Credit Union Central of Saskatchewan
890 - Alliance des caisses populaires de l'Ontario Limitée
899 - Credit Union Alberta
Only for Canada.
Enum
No
Yes
cheque_eft_transit
 
Branch Number / Transit Number / Routing Number
Text
No
No
cheque_eft_account
 
Account Number
Text
No
No
cheque_eft_account_type
 
Account Type
0 - Checking
1 - Savings
2 - Loan Account
US only
Enum
No
No

Response Fields

Field
Description
Type
Required
Nullable
cheque
 
The created brokerstaff cheque
Broker Staff Cheques
No
No
Lawyers
get

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
lawyer_id
 
Lawyer ID
Numeric
No
No
loan_id
 
Loan ID
If provided, return the loan's lender lawyer.
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
lawyer_id
 
Lawyer ID
Numeric
No
No
gsid
 
GS ID
Numeric
No
No
x_lawyer_id
 
External Lawyer ID
Text
No
Yes
x_lawyer_staff_id
 
External Lawyer Staff ID
Text
No
Yes
name
 
Lawyer Name
Text
No
No
address
 
Address
Text
No
No
city
 
City
Text
No
No
province
 
Province
Text
No
No
sub_urb
 
Sub Urb
Text
No
Yes
county
 
County
Text
No
Yes
zip
 
ZIP
Text
No
No
phone
 
Phone
Text
No
No
fax
 
Fax
Text
No
No
toll_free
 
Toll Free
Text
No
No
website
 
Website
Text
No
No
Lawyer Staff
get

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
lawyer_staff_id
 
Lawyer Staff ID
Numeric
No
No
loan_id
 
Loan ID
If provided, return the loan's (lender or borrower) lawyer staff. Use it with loan_lawyer_type.
Numeric
No
No
loan_lawyer_type
 
Lender or Borrower Lawyer Staff
Use it with loan_id.
0: Lender
1: Borrower
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
lawyer_staff_id
 
Lawyer Staff ID
Numeric
No
No
x_lawyer_staff_id
 
External Lawyer Staff ID
Text
No
Yes
lawyer_id
 
Lawyer ID
Numeric
No
No
lawyer
 
Lawyer
Lawyers
No
No
type
 
Lawyer Staff Type
0 - Partner
1 - Lawyer
2 - Clerk
3 - Paralegal
4 - Closer
5 - Pre-Closer
6 - Post-Closer
Enum
No
No
first_name
 
First Name
Text
No
Yes
last_name
 
Last Name
Text
No
No
phone
 
Phone
Text
No
Yes
email
 
Email
Text
No
No
list

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
If provided, response is the loan's broker staff
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
lawyer_staff
 
A List of Lawyer Staff
Refer to LawyerStaff->get
List-Lawyer Staff
No
No
Appraisers
get

POST: {ENDPOINT}/appraisers/get

Field
Description
Type
Required
Nullable
appraiser_id
 
Appraiser ID
Numeric
No
No
loan_id
 
Loan ID
If provided, return the loan's appraiser.
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
appraiser_id
 
Appraiser ID
Numeric
No
No
gsid
 
GS ID
Numeric
No
No
x_appraiser_id
 
External Appraiser ID
Text
No
Yes
name
 
Appraiser Name
Text
No
Yes
title
 
Appraiser Title
Text
No
No
address
 
Address
Text
No
Yes
city
 
City
Text
No
Yes
province
 
Province
Text
No
Yes
sub_urb
 
Sub Urb
Text
No
Yes
county
 
County
Text
No
Yes
zip
 
ZIP
Text
No
Yes
email
 
Email
Text
No
Yes
phone
 
Phone
Text
No
Yes
fax
 
Fax
Text
No
Yes
contact
 
Contact Name
Text
No
Yes
website
 
Website
Text
No
Yes
notes
 
Notes
Text
No
Yes
update

POST: {ENDPOINT}/appraisers/update

Field
Description
Type
Required
Nullable
appraiser_id
 
Appraiser ID
Numeric
No
No
gsid
 
GS ID
Numeric
No
No
x_appraiser_id
 
External Appraiser ID
Text
No
Yes
name
 
Appraiser Name
Text
No
Yes
title
 
Appraiser Title
Text
No
No
address
 
Address
Text
No
Yes
city
 
City
Text
No
Yes
province
 
Province
Text
No
Yes
sub_urb
 
Sub Urb
Text
No
Yes
county
 
County
Text
No
Yes
zip
 
ZIP
Text
No
Yes
email
 
Email
Text
No
Yes
phone
 
Phone
Text
No
Yes
fax
 
Fax
Text
No
Yes
contact
 
Contact Name
Text
No
Yes
website
 
Website
Text
No
Yes
notes
 
Notes
Text
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
appraiser
 
The updated appraiser
Refer to Appraiser->get
Appraisers
No
No
Appraiser Staff
get

POST: {ENDPOINT}/appraiserstaff/get

Field
Description
Type
Required
Nullable
appraiser_staff_id
 
Appraiser Staff ID
Numeric
No
No
loan_id
 
Loan ID
If provided, return the loan's appraiser staff.
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
appraiser_staff_id
 
Appraiser Staff ID
Numeric
No
No
appraiser_id
 
Appraiser ID
Numeric
No
No
appraiser
 
Appraiser
Appraisers
No
No
first_name
 
First Name
Text
No
Yes
last_name
 
Last Name
Text
No
Yes
phone
 
Phone
Text
No
Yes
email
 
Email
Text
No
Yes
update

POST: {ENDPOINT}/appraiserstaff/update

Field
Description
Type
Required
Nullable
appraiser_staff_id
 
Appraiser Staff ID
Numeric
No
No
appraiser_id
 
Appraiser ID
Numeric
No
No
appraiser
 
Appraiser
Appraisers
No
No
first_name
 
First Name
Text
No
Yes
last_name
 
Last Name
Text
No
Yes
phone
 
Phone
Text
No
Yes
email
 
Email
Text
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
appraiser_staff
 
The updated appraiser staff
Refer to AppraiserStaff->get
Appraiser Staff
No
No
Title Companies
get

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
title_company_id
 
Title Company ID
Numeric
No
No
loan_id
 
Loan ID
If provided, return the loan's title company.
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
title_company_id
 
Title Company ID
Numeric
No
No
gsid
 
GS ID
Numeric
No
No
x_title_company_id
 
External Title Company ID
Text
No
Yes
name
 
Title Company Name
Text
No
No
bank_name
 
Title Company Bank Name
Text
No
Yes
bank_address
 
Title Company Bank Address
Text
No
Yes
aba
 
ABA
Text
No
Yes
account_name
 
Bank Account Name
Text
No
Yes
account_number
 
Bank Account Number
Text
No
Yes
city
 
City
Text
No
No
province
 
Province
Text
No
No
sub_urb
 
Sub Urb
Text
No
Yes
county
 
County
Text
No
Yes
zip
 
ZIP
Text
No
No
phone
 
Phone
Text
No
No
toll_free
 
Toll Free Number
Text
No
Yes
policy_amount
 
Policy Amount
Numeric
No
Yes
fax
 
Fax
Text
No
Yes
Title Company Staff
get

POST: {ENDPOINT}/titlecompanystaff/get

Field
Description
Type
Required
Nullable
staff_id
 
Title Company Staff ID
Numeric
No
No
loan_id
 
Loan ID
If provided, return the loan's title company's staff.
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
staff_id
 
Title Company Staff ID
Numeric
No
No
title_company_id
 
Title Company ID
Numeric
No
No
x_staff_id
 
External Title Company Staff ID
Text
No
Yes
title_company
 
Title Company
Title Companies
No
No
first_name
 
First Name
Text
No
No
last_name
 
Last Name
Text
No
No
phone
 
Phone
Text
No
Yes
email
 
Email
Text
No
Yes
Employments
get

POST: {ENDPOINT}/employments/get

Field
Description
Type
Required
Nullable
employment_id
 
Employment ID
If provided, return the employment.
Numeric
No
No
response_field_whitelist
 
Response Field Whitelist
If defined, the employment list will include those fields (only basic fields allowed).
Array
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
employment_id
 
Employment ID
Numeric
No
No
name
 
Name
e.g. Mortgage Automator
Text
No
Yes
phone
 
Phone
e.g. 1234567890
Text
No
Yes
phone_ext
 
Phone Extension
e.g. 1234
Text
No
Yes
industry
 
Industry
e.g. Information Technology
Text
No
Yes
type
 
Type
0 -
1 - Full Time
2 - Part Time
3 - Seasonal
4 - Self Employed
e.g. 1 - Full Time , 2 - Parttime ...
Enum
No
Yes
previous_employer
 
Previous Employer
Text
No
Yes
history_status
 
Employment History Status
0 - current employment
1 - 2nd current employment
2 - past employment
Enum
No
Yes
address_full
 
Full Address
Refer to Addresses->get
Addresses
No
No
address
 
Address
e.g. Eglinton ave east
Text
No
Yes
length
 
Length of employment
e.g. 1 years 2 months
Text
No
Yes
salary
 
Annual Salary
e.g. 50000
Text
No
Yes
occupation
 
Occupation
Currently mapped to industry field
Text
No
Yes
job_title
 
Job Title
e.g. Software Developer
Text
No
Yes
frequency
 
Frequency of Payment
e.g. 1 month
Text
No
No
frequency_of_payment
 
Frequency of Payment
0 -
1 - Annual
2 - Semi-Annual
3 - Quarterly
4 - Monthly
5 - Semi-Monthly
6 - Bi-Weekly
7 - Weekly
e.g. Monthly
Enum
No
Yes
start_date
 
Start date of employment
Timestamp
No
Yes
end_date
 
End date of employment
Timestamp
No
Yes
current_employment
 
Whether the employment is current or past
e.g 0 - Past Employment 1 - Current Employment
Numeric
No
Yes
self_employed
 
Whether self employed
e.g 0 - Not Self Employed 1 - Self Employed
Numeric
No
Yes
list

POST: {ENDPOINT}/employments/list

Field
Description
Type
Required
Nullable
borrower_id
 
Borrower ID
If provided, response is the Borrowers's employments
Numeric
No
No
response_field_whitelist
 
Response Field Whitelist
If defined, the employment list will include those fields (only basic fields allowed).
Array
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
employments
 
List of employments
Refer to Employments->get
List-Employments
No
No
create

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
name
 
Name
e.g. Mortgage Automator
Text
No
Yes
phone
 
Phone
e.g. 1234567890
Text
No
Yes
phone_ext
 
Phone Extension
e.g. 1234
Text
No
Yes
industry
 
Industry
e.g. Information Technology
Text
No
Yes
type
 
Type
0 -
1 - Full Time
2 - Part Time
3 - Seasonal
4 - Self Employed
e.g. 1 - Full Time , 2 - Parttime ...
Enum
No
Yes
previous_employer
 
Previous Employer
Text
No
Yes
history_status
 
Employment History Status
0 - current employment
1 - 2nd current employment
2 - past employment
Enum
No
Yes
address_full
 
Full Address
Refer to Addresses->get
Addresses
No
No
address
 
Address
e.g. Eglinton ave east
Text
No
Yes
length
 
Length of employment
e.g. 1 years 2 months
Text
No
Yes
salary
 
Annual Salary
e.g. 50000
Text
No
Yes
occupation
 
Occupation
Currently mapped to industry field
Text
No
Yes
job_title
 
Job Title
e.g. Software Developer
Text
No
Yes
frequency
 
Frequency of Payment
e.g. 1 month
Text
No
No
frequency_of_payment
 
Frequency of Payment
0 -
1 - Annual
2 - Semi-Annual
3 - Quarterly
4 - Monthly
5 - Semi-Monthly
6 - Bi-Weekly
7 - Weekly
e.g. Monthly
Enum
No
Yes
start_date
 
Start date of employment
Timestamp
No
Yes
end_date
 
End date of employment
Timestamp
No
Yes
current_employment
 
Whether the employment is current or past
e.g 0 - Past Employment 1 - Current Employment
Numeric
No
Yes
self_employed
 
Whether self employed
e.g 0 - Not Self Employed 1 - Self Employed
Numeric
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
employment
 
The created Employment
Refer to Employments->get
Employments
No
No
update

POST: {ENDPOINT}/employments/update

Field
Description
Type
Required
Nullable
employment_id
 
Employment ID
Numeric
No
No
name
 
Name
e.g. Mortgage Automator
Text
No
Yes
phone
 
Phone
e.g. 1234567890
Text
No
Yes
phone_ext
 
Phone Extension
e.g. 1234
Text
No
Yes
industry
 
Industry
e.g. Information Technology
Text
No
Yes
type
 
Type
0 -
1 - Full Time
2 - Part Time
3 - Seasonal
4 - Self Employed
e.g. 1 - Full Time , 2 - Parttime ...
Enum
No
Yes
previous_employer
 
Previous Employer
Text
No
Yes
history_status
 
Employment History Status
0 - current employment
1 - 2nd current employment
2 - past employment
Enum
No
Yes
address_full
 
Full Address
Refer to Addresses->get
Addresses
No
No
length
 
Length of employment
e.g. 1 years 2 months
Text
No
Yes
salary
 
Annual Salary
e.g. 50000
Text
No
Yes
occupation
 
Occupation
Currently mapped to industry field
Text
No
Yes
job_title
 
Job Title
e.g. Software Developer
Text
No
Yes
frequency
 
Frequency of Payment
e.g. 1 month
Text
No
No
frequency_of_payment
 
Frequency of Payment
0 -
1 - Annual
2 - Semi-Annual
3 - Quarterly
4 - Monthly
5 - Semi-Monthly
6 - Bi-Weekly
7 - Weekly
e.g. Monthly
Enum
No
Yes
start_date
 
Start date of employment
Timestamp
No
Yes
end_date
 
End date of employment
Timestamp
No
Yes
current_employment
 
Whether the employment is current or past
e.g 0 - Past Employment 1 - Current Employment
Numeric
No
Yes
self_employed
 
Whether self employed
e.g 0 - Not Self Employed 1 - Self Employed
Numeric
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
employment
 
The updated employment
Refer to Employment->get
Employments
No
No
Incomes
get

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
If provided, response is the Borrower's Other Incomes
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
id
 
ID
Numeric
No
No
borrower_id
 
Borrower ID
Numeric
No
No
type
 
Type
0 -
1 - Salary
2 - Hourly
3 - Hourly + Commisions
4 - Commisions
5 - Interest Income
6 - Child Support
7 - Self-Employed
8 - Pension
9 - Alimony
10 - Rental Income
11 - Other
12 - Other Employment Income
e.g. Salary , Hourly , Commissions, etc
Enum
No
Yes
description
 
Description
e.g. Mortgage Automator
Text
No
Yes
period
 
Income Period
0 -
1 - Annual
2 - Semi-Annual
3 - Quarterly
4 - Monthly
5 - Semi-Monthly
6 - Bi-Weekly
7 - Weekly
Annual , Semi-Annual , Quaterly , Monthly , ..
Enum
No
Yes
amount
 
Amount
Other Income amount
Numeric
No
Yes
list

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
If provided, response is the Borrower's Other Incomes
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
incomes
 
List of other Incomes
Refer to Incomes->get
List-Incomes
No
No
update

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
id
 
ID
Numeric
No
No
borrower_id
 
Borrower ID
Numeric
No
No
type
 
Type
0 -
1 - Salary
2 - Hourly
3 - Hourly + Commisions
4 - Commisions
5 - Interest Income
6 - Child Support
7 - Self-Employed
8 - Pension
9 - Alimony
10 - Rental Income
11 - Other
12 - Other Employment Income
e.g. Salary , Hourly , Commissions, etc
Enum
No
Yes
description
 
Description
e.g. Mortgage Automator
Text
No
Yes
period
 
Income Period
0 -
1 - Annual
2 - Semi-Annual
3 - Quarterly
4 - Monthly
5 - Semi-Monthly
6 - Bi-Weekly
7 - Weekly
Annual , Semi-Annual , Quaterly , Monthly , ..
Enum
No
Yes
amount
 
Amount
Other Income amount
Numeric
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
income
 
The updated Income
Incomes
No
No
create

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
borrower_id
 
Borrower ID
Numeric
No
No
type
 
Type
0 -
1 - Salary
2 - Hourly
3 - Hourly + Commisions
4 - Commisions
5 - Interest Income
6 - Child Support
7 - Self-Employed
8 - Pension
9 - Alimony
10 - Rental Income
11 - Other
12 - Other Employment Income
e.g. Salary , Hourly , Commissions, etc
Enum
No
Yes
description
 
Description
e.g. Mortgage Automator
Text
No
Yes
period
 
Income Period
0 -
1 - Annual
2 - Semi-Annual
3 - Quarterly
4 - Monthly
5 - Semi-Monthly
6 - Bi-Weekly
7 - Weekly
Annual , Semi-Annual , Quaterly , Monthly , ..
Enum
No
Yes
amount
 
Amount
Other Income amount
Numeric
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
income
 
The created Income
Incomes
No
No
Other Expenses
get

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
If provided, response is the loan's other property other expenses
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
expense_id
 
Expense ID
If provided, response is the loan's Other Properties Expenses
Numeric
No
No
name
 
Other Expense name
Text
No
No
amount
 
Other Expense amount
Numeric
No
No
list

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
If provided, response is the other property other expenses
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
otherexpenses
 
List of other expenses in blanket properties
Refer to OtherExpenses->get
List-Other Expenses
No
No
Positions
get

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
If provided, response is the loan's other property positions
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
position_id
 
Position ID
If provided, response is the loan's Other Properties Mortgage Position
Numeric
No
No
balance
 
Other property existing mortgage balance
e.g. 500
Numeric
No
No
holder
 
Other property existing mortgage holder
e.g. Mortgage Automator
Text
No
No
face_value
 
Other property existing mortgage face value
e.g. 500000
Numeric
No
Yes
mortgageposition
 
Other property existing mortgage position
First , Second , Third , Fourth , ..
Numeric
No
No
payment
 
Other property existing mortgage payment
e.g. 500
Numeric
No
Yes
frequency
 
Other property existing mortgage payment frequency
1 - Weekly
2 - Biweekly
0 - Monthly
Weekly , bi-weekly, monthly
Enum
No
Yes
maturity
 
Other property existing mortgage maturity date
e.g. 540104400
Text
No
Yes
ratetype
 
Other property existing mortgage interest rate type
0 -
1 - Fixed
2 - Variable
3 - Adjustable
4 - Capped Variable
5 - Buydown
e.g. Fixed, Variable, Adjustable ..
Enum
No
Yes
termtype
 
Other property existing mortgage interest term type
0 - Fully Closed
1 - Closed Variable
2 - Closed, Then Open
3 - Fully Open
4 - Minimum, Then Open
e.g. Fully Closed, Closed Variable ..
Enum
No
Yes
rate
 
Other property existing mortgage interest rate
e.g. 4
Numeric
No
Yes
penalty
 
Other property existing mortgage penalty
e.g. 4
Numeric
No
Yes
inarrears
 
Other property existing mortgage arrear status
0 0r 1
Numeric
No
Yes
discharged
 
Other property existing mortgage discharged status
0 0r 1
Numeric
No
Yes
list

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
If provided, response is the loan's other property positions
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
positions
 
List of other property Positions
Refer to Positions->get
List-Positions
No
No
Assets
get

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
If provided, response is the loan's borrower assets
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
id
 
Asset ID
Numeric
No
No
borrower_id
 
Borrower ID
Numeric
No
No
type
 
Type
e.g. Savings , RRSP , Gift, etc
Enum
No
Yes
description
 
Description
Text
No
Yes
value
 
Value
Numeric
No
Yes
list

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
If provided, response is the Borrower's Other Incomes
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
assets
 
List of borrower assets
Refer to Asset->get
List-Assets
No
No
update

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
id
 
Asset ID
Numeric
No
No
borrower_id
 
Borrower ID
Numeric
No
No
type
 
Type
e.g. Savings , RRSP , Gift, etc
Enum
No
Yes
description
 
Description
Text
No
Yes
value
 
Value
Numeric
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
asset
 
The updated Asset
Refer to Asset->get
Assets
No
No
create

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
borrower_id
 
Borrower ID
Numeric
No
No
type
 
Type
e.g. Savings , RRSP , Gift, etc
Enum
No
Yes
description
 
Description
Text
No
Yes
value
 
Value
Numeric
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
asset
 
The created Asset
Assets
No
No
Joints
get

POST: {ENDPOINT}/joints/get

Field
Description
Type
Required
Nullable
id
 
Account Joint ID
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
id
 
Account Joint ID
Numeric
No
No
account_id
 
Account ID
Numeric
No
No
legal_name
 
Account joint partner name
Text
No
Yes
stake_percent
 
Account joint stake percent
Numeric
No
No
ssn
 
Account joint partner sin
Text
No
Yes
list

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
If provided, response is the investors's Joint Partners
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
joints
 
Joint partners
Refer to Joints->get
List-Joints
No
No
update

POST: {ENDPOINT}/joints/update

Field
Description
Type
Required
Nullable
id
 
Account Joint ID
Numeric
No
No
legal_name
 
Account joint partner name
Text
No
Yes
stake_percent
 
Account joint stake percent
Numeric
No
No
ssn
 
Account joint partner sin
Text
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
joint
 
The updated joint partner
Refer to Joint->get
Joints
No
No
create

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
account_id
 
Account ID
Numeric
No
No
legal_name
 
Account joint partner name
Text
No
Yes
stake_percent
 
Account joint stake percent
Numeric
No
No
ssn
 
Account joint partner sin
Text
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
joint
 
The created joint partner
Refer to Joint->get
Joints
No
No
Investments
get

POST: {ENDPOINT}/investments/get

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
If provided, return the loan's investors' investments
Numeric
No
No
id
 
Investment ID
If provided, return the investment.
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
id
 
Investment ID
Numeric
No
No
mortgage_id
 
Mortgage ID
Numeric
No
Yes
account_id
 
Account ID
See Account->get()->account_id
Numeric
No
Yes
interest
 
Investment interest
Numeric
No
Yes
rate_delta
 
Investment rate delta
Numeric
No
Yes
rate_type
 
Rate type
0 - Full variable rate
1 - Partial variable rate
2 - Fixed rate
4 - Investor at first loss position automatic rate
5 - A-piece variable rate
6 - Escalating variable A-piece rate (deprecated / old core loans only)
7 - Full variable escalating rate (deprecated / old core loans only)
Enum
No
No
piece_number
 
Investment class sequence
Numeric
No
No
enable_escalating_rate
 
Enable Escalating Rate
Default 0.
Numeric
No
No
escalating_rate
 
Escalating Rate
Numeric
No
No
escalating_cycles
 
Escalating rate becomes active after this number of payment cycles
Numeric
No
No
rest_rate
 
Standby Rate
Numeric
No
Yes
standby_amount
 
Standby amount
Numeric
No
Yes
amount
 
Investment amount
Numeric
No
Yes
min_rate
 
Investment min rate
Numeric
No
Yes
on_title
 
Investment on title
Numeric
No
No
is_residual
 
Is Residual
If 1 , this investor takes/covers the difference between the borrower and other investor payments.
Numeric
No
No
iad_style
 
Investor Iad Style
Enum
No
Yes
interest_method
 
Investor Interest Method
0 - equal amount
1 - per-diem based
2 - 31/360
3 - 360/365
4 - actual/360
6 - 30/360 Special
7 - 30/360 US
5 - decide on a loan by loan basis
Enum
No
Yes
enable_withhold_tax
 
Enable Withold Tax
Numeric
No
No
withhold_tax
 
Withold Tax
Numeric
No
Yes
calculation_properties
 
Calculation properties
Array
No
No
list

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
If provided, response is the investors's Investments
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
investments
 
Investments
Refer to Investment->get
List-Investments
No
No
update

POST: {ENDPOINT}/investments/update

Field
Description
Type
Required
Nullable
id
 
Investment ID
Numeric
No
No
mortgage_id
 
Mortgage ID
Numeric
No
Yes
account_id
 
Account ID
See Account->get()->account_id
Numeric
No
Yes
interest
 
Investment interest
Numeric
No
Yes
rate_delta
 
Investment rate delta
Numeric
No
Yes
rate_type
 
Rate type
0 - Full variable rate
1 - Partial variable rate
2 - Fixed rate
4 - Investor at first loss position automatic rate
5 - A-piece variable rate
6 - Escalating variable A-piece rate (deprecated / old core loans only)
7 - Full variable escalating rate (deprecated / old core loans only)
Enum
No
No
piece_number
 
Investment class sequence
Numeric
No
No
enable_escalating_rate
 
Enable Escalating Rate
Default 0.
Numeric
No
No
escalating_rate
 
Escalating Rate
Numeric
No
No
escalating_cycles
 
Escalating rate becomes active after this number of payment cycles
Numeric
No
No
rest_rate
 
Standby Rate
Numeric
No
Yes
standby_amount
 
Standby amount
Numeric
No
Yes
amount
 
Investment amount
Numeric
No
Yes
min_rate
 
Investment min rate
Numeric
No
Yes
on_title
 
Investment on title
Numeric
No
No
is_residual
 
Is Residual
If 1 , this investor takes/covers the difference between the borrower and other investor payments.
Numeric
No
No
iad_style
 
Investor Iad Style
Enum
No
Yes
interest_method
 
Investor Interest Method
0 - equal amount
1 - per-diem based
2 - 31/360
3 - 360/365
4 - actual/360
6 - 30/360 Special
7 - 30/360 US
5 - decide on a loan by loan basis
Enum
No
Yes
enable_withhold_tax
 
Enable Withold Tax
Numeric
No
No
withhold_tax
 
Withold Tax
Numeric
No
Yes
calculation_properties
 
Calculation properties
Array
No
No

Response Fields

Field
Description
Type
Required
Nullable
investment
 
The updated investment
Refer to Investment->get
Investments
No
No
Accounts
get

POST: {ENDPOINT}/accounts/get

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
If provided, return the loan's investors' accounts
Numeric
No
No
account_id
 
Account ID
If provided, return the investor accounts
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
account_id
 
Account ID
Numeric
No
No
x_accountid
 
External Account ID
Text
No
Yes
investor_id
 
Investor ID
If provided, response is the investor's accounts
Numeric
No
No
internal_account_number
 
Internal Account Number
Text
No
Yes
legal_name
 
Legal Name
Text
No
No
vesting_name
 
Vesting name
Only for Account Types Individual and Joint in US. Options are:
(blank): for Account Type: individual
a widow: for Account Type: individual
a widower: for Account Type: individual
a single woman: for Account Type: individual
a single man: for Account Type: individual
an unmarried woman: for Account Type: individual
an unmarried man: for Account Type: individual
a married man as his sole and separate property: for Account Type: individual
a married woman as her sole and separate property: for Account Type: individual
(blank): for Account Type: joint
husband and wife as joint tenants: for Account Type: joint
wife and husband as joint tenants: for Account Type: joint
husband and wife as community property with right of surivorship: for Account Type: joint
wife and husband as community property with right of surivorship: for Account Type: joint
husband and husband as joint tenants: for Account Type: joint
wife and wife as joint tenants: for Account Type: joint
Or any vesting name of your choice.
Text
No
Yes
check_type
 
Account Type
0 - Individual
1 - Joint
2 - Company
3 - Trust
4 - Personal Trust
5 - In-Trust
Enum
No
Yes
trust_type
 
Trust type
0 - Standard for CA
1 - Olympia Trust Company for CA
2 - ComputerShare Trust Company of Canada for CA
3 - Canadian Western Trust Company for CA
4 - Blueshore Financial for CA
5 - Westminster Savings Credit Union for CA
6 - Community Trust for CA
17 - BMO Nesbitt Burns for CA
18 - Investor Company for CA
19 - National Bank Financial Inc. for CA
20 - Odlum Brown for CA
21 - Scotia Capital Inc. for CA
22 - Central 1 Credit Union for CA
30 - Raymond James Ltd. for CA
31 - Odyssey Trust Company for CA
7 - Pacific Premier Trust for US
8 - Provident Trust Group for US
9 - Forge Trust Co. for US
10 - Millennium Trust Company for US
11 - Equity Trust Company for US
12 - The Entrust Group, Inc. for US
13 - IRAR Trust Co. for US
14 - MidAtlantic IRA for US
15 - Vantage Retirement Plans for US
16 - Other Retirement Plans for US
23 - New Direction Trust Company for US
24 - RBC Capital Markets for US
25 - IRA Financial Trust Company for US
26 - American Estate & Trust for US
27 - National Financial Services for US
28 - Charles Schwab & Co for US
29 - Madison Trust Company for US
32 - Direct Trust Company for US
33 - Advanta IRA for US
34 - Inspira Financial Trust for US
35 - iPlan Group for US
36 - uDirect IRA Services for US
Enum
No
Yes
plan_type
 
Plan type
0 - for CA
1 - TFSA for CA
2 - RRSP for CA
3 - RESP for CA
4 - SDRSP for CA
5 - RRIF for CA
6 - LIRA for CA
7 - RSP for CA
8 - LRSP for CA
9 - RSP (Spousal) for CA
10 - RIF for CA
11 - RIF (Spousal) for CA
12 - RIF (Prescribed) for CA
13 - LIF for CA
14 - LRIF for CA
15 - RLIF for CA
16 - RLSP for CA
33 - FHSA for CA
17 - for US
18 - IRA (Traditional) for US
19 - Roth IRA for US
20 - SEP IRA for US
21 - SIMPLE IRA for US
22 - 401(k) Plan for US
23 - 403(b) Plan for US
24 - 457 Plan for US
25 - Customdial IRA for US
26 - 529 Plan for US
27 - Coverdell Education Savings Accounts for US
28 - HSA for US
29 - PC Profit Sharing Plan & Trust for US
30 - Profit Sharing Plan for US
31 - Defined Benefit Plan for US
32 - Inherited IRA for US
Only for Account Type Trust
Enum
No
Yes
account_number
 
Account number
Text
No
Yes
enable_withhold_tax
 
Enable withhold tax
Numeric
No
Yes
withhold_tax
 
Withold tax rate
Numeric
No
Yes
enable_eft
 
Enable EFT / Direct Deposit
Numeric
No
No
eft_name
 
Account Name
Text
No
No
eft_bankid
 
Institution Number
0 - N/A
1 - BMO
2 - Scotia
3 - RBC
4 - TD
6 - National
10 - CIBC
16 - HSBC
30 - Canadian Western Bank / Western Union
39 - Laurentian
117 - Government
177 - Bank of Canada
219 - ATB
241 - Bank of America
260 - Citi
275 - KEB Hana
307 - Industrial and Commercial Bank of China (Canada)
308 - Bank of China
309 - Citizens
318 - U.S. Bank National Association
320 - PC Financial
321 - Habib Canadian Bank
326 - Simplii Financial
340 - ICICI Bank of Canada
352 - Digital Commerce Bank
370 - Wealth One Bank of Canada
374 - Motus Bank
383 - Peoples Bank of Canada
509 - The Canadian Trust Company
532 - Effort Trust Company
540 - Manulife Bank
568 - Peace Hills Trust Company
608 - Banque Alterna
614 - ING / Tangerine
621 - Peoples Trust Company
623 - Equitable Bank
703 - Wealthsimple Investments Inc.
809 - Central 1 Credit Union BC
815 - Desjardins
819 - La Fédération des caisses populaires du Manitoba Inc.
828 - Central 1 Credit Union Ontario
829 - La Fédération des caisses populaires de l'Ontario Inc.
837 - Meridian Credit Union
839 - Central 1 Credit Union Atlantic
842 - Alterna Savings
849 - Bayview Credit Union
853 - Concentra Financial Services
865 - UNI Financial Coop
879 - Co-op Credit Society of Manitoba
889 - Credit Union Central of Saskatchewan
890 - Alliance des caisses populaires de l'Ontario Limitée
899 - Credit Union Alberta
Only for Canada.
Enum
No
No
eft_transit
 
Branch Number / Transit Number / Routing Number
Text
No
No
eft_account
 
Account Number
Text
No
No
eft_account_type
 
Account Type
0 - Checking
1 - Savings
2 - Loan Account
Only for US.
Enum
No
No
enable_eft_direct_deposit
 
Enable deposits directly from borrower
Default 0. 0: Disable. 1: Enable
Numeric
No
Yes
eft_direct_deposit_data_centre
 
Data Centre for Deposits Directly from Borrower
0 - N/A N/A
120 - BMO All Regions
220 - Scotia All Regions
278 - RBC Regina
300 - RBC Vancouver
310 - RBC Montreal
320 - RBC Toronto
330 - RBC Halifax
370 - RBC Winnipeg
390 - RBC Calgary
420 - TD All Regions
610 - National All Regions
1000 - CIBC Vancouver
1010 - CIBC Montreal
1020 - CIBC Toronto
1030 - CIBC Halifax
1070 - CIBC Winnipeg
1090 - CIBC Calgary
1600 - HSBC All Regions
86990 - Canadian Western Bank / Western Union All Regions
21990 - ATB All Regions
10 - Central 1 Credit Union BC All Regions
86920 - Central 1 Credit Union Ontario Ontario
81510 - La Fédération des caisses populaires de l'Ontario Inc. All Regions
86500 - Central 1 Credit Union Atlantic Atlantic Central
86900 - Central 1 Credit Union Atlantic BC and Atlantic
11 - Credit Union Alberta All Regions
Data Centre ID. Only for Canada.
Enum
No
No
eft_direct_deposit_originator_id
 
Originator ID / Name for Deposits Directly from Borrower
Text
No
No
eft_direct_deposit_company_id
 
ACH Company ID for Deposits Directly from Borrower
Only for US.
Text
No
Yes
eft_direct_deposit_handling_bank
 
Handling Bank for Deposits Directly from Borrower
Only for US.
Text
No
No
ontitle
 
On Title
Numeric
No
Yes
default_interest
 
Default Interest (%)
Numeric
No
Yes
total_funds_to_invest
 
Total Funds to Invest
Numeric
No
Yes
enable_different_tax_address
 
Enable different tax address status
Numeric
No
Yes
tax_address
 
Tax address
Refer to Addresses->get
Addresses
No
No
is_servicer
 
Investor servicer check
Numeric
No
No
tax_id_or_ssn
 
Account Tax ID or SIN
SIN for Individual Account
Text
No
Yes
tax_id_type
 
Recipient ID Type
1 - 1 (Individual)
2 - 2 (Joint account)
3 - 3 (Corporation)
4 - 4 (Association, trust, club, or partnership)
5 - 5 (Government)
6 - 1 (EIN)
7 - 2 (SSN)
8 - 3 (ITIN)
9 - 4 (ATIN)
CA: Recipient ID Type (T5 Box 23). US: Federal ID Type.
Enum
No
Yes
fund_start_date
 
Fund Start Date
Text
No
No
deactivated
 
Account is deactivated
Default 0. 0: false, 1: true.
Numeric
No
Yes
is_primary
 
Account is a primary account of a fund investor
Default 0. 0: false, 1: true.
Numeric
No
No
used_on_loan
 
Whether this investment account is used for the provided loan or not. If the loan ID is not provided, this field will not apply.
Default 0. 0: false, 1: true.
Numeric
No
No
compliance_exemption_rule
 
Compliance: Exemption Rule/Section
0 -
1 - NI 45-106 2.3 [Accredited investor]
2 - NI 45-106 2.5 [Family, friends and business associates]
3 - NI 45-106 2.9(1) [Offering memorandum] (BC, NL)
4 - NI 45-106 2.9(2) [Offering memorandum] (MB, PE, YT, NT, NU)
5 - NI 45-106 2.9(2.1) [Offering memorandum] (AB, SK, ON, QC, NB, NS)
6 - NI 45-106 2.10 [Minimum amount investment]
7 - NI 45-106 2.12 [Asset acquisition]
8 - NI 45-106 2.13 [Petroleum, natural gas and mining properties]
9 - NI 45-106 2.14 [Securities for debt]
10 - NI 45-106 2.19 [Additional investment in investment funds]
11 - NI 45-106 2.30 [Isolated distribution by issuer]
12 - Existing security holder exemption
13 - Investment dealer exemption (BC, AB, SK, MB, NB)
14 - MI 45-108 [Crowdfunding] (SK, MB, ON, QC, NB, NS)
15 - Distributions to purchasers outside of local jurisdiction (BC, AB, NB)
16 - NI 45-106 5.2 [TSX Venture Exchange offering]
17 - Other [describe in next column]
Enum
No
Yes
compliance_other_exemption_rule
 
Compliance: Other Exemption Rule
Number of Local Rule/Order/Blanket Order
Text
No
Yes
compliance_paragraph_number_ni45106s23
 
Compliance: Paragraph Number - Section 2.3 Accredited Investor
0 -
1 - a
2 - b
3 - c
4 - d
5 - e
6 - e.1
7 - f
8 - g
9 - h
10 - i
11 - j
12 - j.1
13 - k
14 - l
15 - m
16 - n
17 - o
18 - p
19 - q
20 - r
21 - s
22 - t
23 - u
24 - v
25 - w
26 - a and/or p
27 - d and/or q
Enum
No
Yes
compliance_paragraph_number_ni45106s25
 
Compliance: Paragraph Number - Section 2.5(1)
0 -
1 - a
2 - b
3 - c
4 - d
5 - e
6 - f
7 - g
8 - h
9 - i
Enum
No
Yes
compliance_name_ni45106s25
 
Compliance: Name of Related Issuer Individual
NI 45-106 2.5
Text
No
Yes
compliance_position_ni45106s25
 
Compliance: Position of Related Issuer Individual
0 -
1 - Director (D)
2 - Executive officer (O)
3 - Control person (C)
4 - Founder (F)
NI 45-106 2.5
Enum
No
Yes
compliance_paragraph_number_ni45106s29
 
Compliance: Paragraph Number - Section 2.9(2/2.1)
0 -
1 - a
2 - b
3 - c
4 - d
5 - e
6 - f
7 - g
8 - h
Enum
No
Yes
compliance_is_purchaser_registrant
 
Compliance: Is the Purchaser a Registrant?
Default 0. 0: false, 1: true.
Numeric
No
Yes
compliance_is_purchaser_insider
 
Compliance: Is the Purchaser a Insider?
Default 0. 0: false, 1: true.
Numeric
No
Yes
compliance_legal_name
 
Compliance: Legal Name of Compensated Person
Text
No
Yes
directors
 
Account Directors
Refer to AccountDirectors->get
List-Account Directors
No
No
trustees
 
Account Trustees
Refer to AccountTrustees->get
List-Account Trustees
No
No
investments
 
Account investments
Refer to Investments->get
List-Investments
No
No
joints
 
Account joint partners
Refer to Joints->get
List-Joints
No
No
loans
 
Loans associated with the Account
loan_id's only.
List-Loans
No
No
report_fields
 
Report Fields
Array
No
No
custom_fields
 
Custom Fields
Array
No
No
list

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
investor_id
 
Investor ID
If provided, response is the investor's accounts
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
accounts
 
Accounts
Refer to Account->get
List-Accounts
No
No
update

POST: {ENDPOINT}/accounts/update

Field
Description
Type
Required
Nullable
account_id
 
Account ID
Numeric
No
No
x_accountid
 
External Account ID
Text
No
Yes
investor_id
 
Investor ID
If provided, response is the investor's accounts
Numeric
No
No
internal_account_number
 
Internal Account Number
Text
No
Yes
legal_name
 
Legal Name
Text
No
No
vesting_name
 
Vesting name
Only for Account Types Individual and Joint in US. Options are:
(blank): for Account Type: individual
a widow: for Account Type: individual
a widower: for Account Type: individual
a single woman: for Account Type: individual
a single man: for Account Type: individual
an unmarried woman: for Account Type: individual
an unmarried man: for Account Type: individual
a married man as his sole and separate property: for Account Type: individual
a married woman as her sole and separate property: for Account Type: individual
(blank): for Account Type: joint
husband and wife as joint tenants: for Account Type: joint
wife and husband as joint tenants: for Account Type: joint
husband and wife as community property with right of surivorship: for Account Type: joint
wife and husband as community property with right of surivorship: for Account Type: joint
husband and husband as joint tenants: for Account Type: joint
wife and wife as joint tenants: for Account Type: joint
Or any vesting name of your choice.
Text
No
Yes
check_type
 
Account Type
0 - Individual
1 - Joint
2 - Company
3 - Trust
4 - Personal Trust
5 - In-Trust
Enum
No
Yes
trust_type
 
Trust type
0 - Standard for CA
1 - Olympia Trust Company for CA
2 - ComputerShare Trust Company of Canada for CA
3 - Canadian Western Trust Company for CA
4 - Blueshore Financial for CA
5 - Westminster Savings Credit Union for CA
6 - Community Trust for CA
17 - BMO Nesbitt Burns for CA
18 - Investor Company for CA
19 - National Bank Financial Inc. for CA
20 - Odlum Brown for CA
21 - Scotia Capital Inc. for CA
22 - Central 1 Credit Union for CA
30 - Raymond James Ltd. for CA
31 - Odyssey Trust Company for CA
7 - Pacific Premier Trust for US
8 - Provident Trust Group for US
9 - Forge Trust Co. for US
10 - Millennium Trust Company for US
11 - Equity Trust Company for US
12 - The Entrust Group, Inc. for US
13 - IRAR Trust Co. for US
14 - MidAtlantic IRA for US
15 - Vantage Retirement Plans for US
16 - Other Retirement Plans for US
23 - New Direction Trust Company for US
24 - RBC Capital Markets for US
25 - IRA Financial Trust Company for US
26 - American Estate & Trust for US
27 - National Financial Services for US
28 - Charles Schwab & Co for US
29 - Madison Trust Company for US
32 - Direct Trust Company for US
33 - Advanta IRA for US
34 - Inspira Financial Trust for US
35 - iPlan Group for US
36 - uDirect IRA Services for US
Enum
No
Yes
plan_type
 
Plan type
0 - for CA
1 - TFSA for CA
2 - RRSP for CA
3 - RESP for CA
4 - SDRSP for CA
5 - RRIF for CA
6 - LIRA for CA
7 - RSP for CA
8 - LRSP for CA
9 - RSP (Spousal) for CA
10 - RIF for CA
11 - RIF (Spousal) for CA
12 - RIF (Prescribed) for CA
13 - LIF for CA
14 - LRIF for CA
15 - RLIF for CA
16 - RLSP for CA
33 - FHSA for CA
17 - for US
18 - IRA (Traditional) for US
19 - Roth IRA for US
20 - SEP IRA for US
21 - SIMPLE IRA for US
22 - 401(k) Plan for US
23 - 403(b) Plan for US
24 - 457 Plan for US
25 - Customdial IRA for US
26 - 529 Plan for US
27 - Coverdell Education Savings Accounts for US
28 - HSA for US
29 - PC Profit Sharing Plan & Trust for US
30 - Profit Sharing Plan for US
31 - Defined Benefit Plan for US
32 - Inherited IRA for US
Only for Account Type Trust
Enum
No
Yes
account_number
 
Account number
Text
No
Yes
enable_withhold_tax
 
Enable withhold tax
Numeric
No
Yes
withhold_tax
 
Withold tax rate
Numeric
No
Yes
enable_eft
 
Enable EFT / Direct Deposit
Numeric
No
No
eft_name
 
Account Name
Text
No
No
eft_bankid
 
Institution Number
0 - N/A
1 - BMO
2 - Scotia
3 - RBC
4 - TD
6 - National
10 - CIBC
16 - HSBC
30 - Canadian Western Bank / Western Union
39 - Laurentian
117 - Government
177 - Bank of Canada
219 - ATB
241 - Bank of America
260 - Citi
275 - KEB Hana
307 - Industrial and Commercial Bank of China (Canada)
308 - Bank of China
309 - Citizens
318 - U.S. Bank National Association
320 - PC Financial
321 - Habib Canadian Bank
326 - Simplii Financial
340 - ICICI Bank of Canada
352 - Digital Commerce Bank
370 - Wealth One Bank of Canada
374 - Motus Bank
383 - Peoples Bank of Canada
509 - The Canadian Trust Company
532 - Effort Trust Company
540 - Manulife Bank
568 - Peace Hills Trust Company
608 - Banque Alterna
614 - ING / Tangerine
621 - Peoples Trust Company
623 - Equitable Bank
703 - Wealthsimple Investments Inc.
809 - Central 1 Credit Union BC
815 - Desjardins
819 - La Fédération des caisses populaires du Manitoba Inc.
828 - Central 1 Credit Union Ontario
829 - La Fédération des caisses populaires de l'Ontario Inc.
837 - Meridian Credit Union
839 - Central 1 Credit Union Atlantic
842 - Alterna Savings
849 - Bayview Credit Union
853 - Concentra Financial Services
865 - UNI Financial Coop
879 - Co-op Credit Society of Manitoba
889 - Credit Union Central of Saskatchewan
890 - Alliance des caisses populaires de l'Ontario Limitée
899 - Credit Union Alberta
Only for Canada.
Enum
No
No
eft_transit
 
Branch Number / Transit Number / Routing Number
Text
No
No
eft_account
 
Account Number
Text
No
No
eft_account_type
 
Account Type
0 - Checking
1 - Savings
2 - Loan Account
Only for US.
Enum
No
No
enable_eft_direct_deposit
 
Enable deposits directly from borrower
Default 0. 0: Disable. 1: Enable
Numeric
No
Yes
eft_direct_deposit_data_centre
 
Data Centre for Deposits Directly from Borrower
0 - N/A N/A
120 - BMO All Regions
220 - Scotia All Regions
278 - RBC Regina
300 - RBC Vancouver
310 - RBC Montreal
320 - RBC Toronto
330 - RBC Halifax
370 - RBC Winnipeg
390 - RBC Calgary
420 - TD All Regions
610 - National All Regions
1000 - CIBC Vancouver
1010 - CIBC Montreal
1020 - CIBC Toronto
1030 - CIBC Halifax
1070 - CIBC Winnipeg
1090 - CIBC Calgary
1600 - HSBC All Regions
86990 - Canadian Western Bank / Western Union All Regions
21990 - ATB All Regions
10 - Central 1 Credit Union BC All Regions
86920 - Central 1 Credit Union Ontario Ontario
81510 - La Fédération des caisses populaires de l'Ontario Inc. All Regions
86500 - Central 1 Credit Union Atlantic Atlantic Central
86900 - Central 1 Credit Union Atlantic BC and Atlantic
11 - Credit Union Alberta All Regions
Data Centre ID. Only for Canada.
Enum
No
No
eft_direct_deposit_originator_id
 
Originator ID / Name for Deposits Directly from Borrower
Text
No
No
eft_direct_deposit_company_id
 
ACH Company ID for Deposits Directly from Borrower
Only for US.
Text
No
Yes
eft_direct_deposit_handling_bank
 
Handling Bank for Deposits Directly from Borrower
Only for US.
Text
No
No
ontitle
 
On Title
Numeric
No
Yes
default_interest
 
Default Interest (%)
Numeric
No
Yes
total_funds_to_invest
 
Total Funds to Invest
Numeric
No
Yes
enable_different_tax_address
 
Enable different tax address status
Numeric
No
Yes
tax_address
 
Tax address
Refer to Addresses->get
Addresses
No
No
is_servicer
 
Investor servicer check
Numeric
No
No
tax_id_or_ssn
 
Account Tax ID or SIN
SIN for Individual Account
Text
No
Yes
tax_id_type
 
Recipient ID Type
1 - 1 (Individual)
2 - 2 (Joint account)
3 - 3 (Corporation)
4 - 4 (Association, trust, club, or partnership)
5 - 5 (Government)
6 - 1 (EIN)
7 - 2 (SSN)
8 - 3 (ITIN)
9 - 4 (ATIN)
CA: Recipient ID Type (T5 Box 23). US: Federal ID Type.
Enum
No
Yes
fund_start_date
 
Fund Start Date
Text
No
No
deactivated
 
Account is deactivated
Default 0. 0: false, 1: true.
Numeric
No
Yes
is_primary
 
Account is a primary account of a fund investor
Default 0. 0: false, 1: true.
Numeric
No
No
compliance_exemption_rule
 
Compliance: Exemption Rule/Section
0 -
1 - NI 45-106 2.3 [Accredited investor]
2 - NI 45-106 2.5 [Family, friends and business associates]
3 - NI 45-106 2.9(1) [Offering memorandum] (BC, NL)
4 - NI 45-106 2.9(2) [Offering memorandum] (MB, PE, YT, NT, NU)
5 - NI 45-106 2.9(2.1) [Offering memorandum] (AB, SK, ON, QC, NB, NS)
6 - NI 45-106 2.10 [Minimum amount investment]
7 - NI 45-106 2.12 [Asset acquisition]
8 - NI 45-106 2.13 [Petroleum, natural gas and mining properties]
9 - NI 45-106 2.14 [Securities for debt]
10 - NI 45-106 2.19 [Additional investment in investment funds]
11 - NI 45-106 2.30 [Isolated distribution by issuer]
12 - Existing security holder exemption
13 - Investment dealer exemption (BC, AB, SK, MB, NB)
14 - MI 45-108 [Crowdfunding] (SK, MB, ON, QC, NB, NS)
15 - Distributions to purchasers outside of local jurisdiction (BC, AB, NB)
16 - NI 45-106 5.2 [TSX Venture Exchange offering]
17 - Other [describe in next column]
Enum
No
Yes
compliance_other_exemption_rule
 
Compliance: Other Exemption Rule
Number of Local Rule/Order/Blanket Order
Text
No
Yes
compliance_paragraph_number_ni45106s23
 
Compliance: Paragraph Number - Section 2.3 Accredited Investor
0 -
1 - a
2 - b
3 - c
4 - d
5 - e
6 - e.1
7 - f
8 - g
9 - h
10 - i
11 - j
12 - j.1
13 - k
14 - l
15 - m
16 - n
17 - o
18 - p
19 - q
20 - r
21 - s
22 - t
23 - u
24 - v
25 - w
26 - a and/or p
27 - d and/or q
Enum
No
Yes
compliance_paragraph_number_ni45106s25
 
Compliance: Paragraph Number - Section 2.5(1)
0 -
1 - a
2 - b
3 - c
4 - d
5 - e
6 - f
7 - g
8 - h
9 - i
Enum
No
Yes
compliance_name_ni45106s25
 
Compliance: Name of Related Issuer Individual
NI 45-106 2.5
Text
No
Yes
compliance_position_ni45106s25
 
Compliance: Position of Related Issuer Individual
0 -
1 - Director (D)
2 - Executive officer (O)
3 - Control person (C)
4 - Founder (F)
NI 45-106 2.5
Enum
No
Yes
compliance_paragraph_number_ni45106s29
 
Compliance: Paragraph Number - Section 2.9(2/2.1)
0 -
1 - a
2 - b
3 - c
4 - d
5 - e
6 - f
7 - g
8 - h
Enum
No
Yes
compliance_is_purchaser_registrant
 
Compliance: Is the Purchaser a Registrant?
Default 0. 0: false, 1: true.
Numeric
No
Yes
compliance_is_purchaser_insider
 
Compliance: Is the Purchaser a Insider?
Default 0. 0: false, 1: true.
Numeric
No
Yes
compliance_legal_name
 
Compliance: Legal Name of Compensated Person
Text
No
Yes
directors
 
Account Directors
Refer to AccountDirectors->get
List-Account Directors
No
No
trustees
 
Account Trustees
Refer to AccountTrustees->get
List-Account Trustees
No
No
investments
 
Account investments
Refer to Investments->get
List-Investments
No
No
joints
 
Account joint partners
Refer to Joints->get
List-Joints
No
No
custom_fields
 
Custom Fields
Array
No
No

Response Fields

Field
Description
Type
Required
Nullable
account
 
The updated Account
Refer to Account->get
Accounts
No
No
create

POST: {ENDPOINT}/accounts/create

Field
Description
Type
Required
Nullable
account_id
 
Account ID
Numeric
No
No
x_accountid
 
External Account ID
Text
No
Yes
investor_id
 
Investor ID
If provided, response is the investor's accounts
Numeric
No
No
internal_account_number
 
Internal Account Number
Text
No
Yes
legal_name
 
Legal Name
Text
No
No
vesting_name
 
Vesting name
Only for Account Types Individual and Joint in US. Options are:
(blank): for Account Type: individual
a widow: for Account Type: individual
a widower: for Account Type: individual
a single woman: for Account Type: individual
a single man: for Account Type: individual
an unmarried woman: for Account Type: individual
an unmarried man: for Account Type: individual
a married man as his sole and separate property: for Account Type: individual
a married woman as her sole and separate property: for Account Type: individual
(blank): for Account Type: joint
husband and wife as joint tenants: for Account Type: joint
wife and husband as joint tenants: for Account Type: joint
husband and wife as community property with right of surivorship: for Account Type: joint
wife and husband as community property with right of surivorship: for Account Type: joint
husband and husband as joint tenants: for Account Type: joint
wife and wife as joint tenants: for Account Type: joint
Or any vesting name of your choice.
Text
No
Yes
check_type
 
Account Type
0 - Individual
1 - Joint
2 - Company
3 - Trust
4 - Personal Trust
5 - In-Trust
Enum
No
Yes
trust_type
 
Trust type
0 - Standard for CA
1 - Olympia Trust Company for CA
2 - ComputerShare Trust Company of Canada for CA
3 - Canadian Western Trust Company for CA
4 - Blueshore Financial for CA
5 - Westminster Savings Credit Union for CA
6 - Community Trust for CA
17 - BMO Nesbitt Burns for CA
18 - Investor Company for CA
19 - National Bank Financial Inc. for CA
20 - Odlum Brown for CA
21 - Scotia Capital Inc. for CA
22 - Central 1 Credit Union for CA
30 - Raymond James Ltd. for CA
31 - Odyssey Trust Company for CA
7 - Pacific Premier Trust for US
8 - Provident Trust Group for US
9 - Forge Trust Co. for US
10 - Millennium Trust Company for US
11 - Equity Trust Company for US
12 - The Entrust Group, Inc. for US
13 - IRAR Trust Co. for US
14 - MidAtlantic IRA for US
15 - Vantage Retirement Plans for US
16 - Other Retirement Plans for US
23 - New Direction Trust Company for US
24 - RBC Capital Markets for US
25 - IRA Financial Trust Company for US
26 - American Estate & Trust for US
27 - National Financial Services for US
28 - Charles Schwab & Co for US
29 - Madison Trust Company for US
32 - Direct Trust Company for US
33 - Advanta IRA for US
34 - Inspira Financial Trust for US
35 - iPlan Group for US
36 - uDirect IRA Services for US
Enum
No
Yes
plan_type
 
Plan type
0 - for CA
1 - TFSA for CA
2 - RRSP for CA
3 - RESP for CA
4 - SDRSP for CA
5 - RRIF for CA
6 - LIRA for CA
7 - RSP for CA
8 - LRSP for CA
9 - RSP (Spousal) for CA
10 - RIF for CA
11 - RIF (Spousal) for CA
12 - RIF (Prescribed) for CA
13 - LIF for CA
14 - LRIF for CA
15 - RLIF for CA
16 - RLSP for CA
33 - FHSA for CA
17 - for US
18 - IRA (Traditional) for US
19 - Roth IRA for US
20 - SEP IRA for US
21 - SIMPLE IRA for US
22 - 401(k) Plan for US
23 - 403(b) Plan for US
24 - 457 Plan for US
25 - Customdial IRA for US
26 - 529 Plan for US
27 - Coverdell Education Savings Accounts for US
28 - HSA for US
29 - PC Profit Sharing Plan & Trust for US
30 - Profit Sharing Plan for US
31 - Defined Benefit Plan for US
32 - Inherited IRA for US
Only for Account Type Trust
Enum
No
Yes
account_number
 
Account number
Text
No
Yes
enable_withhold_tax
 
Enable withhold tax
Numeric
No
Yes
withhold_tax
 
Withold tax rate
Numeric
No
Yes
enable_eft
 
Enable EFT / Direct Deposit
Numeric
No
No
eft_name
 
Account Name
Text
No
No
eft_bankid
 
Institution Number
0 - N/A
1 - BMO
2 - Scotia
3 - RBC
4 - TD
6 - National
10 - CIBC
16 - HSBC
30 - Canadian Western Bank / Western Union
39 - Laurentian
117 - Government
177 - Bank of Canada
219 - ATB
241 - Bank of America
260 - Citi
275 - KEB Hana
307 - Industrial and Commercial Bank of China (Canada)
308 - Bank of China
309 - Citizens
318 - U.S. Bank National Association
320 - PC Financial
321 - Habib Canadian Bank
326 - Simplii Financial
340 - ICICI Bank of Canada
352 - Digital Commerce Bank
370 - Wealth One Bank of Canada
374 - Motus Bank
383 - Peoples Bank of Canada
509 - The Canadian Trust Company
532 - Effort Trust Company
540 - Manulife Bank
568 - Peace Hills Trust Company
608 - Banque Alterna
614 - ING / Tangerine
621 - Peoples Trust Company
623 - Equitable Bank
703 - Wealthsimple Investments Inc.
809 - Central 1 Credit Union BC
815 - Desjardins
819 - La Fédération des caisses populaires du Manitoba Inc.
828 - Central 1 Credit Union Ontario
829 - La Fédération des caisses populaires de l'Ontario Inc.
837 - Meridian Credit Union
839 - Central 1 Credit Union Atlantic
842 - Alterna Savings
849 - Bayview Credit Union
853 - Concentra Financial Services
865 - UNI Financial Coop
879 - Co-op Credit Society of Manitoba
889 - Credit Union Central of Saskatchewan
890 - Alliance des caisses populaires de l'Ontario Limitée
899 - Credit Union Alberta
Only for Canada.
Enum
No
No
eft_transit
 
Branch Number / Transit Number / Routing Number
Text
No
No
eft_account
 
Account Number
Text
No
No
eft_account_type
 
Account Type
0 - Checking
1 - Savings
2 - Loan Account
Only for US.
Enum
No
No
enable_eft_direct_deposit
 
Enable deposits directly from borrower
Default 0. 0: Disable. 1: Enable
Numeric
No
Yes
eft_direct_deposit_data_centre
 
Data Centre for Deposits Directly from Borrower
0 - N/A N/A
120 - BMO All Regions
220 - Scotia All Regions
278 - RBC Regina
300 - RBC Vancouver
310 - RBC Montreal
320 - RBC Toronto
330 - RBC Halifax
370 - RBC Winnipeg
390 - RBC Calgary
420 - TD All Regions
610 - National All Regions
1000 - CIBC Vancouver
1010 - CIBC Montreal
1020 - CIBC Toronto
1030 - CIBC Halifax
1070 - CIBC Winnipeg
1090 - CIBC Calgary
1600 - HSBC All Regions
86990 - Canadian Western Bank / Western Union All Regions
21990 - ATB All Regions
10 - Central 1 Credit Union BC All Regions
86920 - Central 1 Credit Union Ontario Ontario
81510 - La Fédération des caisses populaires de l'Ontario Inc. All Regions
86500 - Central 1 Credit Union Atlantic Atlantic Central
86900 - Central 1 Credit Union Atlantic BC and Atlantic
11 - Credit Union Alberta All Regions
Data Centre ID. Only for Canada.
Enum
No
No
eft_direct_deposit_originator_id
 
Originator ID / Name for Deposits Directly from Borrower
Text
No
No
eft_direct_deposit_company_id
 
ACH Company ID for Deposits Directly from Borrower
Only for US.
Text
No
Yes
eft_direct_deposit_handling_bank
 
Handling Bank for Deposits Directly from Borrower
Only for US.
Text
No
No
ontitle
 
On Title
Numeric
No
Yes
default_interest
 
Default Interest (%)
Numeric
No
Yes
total_funds_to_invest
 
Total Funds to Invest
Numeric
No
Yes
enable_different_tax_address
 
Enable different tax address status
Numeric
No
Yes
tax_address
 
Tax address
Refer to Addresses->get
Addresses
No
No
is_servicer
 
Investor servicer check
Numeric
No
No
tax_id_or_ssn
 
Account Tax ID or SIN
SIN for Individual Account
Text
No
Yes
tax_id_type
 
Recipient ID Type
1 - 1 (Individual)
2 - 2 (Joint account)
3 - 3 (Corporation)
4 - 4 (Association, trust, club, or partnership)
5 - 5 (Government)
6 - 1 (EIN)
7 - 2 (SSN)
8 - 3 (ITIN)
9 - 4 (ATIN)
CA: Recipient ID Type (T5 Box 23). US: Federal ID Type.
Enum
No
Yes
directors
 
Account Directors
Refer to AccountDirectors->get
List-Account Directors
No
No
trustees
 
Account Trustees
Refer to AccountTrustees->get
List-Account Trustees
No
No
joints
 
Account joint partners
Refer to Joints->get
List-Joints
No
No
custom_fields
 
Custom Fields
Array
No
No

Response Fields

Field
Description
Type
Required
Nullable
account
 
The created account
Refer to Account->get
Accounts
No
No
Account Directors
get

POST: {ENDPOINT}/account_directors/get

Field
Description
Type
Required
Nullable
id
 
Account Director ID
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
id
 
Account Director ID
Numeric
No
No
account_id
 
Account ID
Numeric
No
No
legal_name
 
Account Director Legal Name
Text
No
Yes
list

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
account_id
 
Account ID
If provided, response is the account's directors
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
directors
 
Account Directors
Refer to AccountDirector->get
List-Account Directors
No
No
update

POST: {ENDPOINT}/account_directors/update

Field
Description
Type
Required
Nullable
id
 
Account Director ID
Numeric
No
No
legal_name
 
Account Director Legal Name
Text
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
director
 
The updated account director
Refer to AccountDirector->get
Account Directors
No
No
create

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
account_id
 
Account ID
Numeric
No
No
legal_name
 
Account Director Legal Name
Text
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
director
 
The created account director
Account Directors
No
No
Account Trustees
get

POST: {ENDPOINT}/account_trustees/get

Field
Description
Type
Required
Nullable
id
 
Account Trustee ID
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
id
 
Account Trustee ID
Numeric
No
No
account_id
 
Account ID
Numeric
No
No
legal_name
 
Account Trustee Legal Name
Text
No
Yes
tax_id
 
Account Trustee Tax ID
Text
No
Yes
list

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
account_id
 
Account ID
If provided, response is the account's trustees
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
trustees
 
Account Trustees
Refer to AccountTrustee->get
List-Account Trustees
No
No
update

POST: {ENDPOINT}/account_trustees/update

Field
Description
Type
Required
Nullable
id
 
Account Trustee ID
Numeric
No
No
legal_name
 
Account Trustee Legal Name
Text
No
Yes
tax_id
 
Account Trustee Tax ID
Text
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
trustee
 
The updated account trustee
Refer to AccountTrustee->get
Account Trustees
No
No
create

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
account_id
 
Account ID
Numeric
No
No
legal_name
 
Account Trustee Legal Name
Text
No
Yes
tax_id
 
Account Trustee Tax ID
Text
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
trustee
 
The created account trustee
Account Trustees
No
No
Default Expenses
get

POST: {ENDPOINT}/default_expenses/get

Field
Description
Type
Required
Nullable
id
 
Default Expense ID
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
id
 
Default Expense ID
Numeric
No
No
account_id
 
Fund Investor (MIC) Primary Account ID
Numeric
No
No
name
 
Name
Text
No
Yes
amount
 
Amount
Numeric
No
Yes
frequency
 
Frequency
0 - monthly
1 - quarterly
2 - semi-annually
3 - annually
Enum
No
Yes
first_charge_date
 
First Charge Date
Timestamp
No
Yes
list

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
account_id
 
Account ID
If provided, response is the account's trustees
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
default_expenses
 
Default Expenses
Refer to DefaultFees->get
List-Default Expenses
No
No
Investors
get

POST: {ENDPOINT}/investors/get

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
If provided, return the loan's investor's accounts
Numeric
No
No
investor_id
 
Investor ID
Numeric
No
No
response_field_whitelist
 
Response Field Whitelist
If defined, the investor list will include those fields (only basic fields allowed).
Array
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
investor_id
 
Investor ID
Numeric
No
No
x_investorid
 
X Investor ID
Text
No
Yes
type
 
Investor Type
0 - Individual
1 - Organization
3 - Corporation
2 - Fund
4 - Servicer
Organization -> (1) is deprecated. Organization -> (1) and Fund -> (2) cannot be used in Investor->create.
Enum
No
Yes
mic_name
 
Fund Investor (MIC) Name
Text
No
No
mic_leadership_type
 
Fund Investor (MIC) Leadership Type
0 - President and Secretary
1 - Director
2 - Joint Directors
Enum
No
Yes
mic_president
 
Fund Investor (MIC) President
Text
No
No
mic_secretary
 
Fund Investor (MIC) Secretary
Text
No
No
mic_director
 
Fund Investor (MIC) Director
Text
No
No
mic_share_label
 
Fund Investor (MIC) Share Label
0 - Shares
1 - Units
Enum
No
No
mic_payout
 
Fund Investor (MIC) Payout
Day of each month
Numeric
No
No
mic_year_end
 
Fund Investor (MIC) Year End Month
1: January, 2: February, ..., 11: November, 0: December
Numeric
No
Yes
mic_quarterly_statement_date
 
Fund Investor (MIC) Quarterly Statement Date
0 - Quarter End
1 - Dividend Distribution Date
Enum
No
Yes
mic_cert_issue
 
Fund Investor (MIC): Cert Issue
Default 0. 0: false, 1: true.
Numeric
No
Yes
mic_distribution_method
 
Fund Investor (MIC): Distribution Method
0 - Specific Date Holdings
1 - Daily Proportionate Earnings
2 - # of Days (Investor Specific)
Enum
No
Yes
mic_allow_payouts_exceed_earnings
 
Fund Investor (MIC): Allow one-time/regular payouts to exceed earnings (will reduce investment balance)
Default 0. 0: false, 1: true.
Numeric
No
Yes
mic_only_allow_monthly_drip
 
Fund Investor (MIC): Only allow Monthly DRIP for Regular Interest Payments
Default 0. Default 0. 0: Only allow Monthly DRIP for Regular Interest Payments. 1: Payout Frequency (under investor DRIP settings) decides the distribution frequency for regular payments - e.g. Quarterly Payout would cause reinvestment of interest each quarter, rather than on a monthly basis.
Numeric
No
Yes
mic_compound_interest_until_payout
 
Fund Investor (MIC): Compound interest until Payout for Quarterly/Annual Interest Payments
Default 0. 0: false, 1: true.
Numeric
No
Yes
mic_regular_payout_display
 
Fund Investor (MIC): Regular Payout Display
0 - Display Interest Earned on First Day of Following Month
1 - Display Interest Earned on Last Day of Current Month
Enum
No
Yes
mic_onetime_distribution_display
 
Fund Investor (MIC): One-Time Distribution Display
0 - Display One-Time Distribution Earned on Date of Distribution
1 - Display One-Time Distribution Earned on Last Day of Accrual Period
Enum
No
Yes
mic_deposit_date_mode
 
Fund Investor (MIC): Deposit Date Mode
0 - Include Date of Deposit in Regular Payout/One-Time Distribution Calculation
1 - Exclude Date of Deposit in Regular Payout/One-Time Distribution Calculation
2 - Deposits not occurring on the 1st of the month, will wait until the 1st of next month to accrue interest
3 - Deposits not occurring on the 1st of the month, will exclude date of deposit to accrue interest
Enum
No
Yes
mic_redemption_date_mode
 
Fund Investor (MIC): Redemption Date Mode
0 - Exclude Date of Redemption in Regular Payout/One-Time Distribution Calculation
1 - Include Date of Redemption in Regular Payout/One-Time Distribution Calculation
Enum
No
Yes
first_name
 
First Name
Text
No
No
last_name
 
Last Name
Text
No
No
dob
 
Date of birth
Timestamp
No
Yes
homephone
 
Home Phone
Text
No
Yes
mobile
 
Cell Phone
Text
No
Yes
email
 
Email
Text
No
Yes
notes
 
Notes
Text
No
Yes
company
 
Investor Company
Text
No
Yes
max_ltv
 
Max LTV
Numeric
No
Yes
address
 
Investor address
Refer to Addresses->get
Addresses
No
No
receive_statements_monthly
 
Receive Monthly Statements
Numeric
No
No
accounts
 
Investor accounts
Refer to Accounts->get
List-Accounts
No
No
report_fields
 
Report Fields
Array
No
No
loans
 
Loans associated with the Investor
Only Individual Investors' associated loans are listed with loan_id's only. Terminated loans are excluded.
List-Loans
No
No
funds
 
Funds associated with the Investor
Only Individual Investors' associated funds are listed with investor_id's only.
List-Investors
No
No
tags
 
Tags
Only Individual Investors have tags.
List-Tags
No
No
roles
 
Roles
Roles such as system role Investor BDM. Refer to Role->get
List-Roles
No
No
emd_staff
 
EMD Staff
Only Individual Investors could have an EMD Staff.
EMD Staff
No
No
custom_fields
 
Custom Fields
Array
No
No
dry_run
 
Dry Run
Field used for debugging purposes internally.
Numeric
No
Yes
list

POST: {ENDPOINT}/investors/list

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
If provided, response is the loan's investor's accounts
Numeric
No
No
response_field_whitelist
 
Response Field Whitelist
If defined, the investor list will include those fields (only basic fields allowed).
Array
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
investors
 
Investors List
Refer to Investor->get
List-Investors
No
No
create

POST: {ENDPOINT}/investors/create

Field
Description
Type
Required
Nullable
x_investorid
 
X Investor ID
Text
No
Yes
type
 
Investor Type
0 - Individual
1 - Organization
3 - Corporation
2 - Fund
4 - Servicer
Organization -> (1) is deprecated. Organization -> (1) and Fund -> (2) cannot be used in Investor->create.
Enum
No
Yes
first_name
 
First Name
Text
No
No
last_name
 
Last Name
Text
No
No
dob
 
Date of birth
Timestamp
No
Yes
homephone
 
Home Phone
Text
No
Yes
mobile
 
Cell Phone
Text
No
Yes
email
 
Email
Text
No
Yes
notes
 
Notes
Text
No
Yes
company
 
Investor Company
Text
No
Yes
max_ltv
 
Max LTV
Numeric
No
Yes
address
 
Investor address
Refer to Addresses->get
Addresses
No
No
receive_statements_monthly
 
Receive Monthly Statements
Numeric
No
No
accounts
 
Investor accounts
Refer to Accounts->get
List-Accounts
No
No
tags
 
Tags
Only Individual Investors have tags.
List-Tags
No
No
roles
 
Roles
Roles such as system role Investor BDM. Refer to Role->get
List-Roles
No
No
custom_fields
 
Custom Fields
Array
No
No
dry_run
 
Dry Run
Field used for debugging purposes internally.
Numeric
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
investor
 
The created investor
Refer to Investor->get
Investors
No
No
update

POST: {ENDPOINT}/investors/update

Field
Description
Type
Required
Nullable
investor_id
 
Investor ID
Numeric
No
No
x_investorid
 
X Investor ID
Text
No
Yes
mic_name
 
Fund Investor (MIC) Name
Text
No
No
mic_leadership_type
 
Fund Investor (MIC) Leadership Type
0 - President and Secretary
1 - Director
2 - Joint Directors
Enum
No
Yes
mic_president
 
Fund Investor (MIC) President
Text
No
No
mic_secretary
 
Fund Investor (MIC) Secretary
Text
No
No
mic_director
 
Fund Investor (MIC) Director
Text
No
No
mic_share_label
 
Fund Investor (MIC) Share Label
0 - Shares
1 - Units
Enum
No
No
mic_payout
 
Fund Investor (MIC) Payout
Day of each month
Numeric
No
No
mic_year_end
 
Fund Investor (MIC) Year End Month
1: January, 2: February, ..., 11: November, 0: December
Numeric
No
Yes
mic_quarterly_statement_date
 
Fund Investor (MIC) Quarterly Statement Date
0 - Quarter End
1 - Dividend Distribution Date
Enum
No
Yes
mic_cert_issue
 
Fund Investor (MIC): Cert Issue
Default 0. 0: false, 1: true.
Numeric
No
Yes
mic_distribution_method
 
Fund Investor (MIC): Distribution Method
0 - Specific Date Holdings
1 - Daily Proportionate Earnings
2 - # of Days (Investor Specific)
Enum
No
Yes
mic_allow_payouts_exceed_earnings
 
Fund Investor (MIC): Allow one-time/regular payouts to exceed earnings (will reduce investment balance)
Default 0. 0: false, 1: true.
Numeric
No
Yes
mic_only_allow_monthly_drip
 
Fund Investor (MIC): Only allow Monthly DRIP for Regular Interest Payments
Default 0. Default 0. 0: Only allow Monthly DRIP for Regular Interest Payments. 1: Payout Frequency (under investor DRIP settings) decides the distribution frequency for regular payments - e.g. Quarterly Payout would cause reinvestment of interest each quarter, rather than on a monthly basis.
Numeric
No
Yes
mic_compound_interest_until_payout
 
Fund Investor (MIC): Compound interest until Payout for Quarterly/Annual Interest Payments
Default 0. 0: false, 1: true.
Numeric
No
Yes
mic_regular_payout_display
 
Fund Investor (MIC): Regular Payout Display
0 - Display Interest Earned on First Day of Following Month
1 - Display Interest Earned on Last Day of Current Month
Enum
No
Yes
mic_onetime_distribution_display
 
Fund Investor (MIC): One-Time Distribution Display
0 - Display One-Time Distribution Earned on Date of Distribution
1 - Display One-Time Distribution Earned on Last Day of Accrual Period
Enum
No
Yes
mic_deposit_date_mode
 
Fund Investor (MIC): Deposit Date Mode
0 - Include Date of Deposit in Regular Payout/One-Time Distribution Calculation
1 - Exclude Date of Deposit in Regular Payout/One-Time Distribution Calculation
2 - Deposits not occurring on the 1st of the month, will wait until the 1st of next month to accrue interest
3 - Deposits not occurring on the 1st of the month, will exclude date of deposit to accrue interest
Enum
No
Yes
mic_redemption_date_mode
 
Fund Investor (MIC): Redemption Date Mode
0 - Exclude Date of Redemption in Regular Payout/One-Time Distribution Calculation
1 - Include Date of Redemption in Regular Payout/One-Time Distribution Calculation
Enum
No
Yes
first_name
 
First Name
Text
No
No
last_name
 
Last Name
Text
No
No
dob
 
Date of birth
Timestamp
No
Yes
homephone
 
Home Phone
Text
No
Yes
mobile
 
Cell Phone
Text
No
Yes
email
 
Email
Text
No
Yes
notes
 
Notes
Text
No
Yes
company
 
Investor Company
Text
No
Yes
max_ltv
 
Max LTV
Numeric
No
Yes
address
 
Investor address
Refer to Addresses->get
Addresses
No
No
receive_statements_monthly
 
Receive Monthly Statements
Numeric
No
No
accounts
 
Investor accounts
Refer to Accounts->get
List-Accounts
No
No
report_fields
 
Report Fields
Array
No
No
loans
 
Loans associated with the Investor
Only Individual Investors' associated loans are listed with loan_id's only. Terminated loans are excluded.
List-Loans
No
No
funds
 
Funds associated with the Investor
Only Individual Investors' associated funds are listed with investor_id's only.
List-Investors
No
No
tags
 
Tags
Only Individual Investors have tags.
List-Tags
No
No
roles
 
Roles
Roles such as system role Investor BDM. Refer to Role->get
List-Roles
No
No
emd_staff
 
EMD Staff
Only Individual Investors could have an EMD Staff.
EMD Staff
No
No
custom_fields
 
Custom Fields
Array
No
No
dry_run
 
Dry Run
Field used for debugging purposes internally.
Numeric
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
investor
 
The updated investor
Refer to Investor->get
Investors
No
No
Funds
get

POST: {ENDPOINT}/funds/get

Field
Description
Type
Required
Nullable
id
 
Fund/Investor ID
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
id
 
Fund/Investor ID
Numeric
No
No
fund_id
 
Fund/Investor ID
Numeric
No
No
x_investorid
 
X Investor ID
Text
No
No
type
 
Investor Type
Numeric
No
No
name
 
Name
Text
No
No
president
 
President
Text
No
No
secretary
 
Secretary
Text
No
No
share_label
 
Share Label
0 - Shares
1 - Units
Enum
No
No
payout
 
Payout
Day of each month
Numeric
No
No
year_end
 
Year End Month
1: January, 2: February, ..., 11: November, 0: December
Numeric
No
No
quarterly_statement_date
 
Quarterly Statement Date
0 - Quarter End
1 - Dividend Distribution Date
Enum
No
No
fund_revenue_recognition
 
Fund Revenue Recognition Date
0 - Cash basis
1 - Accrual basis
Enum
No
No
investor_revenue_recognition
 
Fund Investor (MIC) Investor Revenue Recognition Date
0 - Cash basis
1 - Accrual basis
Enum
No
No
investor_payment_type
 
Investor Payment Type
0 -
1 - Eligible Dividend
2 - Non-Eligible Dividend
3 - Interest Income
Enum
No
No
default_expenses
 
Default Expenses
List-Default Expenses
No
No
investor_commitment_prior_to_deposit
 
Enable investor commitment prior to deposit
Default 0. 0: false, 1: true.
Numeric
No
No
new_commitments_overwrite
 
New commitments overwrite prior commitments
Default 0. 0: false, 1: true.
Numeric
No
No
fund_generated_trade_confirm
 
Enable Fund generated trade confirmations
Default 0. 0: false, 1: true.
Numeric
No
No
issue_statements_per_account
 
Issue Fund Statements per Investor Account
Default 0. 0: false, 1: true.
Numeric
No
No
share_price
 
Share Price
0 - Floating
1 - Fixed
Enum
No
No
nav_calculated
 
NAV Calculated
0 - Pre-Drip
1 - Post-Drip
Enum
No
No
regular_monthly_payout
 
Regular Monthly Payout
Default 0. 0: false, 1: true.
Numeric
No
No
variable_payout_type
 
Variable Payout Type
0 - Dividend/Top Up
1 - Interest Distribution
Enum
No
No
per_diem_style
 
Regular Payout Per Diem Style
0 - Month-Specific
1 - Annual-Even
2 - 30/360
Enum
No
No
regular_payout_style
 
Regular Payout Style
0 - Annual-Even
1 - Month-Specific
Enum
No
No
cert_issue
 
Cert Issue
Default 0. 0: false, 1: true.
Numeric
No
No
distribution_method
 
Distribution Method
0 - Specific Date Holdings
1 - Daily Proportionate Earnings
2 - # of Days (Investor Specific)
Enum
No
No
withheld_tax
 
Withheld Tax
0 - affect DRIP
1 - affect Payout
Enum
No
No
allow_payouts_exceed_earnings
 
Allow one-time/regular payouts to exceed earnings (will reduce investment balance)
Default 0. 0: false, 1: true.
Numeric
No
No
only_allow_monthly_drip
 
Only allow Monthly DRIP for Regular Interest Payments
Default 0. 0: true, 1: false.
Numeric
No
No
compound_interest_until_payout
 
Compound interest until Payout for Quarterly/Annual Interest Payments
Default 0. 0: false, 1: true.
Numeric
No
No
regular_payout_display
 
Regular Payout Display
0 - Display Interest Earned on First Day of Following Month
1 - Display Interest Earned on Last Day of Current Month
Enum
No
No
onetime_distribution_display
 
One-Time Distribution Display
0 - Display One-Time Distribution Earned on Date of Distribution
1 - Display One-Time Distribution Earned on Last Day of Accrual Period
Enum
No
No
deposit_date_mode
 
Deposit Date Mode
0 - Include Date of Deposit in Regular Payout/One-Time Distribution Calculation
1 - Exclude Date of Deposit in Regular Payout/One-Time Distribution Calculation
2 - Deposits not occurring on the 1st of the month, will wait until the 1st of next month to accrue interest
3 - Deposits not occurring on the 1st of the month, will exclude date of deposit to accrue interest
Enum
No
No
redemption_date_mode
 
Fund Investor (MIC): Redemption Date Mode
0 - Exclude Date of Redemption in Regular Payout/One-Time Distribution Calculation
1 - Include Date of Redemption in Regular Payout/One-Time Distribution Calculation
Enum
No
No
accounts
 
Investor accounts
Refer to Accounts->get
List-Accounts
No
No
list

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
If provided, response is the loan's investor's accounts
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
funds
 
Funds List
Refer to Funds->get
List-Funds
No
No
Fund Active Investors
get

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
fund_id
 
Fund ID
If provided along with day, month & year, will return the fund's active investor data.
Numeric
No
No
day
 
Day
If provided along with fund_id, month & year, will return the fund's active investor data.
Numeric
No
No
month
 
Month
If provided along with fund_id, day & year, will return the fund's active investor data.
Numeric
No
No
year
 
Year
If provided along with fund_id, day & month, will return the fund's active investor data.
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
fund
 
Fund
Fund entity with id & name in details.
Funds
No
No
month
 
Month
Month of the deposit date.
Numeric
No
No
year
 
Year
Year of the deposit date.
Numeric
No
No
day
 
Day
Day of the deposit date.
Numeric
No
No
name
 
name
Name of the Investor
Text
No
No
account
 
Account
Investment account name & Account Id of the investor.
Accounts
No
No
share_class
 
Share Class
Share Class entity with id & name in details.
Share Class
No
No
drip_payout
 
Drip Payouts
Drip Payout entity
Drip Payout
No
No
share_price
 
Share Price
Numeric
No
No
value
 
Value
Numeric
No
No
value_in_percent
 
Value In Percent
Numeric
No
No
shares_units
 
Share/Units
Numeric
No
No
shares_without_penalty
 
Shares Without Penalty
Numeric
No
No
list

POST: {ENDPOINT}/fund_active_investors/list

Field
Description
Type
Required
Nullable
fund_id
 
Fund ID
ID of the fund for which the active investors has to be listed.
Numeric
No
No
day
 
Day
Day (numeric, eg - 12) value of the date for which the active investor detail values should be calculated as of.
Numeric
No
No
month
 
Month
Month (numeric, eg - 9) value of the date for which the active investor detail values should be calculated as of.
Numeric
No
No
year
 
Year
Year (numeric, eg - 2022) value of the date for which the active investor detail values should be calculated as of.
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
fund_active_investors
 
List of fund's active investors
Refer to FundActiveInvestor->get
List-Fund Active Investors
No
No
Tags
get

POST: {ENDPOINT}/tags/get

Field
Description
Type
Required
Nullable
id
 
Tag ID
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
id
 
Tag ID
Numeric
No
No
name
 
Name
Text
No
No
is_persistent
 
Is the tag persistent?
Default 0. 0: false, 1: true.
Numeric
No
Yes
entity_type
 
Entity Type
1 - loan
2 - client
3 - investor
4 - broker
5 - lawyer
6 - titlecompany
7 - appraiser
8 - emd
102 - task
103 - deftask
120 - lender
130 - condocorporation
For a specific entity
Enum
No
Yes
list

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
investor_id
 
Investor ID
If provided, response is the investor's tags
Numeric
No
No
emd_id
 
EMD ID
If provided, response is the EMD's tags
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
tags
 
Tags
Refer to Tag->get
List-Tags
No
No
create

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
name
 
Name
Text
No
No
is_persistent
 
Is the tag persistent?
Default 0. 0: false, 1: true.
Numeric
No
Yes
entity_type
 
Entity Type
1 - loan
2 - client
3 - investor
4 - broker
5 - lawyer
6 - titlecompany
7 - appraiser
8 - emd
102 - task
103 - deftask
120 - lender
130 - condocorporation
For a specific entity
Enum
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
tag
 
The created tag
Tags
No
No
EMD Profiles
get

POST: {ENDPOINT}/emds/get

Field
Description
Type
Required
Nullable
id
 
EMD ID
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
id
 
EMD ID
Numeric
No
No
name
 
Company Name
Text
No
Yes
abbreviation
 
Company Abbreviation
Text
No
No
address
 
Address
Refer to Addresses->get
Addresses
No
No
phone
 
Phone
Text
No
Yes
fax
 
Fax
Text
No
Yes
email
 
Email
Text
No
Yes
website
 
Website
Text
No
Yes
contact
 
Contact
Text
No
Yes
notes
 
Notes
Text
No
Yes
tags
 
Tags
List-Tags
No
No
custom_fields
 
Custom Fields
Array
No
No
list

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
investor_id
 
Investor ID
If provided, response is the investor's EMDs
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
emds
 
List of EMDs
Refer to EMD->get
List-EMD Profiles
No
No
EMD Staff
get

POST: {ENDPOINT}/emd_staff/get

Field
Description
Type
Required
Nullable
id
 
EMD Staff ID
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
id
 
EMD Staff ID
Numeric
No
No
emd
 
EMD
EMD Profiles
No
No
first_name
 
First Name
Text
No
Yes
last_name
 
Last Name
Text
No
Yes
email
 
Email
Text
No
Yes
phone
 
Phone
Text
No
Yes
disabled
 
Is it disabled?
Default 0. 0: false, 1: true.
Numeric
No
Yes
custom_fields
 
Custom Fields
Array
No
No
list

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
investor_id
 
Investor ID
If provided, response is the investor's EMD estaff
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
emd_staff
 
List of EMD Staff
Refer to EMD->get
List-EMD Staff
No
No
update

POST: {ENDPOINT}/emd_staff/update

Field
Description
Type
Required
Nullable
id
 
EMD Staff ID
Numeric
No
No
emd
 
EMD
EMD Profiles
No
No
first_name
 
First Name
Text
No
Yes
last_name
 
Last Name
Text
No
Yes
email
 
Email
Text
No
Yes
phone
 
Phone
Text
No
Yes
disabled
 
Is it disabled?
Default 0. 0: false, 1: true.
Numeric
No
Yes
custom_fields
 
Custom Fields
Array
No
No

Response Fields

Field
Description
Type
Required
Nullable
emdstaff
 
The updated emd staff
Refer to emd_staff->get
EMD Staff
No
No
Roles
get

POST: {ENDPOINT}/roles/get

Field
Description
Type
Required
Nullable
id
 
Role ID
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
id
 
Role ID
Numeric
No
No
name
 
Name
Text
No
No
entity_type_id
 
Entity Type ID
0 - N/A
1 - loan
2 - client
3 - investor
4 - broker
5 - lawyer
6 - titlecompany
7 - appraiser
8 - emd
101 - substatus
If provided, response is a list of roles in which that entity type e.g. investor is involved
Enum
No
Yes
is_system_role
 
Is the role a system role?
Default 0. 0: false, 1: true.
Numeric
No
Yes
users
 
Users who are under this role and involved in an entity e.g. a specific investor
List-Users
No
No
list

POST: {ENDPOINT}/roles/list

Field
Description
Type
Required
Nullable
entity_type_id
 
Entity Type ID
0 - N/A
1 - loan
2 - client
3 - investor
4 - broker
5 - lawyer
6 - titlecompany
7 - appraiser
8 - emd
101 - substatus
If provided, response is a list of roles in which that entity type e.g. investor is involved
Enum
No
No
entity_id
 
Entity ID
If provided along with entity_type_id, response is a list of roles in which that entity e.g. a specific investor is involved
Numeric
No
No
user_id
 
User ID
If provided , response is a list of roles that the user is added to.
Numeric
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
roles
 
Roles
Refer to Tag->get
List-Roles
No
No
attach

POST: {ENDPOINT}/roles/attach

Field
Description
Type
Required
Nullable
id
 
Role ID
Numeric
No
No
entity_type_id
 
Entity Type ID
0 - N/A
1 - loan
2 - client
3 - investor
4 - broker
5 - lawyer
6 - titlecompany
7 - appraiser
8 - emd
101 - substatus
If provided along with entity_id, user is attached to role for the particular entity & entity id, example - User attached to Investor BDM role for a Loan.
Enum
No
Yes
entity_id
 
Entity ID
If provided along with entity_type_id, user is attached to role for the particular entity & entity id, example - User attached to Investor BDM role for a Loan.
Numeric
No
Yes
user
 
A User who are under this role and involved in an entity e.g. a specific investor.This should be an object (details of single user).
Users
No
No
users
 
Users who are under this role and involved in an entity e.g. a specific investor.This should be a list of users (array).
List-Users
No
No

Response Fields

Field
Description
Type
Required
Nullable
role
 
The updated role
Refer to Role->get
Roles
No
No
Users
get

POST: {ENDPOINT}/users/get

Field
Description
Type
Required
Nullable
user_id
 
User ID
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
user_id
 
User ID
Numeric
No
No
name
 
Display Name
Text
No
Yes
email
 
User Email
Text
No
Yes
phone
 
User Phone
Text
No
Yes
roles
 
Roles that a user is added to!
List-Roles
No
No
list

POST: {ENDPOINT}/users/list

Field
Description
Type
Required
Nullable
role_id
 
Role ID
If provided, response is a list of users added to that role
Numeric
No
No
entity_type_id
 
Entity Type ID
0 - N/A
1 - loan
2 - client
3 - investor
4 - broker
5 - lawyer
6 - titlecompany
7 - appraiser
8 - emd
101 - substatus
If provided along with role_id, response is a list of users added to that role and assigned to that entity type e.g. investor
Enum
No
No
entity_id
 
Entity ID
If provided along with role_id and entity_type_id, response is a list of users added to that role and assigned to that entity e.g. a specific investor
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
users
 
Users
Refer to User->get
List-Users
No
No
Loan Note
get

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
id
 
Loan Note ID
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
id
 
Loan Note ID
Numeric
No
No
note
 
Note
Text
No
No
date
 
Date
Timestamp
No
Yes
list

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable

Response Fields

Field
Description
Type
Required
Nullable
loan_notes
 
List of loan notes
Refer to LoanNote->get.
List-Loan Note
No
No
Loan Note for Loan Update
get

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
id
 
Loan Note ID
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
id
 
Loan Note ID
Numeric
No
No
note
 
Note
Text
No
No
Main Property for Loan Update
get

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
If provided, response is the loan's main property
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
address
 
Address
Refer to Addresses->get
Addresses
No
No
value
 
Property value
Numeric
No
Yes
property_tax
 
Property annual tax amount
Numeric
No
Yes
property_tax_monthly
 
Property tax recurring top-up amount
Numeric
No
Yes
property_tax_holdback
 
Property tax initial holdback/reserve amount - legacy
Numeric
No
No
property_tax_monthly_holdback
 
Property Tax Top-up Prepayment/Reserve per loan
Numeric
No
Yes
property_tax_url
 
Property tax URL
Text
No
Yes
property_tax_id
 
Property tax ID
Text
No
Yes
condo_fees
 
Property monthly condo fee amount. For Canada only.
Numeric
No
Yes
heating_fees
 
Property monthly heating fee amount
Numeric
No
No
property_built_date
 
Property built on this date
Unix timestamp integer: number of seconds since Jan 01, 1970 in GMT/UTC timezone
Timestamp
No
Yes
lot_size
 
Property Lot Size
Text
No
No
lot_size_unit
 
Property Lot Size Unit
0 - Sq Feet
1 - Ac
2 - Sq Meters
Enum
No
Yes
living_space
 
Property Living Space
Text
No
Yes
living_space_unit
 
Property Living Space Unit
0 - Sq Feet
1 - Ac
2 - Sq Meters
Enum
No
Yes
rental_income
 
Property Monthly Rental Income
Numeric
No
Yes
legal
 
Property Legal Description
Text
No
Yes
occupancy
 
Property Occupancy Type
0 -
1 - Owner-Occupied
2 - Rental
3 - Owner-Occupied/Tenanted
4 - Second Home
5 - Vacant
Enum
No
No
tenure
 
Property Tenure Type
0 -
1 - Freehold
2 - Leasehold
3 - Condo
4 - Co-Op
Enum
No
No
property_type
 
Property Type
1 - Detached
2 - Semi-Detached
3 - Row/Town House
9 - Apartment
7 - Mobile
8 - Stacked
4 - Commercial
6 - Land
11 - Condo
0 - Other
Enum
No
Yes
property_type_other_description
 
Other Property Type Description
Text
No
No
purchase_price
 
Property Purchase Price
Numeric
No
Yes
propertyjurisdiction
 
Jurisdiction
Text
No
Yes
subdivision_subsection
 
Subdivision/Subsection
Text
No
Yes
propertylronum
 
Property LRO Number
Numeric
No
Yes
propertypin
 
Property Pin Head
Text
No
Yes
propertypintail
 
Property Pin Tail
Text
No
Yes
propertyestate
 
Property Estate
Numeric
No
Yes
xpropertyid
 
External Property ID
Text
No
Yes
repair_cost
 
Property Repair Cost
Numeric
No
Yes
appraised_date
 
Property Appraised Date
Unix timestamp integer: number of seconds since Jan 01, 1970 in GMT/UTC timezone
Numeric
No
Yes
layout
 
Property Layout Type
0 - Empty. For loan types: Standard (0), Construction (1), Commercial (2), Fix & Flip (3), Personal (4)
1 - Single Family. For loan types: Standard (0), Construction (1), Fix & Flip (3), Personal (4)
6 - Multi Family
2 - Duplex. For loan types: Standard (0), Construction (1), Fix & Flip (3), Personal (4)
3 - Tri Plex. For loan types: Standard (0), Construction (1), Fix & Flip (3), Personal (4)
4 - Four Plex. For loan types: Standard (0), Construction (1), Fix & Flip (3), Personal (4)
5 - Modular. For loan types: Standard (0), Construction (1), Fix & Flip (3), Personal (4)
11 - Retail. For loan types: Commercial (2)
12 - Hospitality. For loan types: Commercial (2)
13 - Multi Family. For loan types: Standard (0), Construction (1), Fix & Flip (3)
14 - Mixed use. For loan types: Commercial (2)
15 - Office. For loan types: Commercial (2)
16 - Assisted living. For loan types: Commercial (2)
17 - Medical. For loan types: Commercial (2)
18 - Light Industrial. For loan types: Commercial (2)
19 - Storage. For loan types: Commercial (2)
20 - Special purpose. For loan types: Commercial (2)
21 - Restaurant. For loan types: Commercial (2)
22 - Land. For loan types: Commercial (2)
23 - Other (fill in Property Description). For loan types: Commercial (2)
Enum
No
Yes
custom_fields
 
Custom Fields
Array
No
No
Other Properties
get

POST: {ENDPOINT}/other_properties/get

Field
Description
Type
Required
Nullable
property_id
 
Property ID
Numeric
No
No
loan_id
 
Loan ID
Numeric
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
property_id
 
Property ID
Numeric
No
No
loan_id
 
Loan ID
Numeric
No
No
address
 
Address
Refer to Addresses->get
Addresses
No
No
value
 
Property value
Numeric
No
Yes
property_tax
 
Property annual tax amount
Numeric
No
Yes
property_tax_id
 
Property tax ID
Text
No
Yes
condo_fees
 
Property monthly condo fee amount. For Canada only.
Numeric
No
Yes
heating_fees
 
Property monthly heating fee amount
Numeric
No
No
lot_size
 
Property Lot Size
Text
No
No
living_space
 
Property Living Space
Text
No
Yes
rental_income
 
Property Monthly Rental Income
Numeric
No
Yes
legal
 
Property Legal Description
Text
No
Yes
property_entry_details
 
Property Entry Details
Text
No
Yes
municipal_assessment_year
 
Municipal Assessment Year
Text
No
Yes
is_blanket
 
Is Blanket Property
1 for blanket property, 0 for tagged property
Numeric
No
Yes
custom_fields
 
Custom Fields
Array
No
No
insurances
 
Insurances
Refer to Other Expenses->list .NB- Applicable only for Other Properties
List-Insurances
No
No
otherexpenses
 
Otherexpenses
Refer to Other Expenses->list .NB- Applicable only for Other Properties
List-Other Expenses
No
No
positions
 
Positions
Refer to Positions->list .NB- Applicable only for Other Properties
List-Positions
No
No
update

POST: {ENDPOINT}/other_properties/update

Field
Description
Type
Required
Nullable
property_id
 
Property ID
Numeric
No
No
loan_id
 
Loan ID
Numeric
No
No
address
 
Address
Refer to Addresses->get
Addresses
No
No
value
 
Property value
Numeric
No
Yes
property_tax
 
Property annual tax amount
Numeric
No
Yes
property_tax_id
 
Property tax ID
Text
No
Yes
condo_fees
 
Property monthly condo fee amount. For Canada only.
Numeric
No
Yes
heating_fees
 
Property monthly heating fee amount
Numeric
No
No
lot_size
 
Property Lot Size
Text
No
No
living_space
 
Property Living Space
Text
No
Yes
rental_income
 
Property Monthly Rental Income
Numeric
No
Yes
legal
 
Property Legal Description
Text
No
Yes
property_entry_details
 
Property Entry Details
Text
No
Yes
municipal_assessment_year
 
Municipal Assessment Year
Text
No
Yes
is_blanket
 
Is Blanket Property
1 for blanket property, 0 for tagged property
Numeric
No
Yes
custom_fields
 
Custom Fields
Array
No
No
insurances
 
Insurances
Refer to Other Expenses->list .NB- Applicable only for Other Properties
List-Insurances
No
No
otherexpenses
 
Otherexpenses
Refer to Other Expenses->list .NB- Applicable only for Other Properties
List-Other Expenses
No
No
positions
 
Positions
Refer to Positions->list .NB- Applicable only for Other Properties
List-Positions
No
No

Response Fields

Field
Description
Type
Required
Nullable
other_property
 
The updated Other Property
Refer to OtherProperty->get
Other Properties
No
No
create

POST: {ENDPOINT}/other_properties/create

Field
Description
Type
Required
Nullable
property_id
 
Property ID
Numeric
No
No
loan_id
 
Loan ID
Numeric
No
No
address
 
Address
Refer to Addresses->get
Addresses
No
No
value
 
Property value
Numeric
No
Yes
property_tax
 
Property annual tax amount
Numeric
No
Yes
property_tax_id
 
Property tax ID
Text
No
Yes
condo_fees
 
Property monthly condo fee amount. For Canada only.
Numeric
No
Yes
heating_fees
 
Property monthly heating fee amount
Numeric
No
No
lot_size
 
Property Lot Size
Text
No
No
living_space
 
Property Living Space
Text
No
Yes
rental_income
 
Property Monthly Rental Income
Numeric
No
Yes
legal
 
Property Legal Description
Text
No
Yes
property_entry_details
 
Property Entry Details
Text
No
Yes
municipal_assessment_year
 
Municipal Assessment Year
Text
No
Yes
is_blanket
 
Is Blanket Property
1 for blanket property, 0 for tagged property
Numeric
No
Yes
custom_fields
 
Custom Fields
Array
No
No
insurances
 
Insurances
Refer to Other Expenses->list .NB- Applicable only for Other Properties
List-Insurances
No
No
otherexpenses
 
Otherexpenses
Refer to Other Expenses->list .NB- Applicable only for Other Properties
List-Other Expenses
No
No
positions
 
Positions
Refer to Positions->list .NB- Applicable only for Other Properties
List-Positions
No
No

Response Fields

Field
Description
Type
Required
Nullable
other_property
 
The created Other Property
Refer to OtherProperty->get
Other Properties
No
No
Mortgage for Loan Update
get

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
If provided, response is the loan's mortgage
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
id
 
Mortgage ID
Numeric
No
No
total
 
Total Facility for Construction Loan Type, Credit Limit for Standard Loan Type with Application Type = Mortgage (1), Total Loan for Fix & Flip Loan Type
Numeric
No
Yes
amount
 
Loan Amount / Initial Advance / Advance at Closing
Loan Amount for Standard Loan Type. Initial Advance for Construction Loan Type or Standard Loan Type with Mortgage Application Type. Advance at Closing for Fix & Flip Loan Type.
Numeric
No
Yes
construction_lien_holdback
 
Lien Holdback Amount for Construction Loan Type
Numeric
No
Yes
construction_lien_holdback_days
 
Lien Holdback Days for Construction Loan Type
Numeric
No
No
standby_interest
 
Standby Interest
Number in percentage e.g. 10.99 stands for 10.99%. Standby Interest for Construction Loan Type. Standby Interest for Fix & Flip Loan Type is set to Interest Rate if 'Construction, Fix & Flip Loans: Charge Interest on Total Facility/Total Loan' is enabled under Company Settings > Optional Loan Fields > Commitment Fields
Numeric
No
Yes
enable_variable_rate
 
Enable Variable Rate
1 to enable, 0 to disable.
Numeric
No
Yes
enable_escalating_rate
 
Initial escalating rate is enabled
1 to enable, 0 to disable.
Numeric
No
No
escalating_rate_starts_in
 
Initial escalating rate starts in how many payment cycles
Numeric
No
No
escalating_rate
 
Initial Escalating Rate
Number in percentage e.g. 10.99 stands for 10.99%.
Numeric
No
Yes
interest
 
Interest Rate
Number in percentage e.g. 10.99 stands for 10.99%. If variable rate is enabled, the interest rate = Primate Rate + {prime_delta} >= {minimum_rate}.
Numeric
No
Yes
rate_index
 
Rate Index
0 - N/A
1 - MCAP
2 - TD
3 - CIBC
4 - RBC
5 - WSJ Prime
8 - Custom CA 2 Enabled
9 - TEST
10 - GG
14 - TEST
15 - TEST2
16 - TEST
18 - SRL TD
19 - Test
21 - Prime Rate
22 - My NEw Index
24 - Capstone Custom
25 - Test Custom Index
26 - RBC
28 - gio's rate
29 - gio's second rate
31 - Custom Index
32 - SOFR
36 - Lan Look Back
38 - BMO
40 - Houze
42 - TEST2
47 - National Bank
51 - WY Test
52 - WSJ
57 - GCMIC Prime
58 - SOFR TEST
65 - Test
66 - DMIC TD Index
67 - Custom
68 - new
70 - yup
71 - no
72 - Adam Custom
73 - EQB
76 - MDV-52646
80 - Custom Index
82 - Custom Decrease
88 - TC
89 - SOFR
90 - Custom Index 2
92 - WSJ Prime
94 - SOFR
95 - Custom Index 2022
97 - Shirkhan's Rate
98 - SOFR
103 - Daria Test
104 - SOFR
105 - Custom
107 - bmo
108 - DONT DELETE !!! Variable rate test class
109 - DONT DELETE !!! Variable rate test class 2
123 - TD (1st of Month)
130 - MyIndex
134 - Camila_test_index
135 - RTIndex
137 - 2 nd cycle
139 - 2 nd cycle and discharge
143 - val_testing
145 - val_testing_2
149 - MDV-22108 Index
150 - Eli's rate
155 - Index 2
157 - Robert Cheung
160 - Gio's index
161 - Gagan
162 - SOFR
163 - Gio's Index
164 - CCC
165 - Hell yeah
167 - BMO
168 - New Index
217 - ABCP- BMO
Enum
No
No
minimum_rate
 
Minimum Rate for Variable Rate Interest
Number in percentage e.g. 10.99 stands for 10.99%.
Numeric
No
Yes
prime_delta
 
Prime Delta for Variable Rate Interest
Number in percentage e.g. 10.99 stands for 10.99%. Default 0 for non-variable-rate interest. Default the same as {interest} rate for variable-rate interest.
Numeric
No
Yes
term_mode
 
Early Termination Type
0 - Fully Closed
1 - Closed Variable
2 - Closed, Then Open
3 - Fully Open
4 - Minimum, Then Open
Not available for Personal Loan Type
Enum
No
No
defaulted_rate
 
Defaulted Rate
Number in percentage e.g. 10.99 stands for 10.99%.
Numeric
No
Yes
interest_method
 
Interest Method
0 - equal amount
1 - per-diem based
2 - 31/360
3 - 360/365
4 - actual/360
6 - 30/360 Special
7 - 30/360 US
5 - decide on a loan by loan basis
Enum
No
Yes
position
 
Loan Position
1 - First
2 - Second
3 - Third
4 - Fourth
5 - Fifth
6 - Sixth
7 - Seventh
Enum
No
No
term
 
Term Length in months
Numeric
No
No
holdback_amount
 
Holdback / PPI Amount
Default 0.
Numeric
No
Yes
holdback_app_mode
 
Holdback / PPI Deduction Mode
0 - Apply upfront (deferred payments)
1 - Spread evenly
2 - Apply at the end
Enum
No
No
holdback_app_cycle
 
Months to spread holdback over
Months count to spread holdback evenly over.
Cannot be empty if holdback_app_mode = 1 (spread evenly)
Cannot be > 0 if holdback_app_mode != 1 (any other than “spread evenly”)
Numeric
No
Yes
holdback_start_at
 
Holdback starting month
Starting from month number from which holdback over. (Applies only (and only allowed) when holdback_app_mode is 0).
Cannot be empty if holdback_app_mode = 0 (Apply Upfront).
Cannot be > 0 if holdback_app_mode != 0 (any other than “Apply Upfront”).
Numeric
No
Yes
repay_mode
 
Repayment Type
0 - Interest Only / Interest Only Deferred
1 - Principal + Interest
2 - Capitalizing Interest
Default 0.
Enum
No
No
defer_int_pay
 
Defer Interest Payment
Default 0. 1: defer interest payment. It's set when Repayment Type is Interest Only Deferred.
Numeric
No
No
main_defer_int_pay
 
Defer interest payments until the next advance
Default 0.

0: When {holdback_amount} is specified, "Interest Schedule > charge interest at monthly payment" is enabled. Otherwise, "Interest Schedule > holdback / PPI" is enabled.

1: “Interest Schedule > defer interest payments until the next advance” is enabled.
Numeric
No
No
amort_in_years
 
Amortization in Years
Default 25 in years. If {repay_mode} is Principal Interest (1) and {amort_in_years} is not provided, {amort_yearmonth_years} and {amort_yearmonth_months} combined in years will be the default.
Numeric
No
Yes
amort_yearmonth_years
 
Amortization Years Part in Years/Months
To combine with {amort_yearmonth_months}.
Numeric
No
Yes
amort_yearmonth_months
 
Amortization Months Part in Years/Months
To combine with {amort_yearmonth_years}.
Numeric
No
Yes
amort_compounding
 
Compounding
52 - Weekly
26 - Bi-Weekly
24 - Semi-Monthly
12 - Monthly
4 - Quarterly
2 - Semi-Annually
1 - Annually
Enum
No
No
frequency
 
Payment Frequency
0 - Monthly
1 - Semi-Monthly
2 - Weekly
3 - Bi-Weekly
7 - Quarterly
Default is 0 (Monthly)
Enum
No
Yes
accelerate_payment
 
Accelerate Payment
Default 0. 1 is to enable accelerate payment for {frequency} is Weekly (2) or Bi-Weekly (3)
Numeric
No
No
funding_date
 
Deposit / Funding Date
Timestamp
No
Yes
closing_date
 
Closing Date
The field is shown if this is enabled: Company Settings > Optional Loan Fields > Investor Section > Different Closing vs. Payout Dates. It's greater than or equal to {funding_date}.
Timestamp
No
Yes
doc_date
 
Doc Date
The field is shown if this is enabled: Company Settings > Optional Loan Fields > Investor Section > Custom Maturity Date.
Timestamp
No
Yes
pay_day
 
Borrower Pays on This Day
1 is Day 1. Default is 1.
Timestamp
No
No
pay_day_type
 
Borrower Pay Day Type
0 (default) or 1. 0 means start of each month or from quarterly start. 1 means before month end or from quarter end.

0: Day {pay_day} from quarter start for {frequency} is Quarterly (7)
0: Day {pay_day} of each month for {frequency} is not Quarterly (7)

1: Day {pay_day} from quarter end for {frequency} is Quarterly (7)
1: Day {pay_day} before month end for {frequency} is not Quarterly (7)
Numeric
No
Yes
investor_payout_day
 
Investors Get Paid on: This Day
Default Company Settings > Default Investor Payout Day, {payday} if > 0, or 1
Numeric
No
Yes
investor_payout_day_2
 
Investors Get Paid on: Day {investor_payout_day} and this day
Default {investor_payout_day}. It's shown when {investor_payout_type} is start of quarter/month (0) and {frequency} is Semi-Monthly (1)
Numeric
No
Yes
investor_payout_type
 
Investors Get Paid on Type
Default 0. Investors get paid on 0: Day from start of quarter/month, 1: Day from end of quarter/month, 2: Day from borrower payment date.

0: Day {investor_payout_day} and {investor_payout_day_2} of month following end of quarter for {frequency} is Quarterly (7)
0: Day {investor_payout_day} and {investor_payout_day_2} of each month for {frequency} is not Quarterly (7)

1: Day {investor_payout_day} and {investor_payout_day_2} before month end of month following end of the quarter for {frequency} is Quarterly (7)
1: Day {investor_payout_day} and {investor_payout_day_2} before month end for {frequency} is not Quarterly (7)

2: Day {investor_payout_day} and {investor_payout_day_2} from borrower payment date
Numeric
No
Yes
pay_method
 
Payment Method
Default 0. Only Australia has 2.
Enum
No
No
early_term_penalty_in_months
 
Early Term. Penalty in Months
Default is Company Settings > Default Settings & Rates > Early Termination Penalty in months. Shown when {term_mode} is Fully Closed (0) and {type} is not Personal (4)
Numeric
No
Yes
early_term_penalty_first_months
 
Early Term. Penalty For the first (in months)
Default 0. Early Term. Type: {term_mode}. For the first {early_term_penalty_first_months} month(s), the penalty will be {early_term_penalty_first_months_amount} month(s)
Numeric
No
Yes
type
 
Loan Type
0 - Standard
1 - Construction
2 - Commercial
3 - Fix & Flip
4 - Personal
Enum
No
No
application_type
 
Application Type
0 - Mortgage
1 - LOC
2 - Bridge
3 - Deed of Trust
4 - Promissory Note
Enum
No
Yes
early_term_penalty_first_months_amount
 
Amount for Early Term. Penalty For the first (in months)
Default 0. Early Term. Type: {term_mode}. For the first {early_term_penalty_first_months} month(s), the penalty will be {early_term_penalty_first_months_amount} month(s)
Numeric
No
Yes
down_payment
 
Down Payment
Numeric
No
Yes
early_term_penalty_min_months_then_open
 
Minimum number of month(s) interest earned
for Early Term. Type {term_mode} is 'Minimum, Then Open' (4)
Numeric
No
Yes
early_term_penalty_min_amount_then_open
 
Minimum amount
for Early Term. Type {term_mode} is 'Minimum, Then Open' (4)
Numeric
No
Yes
early_term_penalty_closed_variable_after_months
 
Afterwards, the penalty will be x month(s)
for Early Term. Type {term_mode} is 'Closed Variable' (1)
Numeric
No
Yes
fees
 
Fees
Refer to Fees->get
Fees
No
No
custom_fees
 
Custom Fees
Refer to CustomFees->list
List-Custom Fees
No
No
update

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
id
 
Mortgage ID
Numeric
No
No
total
 
Total Facility for Construction Loan Type, Credit Limit for Standard Loan Type with Application Type = Mortgage (1), Total Loan for Fix & Flip Loan Type
Numeric
No
Yes
amount
 
Loan Amount / Initial Advance / Advance at Closing
Loan Amount for Standard Loan Type. Initial Advance for Construction Loan Type or Standard Loan Type with Mortgage Application Type. Advance at Closing for Fix & Flip Loan Type.
Numeric
No
Yes
construction_lien_holdback
 
Lien Holdback Amount for Construction Loan Type
Numeric
No
Yes
construction_lien_holdback_days
 
Lien Holdback Days for Construction Loan Type
Numeric
No
No
standby_interest
 
Standby Interest
Number in percentage e.g. 10.99 stands for 10.99%. Standby Interest for Construction Loan Type. Standby Interest for Fix & Flip Loan Type is set to Interest Rate if 'Construction, Fix & Flip Loans: Charge Interest on Total Facility/Total Loan' is enabled under Company Settings > Optional Loan Fields > Commitment Fields
Numeric
No
Yes
enable_variable_rate
 
Enable Variable Rate
1 to enable, 0 to disable.
Numeric
No
Yes
enable_escalating_rate
 
Initial escalating rate is enabled
1 to enable, 0 to disable.
Numeric
No
No
escalating_rate_starts_in
 
Initial escalating rate starts in how many payment cycles
Numeric
No
No
escalating_rate
 
Initial Escalating Rate
Number in percentage e.g. 10.99 stands for 10.99%.
Numeric
No
Yes
interest
 
Interest Rate
Number in percentage e.g. 10.99 stands for 10.99%. If variable rate is enabled, the interest rate = Primate Rate + {prime_delta} >= {minimum_rate}.
Numeric
No
Yes
rate_index
 
Rate Index
0 - N/A
1 - MCAP
2 - TD
3 - CIBC
4 - RBC
5 - WSJ Prime
8 - Custom CA 2 Enabled
9 - TEST
10 - GG
14 - TEST
15 - TEST2
16 - TEST
18 - SRL TD
19 - Test
21 - Prime Rate
22 - My NEw Index
24 - Capstone Custom
25 - Test Custom Index
26 - RBC
28 - gio's rate
29 - gio's second rate
31 - Custom Index
32 - SOFR
36 - Lan Look Back
38 - BMO
40 - Houze
42 - TEST2
47 - National Bank
51 - WY Test
52 - WSJ
57 - GCMIC Prime
58 - SOFR TEST
65 - Test
66 - DMIC TD Index
67 - Custom
68 - new
70 - yup
71 - no
72 - Adam Custom
73 - EQB
76 - MDV-52646
80 - Custom Index
82 - Custom Decrease
88 - TC
89 - SOFR
90 - Custom Index 2
92 - WSJ Prime
94 - SOFR
95 - Custom Index 2022
97 - Shirkhan's Rate
98 - SOFR
103 - Daria Test
104 - SOFR
105 - Custom
107 - bmo
108 - DONT DELETE !!! Variable rate test class
109 - DONT DELETE !!! Variable rate test class 2
123 - TD (1st of Month)
130 - MyIndex
134 - Camila_test_index
135 - RTIndex
137 - 2 nd cycle
139 - 2 nd cycle and discharge
143 - val_testing
145 - val_testing_2
149 - MDV-22108 Index
150 - Eli's rate
155 - Index 2
157 - Robert Cheung
160 - Gio's index
161 - Gagan
162 - SOFR
163 - Gio's Index
164 - CCC
165 - Hell yeah
167 - BMO
168 - New Index
217 - ABCP- BMO
Enum
No
No
minimum_rate
 
Minimum Rate for Variable Rate Interest
Number in percentage e.g. 10.99 stands for 10.99%.
Numeric
No
Yes
prime_delta
 
Prime Delta for Variable Rate Interest
Number in percentage e.g. 10.99 stands for 10.99%. Default 0 for non-variable-rate interest. Default the same as {interest} rate for variable-rate interest.
Numeric
No
Yes
term_mode
 
Early Termination Type
0 - Fully Closed
1 - Closed Variable
2 - Closed, Then Open
3 - Fully Open
4 - Minimum, Then Open
Not available for Personal Loan Type
Enum
No
No
defaulted_rate
 
Defaulted Rate
Number in percentage e.g. 10.99 stands for 10.99%.
Numeric
No
Yes
interest_method
 
Interest Method
0 - equal amount
1 - per-diem based
2 - 31/360
3 - 360/365
4 - actual/360
6 - 30/360 Special
7 - 30/360 US
5 - decide on a loan by loan basis
Enum
No
Yes
position
 
Loan Position
1 - First
2 - Second
3 - Third
4 - Fourth
5 - Fifth
6 - Sixth
7 - Seventh
Enum
No
No
term
 
Term Length in months
Numeric
No
No
holdback_amount
 
Holdback / PPI Amount
Default 0.
Numeric
No
Yes
holdback_app_mode
 
Holdback / PPI Deduction Mode
0 - Apply upfront (deferred payments)
1 - Spread evenly
2 - Apply at the end
Enum
No
No
holdback_app_cycle
 
Months to spread holdback over
Months count to spread holdback evenly over.
Cannot be empty if holdback_app_mode = 1 (spread evenly)
Cannot be > 0 if holdback_app_mode != 1 (any other than “spread evenly”)
Numeric
No
Yes
holdback_start_at
 
Holdback starting month
Starting from month number from which holdback over. (Applies only (and only allowed) when holdback_app_mode is 0).
Cannot be empty if holdback_app_mode = 0 (Apply Upfront).
Cannot be > 0 if holdback_app_mode != 0 (any other than “Apply Upfront”).
Numeric
No
Yes
repay_mode
 
Repayment Type
0 - Interest Only / Interest Only Deferred
1 - Principal + Interest
2 - Capitalizing Interest
Default 0.
Enum
No
No
defer_int_pay
 
Defer Interest Payment
Default 0. 1: defer interest payment. It's set when Repayment Type is Interest Only Deferred.
Numeric
No
No
main_defer_int_pay
 
Defer interest payments until the next advance
Default 0.

0: When {holdback_amount} is specified, "Interest Schedule > charge interest at monthly payment" is enabled. Otherwise, "Interest Schedule > holdback / PPI" is enabled.

1: “Interest Schedule > defer interest payments until the next advance” is enabled.
Numeric
No
No
amort_yearmonth_months
 
Amortization Months Part in Years/Months
To combine with {amort_yearmonth_years}.
Numeric
No
Yes
amort_compounding
 
Compounding
52 - Weekly
26 - Bi-Weekly
24 - Semi-Monthly
12 - Monthly
4 - Quarterly
2 - Semi-Annually
1 - Annually
Enum
No
No
frequency
 
Payment Frequency
0 - Monthly
1 - Semi-Monthly
2 - Weekly
3 - Bi-Weekly
7 - Quarterly
Default is 0 (Monthly)
Enum
No
Yes
accelerate_payment
 
Accelerate Payment
Default 0. 1 is to enable accelerate payment for {frequency} is Weekly (2) or Bi-Weekly (3)
Numeric
No
No
funding_date
 
Deposit / Funding Date
Timestamp
No
Yes
closing_date
 
Closing Date
The field is shown if this is enabled: Company Settings > Optional Loan Fields > Investor Section > Different Closing vs. Payout Dates. It's greater than or equal to {funding_date}.
Timestamp
No
Yes
doc_date
 
Doc Date
The field is shown if this is enabled: Company Settings > Optional Loan Fields > Investor Section > Custom Maturity Date.
Timestamp
No
Yes
pay_day
 
Borrower Pays on This Day
1 is Day 1. Default is 1.
Timestamp
No
No
pay_day_type
 
Borrower Pay Day Type
0 (default) or 1. 0 means start of each month or from quarterly start. 1 means before month end or from quarter end.

0: Day {pay_day} from quarter start for {frequency} is Quarterly (7)
0: Day {pay_day} of each month for {frequency} is not Quarterly (7)

1: Day {pay_day} from quarter end for {frequency} is Quarterly (7)
1: Day {pay_day} before month end for {frequency} is not Quarterly (7)
Numeric
No
Yes
investor_payout_day
 
Investors Get Paid on: This Day
Default Company Settings > Default Investor Payout Day, {payday} if > 0, or 1
Numeric
No
Yes
investor_payout_day_2
 
Investors Get Paid on: Day {investor_payout_day} and this day
Default {investor_payout_day}. It's shown when {investor_payout_type} is start of quarter/month (0) and {frequency} is Semi-Monthly (1)
Numeric
No
Yes
investor_payout_type
 
Investors Get Paid on Type
Default 0. Investors get paid on 0: Day from start of quarter/month, 1: Day from end of quarter/month, 2: Day from borrower payment date.

0: Day {investor_payout_day} and {investor_payout_day_2} of month following end of quarter for {frequency} is Quarterly (7)
0: Day {investor_payout_day} and {investor_payout_day_2} of each month for {frequency} is not Quarterly (7)

1: Day {investor_payout_day} and {investor_payout_day_2} before month end of month following end of the quarter for {frequency} is Quarterly (7)
1: Day {investor_payout_day} and {investor_payout_day_2} before month end for {frequency} is not Quarterly (7)

2: Day {investor_payout_day} and {investor_payout_day_2} from borrower payment date
Numeric
No
Yes
pay_method
 
Payment Method
Default 0. Only Australia has 2.
Enum
No
No
early_term_penalty_in_months
 
Early Term. Penalty in Months
Default is Company Settings > Default Settings & Rates > Early Termination Penalty in months. Shown when {term_mode} is Fully Closed (0) and {type} is not Personal (4)
Numeric
No
Yes
early_term_penalty_first_months
 
Early Term. Penalty For the first (in months)
Default 0. Early Term. Type: {term_mode}. For the first {early_term_penalty_first_months} month(s), the penalty will be {early_term_penalty_first_months_amount} month(s)
Numeric
No
Yes
type
 
Loan Type
0 - Standard
1 - Construction
2 - Commercial
3 - Fix & Flip
4 - Personal
Enum
No
No
application_type
 
Application Type
0 - Mortgage
1 - LOC
2 - Bridge
3 - Deed of Trust
4 - Promissory Note
Enum
No
Yes
early_term_penalty_first_months_amount
 
Amount for Early Term. Penalty For the first (in months)
Default 0. Early Term. Type: {term_mode}. For the first {early_term_penalty_first_months} month(s), the penalty will be {early_term_penalty_first_months_amount} month(s)
Numeric
No
Yes
down_payment
 
Down Payment
Numeric
No
Yes
early_term_penalty_min_months_then_open
 
Minimum number of month(s) interest earned
for Early Term. Type {term_mode} is 'Minimum, Then Open' (4)
Numeric
No
Yes
early_term_penalty_min_amount_then_open
 
Minimum amount
for Early Term. Type {term_mode} is 'Minimum, Then Open' (4)
Numeric
No
Yes
early_term_penalty_closed_variable_after_months
 
Afterwards, the penalty will be x month(s)
for Early Term. Type {term_mode} is 'Closed Variable' (1)
Numeric
No
Yes
fees
 
Fees
Refer to Fees->get
Fees
No
No
custom_fees
 
Custom Fees
Refer to CustomFees->list
List-Custom Fees
No
No

Response Fields

Field
Description
Type
Required
Nullable
mortgage_for_loan_update
 
The updated mortgage
Mortgage for Loan Update
No
No
API Key
get

POST: {ENDPOINT}/apikey/get

Field
Description
Type
Required
Nullable

Response Fields

Field
Description
Type
Required
Nullable
gsid
 
GS ID
Numeric
No
No
name
 
Lender Name
Text
No
No
Loan Amenity
get

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
amenity_id
 
Loan Amenity ID
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
amenity_id
 
Loan Amenity ID
Numeric
No
No
loan_id
 
Amenity Loan ID
Numeric
No
No
amenity_number
 
Amenity Number
Numeric
No
No
amenity_description
 
Amenity Description
Text
No
No
list

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
If provided, response is the loan's amenities
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
amenities
 
List of loan amenities
Refer to LoanAmenity->get
List-Loan Amenity
No
No
Tax Payment Schedule
get

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
ps_id
 
Payment Schedule ID
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
ps_id
 
Payment Schedule ID
Numeric
No
No
due_date
 
Due Date
Numeric
No
Yes
amount
 
Amount
Numeric
No
Yes
list

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
If provided, response is the loan's amenities
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
taxpaymentschedules
 
List of property payment schedule that lender pays.
Refer to TaxPaymentSchedule->get
List-Tax Payment Schedule
No
No
Share Class
get

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
share_class_id
 
Share Class Id
Subshareclass ID
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
share_class_id
 
Share Class Id
Numeric
No
No
name
 
Share Class Name
Text
No
No
Drip Payout
get

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
fund_id
 
Fund Id
Numeric
No
No
investor_id
 
Investor Id
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
percent
 
Percent
DRIP % for either reinvest or takeout
Numeric
No
No
amount
 
Amount
DRIP amount for either reinvest or takeout
Numeric
No
No
is_fixed_amount
 
Is Fixed Amount
DRIP amount for either reinvest or takeout
Boolean
No
No
frequency
 
Frequency
0 - monthly
1 - quarterly
2 - semi-annually
3 - annually
DRIP payout frequency value
Enum
No
No
frequency_name
 
Frequency Name
DRIP payout frequency name
Text
No
No
mode
 
Drip Mode
0 - reinvest
1 - takeout
Enum
No
No
Additional Reserve
get

POST: {ENDPOINT}/additional_reserves/get

Field
Description
Type
Required
Nullable
id
 
Additional Reserve ID
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
id
 
Additional Reserve ID
Numeric
No
No
loan_id
 
Loan ID
Numeric
No
No
additional_reserve_name
 
Additional Reserve Name
e.g Property Tax, Insurance , Condo Fees etc
Text
No
No
balance_asoftoday
 
Balance as of Today
Additional Reserve balance as of today
Numeric
No
No
balance_atfunding
 
Balance At Funding
Additional Reserve balance at funding.
Numeric
No
No
addr_id
 
Address Id
Numeric
No
Yes
description
 
Description
Text
No
Yes
list

POST: {ENDPOINT}/additional_reserves/list

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
If provided, response is the Borrower's Other Incomes
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
additional_reserves
 
List of additional reserves
Refer to AdditionalReserve->get
List-Additional Reserve
No
No
Property Owners
get

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
owner_id
 
Property Owner ID
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
owner_id
 
Property Owner ID
Numeric
No
No
loan_id
 
Property Owner Loan ID
Numeric
No
No
loan_property_id
 
Property ID
Numeric
No
No
owner_name
 
Owner Name
Text
No
No
owner_capacity
 
Owner Capacity
Text
No
No
owner_share
 
Owner Share
Numeric
No
No
list

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
If provided, response is the loan's property owners
Numeric
No
No
loanpropertyid
 
Loan Property ID
If provided, response is the loan's property owners
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
propertyowners
 
List of loan property owners
Refer to PropertyOwner->get
List-Property Owners
No
No
Credit Reports
get

POST: {ENDPOINT}/credit_reports/get

Field
Description
Type
Required
Nullable
report_id
 
Report ID
If provided, response is a file
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
report_id
 
Report ID
Numeric
No
No
borrower_id
 
Borrower ID
Numeric
No
Yes
loan_id
 
Loan ID
A credit report may associate with a loan.
Numeric
No
Yes
credit_bureau_name
 
Credit Bureau Name
Text
No
Yes
source
 
Source
Text
No
No
score
 
Score
Numeric
No
Yes
pull_date
 
Pull Date
Timestamp
No
No
report
 
Report
Mortgage Automator Format or other credit bureau report format
Text
No
Yes
fixed_format
 
Fixed Format
Equifax Full File Fixed (FFF) format
Text
No
Yes
pio
 
PIO
Equifax PIO format
Text
No
Yes
pdf
 
PDF
Equifax Consumer Credit Report PDF, CoreLogic PDF
Text
No
Yes
xml
 
XML
Equifax XML, CoreLogic XML
Text
No
Yes
list

POST: {ENDPOINT}/credit_reports/list

Field
Description
Type
Required
Nullable
borrower_id
 
Borrower ID
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
credit_reports
 
List of Credit Reports
List-Credit Reports
No
No
Background Tasks
get

POST: {ENDPOINT}/background_tasks/get

Field
Description
Type
Required
Nullable
id
 
Task ID
The Task ID to get
Numeric
Yes
No

Response Fields

Field
Description
Type
Required
Nullable
id
 
Task ID
Unique Task ID
Numeric
No
No
title
 
Task Title
Text
No
No
status_text
 
Status Text
Text
No
No
status
 
Status
Numeric
No
No
add_date
 
Add Date
Unix timestamp when the task was created
Timestamp
No
No
start_date
 
Start Date
Unix timestamp when the task was started
Timestamp
No
No
end_date
 
End Date
Unix timestamp when the task was completed
Timestamp
No
No
response
 
Response
The response payload
Text
No
No
data
 
Additional Data
Additional data depending on the type of task
Array
No
No
exec

POST: {ENDPOINT}/background_tasks/exec

Field
Description
Type
Required
Nullable
id
 
Task ID
The Task ID to get
Numeric
Yes
No

Response Fields

Field
Description
Type
Required
Nullable
list

POST: {ENDPOINT}/background_tasks/list

Field
Description
Type
Required
Nullable
start_date
 
Start unix timestamp
The unix timestamp for the beginning of the query period
Timestamp
No
Yes
end_date
 
End unix timestamp
The unix timestamp for the end of the query period
Timestamp
No
Yes

Response Fields

Field
Description
Type
Required
Nullable
tasks
 
Tasks
List of Tasks
List-Background Tasks
No
No
Refresh Generated Field
get

POST: {ENDPOINT}/refresh_generatedfield/get

Field
Description
Type
Required
Nullable
ids
 
Loan IDs
The Loan IDs for which to refresh the custom fields
Array
No
No

Response Fields

Field
Description
Type
Required
Nullable
task_ids
 
Task IDs
The Task for this request
Array
No
No
Reports
get

POST: {ENDPOINT}/report/get

Steps to generate reports

1. Under report/list endpoint, get the rbpresetid (required) and rbsavedfilterid (optional)

2. Using report/exec, generate the report with rbpresetid and other required parameters

3. Passing the successfully generated task_id to report/get

4. Under background_tasks/exec, assign the same task_id to id to get the file

5. In Postman, you can save response to file; in browser, the file will be auto downloaded

Field
Description
Type
Required
Nullable
task_id
 
Task ID
The Task ID for which to get the generated report
Numeric
Yes
No

Response Fields

Field
Description
Type
Required
Nullable
rbpresetid
 
Report Preset ID
Report Preset ID
Numeric
No
No
rbsavedfilterid
 
Filter ID
The Filter ID to apply
Numeric
No
No
format
 
Format
Report Format
Text
No
No
start_date
 
Start Date
Unix timestamp for the report's start date range
Timestamp
No
No
end_date
 
End Date
Unix timestamp for the report's end date range
Timestamp
No
No
rbpresetname
 
Report Builder Preset Name
Report Builder Preset Name
Text
No
No
download_link
 
Download Link
Download Link
Text
No
No
list

POST: {ENDPOINT}/report/list

Field
Description
Type
Required
Nullable
section
 
Report Section
The Report Section to filter on
Text
No
No

Response Fields

Field
Description
Type
Required
Nullable
count
 
Total Count
Total count of reports
Numeric
No
No
reports
 
Reports
List of Reports
List-Reports
No
No
exec

POST: {ENDPOINT}/report/exec

Field
Description
Type
Required
Nullable
rbpresetid
 
Report Builder Preset ID
The Report Builder Preset to generate
Numeric
Yes
No
rbsavedfilterid
 
Filter ID
The Filter ID to apply
Numeric
No
No
format
 
Format
The format of the generated report
(0 -> Excel, 2 -> CSV)
Numeric
Yes
No
start_date
 
Start Date
The start date (required when Reporting Period = Date Range)
Numeric
No
No
end_date
 
End Date
The end date (required when Reporting Period = Date Range)
Numeric
No
No
as_of_date
 
As of date
The as of date (required when Reporting Period = As of Date)
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
status
 
Status
Status of the request
Text
No
No
error
 
Error message
Error message if any
Text
No
No
task_id
 
Task ID
Task ID of this request
Numeric
No
No
Ledger
exec

POST: {ENDPOINT}/ledger/exec

Steps to retrieve ledger

1. ledger/exec – Pass in the loan ID and get a task_id in response. Optionally pass as_of_date (unix timestamp) to generate the ledger as of a specific date; defaults to the current time. Optionally pass format (0 -> Excel, 2 -> CSV); defaults to 0.

2. reports/get – Use the received task_id to retrieve the ledger metadata and a download link

3. Under background_tasks/exec, assign the same task_id to id to trigger the download of the ledger

4. In Postman, you can save response to file; in browser, the file will be auto downloaded

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
The Loan ID for which to get the full ledger for
Numeric
Yes
No
format
 
Format
The format of the generated ledger (0 -> Excel, 2 -> CSV). Optional, defaults to 0 (Excel).
Numeric
No
No
as_of_date
 
As of date
The as of date as a unix timestamp. Optional, defaults to the current time.
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
status
 
Status
Status of the request
Text
No
No
error
 
Error message
Error message if any
Text
No
No
task_id
 
Task ID
Task ID of this request
Numeric
No
Yes
format
 
Format
The format of the generated ledger
Numeric
No
No
Servicing Transformations
get

POST: {ENDPOINT}/servicing_transformations/get

Detailed parameters under servicing_transformations/get results array

▶️
Field
Description
Type
Required
Nullable
loan_ids
 
Loan IDs
The Loan IDs for which to get servicing transformations
Array
Yes
No
transformation_types
 
Transformation Types
Types for servicing transformations
1 -> Additional Loan/Advance
4 -> Renewal
5 -> Mid-Loan Adjustment
6 -> Investor Switch
7 -> Partial Paydown
11 -> Payment Frequency Change
12 -> Payment Amount Change
22 -> Discharge
Array
No
No

Response Fields

Field
Description
Type
Required
Nullable
results
 
Results
Array of Results
Array
No
No
exec

POST: {ENDPOINT}/servicing_transformations/exec

Request Fields:

Additional Loan

▶️

Mid-Loan Adjustment & Renewal

▶️

Replace Investor

▶️

Partial Paydown

▶️

Change Payment Frequency

▶️

Change Payment Amount

▶️

Discharge

▶️
Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
The Loan ID for transformation
Numeric
Yes
No
user_id
 
User ID
The User ID for transformation
Numeric
Yes
No
transformation_type
 
Transformation Type
The transformation type to apply
Numeric
Yes
No
transformation_data
 
Transformation Data
The transformation data to apply
Array
No
No

Response Fields

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
Loan ID
Numeric
No
No
user_id
 
User ID
User ID
Numeric
No
No
transformation_type
 
Transformation Type
Transformation Type
Numeric
No
No
transformation_data
 
Transformation Data
The transformation data to apply
Array
No
No
status
 
Status
Status of the request
Text
No
No
error
 
Error
Error of the request
Text
No
No
PAC
get

POST: {ENDPOINT}/pac/get

Detailed parameters under pac/get results array

▶️
Field
Description
Type
Required
Nullable
loan_ids
 
Loan IDs
The Loan IDs for which to get PAC
Array
Yes
No

Response Fields

Field
Description
Type
Required
Nullable
results
 
Results
Array of Results
Array
No
No
exec

POST: {ENDPOINT}/pac/exec

Request Fields:

Add Payment

▶️

NSF Payment

▶️

Defer Payment

▶️

Charge a Fee

▶️

Custom Fee (NSF & Defer Payment)

▶️
Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
The Loan ID for transformation
Numeric
Yes
No
user_id
 
User ID
The User ID for transformation
Numeric
Yes
No
transformation_type
 
Transformation Type
The transformation type to apply
Numeric
Yes
No
transformation_data
 
Transformation Data
The transformation data to apply
Array
No
No

Response Fields

Field
Description
Type
Required
Nullable
loan_id
 
Loan ID
Loan ID
Numeric
No
No
user_id
 
User ID
User ID
Numeric
No
No
transformation_type
 
Transformation Type
Transformation Type
Numeric
No
No
transformation_data
 
Transformation Data
The transformation data to apply
Array
No
No
status
 
Status
Status of the request
Text
No
No
error
 
Error
Error of the request
Text
No
No
Action Logs
get

Endpoint is not open to public yet

Field
Description
Type
Required
Nullable
id
 
Action Log ID
If provided, return action log id
Numeric
No
No

Response Fields

Field
Description
Type
Required
Nullable
id
 
Action Log ID
Numeric
No
No
user
 
Action log name
Text
No
Yes
action
 
User Action
Text
No
No
extra
 
Extra Information
Text
No
Yes
module
 
Module
Text
No
Yes
submodule
 
Sub Module
Text
No
Yes
time
 
Log Action Time
Timestamp
No
Yes
list

POST: {ENDPOINT}/action_logs/list

Field
Description
Type
Required
Nullable

Response Fields

Field
Description
Type
Required
Nullable
action_logs
 
List of action logs
List-Action Logs
No
No
Developer Switches
For the convenience of developers, the API supports special diagnostic switches in the HTTP request header:

help: 1 - displays the request format. The bitfield (10)b in "apifieldflags" indicates a required field.
check: 1 - returns any validation errors if there is any; otherwise an empty list is returned.
format: php - returns a PHP array instead of JSON.