Response Bodies

Actionable List Column Values
The response representation of distinct values for a source column on an actionable list definition.

Actionable List Definition Detail
The response representation of the details of an actionable list definition.

Actionable List Definition Member Status
The response representation of the member status for an actionable list definition.

Actionable List Definition Source Column
The response representation of a source column configuration for an actionable list definition.

Actionable List Definition Source Details
The response representation of the source details for the actionable list definition.

Actionable List Definition Update
The response representation returned after updating an actionable list definition.

Actionable List Definitions Create
The response representation of the actionable list definition that’s created.

Actionable List Definitions Data Column
Metadata for a single column in the actionable list definition records response.

Actionable List Definitions Data Row
A single row in the actionable list definition records response.

Actionable List Definitions Get
The response representation of the details of the actionable list definitions.

Actionable List Definitions Records
The response representation of an actionable list definition along with the associated records, column metadata, and pagination details.

Actionable Lists Upsert
The response representation of the actionable list that’s created or updated.

Address Output
Represents address details.

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

Asset Result
Asset result of the POST or PATCH request.

Borrower Address Output
Represents Borrower addresses.

Borrower Address Result
Borrower address result of the POST or PATCH request.

Borrower Declaration Output
Represents financial issues like foreclosure, lawsuits, or defaults of the applicant or co-applicant.

Borrower Declaration Result
Result containing details about borrower’s declaration.

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

Borrower employment Result
Borrower employment result of the POST or PATCH request.

Borrower Income Output
Represents details about the borrower and co-borrower current monthly income.

Borrower Income Result
Borrower income result of the POST or PATCH request.

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

Borrower Result
Borrower result of the POST or PATCH request.

Client Snapshot Field
Output representation of a single resolved field on the household snapshot, including its API name, data type, label, and value.

Complaint Management Output
Output representation of the created public complaint.

Ethoca Alert Callback Output
Ethoca alert callback output for dispute management.

Extended Fields Output
Represents custom fields names and values.

Financial Goal Details Output
Queried financial goal details.

Financial Goal Funding Output
Output for Financial Goal funding.

Financial Goal Party Output
Output for Financial Goal Parties.

Financial Goal Patch Output
Updated financial goal.

Financial Goals Create Output
Container for created financial goals and goal members.

Financial Goals Create Result
Created financial goals and goal members.

Financial Goals List Output
Queried financial goals.

Financial Output
Output details for the financial transaction.

Financial Result
Financial result of the POST or PATCH request.

Flexible Hierarchy Bulk Validation Details
Output representation to display the status of bulk validation request.

Flexible Hierarchy Check Sync Response
Status of an asynchronous request to evaluate whether rule-based flexible hierarchies are synchronized with their source data.

Flexible Hierarchy Configuration Relationship Details
Allowed parent-child relationship between entities in a flexible hierarchy configuration.

Flexible Hierarchy Configuration Summary Rollup Details
Rollup metric definition from a flexible hierarchy configuration.

Flexible Hierarchy Job Run Delete Response
Output representation of the details when a flexible hierarchy job run is deleted.

Flexible Hierarchy Job Run Response
Details of a single flexible hierarchy rule-based creation job run, including status, record counts, and the user who started the run.

Flexible Hierarchy Job Runs Response
Output representation of a paginated list of flexible hierarchy rule-based creation job runs that match the request filters.

Flexible Hierarchy Job Run Item Response
Details of a single flexible hierarchy job run item, including processing status, the parent job run, and the related hierarchy and root record.

Flexible Hierarchy Job Run Items Response
Output representation of the paginated list of job run items that are associated with a flexible hierarchy job run.

Flexible Hierarchy Job Run Item Details
Details of a job run item in a paginated list, including processing status, the related hierarchy, and the root record that the item processed.

Flexible Hierarchy Job Run Details
Details of a flexible hierarchy rule-based creation job run as an item in a paginated list, including status, record counts, and the user who started the run.

Flexible Hierarchy Pagination Details
Pagination details for a page of child nodes in a flexible hierarchy response.

Flexible Hierarchy Record Search Response
Output representation of the org records that match the record search criteria for a relationship graph definition, along with the status of the request.

Flexible Hierarchy Record Search Record Details
Output representation of a single org record that matches the record search criteria and that you can add as a node to a flexible hierarchy.

Flexible Hierarchy Root Record Details
Output representation of a root record details that matches the root filter on a relationship graph definition.

Flexible Hierarchy Root Records Response
Output representation of the root records that match the root filter defined on a relationship graph definition, grouped by whether each record already has a hierarchy or not.

Flexible Hierarchy Rule-Based Creation Response
Output representation of the status of an asynchronous request to create or update flexible hierarchies by applying relationship graph definition rules.

Flexible Hierarchy Search
Output representation of the snapshot nodes whose captured display name matches the search text, along with the status of the request.

Flexible Hierarchy Search Node
Output representation of one snapshot node returned by a flexible hierarchy snapshot search.

Flexible Hierarchy Search Reference Record
Output representation of the reference record captured on a snapshot node that matches a flexible hierarchy snapshot search.

Flexible Hierarchy Snapshot Response
Output representation of the captured structure of a flexible hierarchy snapshot, lazily loaded one context node at a time.

Flexible Hierarchy Snapshot Capture Context Details
Details that record how a flexible hierarchy snapshot was captured.

Flexible Hierarchy Snapshot Display Value Details
Field value captured on a snapshot node or relationship at the time the snapshot was taken.

Flexible Hierarchy Snapshot Relationship Details
Parent-child connection captured in a flexible hierarchy snapshot.

Flexible Hierarchy Snapshot Entity Display Fields Details
Per-entity fields to display in graph and grid views, as frozen in a snapshot.

