Request Bodies

Actionable List Definition Source Column Input
A source column configuration used for filtering and picklists on an actionable list definition.

Actionable List Definition Update Input
The request payload used to partially update an actionable list definition. Include only the fields that you want to update. Omitted fields remain unchanged.

Actionable List Definitions Create Input
The request payload used to create an actionable list definition.

Actionable List Definitions Member Status Input
A member status configuration for an actionable list definition.

Actionable List Definitions Records Input
The request payload used to get records associated with an actionable list definition.

Actionable List Definitions Source Details Input
Source configuration details for an actionable list definition.

Filter Input
A filter condition used to retrieve actionable list definition records or to create or update an actionable list.

Actionable Lists Upsert Input
The request payload used to create or update an actionable list and its members.

Address Input
Represents address details.

Asset Input
Represents details about the borrower's and co-borrower's current personal and real property.

Borrower Address Input
Input representation for Borrower addresses.

Borrower Declaration Input
Input representation for Borrower declarations

Borrower Employment Input
Represents details about the borrower's or co-borrower's current and past employment.

Borrower Income Input
Input representation for Borrower income

Borrower Input
Represents details of the borrower or co-borrower for the loan application.

Case Info Wrapper
Input representation of a case related to the complaint.

Case Participant Info Wrapper
Input representation of a case participant associated with the complaint.

Complaint Info Wrapper
Input representation of the complaint details.

Complaint Management Request Input
Input representation of the request to create a public complaint.

Document Info Attributes Wrapper
Input representation of the details of a supporting document for the complaint.

Ethoca Alert Callback Input
Ethoca alert input payload for transaction dispute management.

Ethoca Event
Ethoca event payload.

Ethoca Links
Ethoca resource link payload.

Extended Fields Input
Input representation for extended fields.

Filter Criteria
Filter criteria for queries of financial goals and households.

Financial Goal Create Input
Input for creating a single financial goal with goal members and funding.

Financial Goal Funding Input
Input for Financial Accounts that fund the Financial Goal.

Financial Goal Input
Input for creating or updating a financial goal.

Financial Goal List Create Input
Input for creating multiple financial goals with goal members.

Financial Goal Party Input
Input for adding or removing financial goal members.

Financial Goal Patch Input
Input for updating a financial goal.

Financial Goal Query Input
Query input for financial goals and goal members based on a parent record ID. The parent can be a Person Account or Household.

Financial Input
Input details for the financial transaction.

Flexible Hierarchy Bulk Validation Input
Input representation to validate flexible hierarchies in bulk asynchronously.

Flexible Hierarchy Bulk Validation Filter Input
Input representation for a filter criterion used in bulk validation.

Flexible Hierarchy Check Sync Input
Input representation to check whether rule-based flexible hierarchies are out of sync in bulk asynchronously.

Flexible Hierarchy Filters Input
Input representation for filter conditions and expression used in bulk validation.

Flexible Hierarchy Rule-Based Creation Input
Input representation to create or update flexible hierarchies in bulk asynchronously by applying relationship graph definition rules.

Root Record Input
Input representation of a root record to build a hierarchy for.

Generic Object Wrapper
Input representation of additional details of the case, case participant, or complaint.

Liability Input
Details about the borrower and co-borrower current liabilities.

Mapper Input Representation
Represents the input representation for the Mapper POST method.

Mortgage Input
Represents the input for mortgage POST or PATCH method.

Property Input
Represents details of the property the loan application finances.

Title Holder Input
Represents details of borrowers who are applying to hold title to the property the loan application finances.

Referral Assignment Assignee Input
The user or queue that receives referrals matching an assignment rule.

Referral Assignment Condition Input
A single field-operator-value condition used in a referral assignment rule.

Referral Assignment Rule Input
The request payload used to create a draft referral assignment rule.

Referral Assignment Rule Order Input
The request payload used to update the evaluation order of referral assignment rules.

Referral Assignment Rule Order Item Input
One rule and its new sort order value in a reorder request.

Referral Assignment Rule Status Update Input
The request payload used to activate or deactivate a referral assignment rule.

Referral Assignment Rule Update Input
The request payload used to replace the definition of a draft or inactive referral assignment rule.

Referral Form Configuration Input
Input representation of the details to create or update a referral form configuration record, including the top-level definition, the ordered list of steps, and the welcome and success-screen configuration.

Referral Form Configuration Management Input
Input representation of the top-level details for the referral form configuration record that you want to create or update, such as its display name, developer name, base entity, and activation status.

Step Section Condition Management Input
Input representation of a single visibility condition for a step section in a referral form configuration record. Each condition compares a field's value against a supplied value using a specified operator.

Referral Form Configuration Step Section Field Management Input
Input representation of a single field that appears within a step section of a referral form configuration record, including its display metadata, default value, and runtime behavior.

Referral Form Configuration Success Message Management Input
Input representation of the default success-screen message that's shown after a referral is submitted when no configured message rule matches.

Referral Form Configuration Success Rule Message Management Input
Input representation of the message body that's shown when a success-screen message rule matches at runtime.

Referral Form Configuration Welcome Consent Management Input
Input representation of a single consent item that's shown on the welcome screen of a referral intake form, including the consent text, format, and audit metadata.

Referral Form Configuration Welcome Content Management Input
Input representation of the body content shown on the welcome screen of a referral intake form.

Step Section Visibility Condition Input
Input representation of the visibility criteria for a step or step section in a referral form configuration record, including the list of trigger conditions and the logical expression that combines them.

Referral Form Configuration Step Section Input
Input representation of a section within a step of a referral form configuration record, including the section's fields, layout order, and optional visibility criteria.

Referral Form Configuration Success Message Rule Management Input
Input representation of a single success-screen message rule, including the criteria that must match at runtime and the message shown when it does.

Intake Success Screen Management Input
Input representation of the success-screen configuration for a referral intake form, including the default message and any conditional message rules.

Intake Welcome Management Input
Input representation of the welcome-screen configuration that's shown before the first step of a referral intake form, including consent items, welcome content, and prefilled fields.

Referral Form Configuration Step Input
Input representation of a single step within a referral form configuration record, including its layout order, optional visibility criteria, and list of sections.

Referral Form Definition Status Update Input
Input representation used to activate or deactivate a referral form configuration definition without modifying its steps, sections, fields, or other configuration details.

Referral Input
Input representation of the details to create or update a referral through context service at runtime.