Flexible Hierarchy Snapshot Hierarchy Configuration Details
Details of the hierarchy configuration captured in a snapshot, including entity display fields, allowed relationships, and rollup definitions.

Flexible Hierarchy Snapshots Response
Output representation of the list of snapshot summaries for a flexible hierarchy.

Flexible Hierarchy Snapshot Metadata Details
Metadata for a flexible hierarchy snapshot, including when it was captured, how many nodes it contains, and how it was captured.

Flexible Hierarchy Snapshot Node Details
Output representation of the captured node in a flexible hierarchy snapshot, including frozen field values and rollup metrics.

Flexible Hierarchy Snapshot Details
Summary of a flexible hierarchy snapshot, including the version number, captured date, node count, and why the snapshot was created.

Flexible Hierarchy Snapshot Rollup Details
Materialized rollup metric captured on a snapshot node at the time the snapshot was taken.

Flexible Hierarchy Status
Output representation to display the status of the Flexible Hierarchy API request.

Household Account Snapshot Response
Output representation of the profile information for an account, including the account type and the requested primary member and account field details.

Insight Quick Action
Output representation of the details of a recommended action associated with an insight.

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

Liability Result
Liability result of the POST or PATCH request.

Mapper Result
Represents the Mapper result.

Mapper Result Representation
Represents the result representation of the POST method.

Mortgage Information Output
Represents the output of the GET method.

Mortgage Information Response
Response for the GET method.

Mortgage Response
Response for the POST or PATCH method.

Mortgage Result
Represents the result of the POST or PATCH method.

NextGen Wealth Insight
Output representation of the details of an insight or recommendation with the associated actions for the advisor.

Property Result
Property result of the POST or PATCH request.

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

Record Alert
Output representation of the details of a record alert.

Record Alert Collection
Output representation of a collection of record alerts.

Record Alert Collection Map
Output representation of the bulk record alerts request.

Record Alert Action Info
Output representation of the information of the record alert action.

Record Alert Action Info Collection
Output representation of the details of an action on the record alert.

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

Title Holder Result
Title holder result of the POST or PATCH request.

Retrieval Summary Result
Output representation of a retrieval summary definition call.

Retrieval Summary Result Node
Output representation of the result of a retrieval summary definition call.

Retrieval Summary Result Record
Output representation of a record for the result of a retrieval summary definition call.

Retrieval Summary Result Root Node
Output representation of the result of a retrieval summary definition call.

Referral Assignment Rule
The response representation for a single referral assignment rule.

Referral Assignment Rule Assignee
The assignee returned as part of a referral assignment rule.

Referral Assignment Rule Condition
A condition returned as part of a referral assignment rule.

Referral Assignment Rule Create
The response representation returned after creating a draft referral assignment rule.

Referral Assignment Rule Delete
The response representation returned after deleting a referral assignment rule.

Referral Assignment Rule Field Metadata
Field metadata returned for building referral assignment rule conditions.

Referral Assignment Rule List
The response representation containing all referral assignment rules sorted by sequence number.

Referral Assignment Rule Status Update
The response representation returned after activating or deactivating a referral assignment rule.

Referral Assignment Rules Metadata
The response representation containing fields and supported operators for building referral assignment rule conditions.

Referral Assignment Rules Order
The response representation returned after updating the evaluation order of referral assignment rules.

Referral Form Configuration
Output representation of a single referral form configuration record, including its display name, developer name, activation status, and audit fields.

Referral Form Configuration Response
Output representation of the details after a referral form configuration record is created or updated. The response includes the ID of the saved record, the HTTP status, and a human-readable status message.

Referral Form Configuration List
Output representation of a paginated list of referral form configuration records that match the request filters, along with metadata and the overall API response status.

Referral Form Configuration Branding
Output representation of the branding configuration applied to a referral form, including color palette, imagery, and footer text.

Step Section Condition
Output representation of a single condition that governs the visibility of a step or section within a referral form configuration.

Referral Form Configuration Step Section Field
Output representation of a single field rendered within a step section of a referral form configuration, including display metadata, default value, and runtime behavior.

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

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

Referral Form Configuration Welcome Consent
Output representation of a single consent item configured for display on the referral form welcome screen.

Referral Form Configuration Welcome Content
Output representation of the welcome content configured for a referral form.

Referral Form Definition Status Update
Output representation returned after a referral form configuration definition is activated or deactivated. The API response includes the definition ID, its new active state, the HTTP status, and the overall success flag.

Step Section Visibility Criteria
Output representation of the visibility criteria for a step or a section within a step, including the list of trigger conditions and the logical expression that combines them.

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

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

Referral Form Configuration Welcome
Output representation of the welcome-screen configuration for a referral form, including consent items, welcome content, and any prefilled fields.

Referral Form Configuration Definition Step
Output representation of a single step within a referral form configuration definition, including the information required to render and process that step at runtime.

Referral Form Configuration Success Screen
Output representation of the success-screen configuration for a referral form, including the default message and any conditional message rules.

Referral Form Configuration Definition
Output representation of the top-level details for a referral form configuration definition, including display metadata, activation state, and links to design-time artifacts such as the associated Context Definition and OmniScript or FlexCard.

Referral Form Configuration Definition Detail
Output representation of the complete referral form configuration definition, with the top-level definition record and its steps, sections, fields, visibility criteria, welcome screen, and success screen.

Referral Form Configuration Definition Delete
Output representation of the details after a referral form configuration definition is deleted. The API response includes the deleted definition ID, the HTTP status, a message, and the overall success flag.

Referral Response
Output representation of the details after a referral is created or updated through Context Service.