Pylon GraphQL API
Welcome to the Pylon GraphQL API Documentation! This reference includes the complete set of GraphQL queries and mutations needed for mortgage - from getting teaser rates to show potential borrowers to getting a rate lock for a borrower at the end of the application process.
API Endpoints
https://sandbox.pylon.mortgage/graphqlQueries
advisorSession
Response
Returns an AdvisorSession
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query advisorSession($id: ID!) {
advisorSession(id: $id) {
createdAt
id
messages {
...AdvisorSessionAdvisorMessageFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"advisorSession": {
"createdAt": "2007-12-03T10:15:30Z",
"id": 4,
"messages": [AdvisorSessionAdvisorMessage]
}
}
}
analytics
Description
Namespace for analytics queries. Analytics queries are for querying tabular data built from pre-aggregated API entities. The results can be consumed directly or exported in bulk to a file.
Response
Returns an Analytics
Example
Query
query analytics {
analytics {
job {
...AnalyticsExportJobFragment
}
loanApplications {
...LoanApplicationAnalyticsConnectionFragment
}
summary {
...PipelineSummaryResponseFragment
}
}
}
Response
{
"data": {
"analytics": {
"job": AnalyticsExportJob,
"loanApplications": LoanApplicationAnalyticsConnection,
"summary": PipelineSummaryResponse
}
}
}
asset
Description
Get an asset by ID
Example
Query
query asset($id: ID!) {
asset(id: $id) {
amount
borrowerIds
id
nonBorrowerOwnerNames
}
}
Variables
{"id": "4"}
Response
{
"data": {
"asset": {
"amount": 123,
"borrowerIds": ["4"],
"id": 4,
"nonBorrowerOwnerNames": ["xyz789"]
}
}
}
aus
Description
Fetch AUS information associated with a loan.
Response
Returns an Aus
Example
Query
query aus {
aus {
ausRunJob {
...AusRunJobFragment
}
latestAusRunForLoan {
...AusRunJobFragment
}
}
}
Response
{
"data": {
"aus": {
"ausRunJob": AusRunJob,
"latestAusRunForLoan": AusRunJob
}
}
}
borrower
Description
Get a borrower by id
Example
Query
query borrower($id: ID!) {
borrower(id: $id) {
assets {
...AssetFragment
}
borrowerTasks {
...BorrowerTaskFragment
}
createdOn
credit {
...BorrowerCreditFragment
}
deal {
...DealFragment
}
demographicInfo {
...DemographicInfoFragment
}
dependentAges
emailVerified
externalUserId
financialDeclarations {
...BorrowerFinancialDeclarationsFragment
}
id
incomes {
...IncomeConnectionFragment
}
isFirstTimeHomeBuyer
liabilities {
...LiabilityConnectionFragment
}
mailingAddress {
...AddressFragment
}
maritalStatus
militaryService {
...BorrowerMilitaryServiceFragment
}
ownedProperties {
...OwnedPropertyConnectionFragment
}
personalInformation {
...BorrowerPersonalInformationFragment
}
pointOfContact
propertyDeclarations {
...BorrowerPropertyDeclarationsFragment
}
spouse {
...BorrowerSpouseFragment
}
useOwnTitleCompany
}
}
Variables
{"id": 4}
Response
{
"data": {
"borrower": {
"assets": [Asset],
"borrowerTasks": [BorrowerTask],
"createdOn": "2007-12-03T10:15:30Z",
"credit": BorrowerCredit,
"deal": Deal,
"demographicInfo": DemographicInfo,
"dependentAges": [123.45],
"emailVerified": true,
"externalUserId": "abc123",
"financialDeclarations": BorrowerFinancialDeclarations,
"id": "4",
"incomes": IncomeConnection,
"isFirstTimeHomeBuyer": false,
"liabilities": LiabilityConnection,
"mailingAddress": Address,
"maritalStatus": "DIVORCED",
"militaryService": BorrowerMilitaryService,
"ownedProperties": OwnedPropertyConnection,
"personalInformation": BorrowerPersonalInformation,
"pointOfContact": true,
"propertyDeclarations": BorrowerPropertyDeclarations,
"spouse": BorrowerSpouse,
"useOwnTitleCompany": false
}
}
}
borrowerUser
Description
Fetch a user in an organization by id
Response
Returns a BorrowerUser
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query borrowerUser($id: ID!) {
borrowerUser(id: $id) {
id
loanApplications {
...BorrowerUserLoanApplicationSummaryFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"borrowerUser": {
"id": 4,
"loanApplications": [
BorrowerUserLoanApplicationSummary
]
}
}
}
commsTemplate
Description
Get comms template by id
Response
Returns a CommsTemplate
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query commsTemplate($id: ID!) {
commsTemplate(id: $id) {
id
name
subject
template
}
}
Variables
{"id": 4}
Response
{
"data": {
"commsTemplate": {
"id": 4,
"name": "abc123",
"subject": "abc123",
"template": "abc123"
}
}
}
commsTemplates
Description
Get all comms templates
Response
Returns [CommsTemplate!]
Example
Query
query commsTemplates {
commsTemplates {
id
name
subject
template
}
}
Response
{
"data": {
"commsTemplates": [
{
"id": "4",
"name": "abc123",
"subject": "xyz789",
"template": "xyz789"
}
]
}
}
company
Description
Get a company by ID
contributor
Response
Returns a Contributor
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query contributor($id: ID!) {
contributor(id: $id) {
contactInfo {
...ContributorContactInfoFragment
}
deals {
...DealConnectionFragment
}
disabledAt
id
role
roleId
}
}
Variables
{"id": "4"}
Response
{
"data": {
"contributor": {
"contactInfo": ContributorContactInfo,
"deals": DealConnection,
"disabledAt": "2007-12-03T10:15:30Z",
"id": 4,
"role": "xyz789",
"roleId": "4"
}
}
}
contributorRoles
Response
Returns a ContributorRoleConnection
Arguments
| Name | Description |
|---|---|
after - String
|
A cursor value that indicates the position after which items should be returned. Typically this should be the 'endCursor' of the previous page. |
before - String
|
A cursor value that indicates the position before which items should be returned. Typically this should be the 'startCursor' of the following page. |
first - Int
|
The number of items to be retrieved for forward pagination. Either 'first' or 'last' must be specified, but not both. This value must be between 1 and 500. |
last - Int
|
The number of items to be retrieved for backward pagination. Either 'first' or 'last' must be specified, but not both. This value must be between 1 and 500. |
sortDirection - SortDirection
|
The direction in which the results should be sorted. Defaults to ASC. |
Example
Query
query contributorRoles(
$after: String,
$before: String,
$first: Int,
$last: Int,
$sortDirection: SortDirection
) {
contributorRoles(
after: $after,
before: $before,
first: $first,
last: $last,
sortDirection: $sortDirection
) {
edges {
...ContributorRoleEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"after": "xyz789",
"before": "xyz789",
"first": 987,
"last": 123,
"sortDirection": "ASC"
}
Response
{
"data": {
"contributorRoles": {
"edges": [ContributorRoleEdge],
"pageInfo": PageInfo
}
}
}
contributors
Response
Returns a ContributorConnection
Arguments
| Name | Description |
|---|---|
after - String
|
A cursor value that indicates the position after which items should be returned. Typically this should be the 'endCursor' of the previous page. |
before - String
|
A cursor value that indicates the position before which items should be returned. Typically this should be the 'startCursor' of the following page. |
filterBy - ContributorFilter
|
|
first - Int
|
The number of items to be retrieved for forward pagination. Either 'first' or 'last' must be specified, but not both. This value must be between 1 and 500. |
last - Int
|
The number of items to be retrieved for backward pagination. Either 'first' or 'last' must be specified, but not both. This value must be between 1 and 500. |
sortDirection - SortDirection
|
The direction in which the results should be sorted. Defaults to ASC. |
Example
Query
query contributors(
$after: String,
$before: String,
$filterBy: ContributorFilter,
$first: Int,
$last: Int,
$sortDirection: SortDirection
) {
contributors(
after: $after,
before: $before,
filterBy: $filterBy,
first: $first,
last: $last,
sortDirection: $sortDirection
) {
edges {
...ContributorEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"after": "xyz789",
"before": "abc123",
"filterBy": ContributorFilter,
"first": 123,
"last": 987,
"sortDirection": "ASC"
}
Response
{
"data": {
"contributors": {
"edges": [ContributorEdge],
"pageInfo": PageInfo
}
}
}
credit
Description
Namespace for credit queries. These allow checking on the status of a credit pull and retrieving the credit report once the credit pull is complete.
Response
Returns a Credit
Example
Query
query credit {
credit {
job {
...CreditPullJobFragment
}
report {
...CreditReportFragment
}
}
}
Response
{
"data": {
"credit": {
"job": CreditPullJob,
"report": CreditReport
}
}
}
deal
Description
Fetch a deal by id. A deal encapsulates the entire process of getting a mortgage, including situations such as concurrent financing where there could be multiple loans
Example
Query
query deal($id: ID!) {
deal(id: $id) {
borrowers {
...BorrowerConnectionFragment
}
creationTime
friendlyId
id
loans {
...LoanApplicationFragment
}
parties {
...PartyFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"deal": {
"borrowers": BorrowerConnection,
"creationTime": "2007-12-03T10:15:30Z",
"friendlyId": "abc123",
"id": 4,
"loans": [LoanApplication],
"parties": [Party]
}
}
}
deals
Description
List all deals
Response
Returns a DealConnection
Arguments
| Name | Description |
|---|---|
after - String
|
A cursor value that indicates the position after which items should be returned. Typically this should be the 'endCursor' of the previous page. |
before - String
|
A cursor value that indicates the position before which items should be returned. Typically this should be the 'startCursor' of the following page. |
first - Int
|
The number of items to be retrieved for forward pagination. Either 'first' or 'last' must be specified, but not both. This value must be between 1 and 500. |
last - Int
|
The number of items to be retrieved for backward pagination. Either 'first' or 'last' must be specified, but not both. This value must be between 1 and 500. |
sortDirection - SortDirection
|
The direction in which the results should be sorted. Defaults to ASC. |
Example
Query
query deals(
$after: String,
$before: String,
$first: Int,
$last: Int,
$sortDirection: SortDirection
) {
deals(
after: $after,
before: $before,
first: $first,
last: $last,
sortDirection: $sortDirection
) {
edges {
...DealEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"after": "xyz789",
"before": "abc123",
"first": 123,
"last": 987,
"sortDirection": "ASC"
}
Response
{
"data": {
"deals": {
"edges": [DealEdge],
"pageInfo": PageInfo
}
}
}
disclosures
Use
disclosuresHistory instead to grab all disclosures, including both recent and historical runs. Response
Returns a Disclosures
Arguments
| Name | Description |
|---|---|
loanId - String!
|
Example
Query
query disclosures($loanId: String!) {
disclosures(loanId: $loanId) {
adverseAction {
...DisclosureFragment
}
closingDisclosure {
...DisclosureFragment
}
initialDisclosure {
...DisclosureFragment
}
redisclosure {
...DisclosureFragment
}
}
}
Variables
{"loanId": "abc123"}
Response
{
"data": {
"disclosures": {
"adverseAction": Disclosure,
"closingDisclosure": Disclosure,
"initialDisclosure": Disclosure,
"redisclosure": Disclosure
}
}
}
disclosuresHistory
Response
Returns a DisclosuresHistory
Arguments
| Name | Description |
|---|---|
loanId - String!
|
Example
Query
query disclosuresHistory($loanId: String!) {
disclosuresHistory(loanId: $loanId) {
disclosures {
...DisclosureFragment
}
}
}
Variables
{"loanId": "abc123"}
Response
{
"data": {
"disclosuresHistory": {"disclosures": [Disclosure]}
}
}
disclosuresPreviews
Response
Returns a DisclosuresPreviews
Arguments
| Name | Description |
|---|---|
loanId - String!
|
Example
Query
query disclosuresPreviews($loanId: String!) {
disclosuresPreviews(loanId: $loanId) {
adverseAction {
...DisclosurePreviewFragment
}
closingDisclosure {
...DisclosurePreviewFragment
}
initialDisclosure {
...DisclosurePreviewFragment
}
redisclosure {
...DisclosurePreviewFragment
}
}
}
Variables
{"loanId": "abc123"}
Response
{
"data": {
"disclosuresPreviews": {
"adverseAction": DisclosurePreview,
"closingDisclosure": DisclosurePreview,
"initialDisclosure": DisclosurePreview,
"redisclosure": DisclosurePreview
}
}
}
geography
Description
Namespace for geography queries. These allow querying state and county information needed for licensing and pre-approval.
Response
Returns a Geography
Example
Query
query geography {
geography {
usState {
...UsStateFragment
}
}
}
Response
{"data": {"geography": {"usState": UsState}}}
income
Description
Get an income by ID
Example
Query
query income($id: ID!) {
income(id: $id) {
id
payPeriodFrequency
qualifiedAmount
statedAmount
statedMonthlyAmount
verifiedAmount
}
}
Variables
{"id": 4}
Response
{
"data": {
"income": {
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
}
}
liability
Description
Get a liabilitiy by ID
Example
Query
query liability($id: ID!) {
liability(id: $id) {
accountIdentifier
balance
bankName
creditorName
exclusionReason
id
intent
monthlyPayment
type
}
}
Variables
{"id": "4"}
Response
{
"data": {
"liability": {
"accountIdentifier": "xyz789",
"balance": 123.45,
"bankName": "xyz789",
"creditorName": "abc123",
"exclusionReason": "ASSIGNED_TO_ANOTHER_PARTY",
"id": 4,
"intent": "DO_NOTHING",
"monthlyPayment": 123.45,
"type": "BORROWER_ESTIMATED_TOTAL_MONTHLY_LIABILITY_PAYMENT"
}
}
}
loan
Description
Get a Loan by ID or by friendly ID
Example
Query
query loan($id: ID!) {
loan(id: $id) {
allowedStates
appraisal {
...AppraisalFragment
}
assignedLoanOfficer {
...LoanOfficerFragment
}
availableGlobalLoanOfficers {
...GlobalLoanOfficerFragment
}
borrowerPreferences {
...BorrowerPreferencesFragment
}
borrowers {
...BorrowerConnectionFragment
}
changeRequests {
...LoanChangeRequestFragment
}
closingDate
concessions {
...ConcessionLogFragment
}
contacts {
...ContactFragment
}
currentStage
customerPointAdjustments {
...CustomerPointAdjustmentFragment
}
dealId
documents {
...DocumentFragment
}
earnestMoneyDeposit
effectiveAppraisalWaiver
fees {
...FeeFragment
}
friendlyId
id
isClosed
isFirstTimeHomebuyer
isFrozen
latestPreApprovalRunTime
liabilities {
...LiabilityFragment
}
loanContact {
...LoanContactFragment
}
loanNumber
loanOfficerDocumentTasks {
...LoanOfficerDocumentTaskFragment
}
loanPurpose
loanTermYears
ltv
maxLoanAmount
maxPurchasePrice
noteRatePercent
orderOuts {
... on Appraisal {
...AppraisalFragment
}
... on Title {
...TitleFragment
}
}
outOfPocketMax
pointOfContact {
...BorrowerFragment
}
preapprovalProduct {
...ProductFragment
}
productPricingRate {
...ProductPricingRateFragment
}
productStructure {
...ProductPricingRateFragment
}
purchasePrice
pylonApproved
rateLock {
...RateLockDetailsFragment
}
rateLockTerm
refinanceCashOutProceeds
sellerCredit
stages {
...LoanStageFragment
}
subjectProperty {
...SubjectPropertyFragment
}
subjectPropertyIntent {
...SubjectPropertyIntentFragment
}
title {
...TitleFragment
}
totalAssetsAvailable
useOwnTitleCompany
}
}
Variables
{"id": 4}
Response
{
"data": {
"loan": {
"allowedStates": ["AK"],
"appraisal": Appraisal,
"assignedLoanOfficer": LoanOfficer,
"availableGlobalLoanOfficers": [GlobalLoanOfficer],
"borrowerPreferences": BorrowerPreferences,
"borrowers": BorrowerConnection,
"changeRequests": [LoanChangeRequest],
"closingDate": "2007-12-03",
"concessions": [ConcessionLog],
"contacts": [Contact],
"currentStage": "abc123",
"customerPointAdjustments": CustomerPointAdjustment,
"dealId": "xyz789",
"documents": [Document],
"earnestMoneyDeposit": 123.45,
"effectiveAppraisalWaiver": "AUTOMATED_COLLATERAL_EVALUATION",
"fees": [Fee],
"friendlyId": "abc123",
"id": 4,
"isClosed": true,
"isFirstTimeHomebuyer": false,
"isFrozen": true,
"latestPreApprovalRunTime": "2007-12-03T10:15:30Z",
"liabilities": [Liability],
"loanContact": LoanContact,
"loanNumber": "xyz789",
"loanOfficerDocumentTasks": [
LoanOfficerDocumentTask
],
"loanPurpose": "PURCHASE",
"loanTermYears": 123.45,
"ltv": 123.45,
"maxLoanAmount": 123.45,
"maxPurchasePrice": 123.45,
"noteRatePercent": 123.45,
"orderOuts": [Appraisal],
"outOfPocketMax": 123,
"pointOfContact": Borrower,
"preapprovalProduct": Product,
"productPricingRate": ProductPricingRate,
"productStructure": ProductPricingRate,
"purchasePrice": 123,
"pylonApproved": true,
"rateLock": RateLockDetails,
"rateLockTerm": 123,
"refinanceCashOutProceeds": 123,
"sellerCredit": 123,
"stages": [LoanStage],
"subjectProperty": SubjectProperty,
"subjectPropertyIntent": SubjectPropertyIntent,
"title": Title,
"totalAssetsAvailable": 123,
"useOwnTitleCompany": false
}
}
}
marketingRates
Description
Namespace for marketing rates queries. Marketing rates take simple borrower profiles and determine the best rates that borrower could get for various loan products.
Response
Returns a MarketingRates
Example
Query
query marketingRates {
marketingRates {
conforming {
...ConformingMarketingRateFragment
}
custom {
...CustomMarketingRateFragment
}
fha {
...FhaMarketingRateFragment
}
jumbo {
...JumboMarketingRateFragment
}
warehousingCosts {
...WarehousingCostsFragment
}
}
}
Response
{
"data": {
"marketingRates": {
"conforming": [ConformingMarketingRate],
"custom": [CustomMarketingRate],
"fha": [FhaMarketingRate],
"jumbo": [JumboMarketingRate],
"warehousingCosts": WarehousingCosts
}
}
}
nonBorrowingOwner
Response
Returns a NonBorrowingOwner
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query nonBorrowingOwner($id: ID!) {
nonBorrowingOwner(id: $id) {
id
personalInformation {
...PersonalInformationFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"nonBorrowingOwner": {
"id": "4",
"personalInformation": PersonalInformation
}
}
}
organization
Description
Get the current organization.
Response
Returns an Organization
Example
Query
query organization {
organization {
companyLegalName
companyName
companySupportEmail
concessionLimitPerLoan
contacts {
...ContactFragment
}
customerSlug
electronicCommunicationsConsentUrl
enableSso
id
nmlsId
privacyPolicyUrl
telephonicCommunicationsConsentUrl
termsOfServiceUrl
}
}
Response
{
"data": {
"organization": {
"companyLegalName": "xyz789",
"companyName": "xyz789",
"companySupportEmail": "xyz789",
"concessionLimitPerLoan": 123.45,
"contacts": [Contact],
"customerSlug": "xyz789",
"electronicCommunicationsConsentUrl": "xyz789",
"enableSso": false,
"id": "4",
"nmlsId": "xyz789",
"privacyPolicyUrl": "xyz789",
"telephonicCommunicationsConsentUrl": "abc123",
"termsOfServiceUrl": "xyz789"
}
}
}
organizationLicensing
Description
Get licensing information for the current organization.
Response
Returns an OrganizationLicensing
Example
Query
query organizationLicensing {
organizationLicensing {
states {
...OrganizationStateWithLicensesFragment
}
}
}
Response
{
"data": {
"organizationLicensing": {
"states": [OrganizationStateWithLicenses]
}
}
}
organizationRole
Description
Fetch a role in an organization by id
Response
Returns an OrganizationRole
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query organizationRole($id: ID!) {
organizationRole(id: $id) {
description
id
name
permissions
}
}
Variables
{"id": "4"}
Response
{
"data": {
"organizationRole": {
"description": "abc123",
"id": "4",
"name": "xyz789",
"permissions": ["xyz789"]
}
}
}
organizationRoles
Description
List roles in an organization
Response
Returns an OrganizationRoleConnection
Example
Query
query organizationRoles(
$after: ID,
$first: Int
) {
organizationRoles(
after: $after,
first: $first
) {
edges {
...OrganizationRoleEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{"after": null, "first": 100}
Response
{
"data": {
"organizationRoles": {
"edges": [OrganizationRoleEdge],
"pageInfo": PageInfo
}
}
}
organizationUser
Description
Fetch a user in an organization by id
Response
Returns an OrganizationUser
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query organizationUser($id: ID!) {
organizationUser(id: $id) {
email
firstName
id
lastName
organizationRoles {
...OrganizationRoleFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"organizationUser": {
"email": "xyz789",
"firstName": "abc123",
"id": 4,
"lastName": "abc123",
"organizationRoles": [OrganizationRole]
}
}
}
organizationUsers
Description
List users in an organization
Response
Returns an OrganizationUserConnection
Example
Query
query organizationUsers(
$after: ID,
$first: Int
) {
organizationUsers(
after: $after,
first: $first
) {
edges {
...OrganizationUserEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{"after": null, "first": 100}
Response
{
"data": {
"organizationUsers": {
"edges": [OrganizationUserEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
ownedProperty
Description
Get an owned property by ID
Response
Returns an OwnedProperty
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query ownedProperty($id: ID!) {
ownedProperty(id: $id) {
address {
...AddressFragment
}
currentUsageType
homeInsuranceMonthlyPayment
id
intendedDisposition
intendedUsageType
liabilities {
...LiabilityFragment
}
monthlyAssociationDues
mortgageInsuranceMonthlyPayment
neighborhoodHousingType
nonBorrowingOwners {
...NonBorrowingOwnerFragment
}
pendingNetSaleProceedsAsset {
...AssetFragment
}
propertyTaxMonthlyPayment
purchaseDate
rentalIncome {
...IncomeFragment
}
sellDate
}
}
Variables
{"id": 4}
Response
{
"data": {
"ownedProperty": {
"address": Address,
"currentUsageType": "INVESTMENT",
"homeInsuranceMonthlyPayment": 123,
"id": "4",
"intendedDisposition": "PENDING_SALE",
"intendedUsageType": "INVESTMENT",
"liabilities": [Liability],
"monthlyAssociationDues": 123,
"mortgageInsuranceMonthlyPayment": 123,
"neighborhoodHousingType": "CONDOMINIUM",
"nonBorrowingOwners": [NonBorrowingOwner],
"pendingNetSaleProceedsAsset": Asset,
"propertyTaxMonthlyPayment": 123,
"purchaseDate": "2007-12-03",
"rentalIncome": Income,
"sellDate": "2007-12-03"
}
}
}
party
Example
Query
query party($id: ID!) {
party(id: $id) {
address {
...AddressFragment
}
id
individual {
...PartyIndividualFragment
}
legalEntity {
...PartyLegalEntityFragment
}
role
}
}
Variables
{"id": "4"}
Response
{
"data": {
"party": {
"address": Address,
"id": "4",
"individual": PartyIndividual,
"legalEntity": PartyLegalEntity,
"role": "ATTORNEY"
}
}
}
preQualification
Description
Namespace for pre-qualification queries. These queries allow fetching previously created pre-qualifications
Response
Returns a PreQualification
Example
Query
query preQualification {
preQualification {
conventional {
...ConventionalPreQualificationFragment
}
debug {
...PreQualificationProductResultFragment
}
}
}
Response
{
"data": {
"preQualification": {
"conventional": ConventionalPreQualification,
"debug": [PreQualificationProductResult]
}
}
}
pricing
Description
Namespace for pricing queries. These queries are for experimenting with various pricing scenarios, for example comparing products or understanding how concession points influence the downpayment and rate.
Response
Returns a Pricing
Example
Query
query pricing {
pricing {
dumpParameters {
...ProductPricingParameterDumpFragment
}
feeSheet {
...FeeSheetResponseFragment
}
productPricing {
...ProductPricingQueryFragment
}
}
}
Response
{
"data": {
"pricing": {
"dumpParameters": ProductPricingParameterDump,
"feeSheet": FeeSheetResponse,
"productPricing": ProductPricingQuery
}
}
}
rates
Description
Namespace for fetching data associated with raw rates.
Response
Returns a Rates
Example
Query
query rates {
rates {
apor {
...AporFragment
}
}
}
Response
{"data": {"rates": {"apor": Apor}}}
scenario
Response
Returns a Scenario
Example
Query
query scenario {
scenario {
pricing {
...ProductPricingQueryFragment
}
purchasePricing {
...ProductPricingQueryFragment
}
purchasePricingNoRestructure {
...ProductPricingQueryFragment
}
refinancePricing {
...ProductPricingQueryFragment
}
}
}
Response
{
"data": {
"scenario": {
"pricing": ProductPricingQuery,
"purchasePricing": ProductPricingQuery,
"purchasePricingNoRestructure": ProductPricingQuery,
"refinancePricing": ProductPricingQuery
}
}
}
structureValidation
Response
Returns a StructureValidation!
Example
Query
query structureValidation {
structureValidation {
experiment {
...StructureValidationDebugResultFragment
}
}
}
Response
{
"data": {
"structureValidation": {
"experiment": StructureValidationDebugResult
}
}
}
subjectProperty
Response
Returns a SubjectProperty
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query subjectProperty($id: ID!) {
subjectProperty(id: $id) {
address {
...AddressFragment
}
attachmentType
avmEstimatedValue
avmProvider
borrowerSpecifiedMonthlyPropertyTaxes
hoaDues
homeInsuranceMonthlyAmount
id
isPlannedUnitDevelopment
liabilities {
...LiabilityFragment
}
manuallyEstimatedValue
neighborhoodHousingType
propertyTaxesAndInsuranceIncludedInPayment
rentalEstimatedGrossMonthlyRentAmount
subjectPropertyIntent {
...SubjectPropertyIntentFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"subjectProperty": {
"address": Address,
"attachmentType": "ATTACHED",
"avmEstimatedValue": 123,
"avmProvider": "abc123",
"borrowerSpecifiedMonthlyPropertyTaxes": 123,
"hoaDues": 123,
"homeInsuranceMonthlyAmount": 123,
"id": "4",
"isPlannedUnitDevelopment": true,
"liabilities": [Liability],
"manuallyEstimatedValue": 123,
"neighborhoodHousingType": "CONDOMINIUM",
"propertyTaxesAndInsuranceIncludedInPayment": true,
"rentalEstimatedGrossMonthlyRentAmount": 123,
"subjectPropertyIntent": SubjectPropertyIntent
}
}
}
subjectPropertyIntent
Description
Get a SubjectPropertyIntent by ID
Response
Returns a SubjectPropertyIntent
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query subjectPropertyIntent($id: ID!) {
subjectPropertyIntent(id: $id) {
county {
...CountyFragment
}
id
isPlannedUnitDevelopment
neighborhoodHousingType
propertyUsageType
state
}
}
Variables
{"id": 4}
Response
{
"data": {
"subjectPropertyIntent": {
"county": County,
"id": "4",
"isPlannedUnitDevelopment": true,
"neighborhoodHousingType": "CONDOMINIUM",
"propertyUsageType": "INVESTMENT",
"state": "AK"
}
}
}
titleVendors
Response
Returns [TitleVendor!]!
Arguments
| Name | Description |
|---|---|
input - TitleVendorsInput!
|
Example
Query
query titleVendors($input: TitleVendorsInput!) {
titleVendors(input: $input) {
contactInfo {
...TitleVendorContactInfoFragment
}
name
relationType
}
}
Variables
{"input": TitleVendorsInput}
Response
{
"data": {
"titleVendors": [
{
"contactInfo": TitleVendorContactInfo,
"name": "abc123",
"relationType": "CLOSING_ONLY"
}
]
}
}
Mutations
advisor
Response
Returns an AdvisorMutations
Example
Query
mutation advisor {
advisor {
createSession {
...CreateSessionResponseFragment
}
sendMessage {
...SendMessageResponseFragment
}
}
}
Response
{
"data": {
"advisor": {
"createSession": CreateSessionResponse,
"sendMessage": SendMessageResponse
}
}
}
analytics
Description
Namespace for analytics mutations. These allow you to export analytics results to file.
Response
Returns an AnalyticsMutations
Example
Query
mutation analytics {
analytics {
startAnalyticsExportJob {
...StartAnalyticsExportJobResponseFragment
}
}
}
Response
{
"data": {
"analytics": {
"startAnalyticsExportJob": StartAnalyticsExportJobResponse
}
}
}
asset
Description
Asset mutations
Response
Returns an AssetMutations
Example
Query
mutation asset {
asset {
addNotableActivity {
...AddNotableActivityResponseFragment
}
attachBorrower {
...AttachBorrowerAssetResponseFragment
}
create {
...CreateAssetResponseFragment
}
delete {
...DeleteAssetResponseFragment
}
deleteNotableActivity {
...DeleteNotableActivityResponseFragment
}
detachBorrower {
...DetachBorrowerAssetResponseFragment
}
update {
...UpdateAssetResponseFragment
}
updateNotableActivity {
...UpdateNotableActivityResponseFragment
}
}
}
Response
{
"data": {
"asset": {
"addNotableActivity": AddNotableActivityResponse,
"attachBorrower": AttachBorrowerAssetResponse,
"create": CreateAssetResponse,
"delete": DeleteAssetResponse,
"deleteNotableActivity": DeleteNotableActivityResponse,
"detachBorrower": DetachBorrowerAssetResponse,
"update": UpdateAssetResponse,
"updateNotableActivity": UpdateNotableActivityResponse
}
}
}
aus
Description
AUS mutations
Response
Returns an AusMutations
Example
Query
mutation aus {
aus {
triggerAusRun {
...TriggerAusRunResponseFragment
}
}
}
Response
{
"data": {
"aus": {"triggerAusRun": TriggerAusRunResponse}
}
}
auth
Description
Namespace for auth mutations. These allow getting temporary authorization for borrowers to access Pylon's API in a restricted fashion
Response
Returns an AuthMutations
Example
Query
mutation auth {
auth {
createLease {
...CreateLeaseResponseFragment
}
}
}
Response
{"data": {"auth": {"createLease": CreateLeaseResponse}}}
borrower
Description
Borrower mutations
Response
Returns a BorrowerMutations
Example
Query
mutation borrower {
borrower {
attachLiabilities {
...AttachBorrowerLiabilitiesResponseFragment
}
attachNonBorrowingSpouse {
...AttachBorrowerNonBorrowingSpouseResponseFragment
}
create {
...CreateBorrowerResponseFragment
}
delete {
...DeleteBorrowerResponseFragment
}
detachLiabilities {
...DetachBorrowerLiabilitiesResponseFragment
}
linkBorrowersAsSpouses {
...LinkBorrowersAsSpousesResponseFragment
}
rejectDocument {
...RejectDocumentResponseFragment
}
setEmailVerified {
...SetBorrowerEmailVerifiedResponseFragment
}
unsetMilitaryService {
...UnsetBorrowerMilitaryServiceResponseFragment
}
updateBorrower {
...UpdateBorrowerResponseFragment
}
updateConsent {
...UpdateBorrowerConsentResponseFragment
}
updateDemographicInfo {
...UpdateDemographicInfoResponseFragment
}
updateDependents {
...UpdateBorrowerDependentsResponseFragment
}
updateFinancialDeclarations {
...UpdateBorrowerFinancialDeclarationsResponseFragment
}
updateMailingAddress {
...UpdateBorrowerMailingAddressResponseFragment
}
updateMilitaryService {
...UpdateBorrowerMilitaryServiceResponseFragment
}
updatePersonalInformation {
...UpdateBorrowerPersonalInformationResponseFragment
}
updatePhoneNumber {
...UpdateBorrowerPhoneNumberResponseFragment
}
updatePropertyDeclarations {
...UpdateBorrowerPropertyDeclarationsResponseFragment
}
}
}
Response
{
"data": {
"borrower": {
"attachLiabilities": AttachBorrowerLiabilitiesResponse,
"attachNonBorrowingSpouse": AttachBorrowerNonBorrowingSpouseResponse,
"create": CreateBorrowerResponse,
"delete": DeleteBorrowerResponse,
"detachLiabilities": DetachBorrowerLiabilitiesResponse,
"linkBorrowersAsSpouses": LinkBorrowersAsSpousesResponse,
"rejectDocument": RejectDocumentResponse,
"setEmailVerified": SetBorrowerEmailVerifiedResponse,
"unsetMilitaryService": UnsetBorrowerMilitaryServiceResponse,
"updateBorrower": UpdateBorrowerResponse,
"updateConsent": UpdateBorrowerConsentResponse,
"updateDemographicInfo": UpdateDemographicInfoResponse,
"updateDependents": UpdateBorrowerDependentsResponse,
"updateFinancialDeclarations": UpdateBorrowerFinancialDeclarationsResponse,
"updateMailingAddress": UpdateBorrowerMailingAddressResponse,
"updateMilitaryService": UpdateBorrowerMilitaryServiceResponse,
"updatePersonalInformation": UpdateBorrowerPersonalInformationResponse,
"updatePhoneNumber": UpdateBorrowerPhoneNumberResponse,
"updatePropertyDeclarations": UpdateBorrowerPropertyDeclarationsResponse
}
}
}
borrowerAddress
Description
Mutations for borrower addresses
Response
Returns a BorrowerAddressMutations
Example
Query
mutation borrowerAddress {
borrowerAddress {
createPrevious {
...CreatePreviousBorrowerAddressResponseFragment
}
deletePrevious {
...DeletePreviousBorrowerAddressResponseFragment
}
updateCurrent {
...UpdateCurrentBorrowerAddressResponseFragment
}
updatePrevious {
...UpdatePreviousBorrowerAddressResponseFragment
}
}
}
Response
{
"data": {
"borrowerAddress": {
"createPrevious": CreatePreviousBorrowerAddressResponse,
"deletePrevious": DeletePreviousBorrowerAddressResponse,
"updateCurrent": UpdateCurrentBorrowerAddressResponse,
"updatePrevious": UpdatePreviousBorrowerAddressResponse
}
}
}
comms
Description
Comms mutations
Response
Returns a CommsMutations
Example
Query
mutation comms {
comms {
updateCommsTemplate {
...UpdateCommsTemplateResponseFragment
}
}
}
Response
{
"data": {
"comms": {
"updateCommsTemplate": UpdateCommsTemplateResponse
}
}
}
company
Description
Company mutations
Response
Returns a CompanyMutations
Example
Query
mutation company {
company {
create {
...CreateCompanyResponseFragment
}
}
}
Response
{"data": {"company": {"create": CreateCompanyResponse}}}
concession
Response
Returns a ConcessionMutations
Example
Query
mutation concession {
concession {
approveConcession {
...ApproveConcessionResponseFragment
}
requestConcession {
...RequestConcessionResponseFragment
}
revokeConcession {
...RevokeConcessionResponseFragment
}
updateConcession {
...UpdateConcessionResponseFragment
}
}
}
Response
{
"data": {
"concession": {
"approveConcession": ApproveConcessionResponse,
"requestConcession": RequestConcessionResponse,
"revokeConcession": RevokeConcessionResponse,
"updateConcession": UpdateConcessionResponse
}
}
}
contributor
Response
Returns a ContributorMutations
Example
Query
mutation contributor {
contributor {
attachContributorToDeal {
...AttachContributorToDealResponseFragment
}
createContributor {
...CreateContributorResponseFragment
}
createLease {
...ContributorCreateLeaseResponseFragment
}
detachContributorFromDeal {
...DetachContributorFromDealResponseFragment
}
disableContributor {
...DisableContributorResponseFragment
}
enableContributor {
...EnableContributorResponseFragment
}
updateContributor {
...UpdateContributorResponseFragment
}
}
}
Response
{
"data": {
"contributor": {
"attachContributorToDeal": AttachContributorToDealResponse,
"createContributor": CreateContributorResponse,
"createLease": ContributorCreateLeaseResponse,
"detachContributorFromDeal": DetachContributorFromDealResponse,
"disableContributor": DisableContributorResponse,
"enableContributor": EnableContributorResponse,
"updateContributor": UpdateContributorResponse
}
}
}
credit
Description
Namespace for credit mutations. These mutations allow you to initiate credit pulls
Response
Returns a CreditMutations
Example
Query
mutation credit {
credit {
startIndividualCreditPullJob {
...StartIndividualCreditPullJobResponseFragment
}
startJointCreditPullJob {
...StartJointCreditPullJobResponseFragment
}
}
}
Response
{
"data": {
"credit": {
"startIndividualCreditPullJob": StartIndividualCreditPullJobResponse,
"startJointCreditPullJob": StartJointCreditPullJobResponse
}
}
}
deal
Response
Returns a DealMutations
Example
Query
mutation deal {
deal {
create {
...CreateDealResponseFragment
}
}
}
Response
{"data": {"deal": {"create": CreateDealResponse}}}
fulfillmentParty
Response
Returns a FulfillmentPartyMutations
Example
Query
mutation fulfillmentParty {
fulfillmentParty {
create {
...CreateFulfillmentPartyResponseFragment
}
delete {
...DeleteFulfillmentPartyResponseFragment
}
}
}
Response
{
"data": {
"fulfillmentParty": {
"create": CreateFulfillmentPartyResponse,
"delete": DeleteFulfillmentPartyResponse
}
}
}
income
Description
Income mutations
Response
Returns an IncomeMutations
Example
Query
mutation income {
income {
create {
...CreateIncomeResponseFragment
}
delete {
...DeleteIncomeResponseFragment
}
update {
...UpdateIncomeResponseFragment
}
}
}
Response
{
"data": {
"income": {
"create": CreateIncomeResponse,
"delete": DeleteIncomeResponse,
"update": UpdateIncomeResponse
}
}
}
liability
Description
Liability mutations
Response
Returns a LiabilityMutations
Example
Query
mutation liability {
liability {
attachOwnedProperty {
...AttachOwnedPropertyLiabilityResponseFragment
}
create {
...CreateLiabilityResponseFragment
}
delete {
...DeleteLiabilityResponseFragment
}
setExclusionReason {
...SetExclusionReasonResponseFragment
}
setIntent {
...SetIntentResponseFragment
}
}
}
Response
{
"data": {
"liability": {
"attachOwnedProperty": AttachOwnedPropertyLiabilityResponse,
"create": CreateLiabilityResponse,
"delete": DeleteLiabilityResponse,
"setExclusionReason": SetExclusionReasonResponse,
"setIntent": SetIntentResponse
}
}
}
loan
Description
Loan mutations
Response
Returns a LoanMutations
Example
Query
mutation loan {
loan {
approveChangeRequest {
...ApproveLoanChangeRequestResponseFragment
}
archive {
... on ArchiveLoanSuccess {
...ArchiveLoanSuccessFragment
}
... on LoanClosedError {
...LoanClosedErrorFragment
}
}
assignLoanOfficer {
...AssignLoanOfficerResponseFragment
}
attachContact {
...AttachLoanContactResponseFragment
}
attachProductPricingRate {
...AttachProductPricingRateResponseFragment
}
attachSubjectProperty {
...AttachSubjectPropertyResponseFragment
}
attachTitleCompany {
...AttachTitleCompanyResponseFragment
}
confirmRateLock {
...ConfirmRateLockResponseFragment
}
create {
...CreateLoanResponseFragment
}
denyRateLock {
...DenyRateLockResponseFragment
}
detachContact {
...DetachLoanContactResponseFragment
}
freeze {
...FreezeLoanResponseFragment
}
openChangeRequest {
...OpenLoanChangeRequestResponseFragment
}
reassignTask {
...ReassignTaskResponseFragment
}
requestRateLock {
...RequestRateLockResponseFragment
}
setUseOwnTitleCompany {
...SetUseOwnTitleCompanyResponseFragment
}
submitUnderwritingNotes {
...SubmitUnderwritingNotesResponseFragment
}
thaw {
...ThawLoanResponseFragment
}
update {
...UpdateLoanResponseFragment
}
updateBorrowerPreferences {
...UpdateBorrowerPreferencesResponseFragment
}
updateTaskName {
...UpdateTaskNameResponseFragment
}
updateTaskStatus {
...UpdateTaskStatusResponseFragment
}
withdraw {
... on LoanClosedError {
...LoanClosedErrorFragment
}
... on WithdrawLoanSuccess {
...WithdrawLoanSuccessFragment
}
}
}
}
Response
{
"data": {
"loan": {
"approveChangeRequest": ApproveLoanChangeRequestResponse,
"archive": ArchiveLoanSuccess,
"assignLoanOfficer": AssignLoanOfficerResponse,
"attachContact": AttachLoanContactResponse,
"attachProductPricingRate": AttachProductPricingRateResponse,
"attachSubjectProperty": AttachSubjectPropertyResponse,
"attachTitleCompany": AttachTitleCompanyResponse,
"confirmRateLock": ConfirmRateLockResponse,
"create": CreateLoanResponse,
"denyRateLock": DenyRateLockResponse,
"detachContact": DetachLoanContactResponse,
"freeze": FreezeLoanResponse,
"openChangeRequest": OpenLoanChangeRequestResponse,
"reassignTask": ReassignTaskResponse,
"requestRateLock": RequestRateLockResponse,
"setUseOwnTitleCompany": SetUseOwnTitleCompanyResponse,
"submitUnderwritingNotes": SubmitUnderwritingNotesResponse,
"thaw": ThawLoanResponse,
"update": UpdateLoanResponse,
"updateBorrowerPreferences": UpdateBorrowerPreferencesResponse,
"updateTaskName": UpdateTaskNameResponse,
"updateTaskStatus": UpdateTaskStatusResponse,
"withdraw": LoanClosedError
}
}
}
nonBorrowingOwner
Description
NonBorrowingOwner mutations
Response
Returns a NonBorrowingOwnerMutations
Example
Query
mutation nonBorrowingOwner {
nonBorrowingOwner {
create {
...CreateNonBorrowingOwnerResponseFragment
}
delete {
...DeleteNonBorrowingOwnerResponseFragment
}
update {
...UpdateNonBorrowingOwnerResponseFragment
}
}
}
Response
{
"data": {
"nonBorrowingOwner": {
"create": CreateNonBorrowingOwnerResponse,
"delete": DeleteNonBorrowingOwnerResponse,
"update": UpdateNonBorrowingOwnerResponse
}
}
}
organization
Description
Namespace for organization mutations. These allow updating things like your organization's privacy policy url and licensing.
Response
Returns an OrganizationMutations
Example
Query
mutation organization {
organization {
createContact {
...CreateContactResponseFragment
}
createOrganizationRole {
...CreateOrganizationRoleResponseFragment
}
createOrganizationUser {
...CreateOrganizationUserResponseFragment
}
deleteOrganizationRole {
...DeleteOrganizationRoleResponseFragment
}
deleteOrganizationStateLicenses {
...DeleteOrganizationStateLicensesResponseFragment
}
deleteOrganizationUser {
...DeleteOrganizationUserResponseFragment
}
sendOrganizationUserInvitationEmail {
...SendOrganizationUserInvitationEmailResponseFragment
}
updateContact {
...UpdateContactResponseFragment
}
updateOrganization {
...UpdateOrganizationResponseFragment
}
updateOrganizationLicensing {
...UpdateOrganizationLicensingResponseFragment
}
updateOrganizationRolePermissions {
...UpdateOrganizationRolePermissionsResponseFragment
}
updateOrganizationUserRoles {
...UpdateOrganizationUserRolesResponseFragment
}
}
}
Response
{
"data": {
"organization": {
"createContact": CreateContactResponse,
"createOrganizationRole": CreateOrganizationRoleResponse,
"createOrganizationUser": CreateOrganizationUserResponse,
"deleteOrganizationRole": DeleteOrganizationRoleResponse,
"deleteOrganizationStateLicenses": DeleteOrganizationStateLicensesResponse,
"deleteOrganizationUser": DeleteOrganizationUserResponse,
"sendOrganizationUserInvitationEmail": SendOrganizationUserInvitationEmailResponse,
"updateContact": UpdateContactResponse,
"updateOrganization": UpdateOrganizationResponse,
"updateOrganizationLicensing": UpdateOrganizationLicensingResponse,
"updateOrganizationRolePermissions": UpdateOrganizationRolePermissionsResponse,
"updateOrganizationUserRoles": UpdateOrganizationUserRolesResponse
}
}
}
ownedProperty
Description
Owned property mutations
Response
Returns an OwnedPropertyMutations
Example
Query
mutation ownedProperty {
ownedProperty {
attachLiabilities {
...AttachOwnedPropertyLiabilitiesResponseFragment
}
attachNonBorrowingOwner {
...AttachOwnedPropertyNonBorrowingOwnerResponseFragment
}
create {
...CreateOwnedPropertyResponseFragment
}
delete {
...DeleteOwnedPropertyResponseFragment
}
detachLiabilities {
...DetachOwnedPropertyLiabilitiesResponseFragment
}
update {
...UpdateOwnedPropertyResponseFragment
}
}
}
Response
{
"data": {
"ownedProperty": {
"attachLiabilities": AttachOwnedPropertyLiabilitiesResponse,
"attachNonBorrowingOwner": AttachOwnedPropertyNonBorrowingOwnerResponse,
"create": CreateOwnedPropertyResponse,
"delete": DeleteOwnedPropertyResponse,
"detachLiabilities": DetachOwnedPropertyLiabilitiesResponse,
"update": UpdateOwnedPropertyResponse
}
}
}
party
Response
Returns a PartyMutations
Example
Query
mutation party {
party {
create {
...CreatePartyResponseFragment
}
delete {
...DeletePartyResponseFragment
}
optForDefaultTitleVendor {
...OptForDefaultTitleVendorResponseFragment
}
update {
...UpdatePartyResponseFragment
}
}
}
Response
{
"data": {
"party": {
"create": CreatePartyResponse,
"delete": DeletePartyResponse,
"optForDefaultTitleVendor": OptForDefaultTitleVendorResponse,
"update": UpdatePartyResponse
}
}
}
preApproval
Response
Returns a PreApprovalMutations
Example
Query
mutation preApproval {
preApproval {
createLoanPreApprovalLetter {
...CreateLoanPreApprovalLetterResponseFragment
}
createMaxLoanPreApprovalLetter {
...CreateMaxLoanPreApprovalLetterResponseFragment
}
runLoanPreApproval {
...RunLoanPreApprovalResponseFragment
}
}
}
Response
{
"data": {
"preApproval": {
"createLoanPreApprovalLetter": CreateLoanPreApprovalLetterResponse,
"createMaxLoanPreApprovalLetter": CreateMaxLoanPreApprovalLetterResponse,
"runLoanPreApproval": RunLoanPreApprovalResponse
}
}
}
preQualification
Description
Namespace for pre-qualification mutations. Pre-qualification is a lightweight process for estimating how large of a mortgage a borrower might qualify for based on stated information.
Response
Returns a PreQualificationMutations
Example
Query
mutation preQualification {
preQualification {
conventional {
...ConventionalResponseFragment
}
}
}
Response
{
"data": {
"preQualification": {
"conventional": ConventionalResponse
}
}
}
subjectProperty
Description
SubjectProperty mutations
Response
Returns a SubjectPropertyMutations
Example
Query
mutation subjectProperty {
subjectProperty {
addSubjectPropertyIntent {
...AddSubjectPropertyIntentResponseFragment
}
attachAddress {
...AttachSubjectPropertyAddressResponseFragment
}
attachLiabilities {
...AttachSubjectPropertyLiabilitiesResponseFragment
}
create {
...CreateSubjectPropertyResponseFragment
}
detachAddress {
...DetachSubjectPropertyAddressResponseFragment
}
detachLiabilities {
...DetachSubjectPropertyLiabilitiesResponseFragment
}
setFirstLien {
...SetSubjectPropertyFirstLienResponseFragment
}
unsetFirstLien {
...UnsetSubjectPropertyFirstLienResponseFragment
}
update {
...UpdateSubjectPropertyResponseFragment
}
updateSubjectPropertyIntent {
...UpdateSubjectPropertyIntentResponseFragment
}
}
}
Response
{
"data": {
"subjectProperty": {
"addSubjectPropertyIntent": AddSubjectPropertyIntentResponse,
"attachAddress": AttachSubjectPropertyAddressResponse,
"attachLiabilities": AttachSubjectPropertyLiabilitiesResponse,
"create": CreateSubjectPropertyResponse,
"detachAddress": DetachSubjectPropertyAddressResponse,
"detachLiabilities": DetachSubjectPropertyLiabilitiesResponse,
"setFirstLien": SetSubjectPropertyFirstLienResponse,
"unsetFirstLien": UnsetSubjectPropertyFirstLienResponse,
"update": UpdateSubjectPropertyResponse,
"updateSubjectPropertyIntent": UpdateSubjectPropertyIntentResponse
}
}
}
Types
AccessoryUnitIncome
Description
Accessory unit income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
AddNotableActivityInput
Description
Input to the addNotableActivity mutation.
Fields
| Input Field | Description |
|---|---|
activityType - FinancialAccountActivityType
|
Activity type |
amount - Int
|
The amount of money in dollars |
assetId - ID!
|
|
date - Date
|
The date when the activity occurred |
description - String
|
Description of the activity |
Example
{
"activityType": "LARGE_DEPOSIT",
"amount": 123,
"assetId": "4",
"date": "2007-12-03",
"description": "xyz789"
}
AddNotableActivityResponse
Description
Response of the addNotableActivity mutation.
Fields
| Field Name | Description |
|---|---|
activity - FinancialAccountActivity!
|
The FinancialAccountActivity entity that was added to the asset |
Example
{"activity": FinancialAccountActivity}
AddSubjectPropertyIntentInput
Fields
| Input Field | Description |
|---|---|
fipsCountyCode - String!
|
County-level FIPS code |
isPlannedUnitDevelopment - Boolean
|
Marks a subject property as being part of a planned unit development |
loanId - ID!
|
The ID or friendly ID of the Loan to which the SubjectPropertyIntent should be added |
neighborhoodHousingType - NeighborhoodHousingType
|
The type of housing |
propertyUsageType - PropertyUsageType
|
How the borrower(s) intend to use the property |
Example
{
"fipsCountyCode": "xyz789",
"isPlannedUnitDevelopment": true,
"loanId": "4",
"neighborhoodHousingType": "CONDOMINIUM",
"propertyUsageType": "INVESTMENT"
}
AddSubjectPropertyIntentResponse
Fields
| Field Name | Description |
|---|---|
subjectPropertyIntent - SubjectPropertyIntent!
|
The SubjectPropertyIntent that was added to the loan |
Example
{"subjectPropertyIntent": SubjectPropertyIntent}
Address
Description
US Address
Fields
| Field Name | Description |
|---|---|
city - String
|
City |
line - String
|
Street address line 1 |
line2 - String
|
Street address line 2 |
state - StateAbbreviated
|
Abbreviated US state name (including DC) |
zipCode - String
|
Zip code |
Example
{
"city": "abc123",
"line": "xyz789",
"line2": "xyz789",
"state": "AK",
"zipCode": "xyz789"
}
AddressInput
Description
US Address Input
Fields
| Input Field | Description |
|---|---|
city - String
|
City |
line - String
|
Street address line 1 |
line2 - String
|
Street address line 2 |
state - StateAbbreviated
|
Abbreviated US state name (including DC) |
zipCode - String
|
Zip code |
Example
{
"city": "xyz789",
"line": "abc123",
"line2": "abc123",
"state": "AK",
"zipCode": "xyz789"
}
AdvisorCompletionJob
Fields
| Field Name | Description |
|---|---|
failureMessage - String
|
|
id - ID!
|
|
status - JobStatus!
|
Example
{
"failureMessage": "abc123",
"id": 4,
"status": "FAILED"
}
AdvisorMutations
Fields
| Field Name | Description |
|---|---|
createSession - CreateSessionResponse
|
|
sendMessage - SendMessageResponse
|
|
Arguments
|
|
Example
{
"createSession": CreateSessionResponse,
"sendMessage": SendMessageResponse
}
AdvisorSession
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
|
id - ID!
|
|
messages - [AdvisorSessionAdvisorMessage!]!
|
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"id": 4,
"messages": [AdvisorSessionAdvisorMessage]
}
AdvisorSessionAdvisorMessage
Fields
| Field Name | Description |
|---|---|
advisorSessionId - ID!
|
|
content - String!
|
|
createdAt - DateTime!
|
|
feedback - AdvisorSessionAdvisorMessageFeedback
|
|
id - ID!
|
Example
{
"advisorSessionId": "4",
"content": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"feedback": AdvisorSessionAdvisorMessageFeedback,
"id": 4
}
AdvisorSessionAdvisorMessageFeedback
Example
{
"advisorSessionId": 4,
"content": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"id": 4,
"note": "abc123",
"sentiment": "NEGATIVE"
}
AdvisorSessionAdvisorMessageFeedbackSentiment
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"NEGATIVE"
AdvisorSessionMessage
AlimonyIncome
Description
Alimony income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
Analytics
Fields
| Field Name | Description |
|---|---|
job - AnalyticsExportJob!
|
|
Arguments
|
|
loanApplications - LoanApplicationAnalyticsConnection!
|
|
Arguments
|
|
summary - PipelineSummaryResponse!
|
|
Arguments
|
|
Example
{
"job": AnalyticsExportJob,
"loanApplications": LoanApplicationAnalyticsConnection,
"summary": PipelineSummaryResponse
}
AnalyticsExportFile
Fields
| Field Name | Description |
|---|---|
url - String!
|
Example
{"url": "abc123"}
AnalyticsExportFormat
Values
| Enum Value | Description |
|---|---|
|
|
Example
"CSV"
AnalyticsExportJob
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
result - AnalyticsExportFile
|
|
status - JobStatus!
|
Example
{
"id": "4",
"result": AnalyticsExportFile,
"status": "FAILED"
}
AnalyticsExportRoot
Values
| Enum Value | Description |
|---|---|
|
|
Example
"LOAN_APPLICATIONS"
AnalyticsMutations
Fields
| Field Name | Description |
|---|---|
startAnalyticsExportJob - StartAnalyticsExportJobResponse
|
|
Arguments
|
|
Example
{
"startAnalyticsExportJob": StartAnalyticsExportJobResponse
}
Apor
Description
The average interest rate offered to highly qualified buyers, as published by the FFIEC.
Fields
| Field Name | Description |
|---|---|
amortizationType - AporAmortizationType!
|
Whether this APOR applies to fixed or adjustable-rate mortages. |
date - DateTime!
|
The date this APOR was published. |
loanTermOrYearsToFirstAdjustment - PositiveInt!
|
APOR is calculated in buckets according to term for fixed-rate mortgages, or according to the number of years until the rate may adjust for ARMs. |
rate - PositiveFloat!
|
The average interest rate by amortization type and term/years until adjustment. |
Example
{
"amortizationType": "ADJUSTABLE_RATE",
"date": "2007-12-03T10:15:30Z",
"loanTermOrYearsToFirstAdjustment": 123,
"rate": 123.45
}
AporAmortizationType
Description
The amoritization type of the APOR. The APORs of fixed and ARM mortgages are calculated separately.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ADJUSTABLE_RATE"
Appraisal
Description
Represents an appraisal order and related property valuation details.
Fields
| Field Name | Description |
|---|---|
actualValueAmount - Float
|
The actual appraised value of the property in dollars. |
appraisalManagementCompanies - [Contact!]!
|
Appraisal management companies (AMCs) on the appraisal. |
appraisers - [Contact!]!
|
Appraisers assigned on the appraisal. |
assignedAt - DateTime
|
Date the appraiser was assigned. |
avmValueAmount - Float
|
The automated valuation model (AVM) estimated value in dollars. |
deliveredToBorrowerAt - DateTime
|
Date the report was delivered to the borrower. |
documents - [Document!]!
|
Documents associated with the appraisal. |
id - ID!
|
The ID of the appraisal. |
inspectionCompletedAt - DateTime
|
Date the property inspection was completed. |
orderAcceptedAt - DateTime
|
Date the appraisal order was accepted. |
orderCompletedAt - DateTime
|
Date the appraisal order was completed. |
orderStatus - AppraisalOrderStatus
|
Current status of the appraisal order. |
orderedAt - DateTime
|
Date the appraisal was ordered. |
paidAt - Date
|
Date the appraisal order was paid. |
paymentLink - String
|
Link to the payment portal for the appraisal fee. |
paymentStatus - AppraisalPaymentStatus
|
Current status of the appraisal payment. |
receivedAt - DateTime
|
Date the completed report was received. |
reportSignedAt - DateTime
|
Date the report was signed. |
scheduledAt - DateTime
|
Scheduled date of the property inspection by the appraiser. |
valuationMethod - PropertyValuationMethodType
|
Valuation method used to assess the property's value. |
Example
{
"actualValueAmount": 987.65,
"appraisalManagementCompanies": [Contact],
"appraisers": [Contact],
"assignedAt": "2007-12-03T10:15:30Z",
"avmValueAmount": 987.65,
"deliveredToBorrowerAt": "2007-12-03T10:15:30Z",
"documents": [Document],
"id": "4",
"inspectionCompletedAt": "2007-12-03T10:15:30Z",
"orderAcceptedAt": "2007-12-03T10:15:30Z",
"orderCompletedAt": "2007-12-03T10:15:30Z",
"orderStatus": "ACCEPTED",
"orderedAt": "2007-12-03T10:15:30Z",
"paidAt": "2007-12-03",
"paymentLink": "xyz789",
"paymentStatus": "NO_AMOUNT_DUE",
"receivedAt": "2007-12-03T10:15:30Z",
"reportSignedAt": "2007-12-03T10:15:30Z",
"scheduledAt": "2007-12-03T10:15:30Z",
"valuationMethod": "AUTOMATED_VALUATION_MODEL"
}
AppraisalOrderStatus
Description
The current status of the appraisal order.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACCEPTED"
AppraisalPaymentStatus
Description
The current status of payment for the appraisal order.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NO_AMOUNT_DUE"
AppraisalWaiver
Description
Types of appraisal waivers (e.g., PIW, ACE) that waive the need for an appraisal on eligible loans.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"AUTOMATED_COLLATERAL_EVALUATION"
ApproveConcessionInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
ApproveConcessionResponse
Fields
| Field Name | Description |
|---|---|
concession - Concession
|
Example
{"concession": Concession}
ApproveLoanChangeRequestInput
Description
Input to the loan.approveChangeRequest mutation.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the loan change request to approve |
Example
{"id": 4}
ApproveLoanChangeRequestResponse
Description
Response of the loan.approveChangeRequest mutation.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the loan change request |
status - LoanChangeRequestStatus!
|
Current status of this change request |
Example
{"id": 4, "status": "APPROVED"}
ApprovedPreApprovalRun
Description
A successful pre-approval
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
loanAmount - NonNegativeInt!
|
|
maxPreApprovalLetterUrl - String
|
A download URL for a pre-approval letter with the maximum pre-approved loan amount and purchase price for the loan. |
salesContractAmount - NonNegativeInt!
|
Example
{
"id": "4",
"loanAmount": 123,
"maxPreApprovalLetterUrl": "xyz789",
"salesContractAmount": 123
}
ArchiveLoanInput
Description
Input to the archiveLoan mutation.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the loan to archive |
Example
{"id": "4"}
ArchiveLoanResponse
Types
| Union Types |
|---|
Example
ArchiveLoanSuccess
ArchiveLoanSuccess
Description
A successful response after a loan has been archived.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
ID of the archived loan |
Example
{"id": "4"}
AsianRace
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CHINESE"
Asset
Description
Interface with fields shared across all asset types
Fields
| Field Name | Description |
|---|---|
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset |
id - ID!
|
Asset ID |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Possible Types
| Asset Types |
|---|
Example
{
"amount": 123,
"borrowerIds": [4],
"id": 4,
"nonBorrowerOwnerNames": ["abc123"]
}
AssetMutations
Description
Asset mutations
Fields
| Field Name | Description |
|---|---|
addNotableActivity - AddNotableActivityResponse
|
Add a notable activity to an asset |
Arguments
|
|
attachBorrower - AttachBorrowerAssetResponse
|
Attach a borrower to an asset |
Arguments
|
|
create - CreateAssetResponse
|
Create an asset |
Arguments
|
|
delete - DeleteAssetResponse
|
Delete an asset |
Arguments
|
|
deleteNotableActivity - DeleteNotableActivityResponse
|
Delete a notable activity |
Arguments
|
|
detachBorrower - DetachBorrowerAssetResponse
|
Detach a borrower from an asset |
Arguments
|
|
update - UpdateAssetResponse
|
Update an asset. Fields with non-null values will be updated, the rest will be ignored. The input is a 'oneOf' type where exactly one field must be populated. The populated input field must match the type of the asset to update. |
Arguments
|
|
updateNotableActivity - UpdateNotableActivityResponse
|
Update a notable activity |
Arguments
|
|
Example
{
"addNotableActivity": AddNotableActivityResponse,
"attachBorrower": AttachBorrowerAssetResponse,
"create": CreateAssetResponse,
"delete": DeleteAssetResponse,
"deleteNotableActivity": DeleteNotableActivityResponse,
"detachBorrower": DetachBorrowerAssetResponse,
"update": UpdateAssetResponse,
"updateNotableActivity": UpdateNotableActivityResponse
}
AssignLoanOfficerInput
AssignLoanOfficerResponse
AttachBorrowerAssetInput
AttachBorrowerAssetResponse
Description
Response of the attachBorrowerAsset mutation.
Fields
| Field Name | Description |
|---|---|
asset - Asset!
|
The asset that was updated |
Example
{"asset": Asset}
AttachBorrowerLiabilitiesInput
AttachBorrowerLiabilitiesResponse
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The updated Borrower |
Example
{"borrower": Borrower}
AttachBorrowerNonBorrowingSpouseInput
AttachBorrowerNonBorrowingSpouseResponse
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The updated Borrower |
Example
{"borrower": Borrower}
AttachContributorToDealInput
AttachContributorToDealResponse
Fields
| Field Name | Description |
|---|---|
contributor - Contributor!
|
|
deal - Deal!
|
Example
{
"contributor": Contributor,
"deal": Deal
}
AttachLoanContactInput
AttachLoanContactResponse
Description
Response of the loan.attachContact mutation.
Fields
| Field Name | Description |
|---|---|
contact - Contact!
|
The contact that was successfully attached to the loan. |
Example
{"contact": Contact}
AttachOwnedPropertyLiabilitiesInput
AttachOwnedPropertyLiabilitiesResponse
Fields
| Field Name | Description |
|---|---|
ownedProperty - OwnedProperty!
|
The updated OwnedProperty |
Example
{"ownedProperty": OwnedProperty}
AttachOwnedPropertyLiabilityInput
AttachOwnedPropertyLiabilityResponse
Description
Response of the attachOwnedPropertyLiability mutation.
Fields
| Field Name | Description |
|---|---|
liability - Liability!
|
The updated Liability |
Example
{"liability": Liability}
AttachOwnedPropertyNonBorrowingOwnerInput
AttachOwnedPropertyNonBorrowingOwnerResponse
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
AttachProductPricingRateInput
AttachProductPricingRateResponse
Description
Response of the attachProductPricingRate mutation.
Fields
| Field Name | Description |
|---|---|
loanId - ID!
|
The ID or friendly ID of the loan. |
productPricingRate - ProductPricingRate!
|
The latest pricing run outputs |
productStructure - ProductPricingRate!
|
The latest version of pricing-related fields. |
Example
{
"loanId": 4,
"productPricingRate": ProductPricingRate,
"productStructure": ProductPricingRate
}
AttachSubjectPropertyAddressInput
Description
Input to the attachSubjectPropertyAddress mutation.
Example
{
"city": "abc123",
"fipsCountyCode": "xyz789",
"id": "4",
"line": "abc123",
"line2": "abc123",
"zipCode": "xyz789"
}
AttachSubjectPropertyAddressResponse
Description
Response of the attachSubjectPropertyAddress mutation.
Fields
| Field Name | Description |
|---|---|
subjectProperty - SubjectProperty!
|
The SubjectProperty that was updated |
Example
{"subjectProperty": SubjectProperty}
AttachSubjectPropertyInput
AttachSubjectPropertyLiabilitiesInput
AttachSubjectPropertyLiabilitiesResponse
Fields
| Field Name | Description |
|---|---|
subjectProperty - SubjectProperty!
|
The updated SubjectProperty |
Example
{"subjectProperty": SubjectProperty}
AttachSubjectPropertyResponse
Description
Response of the attachSubjectProperty mutation.
Fields
| Field Name | Description |
|---|---|
loan - PickLoanId!
|
The updated loan |
subjectProperty - PickSubjectPropertyId!
|
The subject property |
Example
{
"loan": PickLoanId,
"subjectProperty": PickSubjectPropertyId
}
AttachTitleCompanyInput
AttachTitleCompanyResponse
AttachmentEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ATTACHED"
Aus
AusMutations
Fields
| Field Name | Description |
|---|---|
triggerAusRun - TriggerAusRunResponse
|
|
Arguments
|
|
Example
{"triggerAusRun": TriggerAusRunResponse}
AusResult
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACCEPT_ELIGIBLE"
AusRunJob
Fields
| Field Name | Description |
|---|---|
errors - [String!]!
|
|
id - ID!
|
Job ID |
lockAllowed - Boolean
|
|
reportUrl - String
|
|
result - AusResult
|
|
status - JobStatus!
|
Job status |
system - AusSystem!
|
Example
{
"errors": ["xyz789"],
"id": "4",
"lockAllowed": true,
"reportUrl": "xyz789",
"result": "ACCEPT_ELIGIBLE",
"status": "FAILED",
"system": "DESKTOP_ORIGINATOR"
}
AusSystem
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DESKTOP_ORIGINATOR"
AusUserError
Types
| Union Types |
|---|
Example
NoAusForProduct
AuthMutations
Description
Auth mutations
Fields
| Field Name | Description |
|---|---|
createLease - CreateLeaseResponse
|
Create a lease for a borrower. This will automatically create a Pylon user for this borrower if one does not already exist. |
Arguments
|
|
Example
{"createLease": CreateLeaseResponse}
AutomobileAllowanceIncome
Description
Automobile allowance income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
AutomobileAsset
Description
Automobile asset
Fields
| Field Name | Description |
|---|---|
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset |
id - ID!
|
Asset ID |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"amount": 123,
"borrowerIds": ["4"],
"id": "4",
"nonBorrowerOwnerNames": ["abc123"]
}
BankruptcyChapterType
Description
The type of bankruptcy filed, if any.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CHAPTER_ELEVEN"
BoarderIncome
Description
Boarder income from renting to boarders
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
BondAsset
Description
Bond asset
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset |
id - ID!
|
Asset ID |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": [4],
"id": 4,
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["xyz789"],
"notableActivities": [FinancialAccountActivity]
}
BonusIncome
Description
Bonus income from employment
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
Boolean
Description
The Boolean scalar type represents true or false.
Example
true
Borrower
Description
A borrower or potential borrower
Fields
| Field Name | Description |
|---|---|
assets - [Asset!]!
|
|
borrowerTasks - [BorrowerTask!]!
|
|
createdOn - DateTime!
|
|
credit - BorrowerCredit
|
|
deal - Deal!
|
|
demographicInfo - DemographicInfo!
|
|
dependentAges - [Float!]
|
|
emailVerified - Boolean!
|
|
externalUserId - String
|
|
financialDeclarations - BorrowerFinancialDeclarations!
|
|
id - ID!
|
|
incomes - IncomeConnection!
|
|
Arguments
|
|
isFirstTimeHomeBuyer - Boolean
|
|
liabilities - LiabilityConnection!
|
|
Arguments
|
|
mailingAddress - Address
|
|
maritalStatus - MaritalStatusType
|
|
militaryService - BorrowerMilitaryService
|
|
ownedProperties - OwnedPropertyConnection!
|
|
Arguments
|
|
personalInformation - BorrowerPersonalInformation!
|
|
pointOfContact - Boolean!
|
|
propertyDeclarations - BorrowerPropertyDeclarations!
|
|
spouse - BorrowerSpouse
|
|
useOwnTitleCompany - Boolean
|
|
Example
{
"assets": [Asset],
"borrowerTasks": [BorrowerTask],
"createdOn": "2007-12-03T10:15:30Z",
"credit": BorrowerCredit,
"deal": Deal,
"demographicInfo": DemographicInfo,
"dependentAges": [987.65],
"emailVerified": false,
"externalUserId": "xyz789",
"financialDeclarations": BorrowerFinancialDeclarations,
"id": "4",
"incomes": IncomeConnection,
"isFirstTimeHomeBuyer": false,
"liabilities": LiabilityConnection,
"mailingAddress": Address,
"maritalStatus": "DIVORCED",
"militaryService": BorrowerMilitaryService,
"ownedProperties": OwnedPropertyConnection,
"personalInformation": BorrowerPersonalInformation,
"pointOfContact": true,
"propertyDeclarations": BorrowerPropertyDeclarations,
"spouse": BorrowerSpouse,
"useOwnTitleCompany": false
}
BorrowerAddress
Description
Borrower Address
Fields
| Field Name | Description |
|---|---|
address - Address!
|
US Address |
borrower - Borrower!
|
The borrower that lives or lived in the address |
id - ID!
|
Borrower Address ID |
isCurrentAddress - Boolean!
|
Indicates if the address is current |
monthlyRentAmount - NonNegativeInt
|
The monthly rental amount in dollars |
moveInDate - Date
|
Move in date |
moveOutDate - Date
|
Move out date |
residencyBasis - BorrowerResidencyBasis
|
The basis on which the borrower lives/lived at this address |
Example
{
"address": Address,
"borrower": Borrower,
"id": 4,
"isCurrentAddress": false,
"monthlyRentAmount": 123,
"moveInDate": "2007-12-03",
"moveOutDate": "2007-12-03",
"residencyBasis": "LIVING_RENT_FREE"
}
BorrowerAddressMutations
Fields
| Field Name | Description |
|---|---|
createPrevious - CreatePreviousBorrowerAddressResponse
|
Create borrower's previous address |
Arguments |
|
deletePrevious - DeletePreviousBorrowerAddressResponse
|
Delete borrower's previous address |
Arguments |
|
updateCurrent - UpdateCurrentBorrowerAddressResponse
|
Update borrower's current address |
Arguments |
|
updatePrevious - UpdatePreviousBorrowerAddressResponse
|
Update borrower's previous address |
Arguments |
|
Example
{
"createPrevious": CreatePreviousBorrowerAddressResponse,
"deletePrevious": DeletePreviousBorrowerAddressResponse,
"updateCurrent": UpdateCurrentBorrowerAddressResponse,
"updatePrevious": UpdatePreviousBorrowerAddressResponse
}
BorrowerBusiness
Description
A borrower-owned business
Fields
| Field Name | Description |
|---|---|
address - Address
|
US Address |
businessType - BusinessType!
|
The type of business |
id - ID!
|
Borrower Business ID |
name - String!
|
Name |
ownerships - [BusinessOwnership!]!
|
Borrower ownerships of the business |
Example
{
"address": Address,
"businessType": "CORPORATION",
"id": "4",
"name": "abc123",
"ownerships": [BusinessOwnership]
}
BorrowerConnection
Fields
| Field Name | Description |
|---|---|
edges - [BorrowerEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [BorrowerEdge],
"pageInfo": PageInfo
}
BorrowerCredit
Description
An individual's credit score
Fields
| Field Name | Description |
|---|---|
bankruptcy - Boolean
|
|
creditReport - String
|
|
creditScores - [CreditScore!]!
|
|
lastPulledDate - DateTime
|
|
lastStatus - JobStatus
|
|
pullType - CreditPullType!
|
|
qualifyingScore - Float
|
Example
{
"bankruptcy": false,
"creditReport": "abc123",
"creditScores": [CreditScore],
"lastPulledDate": "2007-12-03T10:15:30Z",
"lastStatus": "FAILED",
"pullType": "HARD",
"qualifyingScore": 123.45
}
BorrowerEdge
BorrowerEstimatedTotalMonthlyIncome
Description
Borrower estimated total monthly income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
BorrowerFinancialDeclarations
Description
Borrower financial declarations
Fields
| Field Name | Description |
|---|---|
bankruptcyChapterType - BankruptcyChapterType
|
The type of bankruptcy filed, if any. |
bankruptcyIndicator - Boolean
|
Indicates if the borrower has filed for bankruptcy. |
homeownerPastThreeYears - Boolean
|
Indicates if the borrower has been a homeowner in the past three years. |
intentToOccupy - Boolean
|
Indicates if the borrower intends to occupy the property. |
outstandingJudgmentsIndicator - Boolean
|
Indicates if the borrower has outstanding judgments. |
partyToLawsuitIndicator - Boolean
|
Indicates if the borrower is currently a party to a lawsuit. |
presentlyDelinquentIndicator - Boolean
|
Indicates if the borrower is presently delinquent on any obligations. |
priorPropertyDeedInLieuConveyedIndicator - Boolean
|
Indicates if the borrower has conveyed a prior property deed in lieu of foreclosure. |
priorPropertyForeclosureCompletedIndicator - Boolean
|
Indicates if the borrower has completed a prior property foreclosure. |
priorPropertyShortSaleCompletedIndicator - Boolean
|
Indicates if the borrower has completed a prior property short sale. |
priorPropertyTitleType - PriorPropertyTitleType
|
Indicates the type of title ownership for the borrower's prior property, such as sole ownership or joint ownership. |
priorPropertyUsageType - PriorPropertyUsageType
|
Specifies how the borrower's prior property was used, such as primary residence, investment, or second home. |
undisclosedComakerOfNoteIndicator - Boolean
|
Indicates if the borrower is an undisclosed co-maker of a note. |
undisclosedCreditApplicationIndicator - Boolean
|
Indicates if the borrower has an undisclosed credit application. |
undisclosedMortgageApplicationIndicator - Boolean
|
Indicates if the borrower has an undisclosed mortgage application. |
Example
{
"bankruptcyChapterType": "CHAPTER_ELEVEN",
"bankruptcyIndicator": true,
"homeownerPastThreeYears": true,
"intentToOccupy": true,
"outstandingJudgmentsIndicator": false,
"partyToLawsuitIndicator": true,
"presentlyDelinquentIndicator": false,
"priorPropertyDeedInLieuConveyedIndicator": false,
"priorPropertyForeclosureCompletedIndicator": true,
"priorPropertyShortSaleCompletedIndicator": false,
"priorPropertyTitleType": "JOINT_WITH_OTHER_THAN_SPOUSE",
"priorPropertyUsageType": "FHA_SECONDARY_RESIDENCE",
"undisclosedComakerOfNoteIndicator": true,
"undisclosedCreditApplicationIndicator": true,
"undisclosedMortgageApplicationIndicator": true
}
BorrowerFinancialDeclarationsInput
Fields
| Input Field | Description |
|---|---|
bankruptcyChapterType - BankruptcyChapterType
|
The type of bankruptcy filed, if any. |
bankruptcyIndicator - Boolean
|
Indicates if the borrower has filed for bankruptcy. |
homeownerPastThreeYears - Boolean
|
Indicates if the borrower has been a homeowner in the past three years. |
intentToOccupy - Boolean
|
Indicates if the borrower intends to occupy the property. |
outstandingJudgmentsIndicator - Boolean
|
Indicates if the borrower has outstanding judgments. |
partyToLawsuitIndicator - Boolean
|
Indicates if the borrower is currently a party to a lawsuit. |
presentlyDelinquentIndicator - Boolean
|
Indicates if the borrower is presently delinquent on any obligations. |
priorPropertyDeedInLieuConveyedIndicator - Boolean
|
Indicates if the borrower has conveyed a prior property deed in lieu of foreclosure. |
priorPropertyForeclosureCompletedIndicator - Boolean
|
Indicates if the borrower has completed a prior property foreclosure. |
priorPropertyShortSaleCompletedIndicator - Boolean
|
Indicates if the borrower has completed a prior property short sale. |
priorPropertyTitleType - PriorPropertyTitleType
|
Indicates the type of title ownership for the borrower's prior property, such as sole ownership or joint ownership. |
priorPropertyUsageType - PriorPropertyUsageType
|
Specifies how the borrower's prior property was used, such as primary residence, investment, or second home. |
undisclosedComakerOfNoteIndicator - Boolean
|
Indicates if the borrower is an undisclosed co-maker of a note. |
undisclosedCreditApplicationIndicator - Boolean
|
Indicates if the borrower has an undisclosed credit application. |
undisclosedMortgageApplicationIndicator - Boolean
|
Indicates if the borrower has an undisclosed mortgage application. |
Example
{
"bankruptcyChapterType": "CHAPTER_ELEVEN",
"bankruptcyIndicator": false,
"homeownerPastThreeYears": true,
"intentToOccupy": false,
"outstandingJudgmentsIndicator": true,
"partyToLawsuitIndicator": false,
"presentlyDelinquentIndicator": false,
"priorPropertyDeedInLieuConveyedIndicator": true,
"priorPropertyForeclosureCompletedIndicator": true,
"priorPropertyShortSaleCompletedIndicator": false,
"priorPropertyTitleType": "JOINT_WITH_OTHER_THAN_SPOUSE",
"priorPropertyUsageType": "FHA_SECONDARY_RESIDENCE",
"undisclosedComakerOfNoteIndicator": true,
"undisclosedCreditApplicationIndicator": true,
"undisclosedMortgageApplicationIndicator": false
}
BorrowerIncome
Description
Borrower income interface. This is for income types that area associated with a single borrower. As opposed to other income types such as RentalIncome which can be associated with multiple borrowers.
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Possible Types
| BorrowerIncome Types |
|---|
Example
{
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
BorrowerMilitaryService
Description
A borrower's military status
Fields
| Field Name | Description |
|---|---|
militaryServiceExpectedCompletionDate - Date
|
|
militaryStatusType - MilitaryStatusType
|
|
survivingSpouseIndicator - Boolean
|
Example
{
"militaryServiceExpectedCompletionDate": "2007-12-03",
"militaryStatusType": "ACTIVE_DUTY",
"survivingSpouseIndicator": false
}
BorrowerMutations
Fields
| Field Name | Description |
|---|---|
attachLiabilities - AttachBorrowerLiabilitiesResponse
|
Attach liabilities to borrower. |
Arguments
|
|
attachNonBorrowingSpouse - AttachBorrowerNonBorrowingSpouseResponse
|
Attach non borrowing spouse to borrower. |
Arguments |
|
create - CreateBorrowerResponse
|
Create a borrower |
Arguments
|
|
delete - DeleteBorrowerResponse
|
Delete a borrower |
Arguments
|
|
detachLiabilities - DetachBorrowerLiabilitiesResponse
|
Detach liabilities from borrower. |
Arguments
|
|
linkBorrowersAsSpouses - LinkBorrowersAsSpousesResponse
|
Link 2 borrowers as spouses of each other |
Arguments
|
|
rejectDocument - RejectDocumentResponse
|
Reject a document and update its status |
Arguments
|
|
setEmailVerified - SetBorrowerEmailVerifiedResponse
|
|
Arguments
|
|
unsetMilitaryService - UnsetBorrowerMilitaryServiceResponse
|
Unset a borrower's military service information. |
Arguments |
|
updateBorrower - UpdateBorrowerResponse
|
Update a borrower's information. Only isFirstTimeHomeBuyer field can be updated currently. |
Arguments
|
|
updateConsent - UpdateBorrowerConsentResponse
|
Update a borrower's consent. Fields with non-null values will be updated, the rest will be ignored. |
Arguments
|
|
updateDemographicInfo - UpdateDemographicInfoResponse
|
Update a borrower's demographic info. Fields with non-null values will be updated, the rest will be ignored. |
Arguments
|
|
updateDependents - UpdateBorrowerDependentsResponse
|
Update a borrower's dependents. Fields with non-null values will be updated, the rest will be ignored. |
Arguments
|
|
updateFinancialDeclarations - UpdateBorrowerFinancialDeclarationsResponse
|
Update a borrower's financial declarations. Fields with non-null values will be updated, the rest will be ignored. |
Arguments |
|
updateMailingAddress - UpdateBorrowerMailingAddressResponse
|
Update a borrower's mailing address. Fields with non-null values will be updated, the rest will be ignored. |
Arguments |
|
updateMilitaryService - UpdateBorrowerMilitaryServiceResponse
|
Update a borrower's military service. Fields with non-null values will be updated, the rest will be ignored. |
Arguments |
|
updatePersonalInformation - UpdateBorrowerPersonalInformationResponse
|
Update a borrower's personal information. Fields with non-null values will be updated, the rest will be ignored. |
Arguments |
|
updatePhoneNumber - UpdateBorrowerPhoneNumberResponse
|
Update a borrower's phone number. Fields with non-null values will be updated, the rest will be ignored. |
Arguments
|
|
updatePropertyDeclarations - UpdateBorrowerPropertyDeclarationsResponse
|
Update a borrower's declarations. Fields with non-null values will be updated, the rest will be ignored. |
Arguments |
|
Example
{
"attachLiabilities": AttachBorrowerLiabilitiesResponse,
"attachNonBorrowingSpouse": AttachBorrowerNonBorrowingSpouseResponse,
"create": CreateBorrowerResponse,
"delete": DeleteBorrowerResponse,
"detachLiabilities": DetachBorrowerLiabilitiesResponse,
"linkBorrowersAsSpouses": LinkBorrowersAsSpousesResponse,
"rejectDocument": RejectDocumentResponse,
"setEmailVerified": SetBorrowerEmailVerifiedResponse,
"unsetMilitaryService": UnsetBorrowerMilitaryServiceResponse,
"updateBorrower": UpdateBorrowerResponse,
"updateConsent": UpdateBorrowerConsentResponse,
"updateDemographicInfo": UpdateDemographicInfoResponse,
"updateDependents": UpdateBorrowerDependentsResponse,
"updateFinancialDeclarations": UpdateBorrowerFinancialDeclarationsResponse,
"updateMailingAddress": UpdateBorrowerMailingAddressResponse,
"updateMilitaryService": UpdateBorrowerMilitaryServiceResponse,
"updatePersonalInformation": UpdateBorrowerPersonalInformationResponse,
"updatePhoneNumber": UpdateBorrowerPhoneNumberResponse,
"updatePropertyDeclarations": UpdateBorrowerPropertyDeclarationsResponse
}
BorrowerPersonalInformation
Description
A borrower's personal information
Fields
| Field Name | Description |
|---|---|
addressHistory - [BorrowerAddress!]!
|
The borrower's address history (current and previous addresses) |
citizenshipResidencyType - CitizenshipResidencyType
|
|
currentAddress - BorrowerAddress
|
The borrower's current address |
dateOfBirth - Date
|
|
email - String!
|
|
firstName - String!
|
|
lastName - String!
|
|
middleName - String
|
|
phoneNumbers - [BorrowerPhoneNumber!]!
|
|
taxIdentifierNumber - String
|
Tax identifier number |
taxIdentifierNumberType - TaxIdentifierNumberType
|
Tax identifier number type |
Example
{
"addressHistory": [BorrowerAddress],
"citizenshipResidencyType": "NON_PERMANENT_RESIDENT_ALIEN",
"currentAddress": BorrowerAddress,
"dateOfBirth": "2007-12-03",
"email": "abc123",
"firstName": "abc123",
"lastName": "abc123",
"middleName": "abc123",
"phoneNumbers": [BorrowerPhoneNumber],
"taxIdentifierNumber": "xyz789",
"taxIdentifierNumberType": "INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER"
}
BorrowerPersonalInformationInput
Fields
| Input Field | Description |
|---|---|
citizenshipResidencyType - CitizenshipResidencyType
|
|
currentAddress - AddressInput
|
|
dateOfBirth - Date
|
|
email - String!
|
|
firstName - String!
|
|
lastName - String!
|
|
middleName - String
|
|
phoneNumber - CreateBorrowerPhoneNumberInput!
|
|
socialSecurityNumber - String!
|
|
taxIdentifierNumber - String
|
Tax identifier number |
taxIdentifierNumberType - TaxIdentifierNumberType
|
Tax identifier number type |
Example
{
"citizenshipResidencyType": "NON_PERMANENT_RESIDENT_ALIEN",
"currentAddress": AddressInput,
"dateOfBirth": "2007-12-03",
"email": "abc123",
"firstName": "xyz789",
"lastName": "abc123",
"middleName": "abc123",
"phoneNumber": CreateBorrowerPhoneNumberInput,
"socialSecurityNumber": "xyz789",
"taxIdentifierNumber": "xyz789",
"taxIdentifierNumberType": "INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER"
}
BorrowerPhoneNumber
Description
A US phone number for a borrower
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Phone number id |
number - String!
|
Phone Number |
type - PhoneNumberType!
|
Phone number type |
Example
{
"id": 4,
"number": "abc123",
"type": "CELL"
}
BorrowerPreferences
Description
Borrower preferences related to loan applications.
Fields
| Field Name | Description |
|---|---|
closingCosts - NonNegativeFloat
|
The maximum allowable closing costs. |
downPaymentAmount - NonNegativeFloat
|
The down payment amount. |
maxDiscountPoints - Float
|
Limit number of rate point buys to not exceed this value. |
maxLtv - NonNegativeFloat
|
Max loan-to-value ratio allowed. Will not override takeout requirements. |
monthlyPayment - NonNegativeFloat
|
The maximum allowable monthly payment. |
mortgageInsurance - Boolean
|
Indicates whether mortgage insurance is required. |
principal - NonNegativeFloat
|
The maximum allowable principal amount. |
rate - NonNegativeFloat
|
The preferred interest rate. |
totalCost - NonNegativeFloat
|
The cost of points for the loan. |
totalPoints - NonNegativeFloat
|
The number of points required for the loan. |
Example
{
"closingCosts": 123.45,
"downPaymentAmount": 123.45,
"maxDiscountPoints": 123.45,
"maxLtv": 123.45,
"monthlyPayment": 123.45,
"mortgageInsurance": false,
"principal": 123.45,
"rate": 123.45,
"totalCost": 123.45,
"totalPoints": 123.45
}
BorrowerPropertyDeclarations
Description
Borrower property declarations
Fields
| Field Name | Description |
|---|---|
propertySubjectToPriorityLienIndicator - Boolean
|
Flag to indicate whether realtor tasks are complete on this loan |
specialBorrowerSellerRelationshipIndicator - Boolean
|
Flag to indicate whether realtor tasks are complete on this loan |
undisclosedBorrowedFundsAmount - Float
|
Flag to indicate whether realtor tasks are complete on this loan |
undisclosedBorrowedFundsIndicator - Boolean
|
Flag to indicate whether realtor tasks are complete on this loan |
Example
{
"propertySubjectToPriorityLienIndicator": false,
"specialBorrowerSellerRelationshipIndicator": true,
"undisclosedBorrowedFundsAmount": 123.45,
"undisclosedBorrowedFundsIndicator": false
}
BorrowerPropertyDeclarationsInput
Fields
| Input Field | Description |
|---|---|
propertySubjectToPriorityLienIndicator - Boolean
|
Flag to indicate whether realtor tasks are complete on this loan |
specialBorrowerSellerRelationshipIndicator - Boolean
|
Flag to indicate whether realtor tasks are complete on this loan |
undisclosedBorrowedFundsAmount - Float
|
Flag to indicate whether realtor tasks are complete on this loan |
undisclosedBorrowedFundsIndicator - Boolean
|
Flag to indicate whether realtor tasks are complete on this loan |
Example
{
"propertySubjectToPriorityLienIndicator": true,
"specialBorrowerSellerRelationshipIndicator": false,
"undisclosedBorrowedFundsAmount": 123.45,
"undisclosedBorrowedFundsIndicator": false
}
BorrowerResidencyBasis
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"LIVING_RENT_FREE"
BorrowerSpouse
Description
A borrower's spouse
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
personalInformation - BorrowerPersonalInformation
|
Example
{
"id": 4,
"personalInformation": BorrowerPersonalInformation
}
BorrowerTask
Description
A borrower's task
Fields
| Field Name | Description |
|---|---|
accessToken - String
|
Access token for SSO PDF viewer or any third-party access, if applicable. |
borrowerFacingDescription - String
|
|
borrowerId - ID!
|
|
completedAt - DateTime
|
|
createdOn - DateTime
|
|
details - TaskEntityDetails
|
Details about the entity this task is associated with |
documentLinks - [DocumentLink!]!
|
|
documentUploadPath - String
|
|
dueDate - DateTime
|
|
fields - [String!]
|
|
id - ID!
|
|
note - String
|
|
priority - Float
|
|
requiredFor1003Form - Boolean
|
|
status - String!
|
|
title - String
|
|
type - String!
|
Example
{
"accessToken": "abc123",
"borrowerFacingDescription": "xyz789",
"borrowerId": "4",
"completedAt": "2007-12-03T10:15:30Z",
"createdOn": "2007-12-03T10:15:30Z",
"details": TaskEntityDetails,
"documentLinks": [DocumentLink],
"documentUploadPath": "abc123",
"dueDate": "2007-12-03T10:15:30Z",
"fields": ["xyz789"],
"id": "4",
"note": "abc123",
"priority": 123.45,
"requiredFor1003Form": true,
"status": "xyz789",
"title": "xyz789",
"type": "abc123"
}
BorrowerUser
Description
Borrower user object
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
loanApplications - [BorrowerUserLoanApplicationSummary!]!
|
Example
{
"id": "4",
"loanApplications": [BorrowerUserLoanApplicationSummary]
}
BorrowerUserLoanApplicationSummary
Description
Borrower user object
Example
{
"archiveDate": "2007-12-03",
"creationDate": "2007-12-03",
"currentStage": "xyz789",
"friendlyId": "4",
"id": 4,
"submitted": true
}
BridgeLoanNotDepositedAsset
Description
Bridge loan not deposited asset
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset |
id - ID!
|
Asset ID |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": ["4"],
"id": 4,
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["xyz789"],
"notableActivities": [FinancialAccountActivity]
}
BusinessOwnership
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower that owns a percentage of the business |
business - BorrowerBusiness!
|
The borrower business |
percentOwnership - NonNegativeFloat!
|
Percent of the business that the borrower owns. This field is expressed as a percent. As an example, 50.1% is expressed as 50.1. |
Example
{
"borrower": Borrower,
"business": BorrowerBusiness,
"percentOwnership": 123.45
}
BusinessType
Description
The type of business
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CORPORATION"
CapitalGainsIncome
Description
Capital gains income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
CashOnHandAsset
Description
Cash on hand asset
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset |
id - ID!
|
Asset ID |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": [4],
"id": "4",
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["abc123"],
"notableActivities": [FinancialAccountActivity]
}
CertificateOfDepositTimeDepositAsset
Description
Certificate of deposit or time deposit asset
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset |
id - ID!
|
Asset ID |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": ["4"],
"id": 4,
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["xyz789"],
"notableActivities": [FinancialAccountActivity]
}
CheckingAccountAsset
Description
Checking account asset
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset |
id - ID!
|
Asset ID |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": ["4"],
"id": 4,
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["abc123"],
"notableActivities": [FinancialAccountActivity]
}
ChildSupportIncome
Description
Child support income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
CitizenshipResidencyType
Description
An individual's US citizenship status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"NON_PERMANENT_RESIDENT_ALIEN"
CommissionsIncome
Description
Commission-based income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
CommsMutations
Fields
| Field Name | Description |
|---|---|
updateCommsTemplate - UpdateCommsTemplateResponse
|
Update comms template |
Arguments
|
|
Example
{"updateCommsTemplate": UpdateCommsTemplateResponse}
CommsTemplate
Company
Description
Company
Fields
| Field Name | Description |
|---|---|
businessType - BusinessType
|
Business type |
id - ID!
|
The ID of the Company |
name - String
|
Company name |
Example
{
"businessType": "CORPORATION",
"id": 4,
"name": "xyz789"
}
CompanyMutations
Description
Company mutations
Fields
| Field Name | Description |
|---|---|
create - CreateCompanyResponse
|
Create a company |
Arguments
|
|
Example
{"create": CreateCompanyResponse}
Concession
Example
{
"amount": 123,
"approvedAt": "2007-12-03T10:15:30Z",
"approvedBy": "xyz789",
"id": "4",
"loanId": "4",
"reason": "xyz789",
"requestedAt": "2007-12-03T10:15:30Z",
"requestedBy": "xyz789",
"revocationReason": "BETTER_LOAN_STRUCTURE",
"revokedAt": "2007-12-03T10:15:30Z",
"revokedBy": "xyz789"
}
ConcessionLog
Fields
| Field Name | Description |
|---|---|
amount - NonNegativeInt
|
|
approvedAt - DateTime
|
|
approvedBy - String
|
|
history - [ConcessionLogItem!]
|
|
id - ID!
|
|
loanId - ID
|
|
reason - String
|
|
requestedAt - DateTime
|
|
requestedBy - String
|
|
revocationReason - ConcessionRevocationReason
|
|
revokedAt - DateTime
|
|
revokedBy - String
|
Example
{
"amount": 123,
"approvedAt": "2007-12-03T10:15:30Z",
"approvedBy": "xyz789",
"history": [ConcessionLogItem],
"id": 4,
"loanId": "4",
"reason": "abc123",
"requestedAt": "2007-12-03T10:15:30Z",
"requestedBy": "abc123",
"revocationReason": "BETTER_LOAN_STRUCTURE",
"revokedAt": "2007-12-03T10:15:30Z",
"revokedBy": "abc123"
}
ConcessionLogItem
Fields
| Field Name | Description |
|---|---|
amount - NonNegativeInt
|
|
approvedAt - DateTime
|
|
approvedBy - String
|
|
reason - String
|
|
requestedAt - DateTime
|
|
requestedBy - String
|
|
revocationReason - ConcessionRevocationReason
|
|
revokedAt - DateTime
|
|
revokedBy - String
|
Example
{
"amount": 123,
"approvedAt": "2007-12-03T10:15:30Z",
"approvedBy": "abc123",
"reason": "xyz789",
"requestedAt": "2007-12-03T10:15:30Z",
"requestedBy": "xyz789",
"revocationReason": "BETTER_LOAN_STRUCTURE",
"revokedAt": "2007-12-03T10:15:30Z",
"revokedBy": "xyz789"
}
ConcessionMutations
Fields
| Field Name | Description |
|---|---|
approveConcession - ApproveConcessionResponse
|
|
Arguments
|
|
requestConcession - RequestConcessionResponse
|
|
Arguments
|
|
revokeConcession - RevokeConcessionResponse
|
|
Arguments
|
|
updateConcession - UpdateConcessionResponse
|
|
Arguments
|
|
Example
{
"approveConcession": ApproveConcessionResponse,
"requestConcession": RequestConcessionResponse,
"revokeConcession": RevokeConcessionResponse,
"updateConcession": UpdateConcessionResponse
}
ConcessionRevocationReason
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"BETTER_LOAN_STRUCTURE"
ConfirmRateLockInput
Description
Input to the confirmRateLock mutation.
Fields
| Input Field | Description |
|---|---|
loanId - ID!
|
The ID or friendly ID of the loan. |
Example
{"loanId": "4"}
ConfirmRateLockResponse
Description
Response of the confirmRateLock mutation.
Fields
| Field Name | Description |
|---|---|
loanId - ID!
|
The ID or friendly ID of the loan. |
Example
{"loanId": 4}
ConformingMarketingRate
Description
Conforming marketing rate
Fields
| Field Name | Description |
|---|---|
apr - Float!
|
|
discountPointsTotal - Float!
|
|
discountPointsTotalAmount - Int!
|
|
fipsCountyCode - String!
|
|
loanAmount - NonNegativeInt!
|
|
ltv - Float!
|
|
propertyUsageType - PropertyUsageType!
|
|
qualifyingFicoScore - Int!
|
|
rate - Float!
|
|
salesContractAmount - NonNegativeInt!
|
The amount of money that the property will be purchased for. Also called the purchase price. |
Example
{
"apr": 123.45,
"discountPointsTotal": 987.65,
"discountPointsTotalAmount": 987,
"fipsCountyCode": "abc123",
"loanAmount": 123,
"ltv": 987.65,
"propertyUsageType": "INVESTMENT",
"qualifyingFicoScore": 123,
"rate": 123.45,
"salesContractAmount": 123
}
ConformingMarketingRateInput
Description
Conforming marketing rate input
Fields
| Input Field | Description |
|---|---|
fipsCountyCode - String!
|
The five-digit FIPS county code based on ANSI standard (INCITS 31:2009) |
loanAmount - NonNegativeInt!
|
Amount of the loan in dollars, also called principal |
loanTermYears - Float!
|
Loan term, in years. Default = 30 |
ltv - Float!
|
Loan to value ratio. Lower values get better rates. A typical value for a conforming conventional loan would be 0.8; values over that usually require mortgage insurance. |
maxDiscountPointsTotal - Float
|
Maximum total discount points. Default = 0 |
propertyUsageType - PropertyUsageType
|
|
qualifyingFicoScore - Int
|
FICO score used to determine loan eligibility and interest rate |
rateLockDays - Float!
|
How long to lock the rate, in days. Default = 30 |
Example
{
"fipsCountyCode": "abc123",
"loanAmount": 123,
"loanTermYears": 987.65,
"ltv": 123.45,
"maxDiscountPointsTotal": 987.65,
"propertyUsageType": "INVESTMENT",
"qualifyingFicoScore": 123,
"rateLockDays": 987.65
}
Contact
Description
Represents a contact entity with details like name, email, phone, company, address, and role.
Fields
| Field Name | Description |
|---|---|
address - Address
|
Address of the contact |
companyLicenseNumber - String
|
License number of the company the contact represents |
companyLicenseState - StateAbbreviated
|
State where the company's license was issued |
companyName - String
|
Company which the contact is from |
email - String
|
Email address of the contact |
firstName - String
|
First name of the contact |
hazardInsuranceCoverage - HazardInsuranceCoverageType
|
Coverage provided by a hazard insurer |
id - ID!
|
id of the contact |
individualLicenseNumber - String
|
Professional license number of the individual contact |
individualLicenseState - StateAbbreviated
|
State where the individual's professional license was issued |
lastName - String
|
Last name of the contact |
middleName - String
|
Middle name of the contact |
phoneNumber - String
|
Phone number of the contact |
role - ContactRole
|
Role of the contact |
Example
{
"address": Address,
"companyLicenseNumber": "xyz789",
"companyLicenseState": "AK",
"companyName": "xyz789",
"email": "abc123",
"firstName": "abc123",
"hazardInsuranceCoverage": "EARTHQUAKE",
"id": "4",
"individualLicenseNumber": "xyz789",
"individualLicenseState": "AK",
"lastName": "xyz789",
"middleName": "abc123",
"phoneNumber": "xyz789",
"role": "APPRAISER"
}
ContactRole
Description
Role of the contact in the context of a loan application.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"APPRAISER"
ContractBasisIncome
Description
Contract-based employment income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
Contributor
Fields
| Field Name | Description |
|---|---|
contactInfo - ContributorContactInfo!
|
|
deals - DealConnection
|
|
Arguments
|
|
disabledAt - DateTime
|
|
id - ID!
|
|
role - String!
|
|
roleId - ID!
|
|
Example
{
"contactInfo": ContributorContactInfo,
"deals": DealConnection,
"disabledAt": "2007-12-03T10:15:30Z",
"id": 4,
"role": "xyz789",
"roleId": 4
}
ContributorConnection
Fields
| Field Name | Description |
|---|---|
edges - [ContributorEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [ContributorEdge],
"pageInfo": PageInfo
}
ContributorContactInfo
ContributorCreateLeaseInput
Description
Input to create a contributor lease
Fields
| Input Field | Description |
|---|---|
contributorId - ID!
|
Example
{"contributorId": 4}
ContributorCreateLeaseResponse
Description
Contributor lease response
Fields
| Field Name | Description |
|---|---|
lease - ContributorLease
|
Lease that was created |
Example
{"lease": ContributorLease}
ContributorEdge
Fields
| Field Name | Description |
|---|---|
cursor - ID!
|
|
node - Contributor!
|
Example
{"cursor": 4, "node": Contributor}
ContributorFilter
Fields
| Input Field | Description |
|---|---|
email - String
|
Example
{"email": "abc123"}
ContributorLease
ContributorMutations
Fields
| Field Name | Description |
|---|---|
attachContributorToDeal - AttachContributorToDealResponse
|
|
Arguments
|
|
createContributor - CreateContributorResponse
|
|
Arguments
|
|
createLease - ContributorCreateLeaseResponse
|
|
Arguments
|
|
detachContributorFromDeal - DetachContributorFromDealResponse
|
|
Arguments
|
|
disableContributor - DisableContributorResponse
|
|
Arguments
|
|
enableContributor - EnableContributorResponse
|
|
Arguments
|
|
updateContributor - UpdateContributorResponse
|
|
Arguments
|
|
Example
{
"attachContributorToDeal": AttachContributorToDealResponse,
"createContributor": CreateContributorResponse,
"createLease": ContributorCreateLeaseResponse,
"detachContributorFromDeal": DetachContributorFromDealResponse,
"disableContributor": DisableContributorResponse,
"enableContributor": EnableContributorResponse,
"updateContributor": UpdateContributorResponse
}
ContributorRole
ContributorRoleConnection
Fields
| Field Name | Description |
|---|---|
edges - [ContributorRoleEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [ContributorRoleEdge],
"pageInfo": PageInfo
}
ContributorRoleEdge
Fields
| Field Name | Description |
|---|---|
cursor - ID!
|
|
node - ContributorRole!
|
Example
{"cursor": 4, "node": ContributorRole}
ConventionalPreQualification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Job ID |
parameters - ConventionalPreQualificationParameters!
|
|
productBreakdown - [PreQualificationProductResult!]!
|
|
result - PreQualificationBestEligibleResult
|
|
status - JobStatus!
|
Job status |
Example
{
"id": 4,
"parameters": ConventionalPreQualificationParameters,
"productBreakdown": [PreQualificationProductResult],
"result": PreQualificationBestEligibleResult,
"status": "FAILED"
}
ConventionalPreQualificationInput
Fields
| Input Field | Description |
|---|---|
fipsCountyCode - String!
|
|
hoaDues - NonNegativeInt
|
|
maxDiscountPointsTotal - Float
|
|
neighborhoodHousingType - NeighborhoodHousingType
|
|
propertyUsageType - PropertyUsageType
|
|
qualifyingAssetsTotalAmount - NonNegativeInt!
|
|
qualifyingFicoScore - Int!
|
|
qualifyingMonthlyExpenses - NonNegativeInt!
|
|
qualifyingMonthlyIncome - NonNegativeInt!
|
Example
{
"fipsCountyCode": "xyz789",
"hoaDues": 123,
"maxDiscountPointsTotal": 987.65,
"neighborhoodHousingType": "CONDOMINIUM",
"propertyUsageType": "INVESTMENT",
"qualifyingAssetsTotalAmount": 123,
"qualifyingFicoScore": 123,
"qualifyingMonthlyExpenses": 123,
"qualifyingMonthlyIncome": 123
}
ConventionalPreQualificationParameters
Fields
| Field Name | Description |
|---|---|
fipsCountyCode - String!
|
|
hoaDues - NonNegativeInt!
|
|
maxDiscountPointsTotal - Float!
|
|
neighborhoodHousingType - NeighborhoodHousingType!
|
|
propertyUsageType - PropertyUsageType!
|
|
qualifyingAssetsTotalAmount - NonNegativeInt!
|
|
qualifyingFicoScore - Int!
|
|
qualifyingMonthlyExpenses - NonNegativeInt!
|
|
qualifyingMonthlyIncome - NonNegativeInt!
|
Example
{
"fipsCountyCode": "abc123",
"hoaDues": 123,
"maxDiscountPointsTotal": 123.45,
"neighborhoodHousingType": "CONDOMINIUM",
"propertyUsageType": "INVESTMENT",
"qualifyingAssetsTotalAmount": 123,
"qualifyingFicoScore": 123,
"qualifyingMonthlyExpenses": 123,
"qualifyingMonthlyIncome": 123
}
ConventionalPreQualificationResult
Types
| Union Types |
|---|
Example
EligiblePreQualification
ConventionalResponse
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
CostAbsorption
Description
Organization cost absorptions per product.
Fields
| Field Name | Description |
|---|---|
points - NonNegativeFloat!
|
|
product - String!
|
Example
{"points": 123.45, "product": "abc123"}
County
Description
US County
Fields
| Field Name | Description |
|---|---|
fipsCountyCode - String!
|
County-level FIPS code |
name - String!
|
County name |
state - StateAbbreviated!
|
Abbreviated US state name (including DC) |
Example
{
"fipsCountyCode": "abc123",
"name": "abc123",
"state": "AK"
}
CreateAccessoryUnitIncomeInput
Description
Input for creating an AccessoryUnitIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateAlimonyIncomeInput
Description
Input for creating an AlimonyIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateAssetInput
Description
Input to the createAsset mutation. This is a 'oneOf' type where exactly one field must be populated.
Fields
Example
{
"automobile": CreateAutomobileAssetInput,
"bond": CreateBondAssetInput,
"bridgeLoanNotDeposited": CreateBridgeLoanNotDepositedAssetInput,
"cashOnHand": CreateCashOnHandAssetInput,
"certificateOfDepositTimeDeposit": CreateCertificateOfDepositTimeDepositAssetInput,
"checkingAccount": CreateCheckingAccountAssetInput,
"gift": CreateGiftAssetInput,
"grant": CreateGrantAssetInput,
"individualDevelopmentAccount": CreateIndividualDevelopmentAccountAssetInput,
"lifeInsurance": CreateLifeInsuranceAssetInput,
"moneyMarketFund": CreateMoneyMarketFundAssetInput,
"mutualFund": CreateMutualFundAssetInput,
"other": CreateOtherAssetInput,
"pendingNetSaleProceedsFromRealEstate": CreatePendingNetSaleProceedsFromRealEstateAssetInput,
"proceedsFromSaleOfNonRealEstateAsset": CreateProceedsFromSaleOfNonRealEstateAssetInput,
"proceedsFromSecuredLoan": CreateProceedsFromSecuredLoanAssetInput,
"proceedsFromUnsecuredLoan": CreateProceedsFromUnsecuredLoanAssetInput,
"retirementFund": CreateRetirementFundAssetInput,
"savingsAccount": CreateSavingsAccountAssetInput,
"stock": CreateStockAssetInput,
"stockOptions": CreateStockOptionsAssetInput,
"trustAccount": CreateTrustAccountAssetInput
}
CreateAssetResponse
Description
Response of the createAsset mutation
Fields
| Field Name | Description |
|---|---|
asset - Asset!
|
The created asset |
Example
{"asset": Asset}
CreateAutomobileAllowanceIncomeInput
Description
Input for creating an AutomobileAllowanceIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateAutomobileAssetInput
Fields
| Input Field | Description |
|---|---|
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"amount": 123,
"borrowerIds": [4],
"nonBorrowerOwnerNames": ["xyz789"]
}
CreateBoarderIncomeInput
Description
Input for creating a BoarderIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateBondAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": [4],
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["abc123"]
}
CreateBonusIncomeInput
Description
Input for creating a BonusIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateBorrowerEstimatedTotalMonthlyIncomeInput
Description
Input for creating a BorrowerEstimatedTotalMonthlyIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateBorrowerInput
Fields
| Input Field | Description |
|---|---|
dealId - ID!
|
ID of the deal |
dependentAges - [Float!]
|
|
financialDeclarations - BorrowerFinancialDeclarationsInput
|
|
mailingAddress - AddressInput
|
|
personalInformation - BorrowerPersonalInformationInput!
|
|
pointOfContact - Boolean!
|
|
propertyDeclarations - BorrowerPropertyDeclarationsInput
|
Example
{
"dealId": 4,
"dependentAges": [123.45],
"financialDeclarations": BorrowerFinancialDeclarationsInput,
"mailingAddress": AddressInput,
"personalInformation": BorrowerPersonalInformationInput,
"pointOfContact": false,
"propertyDeclarations": BorrowerPropertyDeclarationsInput
}
CreateBorrowerPhoneNumberInput
Description
A phone number
Fields
| Input Field | Description |
|---|---|
number - String!
|
Phone Number |
type - PhoneNumberType!
|
Phone number type |
Example
{"number": "abc123", "type": "CELL"}
CreateBorrowerResponse
Description
Response of the create borrower mutation.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
ID of the borrower |
Example
{"id": "4"}
CreateBridgeLoanNotDepositedAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": ["4"],
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["xyz789"]
}
CreateCapitalGainsIncomeInput
Description
Input for creating a CapitalGainsIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateCashOnHandAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": ["4"],
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["xyz789"]
}
CreateCertificateOfDepositTimeDepositAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": [4],
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["abc123"]
}
CreateCheckingAccountAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": ["4"],
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["xyz789"]
}
CreateChildSupportIncomeInput
Description
Input for creating a ChildSupportIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateCommissionsIncomeInput
Description
Input for creating a CommissionsIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateCompanyInput
Fields
| Input Field | Description |
|---|---|
address - AddressInput
|
Company address |
businessType - BusinessType
|
Business type |
dealId - ID!
|
ID of the deal |
name - String
|
Company name |
Example
{
"address": AddressInput,
"businessType": "CORPORATION",
"dealId": 4,
"name": "xyz789"
}
CreateCompanyResponse
Fields
| Field Name | Description |
|---|---|
company - Company!
|
Example
{"company": Company}
CreateContactInput
Fields
| Input Field | Description |
|---|---|
address - AddressInput
|
Optional U.S. address to create with the contact. |
companyLicenseNumber - String
|
License number of the company the contact represents |
companyLicenseState - StateAbbreviated
|
State where the company's license was issued |
companyName - String
|
Company which the contact is from |
email - String
|
Email address of the contact |
firstName - String
|
First name of the contact |
hazardInsuranceCoverage - HazardInsuranceCoverageType
|
Coverage provided by a hazard insurer |
individualLicenseNumber - String
|
Professional license number of the individual contact |
individualLicenseState - StateAbbreviated
|
State where the individual's professional license was issued |
lastName - String
|
Last name of the contact |
middleName - String
|
Middle name of the contact |
phoneNumber - String
|
Phone number of the contact |
role - OrganizationContactRole!
|
Contact's role, limited to supported values. |
Example
{
"address": AddressInput,
"companyLicenseNumber": "xyz789",
"companyLicenseState": "AK",
"companyName": "abc123",
"email": "xyz789",
"firstName": "abc123",
"hazardInsuranceCoverage": "EARTHQUAKE",
"individualLicenseNumber": "xyz789",
"individualLicenseState": "AK",
"lastName": "xyz789",
"middleName": "abc123",
"phoneNumber": "xyz789",
"role": "ATTORNEY"
}
CreateContactResponse
Fields
| Field Name | Description |
|---|---|
created - Contact!
|
The newly created contact. |
Example
{"created": Contact}
CreateContractBasisIncomeInput
Description
Input for creating a ContractBasisIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateContributorContactInfoInput
CreateContributorInput
Fields
| Input Field | Description |
|---|---|
contactInfo - CreateContributorContactInfoInput!
|
|
role - String
|
|
roleId - ID
|
Example
{
"contactInfo": CreateContributorContactInfoInput,
"role": "abc123",
"roleId": 4
}
CreateContributorResponse
Fields
| Field Name | Description |
|---|---|
contributor - Contributor!
|
Example
{"contributor": Contributor}
CreateDealResponse
Fields
| Field Name | Description |
|---|---|
deal - Deal!
|
Example
{"deal": Deal}
CreateDefinedContributionPlanIncomeInput
Description
Input for creating a DefinedContributionPlanIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateDisabilityIncomeInput
Description
Input for creating a DisabilityIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateDividendsInterestIncomeInput
Description
Input for creating a DividendsInterestIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateEmploymentRelatedAccountIncomeInput
Description
Input for creating an EmploymentRelatedAccountIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateFosterCareIncomeInput
Description
Input for creating a FosterCareIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateFulfillmentPartyInput
Fields
| Input Field | Description |
|---|---|
companyId - ID
|
The ID of the associated company |
dealId - ID!
|
|
role - FulfillmentPartyRole
|
The role of the fulfillment party |
Example
{
"companyId": "4",
"dealId": "4",
"role": "NOTARY"
}
CreateFulfillmentPartyResponse
Fields
| Field Name | Description |
|---|---|
fulfillmentParty - FulfillmentParty!
|
Example
{"fulfillmentParty": FulfillmentParty}
CreateGiftAssetInput
Fields
| Input Field | Description |
|---|---|
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
dateOfTransfer - Date
|
The date when the gift/grant funds were transferred into the borrower's account |
donorEmployeeIdentificationNumber - String
|
Employer Identification Number (EIN) of the gift/grant donor |
donorName - String
|
Full name of the person providing the gift/grant |
donorPhoneNumber - String
|
The phone number of the person providing the gift/grant |
isIncludedInAssetAccount - Boolean
|
Indicates whether the gift/grant funds have already been included as part of an asset account considered for the loan |
isSellerFunded - Boolean
|
Indicates whether the gift/grant is funded by the seller |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
source - GiftSource
|
Gift/Grant source |
Example
{
"amount": 123,
"borrowerIds": [4],
"dateOfTransfer": "2007-12-03",
"donorEmployeeIdentificationNumber": "abc123",
"donorName": "abc123",
"donorPhoneNumber": "abc123",
"isIncludedInAssetAccount": true,
"isSellerFunded": true,
"nonBorrowerOwnerNames": ["xyz789"],
"source": "COMMUNITY_NON_PROFIT"
}
CreateGrantAssetInput
Fields
| Input Field | Description |
|---|---|
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
dateOfTransfer - Date
|
The date when the gift/grant funds were transferred into the borrower's account |
donorEmployeeIdentificationNumber - String
|
Employer Identification Number (EIN) of the gift/grant donor |
donorName - String
|
Full name of the person providing the gift/grant |
donorPhoneNumber - String
|
The phone number of the person providing the gift/grant |
isIncludedInAssetAccount - Boolean
|
Indicates whether the gift/grant funds have already been included as part of an asset account considered for the loan |
isSellerFunded - Boolean
|
Indicates whether the gift/grant is funded by the seller |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
source - GiftSource
|
Gift/Grant source |
Example
{
"amount": 123,
"borrowerIds": [4],
"dateOfTransfer": "2007-12-03",
"donorEmployeeIdentificationNumber": "xyz789",
"donorName": "abc123",
"donorPhoneNumber": "abc123",
"isIncludedInAssetAccount": false,
"isSellerFunded": false,
"nonBorrowerOwnerNames": ["xyz789"],
"source": "COMMUNITY_NON_PROFIT"
}
CreateHousingAllowanceIncomeInput
Description
Input for creating a HousingAllowanceIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateHousingChoiceVoucherProgramIncomeInput
Description
Input for creating a HousingChoiceVoucherProgramIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateIncomeInput
Description
Input to the createIncome mutation. This is a 'oneOf' type where exactly one field must be populated.
Fields
Example
{
"accessoryUnitIncome": CreateAccessoryUnitIncomeInput,
"alimony": CreateAlimonyIncomeInput,
"automobileAllowance": CreateAutomobileAllowanceIncomeInput,
"boarder": CreateBoarderIncomeInput,
"bonus": CreateBonusIncomeInput,
"borrowerEstimatedTotalMonthlyIncome": CreateBorrowerEstimatedTotalMonthlyIncomeInput,
"capitalGains": CreateCapitalGainsIncomeInput,
"childSupport": CreateChildSupportIncomeInput,
"commissions": CreateCommissionsIncomeInput,
"contractBasis": CreateContractBasisIncomeInput,
"definedContributionPlan": CreateDefinedContributionPlanIncomeInput,
"disability": CreateDisabilityIncomeInput,
"dividendsInterest": CreateDividendsInterestIncomeInput,
"employmentRelatedAccount": CreateEmploymentRelatedAccountIncomeInput,
"fosterCare": CreateFosterCareIncomeInput,
"housingAllowance": CreateHousingAllowanceIncomeInput,
"housingChoiceVoucherProgram": CreateHousingChoiceVoucherProgramIncomeInput,
"militaryBasePay": CreateMilitaryBasePayIncomeInput,
"militaryClothesAllowance": CreateMilitaryClothesAllowanceIncomeInput,
"militaryCombatPay": CreateMilitaryCombatPayIncomeInput,
"militaryFlightPay": CreateMilitaryFlightPayIncomeInput,
"militaryHazardPay": CreateMilitaryHazardPayIncomeInput,
"militaryOverseasPay": CreateMilitaryOverseasPayIncomeInput,
"militaryPropPay": CreateMilitaryPropPayIncomeInput,
"militaryQuartersAllowance": CreateMilitaryQuartersAllowanceIncomeInput,
"militaryRationsAllowance": CreateMilitaryRationsAllowanceIncomeInput,
"militaryVariableHousingAllowance": CreateMilitaryVariableHousingAllowanceIncomeInput,
"miscellaneousIncome": CreateMiscellaneousIncomeInput,
"mortgageCreditCertificate": CreateMortgageCreditCertificateIncomeInput,
"mortgageDifferential": CreateMortgageDifferentialIncomeInput,
"netRentalIncome": CreateNetRentalIncomeInput,
"nonBorrowerContribution": CreateNonBorrowerContributionIncomeInput,
"nonBorrowerHouseholdIncome": CreateNonBorrowerHouseholdIncomeInput,
"notesReceivableInstallment": CreateNotesReceivableInstallmentIncomeInput,
"other": CreateOtherIncomeInput,
"overtime": CreateOvertimeIncomeInput,
"pension": CreatePensionIncomeInput,
"proposedGrossRentForSubjectProperty": CreateProposedGrossRentForSubjectPropertyIncomeInput,
"publicAssistance": CreatePublicAssistanceIncomeInput,
"realEstateOwnedGrossRentalIncome": CreateRealEstateOwnedGrossRentalIncomeInput,
"retirement": CreateRetirementIncomeInput,
"royalties": CreateRoyaltiesIncomeInput,
"selfEmployment": CreateSelfEmploymentIncomeInput,
"selfEmploymentLoss": CreateSelfEmploymentLossIncomeInput,
"separateMaintenance": CreateSeparateMaintenanceIncomeInput,
"socialSecurity": CreateSocialSecurityIncomeInput,
"standardEmployment": CreateStandardEmploymentIncomeInput,
"subjectPropertyNetCashFlow": CreateSubjectPropertyNetCashFlowIncomeInput,
"temporaryLeave": CreateTemporaryLeaveIncomeInput,
"tipIncome": CreateTipIncomeInput,
"trailingCoBorrower": CreateTrailingCoBorrowerIncomeInput,
"trust": CreateTrustIncomeInput,
"unemployment": CreateUnemploymentIncomeInput,
"vaBenefitsNonEducational": CreateVaBenefitsNonEducationalIncomeInput,
"workersCompensation": CreateWorkersCompensationIncomeInput
}
CreateIncomeResponse
Description
Response of the createIncome mutation
Fields
| Field Name | Description |
|---|---|
income - Income!
|
The income entity that was created |
Example
{"income": Income}
CreateIndividualDevelopmentAccountAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": [4],
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["abc123"]
}
CreateLeaseInput
Description
Input to create a borrower lease
Example
{
"email": "xyz789",
"externalUserId": "abc123",
"firstName": "abc123",
"lastName": "xyz789"
}
CreateLeaseResponse
Description
Borrower lease response
Fields
| Field Name | Description |
|---|---|
lease - Lease
|
Lease that was created |
Example
{"lease": Lease}
CreateLiabilityInput
Description
Input to the createLiability mutation.
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
Account identifier |
balance - NonNegativeFloat
|
Unpaid balance |
bankName - String
|
Bank name |
borrowerIds - [ID!]!
|
Liability-owning borrower IDs |
creditorName - String
|
Creditor name |
exclusionReason - LiabilityExclusionReason
|
The reason this liability should be excluded from total debt |
intent - LiabilityIntent
|
The intent regarding liability |
monthlyPayment - NonNegativeFloat
|
Monthly payment |
type - LiabilityType
|
The type of liability |
Example
{
"accountIdentifier": "xyz789",
"balance": 123.45,
"bankName": "xyz789",
"borrowerIds": ["4"],
"creditorName": "abc123",
"exclusionReason": "ASSIGNED_TO_ANOTHER_PARTY",
"intent": "DO_NOTHING",
"monthlyPayment": 123.45,
"type": "BORROWER_ESTIMATED_TOTAL_MONTHLY_LIABILITY_PAYMENT"
}
CreateLiabilityResponse
Description
Response of the createLiability mutation.
Fields
| Field Name | Description |
|---|---|
liability - Liability!
|
The created liability |
Example
{"liability": Liability}
CreateLifeInsuranceAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": [4],
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["abc123"]
}
CreateLoanInput
Description
Input to the createLoan mutation.
Fields
| Input Field | Description |
|---|---|
closingDate - Date
|
The date that the purchase is set to close. |
dealId - ID!
|
|
loanPurpose - LoanPurposeType
|
The purpose for which the loan proceeds will be used. |
loanTermYears - PositiveFloat
|
The term of this loan in years. Default = 30 |
outOfPocketMax - NonNegativeInt
|
The maximum amount of assets (in dollars) to be used towards the loan. |
purchasePrice - NonNegativeInt
|
The actual purchase price (in dollars). |
Example
{
"closingDate": "2007-12-03",
"dealId": "4",
"loanPurpose": "PURCHASE",
"loanTermYears": 123.45,
"outOfPocketMax": 123,
"purchasePrice": 123
}
CreateLoanPreApprovalLetterError
Description
Union of possible user errors that can occur during execution of the createLoanPreApprovalLetter mutation.
Example
ExpiredCreditPullError
CreateLoanPreApprovalLetterInput
Description
Input to the createLoanPreApprovalLetter mutation.
Fields
| Input Field | Description |
|---|---|
loanAmount - NonNegativeInt!
|
Loan amount (in dollars) to display on the letter. Cannot exceed the maximum pre-approved loan amount. |
loanId - ID!
|
The ID or friendly ID of the loan. |
purchasePrice - NonNegativeInt!
|
Purchase price (in dollars) to display on the letter. Cannot exceed the maximum pre-approved purchase price. |
Example
{"loanAmount": 123, "loanId": 4, "purchasePrice": 123}
CreateLoanPreApprovalLetterResponse
Description
Response of the createLoanPreApprovalLetter mutation.
Fields
| Field Name | Description |
|---|---|
letterUrl - String
|
A download URL for the pre-approval letter. The value will be null if the loan has not been pre-approved. |
userErrors - [CreateLoanPreApprovalLetterError!]!
|
A list of user errors that occurred while executing the createLoanPreApprovalLetter mutation. |
Example
{
"letterUrl": "abc123",
"userErrors": [ExpiredCreditPullError]
}
CreateLoanResponse
Description
Response of the createLoan mutation.
Fields
| Field Name | Description |
|---|---|
loan - Loan!
|
The newly created loan. |
Example
{"loan": Loan}
CreateMaxLoanPreApprovalLetterError
Description
Union of possible user errors that can occur during execution of the createMaxLoanPreApprovalLetter mutation.
Types
| Union Types |
|---|
Example
LoanNotPreApprovedError
CreateMaxLoanPreApprovalLetterInput
Description
Input to the createMaxLoanPreApprovalLetter mutation.
Fields
| Input Field | Description |
|---|---|
loanId - ID!
|
The ID or friendly ID of the loan. |
Example
{"loanId": "4"}
CreateMaxLoanPreApprovalLetterResponse
Description
Response of the createMaxLoanPreApprovalLetter mutation.
Fields
| Field Name | Description |
|---|---|
letterUrl - String
|
A download URL for a pre-approval letter with the maximum pre-approved loan amount and purchase price for the loan. |
userErrors - [CreateMaxLoanPreApprovalLetterError!]!
|
A list of user errors that occurred while executing the createMaxLoanPreApprovalLetter mutation. |
Example
{
"letterUrl": "xyz789",
"userErrors": [LoanNotPreApprovedError]
}
CreateMilitaryBasePayIncomeInput
Description
Input for creating a MilitaryBasePayIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateMilitaryClothesAllowanceIncomeInput
Description
Input for creating a MilitaryClothesAllowanceIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateMilitaryCombatPayIncomeInput
Description
Input for creating a MilitaryCombatPayIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateMilitaryFlightPayIncomeInput
Description
Input for creating a MilitaryFlightPayIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateMilitaryHazardPayIncomeInput
Description
Input for creating a MilitaryHazardPayIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateMilitaryOverseasPayIncomeInput
Description
Input for creating a MilitaryOverseasPayIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateMilitaryPropPayIncomeInput
Description
Input for creating a MilitaryPropPayIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateMilitaryQuartersAllowanceIncomeInput
Description
Input for creating a MilitaryQuartersAllowanceIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateMilitaryRationsAllowanceIncomeInput
Description
Input for creating a MilitaryRationsAllowanceIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateMilitaryVariableHousingAllowanceIncomeInput
Description
Input for creating a MilitaryVariableHousingAllowanceIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateMiscellaneousIncomeInput
Description
Input for creating a MiscellaneousIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateMoneyMarketFundAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": ["4"],
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["abc123"]
}
CreateMortgageCreditCertificateIncomeInput
Description
Input for creating a MortgageCreditCertificateIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
percentageOfInterest - NonNegativeFloat
|
The percentage of interest that the mortgage credit certificate will cover. This field is expressed as a percent. As an example, 50.1% is expressed as 50.1. |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"percentageOfInterest": 123.45,
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateMortgageDifferentialIncomeInput
Description
Input for creating a MortgageDifferentialIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateMutualFundAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": ["4"],
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["xyz789"]
}
CreateNetRentalIncomeInput
Description
Input for creating a NetRentalIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateNonBorrowerContributionIncomeInput
Description
Input for creating a NonBorrowerContributionIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateNonBorrowerHouseholdIncomeInput
Description
Input for creating a NonBorrowerHouseholdIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateNonBorrowingOwnerInput
Fields
| Input Field | Description |
|---|---|
dealId - ID!
|
|
personalInformation - PersonalInformationInput!
|
Example
{
"dealId": 4,
"personalInformation": PersonalInformationInput
}
CreateNonBorrowingOwnerResponse
Fields
| Field Name | Description |
|---|---|
nonBorrowingOwner - NonBorrowingOwner!
|
Example
{"nonBorrowingOwner": NonBorrowingOwner}
CreateNotesReceivableInstallmentIncomeInput
Description
Input for creating a NotesReceivableInstallmentIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateOrganizationRoleInput
Fields
| Input Field | Description |
|---|---|
description - String!
|
|
name - String!
|
|
permissions - [String!]!
|
Example
{
"description": "xyz789",
"name": "xyz789",
"permissions": ["abc123"]
}
CreateOrganizationRoleResponse
Fields
| Field Name | Description |
|---|---|
organizationRole - OrganizationRole
|
|
userErrors - [GenericUserError!]!
|
Example
{
"organizationRole": OrganizationRole,
"userErrors": [GenericUserError]
}
CreateOrganizationUserInput
CreateOrganizationUserResponse
Fields
| Field Name | Description |
|---|---|
organizationUser - OrganizationUser
|
|
userErrors - [GenericUserError!]!
|
Example
{
"organizationUser": OrganizationUser,
"userErrors": [GenericUserError]
}
CreateOtherAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
description - String
|
Description of the asset |
institutionName - String
|
Institution name |
isLiquid - Boolean
|
Indicates whether or not the asset is liquid |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": ["4"],
"description": "abc123",
"institutionName": "abc123",
"isLiquid": false,
"nonBorrowerOwnerNames": ["xyz789"]
}
CreateOtherIncomeInput
Description
Input for creating an OtherIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
description - String
|
Information about the income type |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": "4",
"description": "xyz789",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateOvertimeIncomeInput
Description
Input for creating an OvertimeIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateOwnedPropertyInput
Description
Input to the createOwnedProperty mutation.
Fields
| Input Field | Description |
|---|---|
address - AddressInput
|
US Address |
currentUsageType - PropertyUsageType
|
How the owner is using this property. |
homeInsuranceMonthlyPayment - NonNegativeInt
|
The dollar amount of monthly home insurance premium. |
intendedDisposition - PropertyDisposition
|
The intended disposition of the property. Indicates whether the borrowers will be retaining or selling (or sold) the property. |
intendedUsageType - PropertyUsageType
|
How the owner intends to use this property. |
monthlyAssociationDues - NonNegativeInt
|
Monthly association dues (in dollars) |
monthlyRentalIncome - NonNegativeInt
|
The expected monthly rental income (in dollars) |
mortgageInsuranceMonthlyPayment - NonNegativeInt
|
The dollar amount of monthly mortgage insurance monthly premium. |
neighborhoodHousingType - NeighborhoodHousingType
|
The type of housing (e.g. single or multi-family) |
ownerIds - [ID!]!
|
IDs of the borrowers who own this property |
propertyTaxMonthlyPayment - NonNegativeInt
|
The dollar amount of property taxes due per month. |
purchaseDate - Date
|
The date when the property was originally purchased. |
sellDate - Date
|
The date when the property was sold. Only relevant for previously owned properties. |
Example
{
"address": AddressInput,
"currentUsageType": "INVESTMENT",
"homeInsuranceMonthlyPayment": 123,
"intendedDisposition": "PENDING_SALE",
"intendedUsageType": "INVESTMENT",
"monthlyAssociationDues": 123,
"monthlyRentalIncome": 123,
"mortgageInsuranceMonthlyPayment": 123,
"neighborhoodHousingType": "CONDOMINIUM",
"ownerIds": ["4"],
"propertyTaxMonthlyPayment": 123,
"purchaseDate": "2007-12-03",
"sellDate": "2007-12-03"
}
CreateOwnedPropertyResponse
Description
Response of the createOwnedProperty mutation.
Fields
| Field Name | Description |
|---|---|
ownedProperty - OwnedProperty!
|
The created OwnedProperty |
Example
{"ownedProperty": OwnedProperty}
CreatePartyInput
Fields
| Input Field | Description |
|---|---|
dealId - ID!
|
The ID of the deal to which the party will be associated. Note that the deal must have exactly one loan already. In the future, attaching a party to a loan will be done explicitly. |
party - CreatePartyInputParty!
|
Example
{"dealId": 4, "party": CreatePartyInputParty}
CreatePartyInputParty
Fields
| Input Field | Description |
|---|---|
address - AddressInput
|
US address to update. Fields with non-null values will be updated, the rest will be ignored. |
individual - PartyIndividualInput
|
Details about the party, if the party is an individual (rather than a company) |
legalEntity - PartyLegalEntityInput
|
Details about the party, if the party is a legal entity |
role - PartyRole
|
Indicates the type of relationship between the party and the loan. |
Example
{
"address": AddressInput,
"individual": PartyIndividualInput,
"legalEntity": PartyLegalEntityInput,
"role": "ATTORNEY"
}
CreatePartyResponse
Fields
| Field Name | Description |
|---|---|
party - Party
|
|
userErrors - [UserError!]!
|
Example
{
"party": Party,
"userErrors": [UserError]
}
CreatePendingNetSaleProceedsFromRealEstateAssetInput
Description
Input for creating a PendingNetSaleProceedsFromRealEstateAsset. The amount is the expected proceeds from the sale and should be less than or equal to the salePrice.
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
ownedPropertyId - ID
|
The ID of the associated OwnedProperty that is pending sale |
salePrice - NonNegativeInt
|
Sale price of the property in dollars. The salePrice must be greater than or equal to the asset amount (the expected proceeds). |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": ["4"],
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["xyz789"],
"ownedPropertyId": "4",
"salePrice": 123
}
CreatePensionIncomeInput
Description
Input for creating a PensionIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreatePreviousBorrowerAddressInput
Description
Create previous borrower address input
Fields
| Input Field | Description |
|---|---|
address - AddressInput
|
US address to update |
borrowerId - ID!
|
Borrower ID |
monthlyRentAmount - NonNegativeInt
|
The monthly rental amount in dollars |
moveInDate - Date
|
Move in date |
moveOutDate - Date
|
Move out date |
residencyBasis - BorrowerResidencyBasis
|
The basis on which the borrower lives/lived at this address |
Example
{
"address": AddressInput,
"borrowerId": "4",
"monthlyRentAmount": 123,
"moveInDate": "2007-12-03",
"moveOutDate": "2007-12-03",
"residencyBasis": "LIVING_RENT_FREE"
}
CreatePreviousBorrowerAddressResponse
Fields
| Field Name | Description |
|---|---|
address - Address!
|
US Address |
id - ID!
|
Borrower Address ID |
monthlyRentAmount - NonNegativeInt
|
The monthly rental amount in dollars |
moveInDate - Date
|
Move in date |
moveOutDate - Date
|
Move out date |
residencyBasis - BorrowerResidencyBasis
|
The basis on which the borrower lives/lived at this address |
Example
{
"address": Address,
"id": 4,
"monthlyRentAmount": 123,
"moveInDate": "2007-12-03",
"moveOutDate": "2007-12-03",
"residencyBasis": "LIVING_RENT_FREE"
}
CreateProceedsFromSaleOfNonRealEstateAssetInput
Fields
| Input Field | Description |
|---|---|
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"amount": 123,
"borrowerIds": [4],
"nonBorrowerOwnerNames": ["abc123"]
}
CreateProceedsFromSecuredLoanAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": [4],
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["abc123"]
}
CreateProceedsFromUnsecuredLoanAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": ["4"],
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["xyz789"]
}
CreateProposedGrossRentForSubjectPropertyIncomeInput
Description
Input for creating a ProposedGrossRentForSubjectPropertyIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreatePublicAssistanceIncomeInput
Description
Input for creating a PublicAssistanceIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateRealEstateOwnedGrossRentalIncomeInput
Description
Input for creating a RealEstateOwnedGrossRentalIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateRetirementFundAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": [4],
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["xyz789"]
}
CreateRetirementIncomeInput
Description
Input for creating a RetirementIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateRoyaltiesIncomeInput
Description
Input for creating a RoyaltiesIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateSavingsAccountAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": ["4"],
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["xyz789"]
}
CreateSelfEmploymentIncomeInput
Description
Input for creating a SelfEmploymentIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
business - SelfEmploymentBusinessInput
|
The associated self-employment business (if one exists) |
employmentClassification - EmploymentClassificationType!
|
Whether this is the borrower's primary or secondary employer. Default = PRIMARY |
endDate - Date
|
End date. A value of null indicates that the employment is current. |
isCurrentEmployment - Boolean
|
Is the employment current? |
numberOfMonthsInLineOfWork - NonNegativeInt
|
The total number of months the borrower has been employed in this line of work, regardless of employer |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
position - String
|
A name or description of the employment position or job title |
startDate - Date
|
Start date |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": "4",
"business": SelfEmploymentBusinessInput,
"employmentClassification": "PRIMARY",
"endDate": "2007-12-03",
"isCurrentEmployment": false,
"numberOfMonthsInLineOfWork": 123,
"payPeriodFrequency": "ANNUALLY",
"position": "abc123",
"startDate": "2007-12-03",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateSelfEmploymentLossIncomeInput
Description
Input for creating a SelfEmploymentLossIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateSeparateMaintenanceIncomeInput
Description
Input for creating a SeparateMaintenanceIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateSessionResponse
Fields
| Field Name | Description |
|---|---|
advisorSession - AdvisorSession!
|
Example
{"advisorSession": AdvisorSession}
CreateSocialSecurityIncomeInput
Description
Input for creating a SocialSecurityIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateStandardEmploymentIncomeInput
Description
Input for creating a StandardEmploymentIncome
Fields
| Input Field | Description |
|---|---|
borrowerHasSpecialRelationshipWithEmployer - Boolean!
|
When true, indicates that the borrower has a special relationship with the employer, such as familial ties. Default = false |
borrowerId - ID!
|
The borrower associated with the income |
employer - EmployerInput
|
Employer details |
employmentClassification - EmploymentClassificationType!
|
Whether this is the borrower's primary or secondary employer. Default = PRIMARY |
endDate - Date
|
End date. A value of null indicates that the employment is current. |
incomePayType - IncomePayType
|
The type of pay (hourly or salaried) |
isCurrentEmployment - Boolean
|
Is the employment current? |
numberOfMonthsInLineOfWork - NonNegativeInt
|
The total number of months the borrower has been employed in this line of work, regardless of employer |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
position - String
|
A name or description of the employment position or job title |
startDate - Date
|
Start date |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerHasSpecialRelationshipWithEmployer": false,
"borrowerId": "4",
"employer": EmployerInput,
"employmentClassification": "PRIMARY",
"endDate": "2007-12-03",
"incomePayType": "HOURLY",
"isCurrentEmployment": false,
"numberOfMonthsInLineOfWork": 123,
"payPeriodFrequency": "ANNUALLY",
"position": "xyz789",
"startDate": "2007-12-03",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateStockAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": ["4"],
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["xyz789"]
}
CreateStockOptionsAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": ["4"],
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["xyz789"]
}
CreateSubjectPropertyInput
Description
Input to the createSubjectProperty mutation
Fields
| Input Field | Description |
|---|---|
address - AddressInput
|
US Address |
attachmentType - AttachmentEnum
|
Whether the property is physically attached to neighboring units |
dealId - ID!
|
The ID of the deal |
manuallyEstimatedValue - NonNegativeInt
|
The manually estimated value of the property |
propertyTaxesAndInsuranceIncludedInPayment - Boolean
|
Is Property taxes and insurance included in payment |
rentalEstimatedGrossMonthlyRentAmount - NonNegativeInt
|
The estimated gross monthly rent amount (for investment properties) |
Example
{
"address": AddressInput,
"attachmentType": "ATTACHED",
"dealId": "4",
"manuallyEstimatedValue": 123,
"propertyTaxesAndInsuranceIncludedInPayment": true,
"rentalEstimatedGrossMonthlyRentAmount": 123
}
CreateSubjectPropertyNetCashFlowIncomeInput
Description
Input for creating a SubjectPropertyNetCashFlowIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateSubjectPropertyResponse
Description
Response of the createSubjectProperty mutation
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the SubjectProperty that was created |
Example
{"id": 4}
CreateTemporaryLeaveIncomeInput
Description
Input for creating a TemporaryLeaveIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateTipIncomeInput
Description
Input for creating a TipIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateTrailingCoBorrowerIncomeInput
Description
Input for creating a TrailingCoBorrowerIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateTrustAccountAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
trusteeName - String
|
The legal name of the trustee |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": ["4"],
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["xyz789"],
"trusteeName": "abc123"
}
CreateTrustIncomeInput
Description
Input for creating a TrustIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateUnemploymentIncomeInput
Description
Input for creating an UnemploymentIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateVaBenefitsNonEducationalIncomeInput
Description
Input for creating a VaBenefitsNonEducationalIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
CreateWorkersCompensationIncomeInput
Description
Input for creating a WorkersCompensationIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
Credit
Description
Credit related fields
Fields
| Field Name | Description |
|---|---|
job - CreditPullJob
|
Credit pull job |
Arguments
|
|
report - CreditReport
|
Credit report |
Arguments
|
|
Example
{
"job": CreditPullJob,
"report": CreditReport
}
CreditBureau
Description
The name of a credit bureau
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"EQUIFAX"
CreditMutations
Description
Credit mutations
Fields
| Field Name | Description |
|---|---|
startIndividualCreditPullJob - StartIndividualCreditPullJobResponse
|
Start a hard credit pull for an individual |
Arguments |
|
startJointCreditPullJob - StartJointCreditPullJobResponse
|
Start a joint hard credit pull for a married couple of borrowers |
Arguments
|
|
Example
{
"startIndividualCreditPullJob": StartIndividualCreditPullJobResponse,
"startJointCreditPullJob": StartJointCreditPullJobResponse
}
CreditPullBorrowerInput
Description
Borrower with fields required for a credit pull
Fields
| Input Field | Description |
|---|---|
consentType - CreditPullConsentType
|
Credit pull consent type |
id - ID!
|
Borrower ID |
taxIdentifierNumber - String
|
Tax identifier number |
taxIdentifierNumberType - TaxIdentifierNumberType
|
Tax identifier number type |
Example
{
"consentType": "ELECTRONIC",
"id": 4,
"taxIdentifierNumber": "xyz789",
"taxIdentifierNumberType": "INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER"
}
CreditPullConsentType
Description
Credit pull consent type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ELECTRONIC"
CreditPullJob
Description
Credit pull job
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Job ID |
result - CreditReport
|
The credit report. This field will be populated only if the credit pull job status is SUCCEEDED. Otherwise it will be null. |
status - JobStatus!
|
Job status |
Example
{
"id": "4",
"result": CreditReport,
"status": "FAILED"
}
CreditPullType
Description
The type of credit pull performed on a borrower
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"HARD"
CreditReport
CreditScore
Description
An individual's credit score as reported by a specific credit bureau
Fields
| Field Name | Description |
|---|---|
bureau - CreditBureau!
|
|
score - Float!
|
Example
{"bureau": "EQUIFAX", "score": 987.65}
CustomMarketingRate
Description
Custom marketing rate
Fields
| Field Name | Description |
|---|---|
apr - Float!
|
|
discountPointsTotal - Float!
|
|
discountPointsTotalAmount - Int!
|
|
fipsCountyCode - String!
|
|
loanAmount - NonNegativeInt!
|
|
ltv - Float!
|
|
propertyUsageType - PropertyUsageType!
|
|
qualifyingFicoScore - Int!
|
|
rate - Float!
|
|
salesContractAmount - NonNegativeInt!
|
The amount of money that the property will be purchased for. Also called the purchase price. |
Example
{
"apr": 123.45,
"discountPointsTotal": 123.45,
"discountPointsTotalAmount": 987,
"fipsCountyCode": "xyz789",
"loanAmount": 123,
"ltv": 987.65,
"propertyUsageType": "INVESTMENT",
"qualifyingFicoScore": 987,
"rate": 987.65,
"salesContractAmount": 123
}
CustomMarketingRateInput
Description
Custom marketing rate input
Fields
| Input Field | Description |
|---|---|
fipsCountyCode - String!
|
The five-digit FIPS county code based on ANSI standard (INCITS 31:2009) |
loanAmount - NonNegativeInt!
|
Amount of the loan in dollars, also called principal |
loanTermYears - Float!
|
Loan term, in years. Default = 30 |
ltv - Float!
|
Loan to value ratio. Lower values get better rates. A typical value for a conforming conventional loan would be 0.8; values over that usually require mortgage insurance. |
maxDiscountPointsTotal - Float
|
Maximum total discount points. Default = 0 |
propertyUsageType - PropertyUsageType
|
|
qualifyingFicoScore - Int
|
FICO score used to determine loan eligibility and interest rate |
rateLockDays - Float!
|
How long to lock the rate, in days. Default = 30 |
Example
{
"fipsCountyCode": "xyz789",
"loanAmount": 123,
"loanTermYears": 123.45,
"ltv": 987.65,
"maxDiscountPointsTotal": 123.45,
"propertyUsageType": "INVESTMENT",
"qualifyingFicoScore": 987,
"rateLockDays": 123.45
}
CustomerPointAdjustment
Fields
| Field Name | Description |
|---|---|
costAbsorption - [CostAbsorption!]
|
The cost absorption from the customer on the loan |
costMultiplier - Float!
|
Determines if we should apply warehousing costs or not |
margin - Float
|
The margin from the customer on the loan |
Example
{
"costAbsorption": [CostAbsorption],
"costMultiplier": 987.65,
"margin": 987.65
}
Date
Description
A date string, such as 2007-12-03, compliant with the full-date format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
Example
"2007-12-03"
DateTime
Description
A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the date-time format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
Example
"2007-12-03T10:15:30Z"
Deal
Fields
| Field Name | Description |
|---|---|
borrowers - BorrowerConnection!
|
|
Arguments
|
|
creationTime - DateTime!
|
The time when the deal was created |
friendlyId - String!
|
An alternative ID that might be more aesthetically pleasing. |
id - ID!
|
Deal ID |
loans - [LoanApplication!]!
|
|
parties - [Party!]
|
|
Example
{
"borrowers": BorrowerConnection,
"creationTime": "2007-12-03T10:15:30Z",
"friendlyId": "abc123",
"id": "4",
"loans": [LoanApplication],
"parties": [Party]
}
DealConnection
Fields
| Field Name | Description |
|---|---|
edges - [DealEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [DealEdge],
"pageInfo": PageInfo
}
DealEdge
DealMutations
Fields
| Field Name | Description |
|---|---|
create - CreateDealResponse
|
Example
{"create": CreateDealResponse}
DebtToIncomeViolation
Description
Optimizer could not find a solution without exceeding the DTI limit.
Fields
| Field Name | Description |
|---|---|
debtExceededDollars - Float!
|
Minimum dollar amount needed in monthly debt reduction get to the allowed DTI. |
dti - Float!
|
Borrower's DTI in decimals, including this product. |
dtiLimit - Float!
|
Maximum allowed DTI in decimals, per the guidelines. |
increaseMonthlyIncome - Float!
|
Minimum dollar amount of extra monthly income needed to reach DTI limit. |
Example
{
"debtExceededDollars": 987.65,
"dti": 987.65,
"dtiLimit": 123.45,
"increaseMonthlyIncome": 987.65
}
DeclinedPreApprovalRun
Description
A declined pre-approval run
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
ineligibleProducts - [IneligibleProduct!]!
|
Example
{"id": 4, "ineligibleProducts": [IneligibleProduct]}
DefinedContributionPlanIncome
Description
Income from defined contribution plans
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
DeleteAssetInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the asset to delete |
Example
{"id": "4"}
DeleteAssetResponse
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the asset that was deleted |
Example
{"id": "4"}
DeleteBorrowerInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the borrower to delete |
Example
{"id": "4"}
DeleteBorrowerResponse
Description
Response of the delete borrower mutation.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
ID of the borrower that was deleted |
Example
{"id": 4}
DeleteFulfillmentPartyInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
DeleteFulfillmentPartyResponse
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
DeleteIncomeInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the income to delete |
Example
{"id": "4"}
DeleteIncomeResponse
Fields
| Field Name | Description |
|---|---|
id - ID!
|
ID of the deleted income |
Example
{"id": 4}
DeleteLiabilityInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Liability ID |
Example
{"id": "4"}
DeleteLiabilityResponse
Description
Response of the deleteLiability mutation.
Fields
| Field Name | Description |
|---|---|
id - ID
|
Liability ID |
userErrors - [GenericUserError!]!
|
Example
{
"id": "4",
"userErrors": [GenericUserError]
}
DeleteNonBorrowingOwnerInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
DeleteNonBorrowingOwnerResponse
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
DeleteNotableActivityInput
Description
Input to the deleteNotableActivity mutation.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the activity to delete |
Example
{"id": 4}
DeleteNotableActivityResponse
Description
Response of the deleteNotableActivity mutation.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the activity that was deleted |
Example
{"id": 4}
DeleteOrganizationRoleInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
DeleteOrganizationRoleResponse
Fields
| Field Name | Description |
|---|---|
deletedOrganizationRole - DeletedOrganizationRole!
|
Example
{"deletedOrganizationRole": DeletedOrganizationRole}
DeleteOrganizationStateLicensesInput
Fields
| Input Field | Description |
|---|---|
stateLicenses - [ID!]!
|
Example
{"stateLicenses": ["4"]}
DeleteOrganizationStateLicensesResponse
Fields
| Field Name | Description |
|---|---|
licensing - OrganizationLicensing
|
|
userErrors - [GenericUserError!]!
|
Example
{
"licensing": OrganizationLicensing,
"userErrors": [GenericUserError]
}
DeleteOrganizationUserInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
DeleteOrganizationUserResponse
Fields
| Field Name | Description |
|---|---|
deletedOrganizationUser - DeletedOrganizationUser!
|
Example
{"deletedOrganizationUser": DeletedOrganizationUser}
DeleteOwnedPropertyInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the owned property to delete |
Example
{"id": "4"}
DeleteOwnedPropertyResponse
Fields
| Field Name | Description |
|---|---|
id - ID!
|
ID of the deleted owned property |
Example
{"id": "4"}
DeletePartyInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
DeletePartyResponse
Fields
| Field Name | Description |
|---|---|
party - Party!
|
Example
{"party": Party}
DeletePreviousBorrowerAddressInput
Description
Delete previous borrower address Input
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Borrower Address ID |
Example
{"id": 4}
DeletePreviousBorrowerAddressResponse
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Borrower Address ID |
Example
{"id": 4}
DeletedOrganizationRole
Fields
| Field Name | Description |
|---|---|
name - String!
|
Example
{"name": "abc123"}
DeletedOrganizationUser
DemographicInfo
Description
Demographic information
Fields
| Field Name | Description |
|---|---|
asianOther - String
|
|
asianRace - [AsianRace!]
|
|
ethnicity - [Ethnicity!]
|
|
ethnicityNotDisclosed - Boolean
|
|
hispanicOrigin - [HispanicOrigin!]
|
|
hispanicOther - String
|
|
pacificIslanderOther - String
|
|
pacificIslanderRace - [PacificIslanderRace!]
|
|
race - [Race!]
|
|
raceNotDisclosed - Boolean
|
|
sex - [Sex!]
|
|
sexNotDisclosed - Boolean
|
|
tribe - String
|
Example
{
"asianOther": "xyz789",
"asianRace": ["CHINESE"],
"ethnicity": ["HISPANIC"],
"ethnicityNotDisclosed": true,
"hispanicOrigin": ["CUBA"],
"hispanicOther": "abc123",
"pacificIslanderOther": "abc123",
"pacificIslanderRace": ["GUAMANIAN_OR_CHAMORRO"],
"race": ["AM_INDIAN_ALASKAN"],
"raceNotDisclosed": true,
"sex": ["FEMALE"],
"sexNotDisclosed": false,
"tribe": "abc123"
}
DenyRateLockInput
Description
Input to the denyRateLock mutation.
Fields
| Input Field | Description |
|---|---|
loanId - ID!
|
The ID or friendly ID of the loan. |
Example
{"loanId": "4"}
DenyRateLockResponse
Description
Response of the denyRateLock mutation.
Fields
| Field Name | Description |
|---|---|
loanId - ID!
|
The ID or friendly ID of the loan. |
Example
{"loanId": "4"}
DetachBorrowerAssetInput
DetachBorrowerAssetResponse
Description
Response of the detachBorrowerAsset mutation.
Fields
| Field Name | Description |
|---|---|
asset - Asset!
|
The asset that was updated |
Example
{"asset": Asset}
DetachBorrowerLiabilitiesInput
DetachBorrowerLiabilitiesResponse
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The updated Borrower |
Example
{"borrower": Borrower}
DetachContributorFromDealInput
DetachContributorFromDealResponse
Fields
| Field Name | Description |
|---|---|
contributor - Contributor!
|
|
deal - Deal!
|
Example
{
"contributor": Contributor,
"deal": Deal
}
DetachLoanContactInput
DetachLoanContactResponse
Description
Response of the loan.detachContact mutation.
Fields
| Field Name | Description |
|---|---|
contact - Contact!
|
The contact that was successfully detached from the loan. |
Example
{"contact": Contact}
DetachOwnedPropertyLiabilitiesInput
DetachOwnedPropertyLiabilitiesResponse
Fields
| Field Name | Description |
|---|---|
ownedProperty - OwnedProperty!
|
The updated OwnedPropertyIntent |
Example
{"ownedProperty": OwnedProperty}
DetachSubjectPropertyAddressInput
Description
Input to the detachSubjectPropertyAddress mutation.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the subject property from which the address should be detached |
Example
{"id": "4"}
DetachSubjectPropertyAddressResponse
Description
Response of the detachSubjectPropertyAddress mutation.
Fields
| Field Name | Description |
|---|---|
subjectProperty - SubjectProperty!
|
The SubjectProperty that was updated |
Example
{"subjectProperty": SubjectProperty}
DetachSubjectPropertyLiabilitiesInput
DetachSubjectPropertyLiabilitiesResponse
Fields
| Field Name | Description |
|---|---|
subjectProperty - SubjectProperty!
|
The updated SubjectProperty |
Example
{"subjectProperty": SubjectProperty}
DisabilityIncome
Description
Disability income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
DisableContributorInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
DisableContributorResponse
Fields
| Field Name | Description |
|---|---|
contributor - Contributor!
|
Example
{"contributor": Contributor}
Disclosure
Fields
| Field Name | Description |
|---|---|
completedOn - DateTime
|
|
documentLinks - [DocumentLink!]
|
|
id - ID!
|
The ID of the disclosure. |
packageType - DisclosurePackageType!
|
|
provider - String!
|
|
receivedOn - DateTime
|
|
recipients - [DisclosureRecipient!]
|
|
sentOn - DateTime
|
|
status - DisclosureStatus
|
Example
{
"completedOn": "2007-12-03T10:15:30Z",
"documentLinks": [DocumentLink],
"id": "4",
"packageType": "ADVERSE_ACTION",
"provider": "abc123",
"receivedOn": "2007-12-03T10:15:30Z",
"recipients": [DisclosureRecipient],
"sentOn": "2007-12-03T10:15:30Z",
"status": "CANCELLED"
}
DisclosureLink
DisclosurePackageType
Description
Stage of a disclosure package.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ADVERSE_ACTION"
DisclosurePreview
Fields
| Field Name | Description |
|---|---|
createdOn - DateTime
|
|
documentLinks - [DocumentLink!]
|
Example
{
"createdOn": "2007-12-03T10:15:30Z",
"documentLinks": [DocumentLink]
}
DisclosureRecipient
Description
A recipient of a disclosure package.
Fields
| Field Name | Description |
|---|---|
displayName - String
|
The full name of the disclosure recipient. |
email - String
|
The email address of the disclosure recipient. |
link - DisclosureLink!
|
Link with access information for the disclosure recipient. |
signed - Boolean!
|
Indicates whether the recipient has signed the disclosure. |
type - DisclosureRecipientType
|
The enum type of the disclosure recipient. |
Example
{
"displayName": "xyz789",
"email": "abc123",
"link": DisclosureLink,
"signed": false,
"type": "BORROWER"
}
DisclosureRecipientType
Description
Type of a recipient of a disclosure package.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"BORROWER"
DisclosureStatus
Description
The status of a disclosure package.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CANCELLED"
Disclosures
Fields
| Field Name | Description |
|---|---|
adverseAction - Disclosure
|
|
closingDisclosure - Disclosure
|
|
initialDisclosure - Disclosure
|
|
redisclosure - Disclosure
|
Example
{
"adverseAction": Disclosure,
"closingDisclosure": Disclosure,
"initialDisclosure": Disclosure,
"redisclosure": Disclosure
}
DisclosuresHistory
Fields
| Field Name | Description |
|---|---|
disclosures - [Disclosure!]!
|
Example
{"disclosures": [Disclosure]}
DisclosuresPreviews
Fields
| Field Name | Description |
|---|---|
adverseAction - DisclosurePreview
|
|
closingDisclosure - DisclosurePreview
|
|
initialDisclosure - DisclosurePreview
|
|
redisclosure - DisclosurePreview
|
Example
{
"adverseAction": DisclosurePreview,
"closingDisclosure": DisclosurePreview,
"initialDisclosure": DisclosurePreview,
"redisclosure": DisclosurePreview
}
DividendsInterestIncome
Description
Dividends interest income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
Document
Description
Represents a document entity that groups one or more related files.
Fields
| Field Name | Description |
|---|---|
associatedEntities - [DocumentEntity!]!
|
The entities (like borrowers) associated with this document. |
category - String!
|
The category of the document, such as Borrower, Credit, or Disclosure. |
documentLink - DocumentLink!
|
The link corresponding to the document. |
id - ID!
|
The ID of the document. |
name - String!
|
The display name of the document. |
uploadedAt - DateTime!
|
The date and time the document was uploaded. |
Example
{
"associatedEntities": [DocumentEntity],
"category": "abc123",
"documentLink": DocumentLink,
"id": 4,
"name": "abc123",
"uploadedAt": "2007-12-03T10:15:30Z"
}
DocumentEntity
Description
Represents an entity (like a borrower) that is associated with a document.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique identifier of the entity. |
kind - DocumentEntityKind!
|
The type of entity this represents (e.g., BORROWER). |
Example
{"id": "4", "kind": "APPRAISAL"}
DocumentEntityKind
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"APPRAISAL"
DocumentLink
Fields
| Field Name | Description |
|---|---|
id - String
|
|
title - String!
|
|
uploadStatus - DocumentUploadStatus
|
|
url - String!
|
Example
{
"id": "abc123",
"title": "abc123",
"uploadStatus": "COMPLETE",
"url": "xyz789"
}
DocumentRequiredCondition
Fields
| Field Name | Description |
|---|---|
numberOfRequiredDocumentTypes - Int
|
|
requireDistinctDocumentTypes - Boolean
|
|
requiredDocumentTypes - [DocumentType!]!
|
Example
{
"numberOfRequiredDocumentTypes": 123,
"requireDistinctDocumentTypes": true,
"requiredDocumentTypes": [DocumentType]
}
DocumentType
DocumentUploadStatus
Description
The status of a document upload.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COMPLETE"
EligiblePreQualification
Fields
| Field Name | Description |
|---|---|
apr - Float!
|
|
discountPointsTotal - Float!
|
|
discountPointsTotalAmount - Int!
|
|
loanAmount - NonNegativeInt!
|
|
ltv - Float!
|
|
rate - Float!
|
|
salesContractAmount - NonNegativeInt!
|
Example
{
"apr": 123.45,
"discountPointsTotal": 987.65,
"discountPointsTotalAmount": 987,
"loanAmount": 123,
"ltv": 123.45,
"rate": 987.65,
"salesContractAmount": 123
}
EligibleProductPricing
Fields
| Field Name | Description |
|---|---|
adjustableRateDetail - ProductPricingAdjustableRateDetail
|
If non-null, this product represents an adjustable rate |
id - ID
|
The unique ID of this product pricing result. |
lock - PositiveInt!
|
The number of days this rate can be locked for. |
product - Product!
|
The product to which these calculations apply. |
publishedOn - Date!
|
The date that rates for this product were published. |
rateStack - [StructuringResult!]!
|
|
rates - [ProductPricingRate!]!
|
A list of rates available for this loan. The first rate in the list is the best rate available given the provided points buy. Each subsequent rate is better but requires additional points buy in order for the borrower to qualify. |
term - PositiveInt!
|
The term of the loan being considered in years. |
Example
{
"adjustableRateDetail": ProductPricingAdjustableRateDetail,
"id": "4",
"lock": 123,
"product": Product,
"publishedOn": "2007-12-03",
"rateStack": [EligibleProductStructure],
"rates": [ProductPricingRate],
"term": 123
}
EligibleProductStructure
Fields
| Field Name | Description |
|---|---|
adjustments - [ProductPricingAdjustment!]!
|
All adjustments that apply to this product, rate, and deal. |
apor - ProductPricingApor!
|
The published APOR for a comparible mortgage at the time of this pricing run. |
apr - Float!
|
The APR with this rate applied as a percentage. |
cashFromToBorrower - Float!
|
The net change in cash from/to the borrower at closing. |
cashOutAmount - NonNegativeFloat!
|
The cash out amount. |
cashOutType - RefinanceCashOutType!
|
The cash out type. |
closingCosts - Float!
|
The closing costs for this rate. Currently, this is only an estimate-- things like title fees are difficult to correctly compute, but this should be a good approximation. |
concessionPoints - NonNegativeFloat!
|
The concessions being applied to the rate cost in this scenario, in points. |
downPaymentAmount - NonNegativeFloat!
|
The down payment on a property. |
dti - NonNegativeFloat!
|
The debt-to-income ratio of the borrowers with the PITIA for this rate taken into account. |
floodInsurance - NonNegativeFloat!
|
The cost of flood insurance. |
id - ID
|
The unique ID of this product pricing result. |
interest - PositiveInt!
|
The total interest over the life of the loan, in dollars, with this rate applied. |
loanTermYears - PositiveInt!
|
The term length of the loan, in years |
lock - PositiveInt!
|
The number of days this rate can be locked for. |
ltv - Float!
|
The ratio of the loan amount to the total value of the property, expressed as a percentage |
monthlyPayment - NonNegativeFloat!
|
The monthly mortgage payment (PITIA) of a loan at this rate. |
mortgageInsurance - NonNegativeFloat!
|
The cost of mandatory mortgage insurance each month. |
pitia - Pitia!
|
Breakdown of the monthly payment for this rate. |
pointsCost - NonNegativeFloat!
|
The cost, in dollars, to buy enough points in order to qualify for a better rate. |
pointsNeeded - NonNegativeFloat!
|
The number of additional points that must be purchased in order to qualify for this rate. |
prepaidInterestDailyAmount - NonNegativeFloat!
|
The amount of prepaid interest paid per day before closing, |
prepaidInterestDaysPaid - NonNegativeFloat!
|
The number of days' worth of prepaid interest to be paid at closing, |
prepaidInterestTotalAmount - NonNegativeFloat!
|
The total dollar amount of prepaid interest due at closing, |
principal - PositiveFloat!
|
The total principal, in dollars, of the loan with this rate applied. |
product - Product!
|
The product to which these calculations apply. |
publishedOn - Date!
|
The date that rates for this product were published. |
rate - Float!
|
The interest rate as a percentage. |
rateId - ID!
|
The ID of the rate. |
ratePoints - Float!
|
The cost, in points, of this rate. |
totalCost - Float!
|
The total cost after adjustments for this rate. Can be negative if the rate is below par. |
totalPoints - Float!
|
The total number of points after adjustments for this rate. |
Example
{
"adjustments": [ProductPricingAdjustment],
"apor": ProductPricingApor,
"apr": 123.45,
"cashFromToBorrower": 987.65,
"cashOutAmount": 123.45,
"cashOutType": "CASH_OUT",
"closingCosts": 987.65,
"concessionPoints": 123.45,
"downPaymentAmount": 123.45,
"dti": 123.45,
"floodInsurance": 123.45,
"id": 4,
"interest": 123,
"loanTermYears": 123,
"lock": 123,
"ltv": 987.65,
"monthlyPayment": 123.45,
"mortgageInsurance": 123.45,
"pitia": Pitia,
"pointsCost": 123.45,
"pointsNeeded": 123.45,
"prepaidInterestDailyAmount": 123.45,
"prepaidInterestDaysPaid": 123.45,
"prepaidInterestTotalAmount": 123.45,
"principal": 123.45,
"product": Product,
"publishedOn": "2007-12-03",
"rate": 987.65,
"rateId": 4,
"ratePoints": 123.45,
"totalCost": 123.45,
"totalPoints": 123.45
}
Employer
Description
Employer
Fields
| Field Name | Description |
|---|---|
address - Address
|
Employer's address |
contact - EmployerContact
|
Employer contact |
id - ID!
|
Employer ID |
name - String!
|
Name of the employer |
Example
{
"address": Address,
"contact": EmployerContact,
"id": 4,
"name": "abc123"
}
EmployerContact
EmployerContactInput
EmployerInput
Description
Employer input
Fields
| Input Field | Description |
|---|---|
address - AddressInput
|
Employer's address |
contact - EmployerContactInput
|
Employer contact |
name - String
|
Name of the employer |
Example
{
"address": AddressInput,
"contact": EmployerContactInput,
"name": "xyz789"
}
Employment
Description
Employment interface
Fields
| Field Name | Description |
|---|---|
employmentClassification - EmploymentClassificationType!
|
Whether this is the borrower's primary or secondary employer |
endDate - Date
|
End date. Will be null if the employment is current. |
id - ID!
|
Employment ID |
isCurrentEmployment - Boolean!
|
Is the employment current? |
numberOfMonthsInLineOfWork - NonNegativeInt
|
The total number of months the borrower has been employed in this line of work, regardless of employer |
position - String
|
A name or description of the employment position or job title |
startDate - Date
|
Start date |
Possible Types
| Employment Types |
|---|
Example
{
"employmentClassification": "PRIMARY",
"endDate": "2007-12-03",
"id": 4,
"isCurrentEmployment": false,
"numberOfMonthsInLineOfWork": 123,
"position": "xyz789",
"startDate": "2007-12-03"
}
EmploymentClassificationType
Description
Whether this is the borrower's primary or secondary employer
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PRIMARY"
EmploymentIncome
Description
Interface for employment incomes types
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
employment - Employment!
|
The associated employment |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Possible Types
| EmploymentIncome Types |
|---|
Example
{
"borrower": Borrower,
"employment": Employment,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
EmploymentRelatedAccountIncome
Description
Income from employment-related accounts
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
EnableContributorInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
EnableContributorResponse
Fields
| Field Name | Description |
|---|---|
contributor - Contributor!
|
Example
{"contributor": Contributor}
EscrowItemType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ASSESSMENT_TAX"
Ethnicity
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"HISPANIC"
ExpiredCreditPullError
Description
User error indicating that credit pulls are expired for one or more borrowers
Fields
| Field Name | Description |
|---|---|
message - String!
|
Example
{"message": "abc123"}
Fee
Fields
| Field Name | Description |
|---|---|
escrowItemType - EscrowItemType
|
|
feeActualTotalAmount - NonNegativeInt
|
|
feeDescription - String
|
|
feePaidToType - FeePaidToType
|
|
feePayments - [FeePayment!]
|
|
feeType - FeeType
|
|
id - ID!
|
|
integratedDisclosureSectionType - IntegratedDisclosureSectionType
|
|
monthlyAmount - NonNegativeInt
|
|
monthsPaid - NonNegativeInt
|
|
paidTo - PaidTo
|
|
prepaidItemType - PrepaidItemType
|
Example
{
"escrowItemType": "ASSESSMENT_TAX",
"feeActualTotalAmount": 123,
"feeDescription": "abc123",
"feePaidToType": "BROKER",
"feePayments": [FeePayment],
"feeType": "APPLICATION_FEE",
"id": "4",
"integratedDisclosureSectionType": "DUE_FROM_BORROWER_AT_CLOSING",
"monthlyAmount": 123,
"monthsPaid": 123,
"paidTo": PaidTo,
"prepaidItemType": "BOROUGH_PROPERTY_TAX"
}
FeePaidToType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BROKER"
FeePayment
Fields
| Field Name | Description |
|---|---|
feeActualTotalAmount - NonNegativeInt
|
|
feePaymentPaidByType - FeePaymentPaidByTypeEnum
|
|
feePaymentPaidOutsideOfClosingIndicator - Boolean
|
|
feePaymentResponsiblePartyType - FeePaymentResponsiblePartyType
|
|
paymentIncludedInAprIndicator - Boolean
|
Example
{
"feeActualTotalAmount": 123,
"feePaymentPaidByType": "BORROWER",
"feePaymentPaidOutsideOfClosingIndicator": false,
"feePaymentResponsiblePartyType": "BRANCH",
"paymentIncludedInAprIndicator": true
}
FeePaymentPaidByTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BORROWER"
FeePaymentResponsiblePartyType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BRANCH"
FeeSheetInput
FeeSheetResponse
Description
Response of the feeSheet mutation.
Fields
| Field Name | Description |
|---|---|
url - String
|
A download URL for a fee sheet |
Example
{"url": "abc123"}
FeeType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"APPLICATION_FEE"
FhaMarketingRate
Description
FHA marketing rate
Fields
| Field Name | Description |
|---|---|
apr - Float!
|
|
discountPointsTotal - Float!
|
|
discountPointsTotalAmount - Int!
|
|
fipsCountyCode - String!
|
|
loanAmount - NonNegativeInt!
|
|
ltv - Float!
|
|
propertyUsageType - PropertyUsageType!
|
|
qualifyingFicoScore - Int!
|
|
rate - Float!
|
|
salesContractAmount - NonNegativeInt!
|
The amount of money that the property will be purchased for. Also called the purchase price. |
Example
{
"apr": 123.45,
"discountPointsTotal": 987.65,
"discountPointsTotalAmount": 123,
"fipsCountyCode": "xyz789",
"loanAmount": 123,
"ltv": 987.65,
"propertyUsageType": "INVESTMENT",
"qualifyingFicoScore": 123,
"rate": 987.65,
"salesContractAmount": 123
}
FhaMarketingRateInput
Description
FHA marketing rate input
Fields
| Input Field | Description |
|---|---|
fipsCountyCode - String!
|
The five-digit FIPS county code based on ANSI standard (INCITS 31:2009) |
loanAmount - NonNegativeInt!
|
Amount of the loan in dollars, also called principal |
loanTermYears - Float!
|
Loan term, in years. Default = 30 |
ltv - Float!
|
Loan to value ratio. Lower values get better rates. A typical value for a conforming conventional loan would be 0.8; values over that usually require mortgage insurance. |
maxDiscountPointsTotal - Float
|
Maximum total discount points. Default = 0 |
propertyUsageType - PropertyUsageType
|
|
qualifyingFicoScore - Int
|
FICO score used to determine loan eligibility and interest rate |
rateLockDays - Float!
|
How long to lock the rate, in days. Default = 30 |
Example
{
"fipsCountyCode": "abc123",
"loanAmount": 123,
"loanTermYears": 123.45,
"ltv": 123.45,
"maxDiscountPointsTotal": 987.65,
"propertyUsageType": "INVESTMENT",
"qualifyingFicoScore": 987,
"rateLockDays": 987.65
}
FinancialAccountActivity
Description
Activity associated with a financial account asset
Fields
| Field Name | Description |
|---|---|
activityType - FinancialAccountActivityType
|
Activity type |
amount - Int
|
The amount of money in dollars |
date - Date
|
The date when the activity occurred |
description - String
|
Description of the activity |
id - ID!
|
The ID of the FinancialAccountActivity |
Example
{
"activityType": "LARGE_DEPOSIT",
"amount": 987,
"date": "2007-12-03",
"description": "abc123",
"id": "4"
}
FinancialAccountActivityType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"LARGE_DEPOSIT"
FinancialAccountAsset
Description
Interface for financial account assets
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset |
id - ID!
|
Asset ID |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
Possible Types
| FinancialAccountAsset Types |
|---|
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": ["4"],
"id": "4",
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["abc123"],
"notableActivities": [FinancialAccountActivity]
}
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
123.45
FosterCareIncome
Description
Foster care income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
FreezeLoanInput
Description
Input to the freeze mutation.
Fields
| Input Field | Description |
|---|---|
loanId - ID!
|
The ID or friendly ID of the loan. |
Example
{"loanId": "4"}
FreezeLoanResponse
Description
Response of the freeze mutation.
Fields
| Field Name | Description |
|---|---|
loan - Loan!
|
The loan |
Example
{"loan": Loan}
FulfillmentParty
Description
FulfillmentParty
Fields
| Field Name | Description |
|---|---|
companyId - ID
|
The ID of the associated company |
fulfillmentParty - FulfillmentParty
|
|
id - ID!
|
The ID of the FulfillmentParty |
role - FulfillmentPartyRole
|
The role of the fulfillment party |
Example
{
"companyId": 4,
"fulfillmentParty": FulfillmentParty,
"id": "4",
"role": "NOTARY"
}
FulfillmentPartyMutations
Description
FulfillmentParty mutations
Fields
| Field Name | Description |
|---|---|
create - CreateFulfillmentPartyResponse
|
|
Arguments
|
|
delete - DeleteFulfillmentPartyResponse
|
|
Arguments
|
|
Example
{
"create": CreateFulfillmentPartyResponse,
"delete": DeleteFulfillmentPartyResponse
}
FulfillmentPartyRole
Description
The role of the fulfillment party
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"NOTARY"
GenericUserError
Description
Generic user error
Fields
| Field Name | Description |
|---|---|
message - String!
|
Example
{"message": "abc123"}
Geography
GiftAsset
Description
Gift asset
Fields
| Field Name | Description |
|---|---|
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset |
dateOfTransfer - Date
|
The date when the gift/grant funds were transferred into the borrower's account |
donorEmployeeIdentificationNumber - String
|
Employer Identification Number (EIN) of the gift/grant donor |
donorName - String
|
Full name of the person providing the gift/grant |
donorPhoneNumber - String
|
The phone number of the person providing the gift/grant |
id - ID!
|
Asset ID |
isIncludedInAssetAccount - Boolean
|
Indicates whether the gift/grant funds have already been included as part of an asset account considered for the loan |
isSellerFunded - Boolean
|
Indicates whether the gift/grant is funded by the seller |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
source - GiftSource
|
Gift/Grant source |
Example
{
"amount": 123,
"borrowerIds": [4],
"dateOfTransfer": "2007-12-03",
"donorEmployeeIdentificationNumber": "xyz789",
"donorName": "abc123",
"donorPhoneNumber": "xyz789",
"id": "4",
"isIncludedInAssetAccount": false,
"isSellerFunded": true,
"nonBorrowerOwnerNames": ["abc123"],
"source": "COMMUNITY_NON_PROFIT"
}
GiftOrGrantAsset
Description
Interface for gift or grant assets
Fields
| Field Name | Description |
|---|---|
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset |
dateOfTransfer - Date
|
The date when the gift/grant funds were transferred into the borrower's account |
donorEmployeeIdentificationNumber - String
|
Employer Identification Number (EIN) of the gift/grant donor |
donorName - String
|
Full name of the person providing the gift/grant |
donorPhoneNumber - String
|
The phone number of the person providing the gift/grant |
id - ID!
|
Asset ID |
isIncludedInAssetAccount - Boolean
|
Indicates whether the gift/grant funds have already been included as part of an asset account considered for the loan |
isSellerFunded - Boolean
|
Indicates whether the gift/grant is funded by the seller |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
source - GiftSource
|
Gift/Grant source |
Possible Types
| GiftOrGrantAsset Types |
|---|
Example
{
"amount": 123,
"borrowerIds": ["4"],
"dateOfTransfer": "2007-12-03",
"donorEmployeeIdentificationNumber": "xyz789",
"donorName": "xyz789",
"donorPhoneNumber": "abc123",
"id": 4,
"isIncludedInAssetAccount": true,
"isSellerFunded": true,
"nonBorrowerOwnerNames": ["xyz789"],
"source": "COMMUNITY_NON_PROFIT"
}
GiftSource
Description
Gift/Grant source
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"COMMUNITY_NON_PROFIT"
GlobalLoanOfficer
GrantAsset
Description
Grant asset
Fields
| Field Name | Description |
|---|---|
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset |
dateOfTransfer - Date
|
The date when the gift/grant funds were transferred into the borrower's account |
donorEmployeeIdentificationNumber - String
|
Employer Identification Number (EIN) of the gift/grant donor |
donorName - String
|
Full name of the person providing the gift/grant |
donorPhoneNumber - String
|
The phone number of the person providing the gift/grant |
id - ID!
|
Asset ID |
isIncludedInAssetAccount - Boolean
|
Indicates whether the gift/grant funds have already been included as part of an asset account considered for the loan |
isSellerFunded - Boolean
|
Indicates whether the gift/grant is funded by the seller |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
source - GiftSource
|
Gift/Grant source |
Example
{
"amount": 123,
"borrowerIds": [4],
"dateOfTransfer": "2007-12-03",
"donorEmployeeIdentificationNumber": "abc123",
"donorName": "xyz789",
"donorPhoneNumber": "abc123",
"id": 4,
"isIncludedInAssetAccount": true,
"isSellerFunded": true,
"nonBorrowerOwnerNames": ["abc123"],
"source": "COMMUNITY_NON_PROFIT"
}
GuidelineViolation
Description
Represents a violation of a prescription in a guideline document.
Fields
| Field Name | Description |
|---|---|
constraint - String
|
If a violated constraint is found, this is a serialized representation of said constraint. For internal use at Pylon; this field has no guarantees. |
description - String
|
A human-readable description of the encoded guideline. |
document - String
|
The URL for the specific guideline document or the specific section. |
pages - PageRange
|
For document-based guidelines, the page numbers on which a set of guidelines falls. |
section - String
|
The section number and title of the violated guideline. |
updatedAt - Date
|
The last date that Pylon's model was updated to match the guideline document. |
Example
{
"constraint": "xyz789",
"description": "xyz789",
"document": "xyz789",
"pages": PageRange,
"section": "xyz789",
"updatedAt": "2007-12-03"
}
HazardInsuranceCoverageType
Description
Coverage provided by a hazard insurer
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EARTHQUAKE"
HispanicOrigin
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CUBA"
HmdaDispositionCode
Description
Code for the HMDA action taken on a loan application.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"APPLICATION_APPROVED_BUT_NOT_ACCEPTED"
HousingAllowanceIncome
Description
Housing allowance income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
HousingChoiceVoucherProgramIncome
Description
Housing Choice Voucher Program income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
4
Income
Description
Income interface
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Possible Types
| Income Types |
|---|
Example
{
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
IncomeConnection
Fields
| Field Name | Description |
|---|---|
edges - [IncomeEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [IncomeEdge],
"pageInfo": PageInfo
}
IncomeEdge
IncomeMutations
Fields
| Field Name | Description |
|---|---|
create - CreateIncomeResponse
|
Create an income. The input is a 'oneOf' type where exactly one field must be populated. The type of income to be created depends on which input field is populated. Example: If socialSecurity is populated, a SocialSecurityIncome entity will be created. |
Arguments
|
|
delete - DeleteIncomeResponse
|
Delete an income |
Arguments
|
|
update - UpdateIncomeResponse
|
Update income. |
Arguments
|
|
Example
{
"create": CreateIncomeResponse,
"delete": DeleteIncomeResponse,
"update": UpdateIncomeResponse
}
IncomePayType
Description
The type of pay for the income (hourly or salaried)
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"HOURLY"
IndividualDevelopmentAccountAsset
Description
Individual development account asset
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset |
id - ID!
|
Asset ID |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": [4],
"id": "4",
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["xyz789"],
"notableActivities": [FinancialAccountActivity]
}
IneligibilityDetails
Description
Information providing extra detail as to why a borrower is ineligible for a loan-product.
Example
DebtToIncomeViolation
IneligiblePreQualification
Fields
| Field Name | Description |
|---|---|
details - [IneligibilityDetails!]!
|
Example
{"details": [DebtToIncomeViolation]}
IneligibleProduct
Fields
| Field Name | Description |
|---|---|
details - [IneligibilityDetails!]!
|
|
product - Product!
|
Example
{
"details": [DebtToIncomeViolation],
"product": Product
}
IneligibleProductPricing
Fields
| Field Name | Description |
|---|---|
adjustableRateDetail - ProductPricingAdjustableRateDetail
|
If non-null, this product represents an adjustable rate |
details - [IneligibilityDetails!]!
|
|
id - ID
|
The unique ID of this product pricing result. |
lock - PositiveInt!
|
The number of days this rate can be locked for. |
product - Product!
|
The product to which these calculations apply. |
publishedOn - Date!
|
The date that rates for this product were published. |
term - PositiveInt!
|
The term of the loan being considered in years. |
Example
{
"adjustableRateDetail": ProductPricingAdjustableRateDetail,
"details": [DebtToIncomeViolation],
"id": "4",
"lock": 123,
"product": Product,
"publishedOn": "2007-12-03",
"term": 123
}
IneligibleProductStructure
Fields
| Field Name | Description |
|---|---|
adjustments - [ProductPricingAdjustment!]!
|
All adjustments that apply to this product, rate, and deal. |
apor - ProductPricingApor!
|
The published APOR for a comparible mortgage at the time of this pricing run. |
apr - Float!
|
The APR with this rate applied as a percentage. |
cashFromToBorrower - Float!
|
The net change in cash from/to the borrower at closing. |
cashOutAmount - NonNegativeFloat!
|
The cash out amount. |
cashOutType - RefinanceCashOutType!
|
The cash out type. |
closingCosts - Float!
|
The closing costs for this rate. Currently, this is only an estimate-- things like title fees are difficult to correctly compute, but this should be a good approximation. |
concessionPoints - NonNegativeFloat!
|
The concessions being applied to the rate cost in this scenario, in points. |
downPaymentAmount - NonNegativeFloat!
|
The down payment on a property. |
dti - NonNegativeFloat!
|
The debt-to-income ratio of the borrowers with the PITIA for this rate taken into account. |
floodInsurance - NonNegativeFloat!
|
The cost of flood insurance. |
id - ID
|
The unique ID of this product pricing result. |
ineligibilityDetails - [ProductStructureIneligibilityDetails!]!
|
|
interest - PositiveInt!
|
The total interest over the life of the loan, in dollars, with this rate applied. |
loanTermYears - PositiveInt!
|
The term length of the loan, in years |
lock - PositiveInt!
|
The number of days this rate can be locked for. |
ltv - Float!
|
The ratio of the loan amount to the total value of the property, expressed as a percentage |
monthlyPayment - NonNegativeFloat!
|
The monthly mortgage payment (PITIA) of a loan at this rate. |
mortgageInsurance - NonNegativeFloat!
|
The cost of mandatory mortgage insurance each month. |
pitia - Pitia!
|
Breakdown of the monthly payment for this rate. |
pointsCost - NonNegativeFloat!
|
The cost, in dollars, to buy enough points in order to qualify for a better rate. |
pointsNeeded - NonNegativeFloat!
|
The number of additional points that must be purchased in order to qualify for this rate. |
prepaidInterestDailyAmount - NonNegativeFloat!
|
The amount of prepaid interest paid per day before closing, |
prepaidInterestDaysPaid - NonNegativeFloat!
|
The number of days' worth of prepaid interest to be paid at closing, |
prepaidInterestTotalAmount - NonNegativeFloat!
|
The total dollar amount of prepaid interest due at closing, |
principal - PositiveFloat!
|
The total principal, in dollars, of the loan with this rate applied. |
product - Product!
|
The product to which these calculations apply. |
publishedOn - Date!
|
The date that rates for this product were published. |
rate - Float!
|
The interest rate as a percentage. |
rateId - ID!
|
The ID of the rate. |
ratePoints - Float!
|
The cost, in points, of this rate. |
totalCost - Float!
|
The total cost after adjustments for this rate. Can be negative if the rate is below par. |
totalPoints - Float!
|
The total number of points after adjustments for this rate. |
Example
{
"adjustments": [ProductPricingAdjustment],
"apor": ProductPricingApor,
"apr": 987.65,
"cashFromToBorrower": 123.45,
"cashOutAmount": 123.45,
"cashOutType": "CASH_OUT",
"closingCosts": 987.65,
"concessionPoints": 123.45,
"downPaymentAmount": 123.45,
"dti": 123.45,
"floodInsurance": 123.45,
"id": 4,
"ineligibilityDetails": [DebtToIncomeViolation],
"interest": 123,
"loanTermYears": 123,
"lock": 123,
"ltv": 987.65,
"monthlyPayment": 123.45,
"mortgageInsurance": 123.45,
"pitia": Pitia,
"pointsCost": 123.45,
"pointsNeeded": 123.45,
"prepaidInterestDailyAmount": 123.45,
"prepaidInterestDaysPaid": 123.45,
"prepaidInterestTotalAmount": 123.45,
"principal": 123.45,
"product": Product,
"publishedOn": "2007-12-03",
"rate": 987.65,
"rateId": "4",
"ratePoints": 123.45,
"totalCost": 987.65,
"totalPoints": 123.45
}
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
123
IntegratedDisclosureSectionType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DUE_FROM_BORROWER_AT_CLOSING"
Job
Description
Job interface
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Job ID |
status - JobStatus!
|
Job status |
Possible Types
| Job Types |
|---|
Example
{"id": "4", "status": "FAILED"}
JobStatus
Description
Job status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"FAILED"
JumboMarketingRate
Description
Jumbo marketing rate
Fields
| Field Name | Description |
|---|---|
apr - Float!
|
|
discountPointsTotal - Float!
|
|
discountPointsTotalAmount - Int!
|
|
fipsCountyCode - String!
|
|
loanAmount - NonNegativeInt!
|
|
ltv - Float!
|
|
propertyUsageType - PropertyUsageType!
|
|
qualifyingFicoScore - Int!
|
|
rate - Float!
|
|
salesContractAmount - NonNegativeInt!
|
The amount of money that the property will be purchased for. Also called the purchase price. |
Example
{
"apr": 123.45,
"discountPointsTotal": 123.45,
"discountPointsTotalAmount": 987,
"fipsCountyCode": "abc123",
"loanAmount": 123,
"ltv": 123.45,
"propertyUsageType": "INVESTMENT",
"qualifyingFicoScore": 123,
"rate": 123.45,
"salesContractAmount": 123
}
JumboMarketingRateInput
Description
Jumbo marketing rate input
Fields
| Input Field | Description |
|---|---|
fipsCountyCode - String!
|
The five-digit FIPS county code based on ANSI standard (INCITS 31:2009) |
loanAmount - NonNegativeInt!
|
Amount of the loan in dollars, also called principal |
loanTermYears - Float!
|
Loan term, in years. Default = 30 |
ltv - Float!
|
Loan to value ratio. Lower values get better rates. A typical value for a conforming conventional loan would be 0.8; values over that usually require mortgage insurance. |
maxDiscountPointsTotal - Float
|
Maximum total discount points. Default = 0 |
qualifyingFicoScore - Int
|
FICO score used to determine loan eligibility and interest rate |
rateLockDays - Float!
|
How long to lock the rate, in days. Default = 30 |
Example
{
"fipsCountyCode": "xyz789",
"loanAmount": 123,
"loanTermYears": 123.45,
"ltv": 123.45,
"maxDiscountPointsTotal": 123.45,
"qualifyingFicoScore": 123,
"rateLockDays": 987.65
}
Lease
LegalEntity
Fields
| Field Name | Description |
|---|---|
fullName - String
|
Example
{"fullName": "abc123"}
Liability
Description
Liability type
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
Account identifier |
balance - NonNegativeFloat
|
Unpaid balance |
bankName - String
|
Bank name |
creditorName - String
|
Creditor name Use bankName instead |
exclusionReason - LiabilityExclusionReason
|
The reason why the liability is excluded |
id - ID!
|
Liability ID |
intent - LiabilityIntent
|
The intent regarding liability |
monthlyPayment - NonNegativeFloat
|
Monthly payment |
type - LiabilityType
|
The type of liability |
Example
{
"accountIdentifier": "abc123",
"balance": 123.45,
"bankName": "abc123",
"creditorName": "xyz789",
"exclusionReason": "ASSIGNED_TO_ANOTHER_PARTY",
"id": 4,
"intent": "DO_NOTHING",
"monthlyPayment": 123.45,
"type": "BORROWER_ESTIMATED_TOTAL_MONTHLY_LIABILITY_PAYMENT"
}
LiabilityConnection
Fields
| Field Name | Description |
|---|---|
edges - [LiabilityEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [LiabilityEdge],
"pageInfo": PageInfo
}
LiabilityEdge
Fields
| Field Name | Description |
|---|---|
cursor - ID!
|
|
node - Liability!
|
Example
{
"cursor": "4",
"node": Liability
}
LiabilityExclusionReason
Description
The reason why the liability is excluded
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ASSIGNED_TO_ANOTHER_PARTY"
LiabilityIntent
Description
The intent regarding liability
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"DO_NOTHING"
LiabilityMutations
Description
Liability mutations
Fields
| Field Name | Description |
|---|---|
attachOwnedProperty - AttachOwnedPropertyLiabilityResponse
|
Update a Liability. Fields with non-null values will be updated, the rest will be ignored. |
Arguments |
|
create - CreateLiabilityResponse
|
Create a liability |
Arguments
|
|
delete - DeleteLiabilityResponse
|
Delete a liability |
Arguments
|
|
setExclusionReason - SetExclusionReasonResponse
|
Update a Liability. Fields with non-null values will be updated, the rest will be ignored. |
Arguments
|
|
setIntent - SetIntentResponse
|
Update a Liability. Fields with non-null values will be updated, the rest will be ignored. |
Arguments
|
|
Example
{
"attachOwnedProperty": AttachOwnedPropertyLiabilityResponse,
"create": CreateLiabilityResponse,
"delete": DeleteLiabilityResponse,
"setExclusionReason": SetExclusionReasonResponse,
"setIntent": SetIntentResponse
}
LiabilityType
Description
The type of liability
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BORROWER_ESTIMATED_TOTAL_MONTHLY_LIABILITY_PAYMENT"
LifeInsuranceAsset
Description
Life insurance asset
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset |
id - ID!
|
Asset ID |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": ["4"],
"id": 4,
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["xyz789"],
"notableActivities": [FinancialAccountActivity]
}
LinkBorrowersAsSpousesInput
LinkBorrowersAsSpousesResponse
Loan
Description
Loan
Fields
| Field Name | Description |
|---|---|
allowedStates - [StateAbbreviated!]!
|
The list of states where the organization is actively licensed. |
appraisal - Appraisal
|
Get an Appraisal by ID |
Arguments
|
|
assignedLoanOfficer - LoanOfficer
|
The mortgage broker assigned to the loan. |
availableGlobalLoanOfficers - [GlobalLoanOfficer!]
|
The list of global loan officers available to be assigned to the loan. This list will vary depending on the subject property state. |
borrowerPreferences - BorrowerPreferences
|
Borrower preferences associated with the loan. |
borrowers - BorrowerConnection!
|
Borrowers on the loan |
Arguments
|
|
changeRequests - [LoanChangeRequest!]!
|
Change requests associated with this loan |
Arguments
|
|
closingDate - Date
|
The date that the purchase is set to close. |
concessions - [ConcessionLog!]!
|
A log of all lender-paid concessions that have been requested or applied to this loan. |
contacts - [Contact!]!
|
Contacts associated with the loan. |
currentStage - String
|
The current stage that the loan is in. |
customerPointAdjustments - CustomerPointAdjustment
|
Customer margins, cost absorptions, and warehouse responsibility on the loan. |
dealId - String!
|
The unique ID of the deal associated with this loan. |
documents - [Document!]!
|
The list of documents associated with this loan. |
earnestMoneyDeposit - NonNegativeFloat
|
The total amount of earnest money deposit |
effectiveAppraisalWaiver - AppraisalWaiver
|
The appraisal waivers applied to the loan. |
fees - [Fee!]
|
Fees associated with the loan. |
friendlyId - String!
|
An alternative ID that might be more aesthetically pleasing. May be shared by multiple objects representing the same loan. |
id - ID!
|
The ID of the Loan |
isClosed - Boolean
|
Whether the loan has been closed. |
isFirstTimeHomebuyer - Boolean
|
Is this for a first time homebuyer? |
isFrozen - Boolean!
|
Whether the loan is frozen |
latestPreApprovalRunTime - DateTime
|
Time of the latest successful pre-approval |
liabilities - [Liability!]!
|
All liabilities associated with this loan |
loanContact - LoanContact!
|
The contact for this loan |
loanNumber - String
|
The current loan number for internal Pylon use. |
loanOfficerDocumentTasks - [LoanOfficerDocumentTask!]
|
The borrower tasks available to Loan Officers. |
loanPurpose - LoanPurposeType
|
The purpose for which the loan proceeds will be used. |
loanTermYears - PositiveFloat
|
The term of this loan in years. |
ltv - NonNegativeFloat
|
The loan-to-value ratio expressed as a percentage |
maxLoanAmount - Float
|
Maximum loan amount (in dollars) calculated by the preapproval engine. |
maxPurchasePrice - Float
|
Maximum purchase price (in dollars) calculated by the preapproval engine. |
noteRatePercent - NonNegativeFloat
|
Interest rate. This field is expressed as a percent. As an example, 50.1% is expressed as 50.1. |
orderOuts - [OrderOut!]!
|
List of order outs on the loan. |
outOfPocketMax - NonNegativeInt
|
The maximum amount of assets (in dollars) to be used towards the loan. |
pointOfContact - Borrower
|
The borrower who has been designated as the point of contact on the loan (or the first borrower on the loan if no borrower has been designated as the point of contact) |
preapprovalProduct - Product
|
The loan product with the optimal preapproval result. The value is null if the loan has not been preapproved (yet). |
productPricingRate - ProductPricingRate
|
The latest pricing run outputs. |
productStructure - ProductPricingRate
|
The latest version of pricing-related fields. |
purchasePrice - NonNegativeInt
|
The actual purchase price (in dollars). |
pylonApproved - Boolean!
|
Must be approved before a rate lock can be requested |
rateLock - RateLockDetails!
|
Rate lock related fields |
rateLockTerm - NonNegativeInt
|
Number of days borrower wants to lock the rate for |
refinanceCashOutProceeds - NonNegativeInt
|
Refinance cash out proceeds not used towards paying off existing liens. |
sellerCredit - NonNegativeInt
|
The total seller credit to be applied towards closing costs |
stages - [LoanStage!]
|
The chronological sequence of stages a loan has progressed through, listed from earliest to most recent. |
subjectProperty - SubjectProperty
|
The subject property associated with the loan |
subjectPropertyIntent - SubjectPropertyIntent
|
The subject property intent associated with the loan |
title - Title
|
Title information for the loan. |
totalAssetsAvailable - NonNegativeInt
|
The total amount of assets on this loan. |
useOwnTitleCompany - Boolean
|
Whether the borrower wants to use their own title company. |
Example
{
"allowedStates": ["AK"],
"appraisal": Appraisal,
"assignedLoanOfficer": LoanOfficer,
"availableGlobalLoanOfficers": [GlobalLoanOfficer],
"borrowerPreferences": BorrowerPreferences,
"borrowers": BorrowerConnection,
"changeRequests": [LoanChangeRequest],
"closingDate": "2007-12-03",
"concessions": [ConcessionLog],
"contacts": [Contact],
"currentStage": "xyz789",
"customerPointAdjustments": CustomerPointAdjustment,
"dealId": "xyz789",
"documents": [Document],
"earnestMoneyDeposit": 123.45,
"effectiveAppraisalWaiver": "AUTOMATED_COLLATERAL_EVALUATION",
"fees": [Fee],
"friendlyId": "xyz789",
"id": 4,
"isClosed": false,
"isFirstTimeHomebuyer": true,
"isFrozen": false,
"latestPreApprovalRunTime": "2007-12-03T10:15:30Z",
"liabilities": [Liability],
"loanContact": LoanContact,
"loanNumber": "xyz789",
"loanOfficerDocumentTasks": [LoanOfficerDocumentTask],
"loanPurpose": "PURCHASE",
"loanTermYears": 123.45,
"ltv": 123.45,
"maxLoanAmount": 123.45,
"maxPurchasePrice": 123.45,
"noteRatePercent": 123.45,
"orderOuts": [Appraisal],
"outOfPocketMax": 123,
"pointOfContact": Borrower,
"preapprovalProduct": Product,
"productPricingRate": ProductPricingRate,
"productStructure": ProductPricingRate,
"purchasePrice": 123,
"pylonApproved": false,
"rateLock": RateLockDetails,
"rateLockTerm": 123,
"refinanceCashOutProceeds": 123,
"sellerCredit": 123,
"stages": [LoanStage],
"subjectProperty": SubjectProperty,
"subjectPropertyIntent": SubjectPropertyIntent,
"title": Title,
"totalAssetsAvailable": 123,
"useOwnTitleCompany": true
}
LoanAmountExceedsPurchasePriceError
Description
User error indicating that the requested loan amount exceeds the requested purchase price.
Fields
| Field Name | Description |
|---|---|
message - String!
|
Example
{"message": "xyz789"}
LoanApplication
Description
Loan application object
Example
{
"creationDate": "2007-12-03T10:15:30Z",
"friendlyId": "abc123",
"id": 4,
"submitted": true
}
LoanApplicationAnalyticsArchiveDateFilter
LoanApplicationAnalyticsConnection
Fields
| Field Name | Description |
|---|---|
edges - [LoanApplicationAnalyticsEdge!]!
|
|
pageInfo - PageInfo!
|
|
totalCount - NonNegativeInt!
|
The total number of loans that meet the filter criteria. |
Example
{
"edges": [LoanApplicationAnalyticsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
LoanApplicationAnalyticsContactPointFullNameFilter
LoanApplicationAnalyticsEdge
Fields
| Field Name | Description |
|---|---|
cursor - ID!
|
|
node - LoanApplicationAnalyticsRoot!
|
Example
{"cursor": 4, "node": LoanApplicationAnalyticsRoot}
LoanApplicationAnalyticsFilters
Fields
| Input Field | Description |
|---|---|
archiveDate - LoanApplicationAnalyticsArchiveDateFilter
|
|
contactPointFullName - LoanApplicationAnalyticsContactPointFullNameFilter
|
|
globalSearch - String
|
|
hmdaDisposition - LoanApplicationAnalyticsHmdaDispositionFilter
|
|
loanOfficerEmail - LoanApplicationAnalyticsLoanOfficerEmailFilter
|
|
loanStage - LoanApplicationAnalyticsLoanLoanStageFilter
|
|
preapproved - LoanApplicationAnalyticsPreapprovedLoanAmountFilter
|
Example
{
"archiveDate": LoanApplicationAnalyticsArchiveDateFilter,
"contactPointFullName": LoanApplicationAnalyticsContactPointFullNameFilter,
"globalSearch": "xyz789",
"hmdaDisposition": LoanApplicationAnalyticsHmdaDispositionFilter,
"loanOfficerEmail": LoanApplicationAnalyticsLoanOfficerEmailFilter,
"loanStage": LoanApplicationAnalyticsLoanLoanStageFilter,
"preapproved": LoanApplicationAnalyticsPreapprovedLoanAmountFilter
}
LoanApplicationAnalyticsHmdaDispositionFilter
Fields
| Input Field | Description |
|---|---|
eq - HmdaDispositionCode
|
|
isNull - Boolean
|
Example
{"eq": "APPLICATION_APPROVED_BUT_NOT_ACCEPTED", "isNull": false}
LoanApplicationAnalyticsLoanLoanStageFilter
LoanApplicationAnalyticsLoanOfficerEmailFilter
LoanApplicationAnalyticsPreapprovedLoanAmountFilter
LoanApplicationAnalyticsRoot
Fields
| Field Name | Description |
|---|---|
addressLineText - String
|
The street address of the property. |
addressUnitIdentifier - String
|
The unit identifier of the property. |
archiveDate - DateTime
|
Set to the date a loan application is archived; has no value if the loan application is not yet archived. |
cashOutType - RefinanceCashOutType
|
The type of cashout on the loan. |
cityName - String
|
The name of the city where the property is located. |
closingDate - Date
|
The date that the purchase is set to close. |
contactPointEmailValue - String
|
The email address for the primary contract on the loan. |
contactPointFullName - String
|
The full name of the primary contact on the loan. |
contactPointTelephoneValues - [String!]
|
The phone number (or numbers) of the primary contact on the loan. |
countyName - String
|
The name of the county where the property is located. |
creationDate - DateTime
|
The date the loan application was first started by the user. |
creditScoreAggregate - MatrixAggregate!
|
|
dealId - String!
|
The unique ID of the deal associated with this loan. |
debtToIncome - Float
|
Debt to income |
downPaymentAmount - NonNegativeInt
|
The down payment on the property. |
estimatedClosingCostsAmount - NonNegativeInt
|
The dollar amount of the estimated loan fees, title fees, appraisal fees and other closing costs associated with the subject transaction excluding discount points. |
friendlyId - String!
|
An alternative ID that might be more aesthetically pleasing. May be shared by multiple objects representing the same loan. |
hasSubjectProperty - Boolean!
|
Whether or not a subject property is associated with this application |
id - ID!
|
|
loanAmount - NonNegativeInt
|
If the loan is approved, this is the total amount of the loan. |
loanNumber - String
|
The current loan number for internal Pylon use. |
loanPurpose - LoanPurposeType
|
The type of loan, purchase or refinance. |
loanStage - String
|
A human readable description of the current loan stage in the legacy origination system. |
noteRatePercent - Float
|
The rate at which the interest on the mortgage is amortized. |
organizationId - String
|
The organization ID associated with the loan application. |
postalCode - String
|
The ZIP code where the property is located. |
preapprovedLoanAmount - NonNegativeInt
|
The preapproved amount of the loan |
rateLockStatus - RateLockStatus
|
Is the rate locked |
salesContractAmount - NonNegativeInt
|
The total amount of money property is being purchased for. |
stateCode - String
|
The two-letter abbreviation of the state where the property is located. |
Example
{
"addressLineText": "abc123",
"addressUnitIdentifier": "abc123",
"archiveDate": "2007-12-03T10:15:30Z",
"cashOutType": "CASH_OUT",
"cityName": "abc123",
"closingDate": "2007-12-03",
"contactPointEmailValue": "xyz789",
"contactPointFullName": "xyz789",
"contactPointTelephoneValues": ["xyz789"],
"countyName": "abc123",
"creationDate": "2007-12-03T10:15:30Z",
"creditScoreAggregate": MatrixAggregate,
"dealId": "abc123",
"debtToIncome": 987.65,
"downPaymentAmount": 123,
"estimatedClosingCostsAmount": 123,
"friendlyId": "abc123",
"hasSubjectProperty": true,
"id": 4,
"loanAmount": 123,
"loanNumber": "abc123",
"loanPurpose": "PURCHASE",
"loanStage": "xyz789",
"noteRatePercent": 987.65,
"organizationId": "abc123",
"postalCode": "abc123",
"preapprovedLoanAmount": 123,
"rateLockStatus": "CANCELLED",
"salesContractAmount": 123,
"stateCode": "abc123"
}
LoanChangeRequest
Description
A request to make changes to a loan
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the loan change request |
status - LoanChangeRequestStatus!
|
Current status of this change request |
Example
{"id": 4, "status": "APPROVED"}
LoanChangeRequestStatus
Description
Status of a loan change request
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"APPROVED"
LoanClosedError
Fields
| Field Name | Description |
|---|---|
message - String!
|
Example
{"message": "xyz789"}
LoanContact
Description
LoanContact
Example
{
"email": "xyz789",
"firstName": "xyz789",
"id": 4,
"lastName": "xyz789",
"middleName": "xyz789",
"nmlsId": "abc123",
"phoneNumber": "xyz789",
"title": "abc123"
}
LoanMutations
Fields
| Field Name | Description |
|---|---|
approveChangeRequest - ApproveLoanChangeRequestResponse
|
Approve a change request |
Arguments
|
|
archive - ArchiveLoanResponse
|
Archive a loan |
Arguments
|
|
assignLoanOfficer - AssignLoanOfficerResponse
|
Assign aloan officer to a loan |
Arguments
|
|
attachContact - AttachLoanContactResponse
|
Associate a contact with a loan |
Arguments
|
|
attachProductPricingRate - AttachProductPricingRateResponse
|
Assign a product pricing rate to a loan |
Arguments
|
|
attachSubjectProperty - AttachSubjectPropertyResponse
|
Attach a subject property to a loan |
Arguments
|
|
attachTitleCompany - AttachTitleCompanyResponse
|
Attach a title company to a loan |
Arguments
|
|
confirmRateLock - ConfirmRateLockResponse
|
Confirm a rate lock for a loan |
Arguments
|
|
create - CreateLoanResponse
|
Create a loan |
Arguments
|
|
denyRateLock - DenyRateLockResponse
|
Deny a rate lock for a loan Functionality has been absorbed into confirmRateLock |
Arguments
|
|
detachContact - DetachLoanContactResponse
|
Remove a contact's association from a loan |
Arguments
|
|
freeze - FreezeLoanResponse
|
Freeze a loan, only available to Pylon employees. |
Arguments
|
|
openChangeRequest - OpenLoanChangeRequestResponse
|
Open a new change request for a loan |
Arguments
|
|
reassignTask - ReassignTaskResponse
|
Flip a task's responsibility to a new assignee |
Arguments
|
|
requestRateLock - RequestRateLockResponse
|
Request a rate lock for a loan Functionality has been absorbed into confirmRateLock |
Arguments
|
|
setUseOwnTitleCompany - SetUseOwnTitleCompanyResponse
|
Set whether the borrower wants to use their own title company |
Arguments
|
|
submitUnderwritingNotes - SubmitUnderwritingNotesResponse
|
Start an underwriting run with optional notes |
Arguments
|
|
thaw - ThawLoanResponse
|
Thaw a loan, only available to Pylon employees. |
Arguments
|
|
update - UpdateLoanResponse
|
Update top-level Loan fields. Fields with non-null values will be updated, the rest will be ignored. |
Arguments
|
|
updateBorrowerPreferences - UpdateBorrowerPreferencesResponse
|
Update borrower preferences for a loan. |
Arguments
|
|
updateTaskName - UpdateTaskNameResponse
|
Updates the task name |
Arguments
|
|
updateTaskStatus - UpdateTaskStatusResponse
|
Updates the task status |
Arguments
|
|
withdraw - WithdrawLoanResponse
|
Withdraw a loan |
Arguments
|
|
Example
{
"approveChangeRequest": ApproveLoanChangeRequestResponse,
"archive": ArchiveLoanSuccess,
"assignLoanOfficer": AssignLoanOfficerResponse,
"attachContact": AttachLoanContactResponse,
"attachProductPricingRate": AttachProductPricingRateResponse,
"attachSubjectProperty": AttachSubjectPropertyResponse,
"attachTitleCompany": AttachTitleCompanyResponse,
"confirmRateLock": ConfirmRateLockResponse,
"create": CreateLoanResponse,
"denyRateLock": DenyRateLockResponse,
"detachContact": DetachLoanContactResponse,
"freeze": FreezeLoanResponse,
"openChangeRequest": OpenLoanChangeRequestResponse,
"reassignTask": ReassignTaskResponse,
"requestRateLock": RequestRateLockResponse,
"setUseOwnTitleCompany": SetUseOwnTitleCompanyResponse,
"submitUnderwritingNotes": SubmitUnderwritingNotesResponse,
"thaw": ThawLoanResponse,
"update": UpdateLoanResponse,
"updateBorrowerPreferences": UpdateBorrowerPreferencesResponse,
"updateTaskName": UpdateTaskNameResponse,
"updateTaskStatus": UpdateTaskStatusResponse,
"withdraw": LoanClosedError
}
LoanNotPreApprovedError
Description
User error indicating that the operation failed because the loan is not preapproved.
Fields
| Field Name | Description |
|---|---|
message - String!
|
Example
{"message": "abc123"}
LoanOfficer
LoanOfficerDocumentTask
Description
A borrower's task that is only available to the loan officer
Fields
| Field Name | Description |
|---|---|
accessToken - String
|
Access token for SSO PDF viewer or any third-party access, if applicable. |
completedAt - DateTime
|
|
createdOn - DateTime
|
|
description - String
|
|
details - TaskEntityDetails
|
Details about the entity this task is associated with |
disclosureRecipient - DisclosureRecipient
|
|
documentLinks - [DocumentLink!]!
|
|
documentUploadPath - String
|
|
dueDate - DateTime
|
|
fields - [String!]
|
|
id - ID!
|
|
note - String
|
|
priority - Float
|
|
requiredFor1003Form - Boolean
|
|
status - String!
|
|
title - String
|
|
type - String!
|
Example
{
"accessToken": "xyz789",
"completedAt": "2007-12-03T10:15:30Z",
"createdOn": "2007-12-03T10:15:30Z",
"description": "abc123",
"details": TaskEntityDetails,
"disclosureRecipient": DisclosureRecipient,
"documentLinks": [DocumentLink],
"documentUploadPath": "abc123",
"dueDate": "2007-12-03T10:15:30Z",
"fields": ["abc123"],
"id": "4",
"note": "xyz789",
"priority": 987.65,
"requiredFor1003Form": false,
"status": "xyz789",
"title": "xyz789",
"type": "xyz789"
}
LoanPreApprovedForLowerAmountError
Description
User error indicating that the operation failed because the loan was preapproved for a lower amount than what was requested.
Fields
| Field Name | Description |
|---|---|
message - String!
|
Example
{"message": "abc123"}
LoanPurposeType
Description
The purpose for which the loan proceeds will be used.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PURCHASE"
LoanStage
LoanToValueViolation
Description
Optimizer could not find a solution without exceeding the LTV limit.
Example
{"loanAmountExceeded": 987.65, "ltv": 987.65, "ltvLimit": 123.45}
MaritalStatusType
Description
An individual's marital status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DIVORCED"
MarketingRates
Description
Marketing rates
Fields
| Field Name | Description |
|---|---|
conforming - [ConformingMarketingRate]!
|
|
Arguments
|
|
custom - [CustomMarketingRate]!
|
|
Arguments
|
|
fha - [FhaMarketingRate]!
|
|
Arguments
|
|
jumbo - [JumboMarketingRate]!
|
|
Arguments
|
|
warehousingCosts - WarehousingCosts
|
Warehousing costs for all products |
Example
{
"conforming": [ConformingMarketingRate],
"custom": [CustomMarketingRate],
"fha": [FhaMarketingRate],
"jumbo": [JumboMarketingRate],
"warehousingCosts": WarehousingCosts
}
MatrixAggregate
Fields
| Field Name | Description |
|---|---|
minimumMedian - Float
|
The minimum of all median values |
Example
{"minimumMedian": 987.65}
MilitaryBasePayIncome
Description
Military base pay income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
MilitaryClothesAllowanceIncome
Description
Military clothes allowance income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
MilitaryCombatPayIncome
Description
Military combat pay income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
MilitaryFlightPayIncome
Description
Military flight pay income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
MilitaryHazardPayIncome
Description
Military hazard pay income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
MilitaryOverseasPayIncome
Description
Military overseas pay income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
MilitaryPropPayIncome
Description
Military prop pay income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
MilitaryQuartersAllowanceIncome
Description
Military quarters allowance income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
MilitaryRationsAllowanceIncome
Description
Military rations allowance income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
MilitaryStatusType
Description
An individual's military status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACTIVE_DUTY"
MilitaryVariableHousingAllowanceIncome
Description
Military variable housing allowance income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
MiscellaneousIncome
Description
Miscellaneous income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
MissingCreditPullError
Description
User error indicating that there is no credit-pull associated with a borrower, blocking pricing and preapproval
Fields
| Field Name | Description |
|---|---|
message - String!
|
Example
{"message": "abc123"}
MissingDataError
MoneyMarketFundAsset
Description
Money market fund asset
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset |
id - ID!
|
Asset ID |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": ["4"],
"id": "4",
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["xyz789"],
"notableActivities": [FinancialAccountActivity]
}
MortgageCreditCertificateIncome
Description
Mortgage credit certificate income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
percentageOfInterest - NonNegativeFloat
|
The percentage of interest that the mortgage credit certificate will cover. This field is expressed as a percent. As an example, 50.1% is expressed as 50.1. |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"percentageOfInterest": 123.45,
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
MortgageDifferentialIncome
Description
Mortgage differential income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
MutualFundAsset
Description
Mutual fund asset
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset |
id - ID!
|
Asset ID |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": [4],
"id": "4",
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["xyz789"],
"notableActivities": [FinancialAccountActivity]
}
NeighborhoodHousingType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CONDOMINIUM"
NetRentalIncome
Description
Net rental income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
NoAusForProduct
Fields
| Field Name | Description |
|---|---|
message - String!
|
Example
{"message": "xyz789"}
NoProductPricingError
Fields
| Field Name | Description |
|---|---|
message - String!
|
Example
{"message": "abc123"}
NonBorrowerContributionIncome
Description
Non-borrower contribution income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
NonBorrowerHouseholdIncome
Description
Non-borrower household income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
NonBorrowingOwner
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
personalInformation - PersonalInformation!
|
Example
{"id": 4, "personalInformation": PersonalInformation}
NonBorrowingOwnerMutations
Fields
| Field Name | Description |
|---|---|
create - CreateNonBorrowingOwnerResponse
|
Create a new non-borrowing owner |
Arguments
|
|
delete - DeleteNonBorrowingOwnerResponse
|
Delete a non-borrowing owner |
Arguments
|
|
update - UpdateNonBorrowingOwnerResponse
|
Update a NonBorrowingOwner. Fields with non-null values will be updated, the rest will be ignored. |
Arguments
|
|
Example
{
"create": CreateNonBorrowingOwnerResponse,
"delete": DeleteNonBorrowingOwnerResponse,
"update": UpdateNonBorrowingOwnerResponse
}
NonNegativeFloat
Description
Floats that will have a value of 0 or more.
Example
123.45
NonNegativeInt
Description
Integers that will have a value of 0 or more.
Example
123
NotesReceivableInstallmentIncome
Description
Notes receivable installment income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
OpenLoanChangeRequestInput
OpenLoanChangeRequestResponse
Description
Response of the loan.openChangeRequest mutation.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the loan change request |
status - LoanChangeRequestStatus!
|
Current status of this change request |
Example
{"id": 4, "status": "APPROVED"}
OptForDefaultTitleVendorInput
Fields
| Input Field | Description |
|---|---|
loanId - ID!
|
Example
{"loanId": 4}
OptForDefaultTitleVendorResponse
Fields
| Field Name | Description |
|---|---|
loanId - ID!
|
Example
{"loanId": "4"}
OptimizerUnsatisfied
Description
Represents a failed optimizer solve.
Fields
| Field Name | Description |
|---|---|
_ - Boolean!
|
A no-op field that should not be requested. It will always throw an error if requested. It only exists to allow empty objects and may be removed in the future. This field should not be requested. It only exists to allow empty objects and may be removed in the future if more fields are added to this type. |
Example
{"_": true}
OrderOut
Organization
Description
Organization
Fields
| Field Name | Description |
|---|---|
companyLegalName - String
|
|
companyName - String!
|
|
companySupportEmail - String
|
|
concessionLimitPerLoan - Float
|
|
contacts - [Contact!]
|
Contacts used or saved for this organization |
customerSlug - String
|
|
electronicCommunicationsConsentUrl - String
|
|
enableSso - Boolean!
|
Indicates whether this customer's users will use SSO-based login in the command center |
id - ID!
|
|
nmlsId - String
|
|
privacyPolicyUrl - String
|
|
telephonicCommunicationsConsentUrl - String
|
|
termsOfServiceUrl - String
|
Example
{
"companyLegalName": "xyz789",
"companyName": "abc123",
"companySupportEmail": "abc123",
"concessionLimitPerLoan": 123.45,
"contacts": [Contact],
"customerSlug": "abc123",
"electronicCommunicationsConsentUrl": "xyz789",
"enableSso": true,
"id": "4",
"nmlsId": "xyz789",
"privacyPolicyUrl": "xyz789",
"telephonicCommunicationsConsentUrl": "xyz789",
"termsOfServiceUrl": "xyz789"
}
OrganizationContactRole
Description
Role of the contact in the context of an organization.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ATTORNEY"
OrganizationLicensing
Fields
| Field Name | Description |
|---|---|
states - [OrganizationStateWithLicenses!]!
|
Example
{"states": [OrganizationStateWithLicenses]}
OrganizationMutations
Description
Organization mutations
Fields
| Field Name | Description |
|---|---|
createContact - CreateContactResponse
|
Create and add a new contact to the current organization. |
Arguments
|
|
createOrganizationRole - CreateOrganizationRoleResponse
|
|
Arguments
|
|
createOrganizationUser - CreateOrganizationUserResponse
|
|
Arguments
|
|
deleteOrganizationRole - DeleteOrganizationRoleResponse
|
|
Arguments
|
|
deleteOrganizationStateLicenses - DeleteOrganizationStateLicensesResponse
|
Delete the current organization's state licenses |
Arguments |
|
deleteOrganizationUser - DeleteOrganizationUserResponse
|
|
Arguments
|
|
sendOrganizationUserInvitationEmail - SendOrganizationUserInvitationEmailResponse
|
|
Arguments |
|
updateContact - UpdateContactResponse
|
Update an existing contact and returns the result. |
Arguments
|
|
updateOrganization - UpdateOrganizationResponse
|
Update the current organization |
Arguments
|
|
updateOrganizationLicensing - UpdateOrganizationLicensingResponse
|
Update the current organization's state licensing |
Arguments |
|
updateOrganizationRolePermissions - UpdateOrganizationRolePermissionsResponse
|
|
Arguments |
|
updateOrganizationUserRoles - UpdateOrganizationUserRolesResponse
|
|
Arguments |
|
Example
{
"createContact": CreateContactResponse,
"createOrganizationRole": CreateOrganizationRoleResponse,
"createOrganizationUser": CreateOrganizationUserResponse,
"deleteOrganizationRole": DeleteOrganizationRoleResponse,
"deleteOrganizationStateLicenses": DeleteOrganizationStateLicensesResponse,
"deleteOrganizationUser": DeleteOrganizationUserResponse,
"sendOrganizationUserInvitationEmail": SendOrganizationUserInvitationEmailResponse,
"updateContact": UpdateContactResponse,
"updateOrganization": UpdateOrganizationResponse,
"updateOrganizationLicensing": UpdateOrganizationLicensingResponse,
"updateOrganizationRolePermissions": UpdateOrganizationRolePermissionsResponse,
"updateOrganizationUserRoles": UpdateOrganizationUserRolesResponse
}
OrganizationRole
OrganizationRoleConnection
Fields
| Field Name | Description |
|---|---|
edges - [OrganizationRoleEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [OrganizationRoleEdge],
"pageInfo": PageInfo
}
OrganizationRoleEdge
Fields
| Field Name | Description |
|---|---|
cursor - ID!
|
|
node - OrganizationRoleNode!
|
Example
{
"cursor": "4",
"node": OrganizationRoleNode
}
OrganizationRoleNode
OrganizationStateWithLicenses
Fields
| Field Name | Description |
|---|---|
active - Boolean!
|
|
licenses - [StateLicense!]!
|
|
state - StateAbbreviated!
|
Example
{
"active": false,
"licenses": [StateLicense],
"state": "AK"
}
OrganizationStateWithLicensesInput
Fields
| Input Field | Description |
|---|---|
active - Boolean!
|
|
licenses - [StateLicenseInput!]
|
|
state - StateAbbreviated!
|
Example
{
"active": true,
"licenses": [StateLicenseInput],
"state": "AK"
}
OrganizationUser
Description
Organization user object
Fields
| Field Name | Description |
|---|---|
email - String!
|
|
firstName - String!
|
|
id - ID!
|
|
lastName - String!
|
|
organizationRoles - [OrganizationRole!]
|
Example
{
"email": "abc123",
"firstName": "xyz789",
"id": "4",
"lastName": "abc123",
"organizationRoles": [OrganizationRole]
}
OrganizationUserConnection
Fields
| Field Name | Description |
|---|---|
edges - [OrganizationUserEdge!]!
|
|
pageInfo - PageInfo!
|
|
totalCount - NonNegativeInt!
|
The total number of users in the organization. |
Example
{
"edges": [OrganizationUserEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
OrganizationUserEdge
Fields
| Field Name | Description |
|---|---|
cursor - ID!
|
|
node - OrganizationUserNode!
|
Example
{"cursor": 4, "node": OrganizationUserNode}
OrganizationUserNode
OtherAsset
Description
Asset of miscellaneous or unspecified type
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset |
description - String
|
Description of the asset |
id - ID!
|
Asset ID |
institutionName - String
|
Institution name |
isLiquid - Boolean
|
Indicates whether or not the asset is liquid |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": [4],
"description": "xyz789",
"id": 4,
"institutionName": "xyz789",
"isLiquid": true,
"nonBorrowerOwnerNames": ["abc123"],
"notableActivities": [FinancialAccountActivity]
}
OtherIncome
Description
Income that does not fall into any of the predefined types
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
description - String
|
Information about the income type |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"description": "abc123",
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
OvertimeIncome
Description
Overtime income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
OwnedProperty
Description
Owned property
Fields
| Field Name | Description |
|---|---|
address - Address
|
US Address |
currentUsageType - PropertyUsageType
|
How the owner is using this property. |
homeInsuranceMonthlyPayment - NonNegativeInt
|
The dollar amount of monthly home insurance premium. |
id - ID!
|
Owned property ID |
intendedDisposition - PropertyDisposition
|
The intended disposition of the property. Indicates whether the borrowers will be retaining or selling (or sold) the property. |
intendedUsageType - PropertyUsageType
|
How the owner intends to use this property. |
liabilities - [Liability!]
|
Liabilities associated with an owned property |
monthlyAssociationDues - NonNegativeInt
|
Monthly association dues (in dollars) |
mortgageInsuranceMonthlyPayment - NonNegativeInt
|
The dollar amount of monthly mortgage insurance monthly premium. |
neighborhoodHousingType - NeighborhoodHousingType
|
The type of housing (e.g. single or multi-family) |
nonBorrowingOwners - [NonBorrowingOwner!]!
|
|
pendingNetSaleProceedsAsset - Asset
|
If the property is pending sale, the associated asset that represents the expected net proceeds from the sale. |
propertyTaxMonthlyPayment - NonNegativeInt
|
The dollar amount of property taxes due per month. |
purchaseDate - Date
|
The date when the property was originally purchased |
rentalIncome - Income
|
If the property is a rental property, the associated rental income entity. |
sellDate - Date
|
The date when the property was sold (or null if the borrower(s) still own the property). |
Example
{
"address": Address,
"currentUsageType": "INVESTMENT",
"homeInsuranceMonthlyPayment": 123,
"id": 4,
"intendedDisposition": "PENDING_SALE",
"intendedUsageType": "INVESTMENT",
"liabilities": [Liability],
"monthlyAssociationDues": 123,
"mortgageInsuranceMonthlyPayment": 123,
"neighborhoodHousingType": "CONDOMINIUM",
"nonBorrowingOwners": [NonBorrowingOwner],
"pendingNetSaleProceedsAsset": Asset,
"propertyTaxMonthlyPayment": 123,
"purchaseDate": "2007-12-03",
"rentalIncome": Income,
"sellDate": "2007-12-03"
}
OwnedPropertyConnection
Fields
| Field Name | Description |
|---|---|
edges - [OwnedPropertyEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [OwnedPropertyEdge],
"pageInfo": PageInfo
}
OwnedPropertyEdge
Fields
| Field Name | Description |
|---|---|
cursor - ID!
|
|
node - OwnedProperty!
|
Example
{
"cursor": "4",
"node": OwnedProperty
}
OwnedPropertyMutations
Description
Owned property mutations
Fields
| Field Name | Description |
|---|---|
attachLiabilities - AttachOwnedPropertyLiabilitiesResponse
|
Attach liabilities to owned property. |
Arguments |
|
attachNonBorrowingOwner - AttachOwnedPropertyNonBorrowingOwnerResponse
|
Attach non-borrowing owner to owned property. |
Arguments |
|
create - CreateOwnedPropertyResponse
|
Create an OwnedProperty |
Arguments
|
|
delete - DeleteOwnedPropertyResponse
|
Delete an owned property |
Arguments
|
|
detachLiabilities - DetachOwnedPropertyLiabilitiesResponse
|
Detach the address from an owned property. |
Arguments |
|
update - UpdateOwnedPropertyResponse
|
Update an OwnedProperty. Fields with non-null values will be updated, the rest will be ignored. |
Arguments
|
|
Example
{
"attachLiabilities": AttachOwnedPropertyLiabilitiesResponse,
"attachNonBorrowingOwner": AttachOwnedPropertyNonBorrowingOwnerResponse,
"create": CreateOwnedPropertyResponse,
"delete": DeleteOwnedPropertyResponse,
"detachLiabilities": DetachOwnedPropertyLiabilitiesResponse,
"update": UpdateOwnedPropertyResponse
}
PacificIslanderRace
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"GUAMANIAN_OR_CHAMORRO"
PageInfo
PageRange
Fields
| Field Name | Description |
|---|---|
from - PositiveInt!
|
|
to - PositiveInt!
|
Example
{"from": 123, "to": 123}
PaidTo
Fields
| Field Name | Description |
|---|---|
legalEntity - LegalEntity
|
Example
{"legalEntity": LegalEntity}
Party
Fields
| Field Name | Description |
|---|---|
address - Address
|
|
id - ID!
|
The unique ID of the Party. |
individual - PartyIndividual
|
Details about the party, if the party is an individual (rather than a company) |
legalEntity - PartyLegalEntity
|
Details about the party, if the party is a legal entity |
role - PartyRole
|
Indicates the type of relationship between the party and the loan. |
Example
{
"address": Address,
"id": 4,
"individual": PartyIndividual,
"legalEntity": PartyLegalEntity,
"role": "ATTORNEY"
}
PartyIndividual
Example
{
"email": "xyz789",
"name": PartyName,
"telephoneNumber": "xyz789"
}
PartyIndividualInput
Fields
| Input Field | Description |
|---|---|
email - String
|
The e-mail address of the individual associated with the loan. |
name - PartyNameInput
|
The name of the individual associated with the loan. |
telephoneNumber - String
|
The phone number of the individual associated with the loan. |
Example
{
"email": "xyz789",
"name": PartyNameInput,
"telephoneNumber": "abc123"
}
PartyLegalEntity
Fields
| Field Name | Description |
|---|---|
legalEntityDetail - PartyLegalEntityDetail
|
Details about the legal entity associated with the loan. |
Example
{"legalEntityDetail": PartyLegalEntityDetail}
PartyLegalEntityDetail
PartyLegalEntityDetailInput
PartyLegalEntityInput
Fields
| Input Field | Description |
|---|---|
legalEntityDetail - PartyLegalEntityDetailInput
|
Details about the legal entity associated with the loan. |
Example
{"legalEntityDetail": PartyLegalEntityDetailInput}
PartyMutations
Fields
| Field Name | Description |
|---|---|
create - CreatePartyResponse
|
|
Arguments
|
|
delete - DeletePartyResponse
|
|
Arguments
|
|
optForDefaultTitleVendor - OptForDefaultTitleVendorResponse
|
|
Arguments
|
|
update - UpdatePartyResponse
|
|
Arguments
|
|
Example
{
"create": CreatePartyResponse,
"delete": DeletePartyResponse,
"optForDefaultTitleVendor": OptForDefaultTitleVendorResponse,
"update": UpdatePartyResponse
}
PartyName
PartyNameInput
PartyRole
Description
A designation for what type of Party is being represented.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ATTORNEY"
PayPeriodFrequency
Description
The frequency at which income is paid
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ANNUALLY"
PendingNetSaleProceedsFromRealEstateAsset
Description
Pending net sale proceeds from a real estate asset. The amount is the expected proceeds and should be less than or equal to the salePrice.
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset |
id - ID!
|
Asset ID |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
ownedProperty - OwnedProperty
|
The property being sold |
salePrice - NonNegativeInt
|
Sale price of the property in dollars |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": [4],
"id": "4",
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["xyz789"],
"notableActivities": [FinancialAccountActivity],
"ownedProperty": OwnedProperty,
"salePrice": 123
}
PensionIncome
Description
Pension income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
PersonalInformation
PersonalInformationInput
PhoneNumberType
Description
Phone number type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CELL"
PickLoanId
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the Loan |
Example
{"id": 4}
PickSubjectPropertyId
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
PipelineSummaryCounter
Fields
| Input Field | Description |
|---|---|
filters - LoanApplicationAnalyticsFilters!
|
|
label - String!
|
Example
{
"filters": LoanApplicationAnalyticsFilters,
"label": "abc123"
}
PipelineSummaryItem
PipelineSummaryResponse
Fields
| Field Name | Description |
|---|---|
counts - [PipelineSummaryItem!]!
|
|
totalCount - Float!
|
Example
{"counts": [PipelineSummaryItem], "totalCount": 123.45}
Pitia
Fields
| Field Name | Description |
|---|---|
floodInsurance - NonNegativeFloat
|
|
hoaDues - NonNegativeFloat
|
|
homeownersInsurance - NonNegativeFloat
|
|
mortgageInsurance - NonNegativeFloat
|
|
principalAndInterest - NonNegativeFloat
|
|
taxes - NonNegativeFloat
|
Example
{
"floodInsurance": 123.45,
"hoaDues": 123.45,
"homeownersInsurance": 123.45,
"mortgageInsurance": 123.45,
"principalAndInterest": 123.45,
"taxes": 123.45
}
PositiveFloat
Description
Floats that will have a value greater than 0.
Example
123.45
PositiveInt
Description
Integers that will have a value greater than 0.
Example
123
PreApprovalMutations
Description
Pre-approval mutations
Fields
| Field Name | Description |
|---|---|
createLoanPreApprovalLetter - CreateLoanPreApprovalLetterResponse
|
Create a pre-approval letter for a loan that has already been pre-approved. |
Arguments |
|
createMaxLoanPreApprovalLetter - CreateMaxLoanPreApprovalLetterResponse
|
Create a pre-approval letter with the maximum pre-approved loan amount and purchase price for a loan that has already been pre-approved. |
Arguments |
|
runLoanPreApproval - RunLoanPreApprovalResponse
|
Create a pre-approval for a loan |
Arguments
|
|
Example
{
"createLoanPreApprovalLetter": CreateLoanPreApprovalLetterResponse,
"createMaxLoanPreApprovalLetter": CreateMaxLoanPreApprovalLetterResponse,
"runLoanPreApproval": RunLoanPreApprovalResponse
}
PreApprovalRun
Description
A pre-approval run
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Possible Types
| PreApprovalRun Types |
|---|
Example
{"id": 4}
PreQualification
Fields
| Field Name | Description |
|---|---|
conventional - ConventionalPreQualification
|
|
Arguments
|
|
debug - [PreQualificationProductResult!]!
|
|
Arguments |
|
Example
{
"conventional": ConventionalPreQualification,
"debug": [PreQualificationProductResult]
}
PreQualificationBestEligibleResult
Fields
| Field Name | Description |
|---|---|
apr - Float!
|
|
discountPointsTotal - Float!
|
|
discountPointsTotalAmount - Int!
|
|
loanAmount - NonNegativeInt!
|
|
ltv - Float!
|
|
product - Product!
|
The loan product with the optimal prequalification result. |
rate - Float!
|
|
salesContractAmount - NonNegativeInt!
|
Example
{
"apr": 987.65,
"discountPointsTotal": 987.65,
"discountPointsTotalAmount": 123,
"loanAmount": 123,
"ltv": 987.65,
"product": Product,
"rate": 123.45,
"salesContractAmount": 123
}
PreQualificationMutations
Description
Pre-qualification mutations
Fields
| Field Name | Description |
|---|---|
conventional - ConventionalResponse
|
Create a conventional pre-qualification |
Arguments |
|
Example
{"conventional": ConventionalResponse}
PreQualificationProductResult
Fields
| Field Name | Description |
|---|---|
product - Product!
|
|
result - ConventionalPreQualificationResult!
|
Example
{
"product": Product,
"result": EligiblePreQualification
}
PrepaidItemType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BOROUGH_PROPERTY_TAX"
Pricing
Fields
| Field Name | Description |
|---|---|
dumpParameters - ProductPricingParameterDump
|
|
Arguments
|
|
feeSheet - FeeSheetResponse
|
|
Arguments
|
|
productPricing - ProductPricingQuery
|
|
Arguments
|
|
Example
{
"dumpParameters": ProductPricingParameterDump,
"feeSheet": FeeSheetResponse,
"productPricing": ProductPricingQuery
}
PricingObjectiveIntent
Description
Configure the objective that the optimizer uses. E.g. minimize monthly cost or out of pocket.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"MIN_DOWN_PAYMENT"
PrimaryIncomeHourlyPayError
Description
User error indicating that a preapproval was run with a borrower who is paid hourly, which is currently unsupported
Fields
| Field Name | Description |
|---|---|
message - String!
|
Example
{"message": "abc123"}
PriorPropertyTitleType
Description
Specifies the ownership title type of the prior property.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"JOINT_WITH_OTHER_THAN_SPOUSE"
PriorPropertyUsageType
Description
Defines how the borrower's prior property was used.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"FHA_SECONDARY_RESIDENCE"
ProceedsFromSaleOfNonRealEstateAsset
Description
Proceeds from sale of non-real estate asset
Fields
| Field Name | Description |
|---|---|
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset |
id - ID!
|
Asset ID |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"amount": 123,
"borrowerIds": [4],
"id": "4",
"nonBorrowerOwnerNames": ["xyz789"]
}
ProceedsFromSecuredLoanAsset
Description
Proceeds from secured loan asset
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset |
id - ID!
|
Asset ID |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": [4],
"id": "4",
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["abc123"],
"notableActivities": [FinancialAccountActivity]
}
ProceedsFromUnsecuredLoanAsset
Description
Proceeds from unsecured loan asset
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset |
id - ID!
|
Asset ID |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": ["4"],
"id": 4,
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["abc123"],
"notableActivities": [FinancialAccountActivity]
}
Product
ProductPricing
Fields
| Field Name | Description |
|---|---|
adjustableRateDetail - ProductPricingAdjustableRateDetail
|
If non-null, this product represents an adjustable rate |
id - ID
|
The unique ID of this product pricing result. |
lock - PositiveInt!
|
The number of days this rate can be locked for. |
product - Product!
|
The product to which these calculations apply. |
publishedOn - Date!
|
The date that rates for this product were published. |
term - PositiveInt!
|
The term of the loan being considered in years. |
Possible Types
| ProductPricing Types |
|---|
Example
{
"adjustableRateDetail": ProductPricingAdjustableRateDetail,
"id": "4",
"lock": 123,
"product": Product,
"publishedOn": "2007-12-03",
"term": 123
}
ProductPricingAdjustableRateDetail
Fields
| Field Name | Description |
|---|---|
initialFixedPeriodEffectiveMonthsCount - NonNegativeInt!
|
The number of months in the initial fixed period of a loan with an adjustable rate or payment |
marginRatePercent - NonNegativeFloat!
|
The number of percentage points to be added to the index to arrive at the new interest rate. |
maximumIncreaseRatePercent - NonNegativeFloat!
|
The maximum number of percentage points by which the interest rate can increase from the original interest rate over the life of the loan. |
paymentsBetweenBaseRatesCount - NonNegativeInt!
|
The number of payments between rate changes. |
perChangeMaximumIncreaseRatePercent - NonNegativeFloat!
|
The maximum number of percentage points by which the rate can increase from the previous interest rate. |
periodicMaximumIncreaseRatePercent - NonNegativeFloat!
|
The maximum number of percentage points by which the interest rate can increase from the Periodic Base Rate until the next base rate selection date. |
Example
{
"initialFixedPeriodEffectiveMonthsCount": 123,
"marginRatePercent": 123.45,
"maximumIncreaseRatePercent": 123.45,
"paymentsBetweenBaseRatesCount": 123,
"perChangeMaximumIncreaseRatePercent": 123.45,
"periodicMaximumIncreaseRatePercent": 123.45
}
ProductPricingAdjustment
ProductPricingApor
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique ID of the APOR. |
rate - PositiveFloat!
|
The average prime offer rate at the time of this pricing run for a comparible loan with the same term and amortization type. |
Example
{"id": 4, "rate": 123.45}
ProductPricingErrorUnsetEitherDownPaymentOrMaxAssetsToUse
Fields
| Field Name | Description |
|---|---|
message - String!
|
Example
{"message": "xyz789"}
ProductPricingErrorUnsetPurchasePrice
Fields
| Field Name | Description |
|---|---|
message - String!
|
Example
{"message": "abc123"}
ProductPricingOverrides
Fields
| Input Field | Description |
|---|---|
maximumAssetsToUse - NonNegativeInt
|
Override the maximum asset amount to use toward upfront costs of the loan. |
purchasePrice - PositiveInt
|
Override the purchase price of the subject property. |
Example
{"maximumAssetsToUse": 123, "purchasePrice": 123}
ProductPricingParameterDump
Fields
| Field Name | Description |
|---|---|
serializedParameters - String
|
|
userErrors - [UserError!]!
|
Example
{
"serializedParameters": "abc123",
"userErrors": [UserError]
}
ProductPricingQuery
Fields
| Field Name | Description |
|---|---|
products - [ProductPricing!]
|
|
userErrors - [UserError!]!
|
Example
{
"products": [ProductPricing],
"userErrors": [UserError]
}
ProductPricingRate
Fields
| Field Name | Description |
|---|---|
adjustments - [ProductPricingAdjustment!]!
|
All adjustments that apply to this product, rate, and deal. |
apor - ProductPricingApor!
|
The published APOR for a comparible mortgage at the time of this pricing run. |
apr - Float!
|
The APR with this rate applied as a percentage. |
breakEvenMonths - NonNegativeInt!
|
The number of months before the interest savings surpases the points cost of this rate. |
cashFromToBorrower - Float!
|
The net change in cash from/to the borrower at closing. |
cashOutAmount - NonNegativeFloat!
|
The cash out amount. |
cashOutType - RefinanceCashOutType!
|
The cash out type. |
closingCosts - Float!
|
The closing costs for this rate. Currently, this is only an estimate-- things like title fees are difficult to correctly compute, but this should be a good approximation. |
concessionPoints - NonNegativeFloat!
|
The concessions being applied to the rate cost in this scenario, in points. |
downPaymentAmount - NonNegativeFloat!
|
The down payment on a property. |
dti - NonNegativeFloat!
|
The debt-to-income ratio of the borrowers with the PITIA for this rate taken into account. |
floodInsurance - NonNegativeFloat!
|
The cost of flood insurance. |
id - ID
|
The unique ID of this product pricing result. |
increasedClosingCosts - NonNegativeFloat!
|
The increased closing costs compared to the baseline preapproval rate. |
interest - PositiveInt!
|
The total interest over the life of the loan, in dollars, with this rate applied. |
lock - PositiveInt!
|
The number of days this rate can be locked for. |
ltv - Float!
|
The ratio of the loan amount to the total value of the property, expressed as a percentage |
monthlyPayment - NonNegativeFloat!
|
The monthly mortgage payment (PITIA) of a loan at this rate. |
monthlySavings - NonNegativeFloat!
|
The increased savings month over month between this rate and the baseline preapproval rate. |
mortgageInsurance - NonNegativeFloat!
|
The cost of mandatory mortgage insurance each month. |
pitia - Pitia!
|
Breakdown of the monthly payment for this rate. |
pointsCost - NonNegativeFloat!
|
The cost, in dollars, to buy enough points in order to qualify for a better rate. |
pointsNeeded - NonNegativeFloat!
|
The number of additional points that must be purchased in order to qualify for this rate. |
prepaidInterestDailyAmount - NonNegativeFloat!
|
The amount of prepaid interest paid per day before closing, |
prepaidInterestDaysPaid - NonNegativeFloat!
|
The number of days' worth of prepaid interest to be paid at closing, |
prepaidInterestTotalAmount - NonNegativeFloat!
|
The total dollar amount of prepaid interest due at closing, |
principal - PositiveFloat!
|
The total principal, in dollars, of the loan with this rate applied. |
product - Product!
|
The product to which these calculations apply. |
publishedOn - Date!
|
The date that rates for this product were published. |
rate - Float!
|
The interest rate as a percentage. |
rateId - ID!
|
The ID of the rate. |
ratePoints - Float!
|
The cost, in points, of this rate. |
term - PositiveInt!
|
The term of the loan being considered in years. |
totalCost - Float!
|
The total cost after adjustments for this rate. Can be negative if the rate is below par. |
totalPoints - Float!
|
The total number of points after adjustments for this rate. |
Example
{
"adjustments": [ProductPricingAdjustment],
"apor": ProductPricingApor,
"apr": 987.65,
"breakEvenMonths": 123,
"cashFromToBorrower": 123.45,
"cashOutAmount": 123.45,
"cashOutType": "CASH_OUT",
"closingCosts": 123.45,
"concessionPoints": 123.45,
"downPaymentAmount": 123.45,
"dti": 123.45,
"floodInsurance": 123.45,
"id": "4",
"increasedClosingCosts": 123.45,
"interest": 123,
"lock": 123,
"ltv": 123.45,
"monthlyPayment": 123.45,
"monthlySavings": 123.45,
"mortgageInsurance": 123.45,
"pitia": Pitia,
"pointsCost": 123.45,
"pointsNeeded": 123.45,
"prepaidInterestDailyAmount": 123.45,
"prepaidInterestDaysPaid": 123.45,
"prepaidInterestTotalAmount": 123.45,
"principal": 123.45,
"product": Product,
"publishedOn": "2007-12-03",
"rate": 987.65,
"rateId": "4",
"ratePoints": 123.45,
"term": 123,
"totalCost": 987.65,
"totalPoints": 987.65
}
ProductStructure
Fields
| Field Name | Description |
|---|---|
adjustments - [ProductPricingAdjustment!]!
|
All adjustments that apply to this product, rate, and deal. |
apor - ProductPricingApor!
|
The published APOR for a comparible mortgage at the time of this pricing run. |
apr - Float!
|
The APR with this rate applied as a percentage. |
cashFromToBorrower - Float!
|
The net change in cash from/to the borrower at closing. |
cashOutAmount - NonNegativeFloat!
|
The cash out amount. |
cashOutType - RefinanceCashOutType!
|
The cash out type. |
closingCosts - Float!
|
The closing costs for this rate. Currently, this is only an estimate-- things like title fees are difficult to correctly compute, but this should be a good approximation. |
concessionPoints - NonNegativeFloat!
|
The concessions being applied to the rate cost in this scenario, in points. |
downPaymentAmount - NonNegativeFloat!
|
The down payment on a property. |
dti - NonNegativeFloat!
|
The debt-to-income ratio of the borrowers with the PITIA for this rate taken into account. |
floodInsurance - NonNegativeFloat!
|
The cost of flood insurance. |
id - ID
|
The unique ID of this product pricing result. |
interest - PositiveInt!
|
The total interest over the life of the loan, in dollars, with this rate applied. |
loanTermYears - PositiveInt!
|
The term length of the loan, in years |
lock - PositiveInt!
|
The number of days this rate can be locked for. |
ltv - Float!
|
The ratio of the loan amount to the total value of the property, expressed as a percentage |
monthlyPayment - NonNegativeFloat!
|
The monthly mortgage payment (PITIA) of a loan at this rate. |
mortgageInsurance - NonNegativeFloat!
|
The cost of mandatory mortgage insurance each month. |
pitia - Pitia!
|
Breakdown of the monthly payment for this rate. |
pointsCost - NonNegativeFloat!
|
The cost, in dollars, to buy enough points in order to qualify for a better rate. |
pointsNeeded - NonNegativeFloat!
|
The number of additional points that must be purchased in order to qualify for this rate. |
prepaidInterestDailyAmount - NonNegativeFloat!
|
The amount of prepaid interest paid per day before closing, |
prepaidInterestDaysPaid - NonNegativeFloat!
|
The number of days' worth of prepaid interest to be paid at closing, |
prepaidInterestTotalAmount - NonNegativeFloat!
|
The total dollar amount of prepaid interest due at closing, |
principal - PositiveFloat!
|
The total principal, in dollars, of the loan with this rate applied. |
product - Product!
|
The product to which these calculations apply. |
publishedOn - Date!
|
The date that rates for this product were published. |
rate - Float!
|
The interest rate as a percentage. |
rateId - ID!
|
The ID of the rate. |
ratePoints - Float!
|
The cost, in points, of this rate. |
totalCost - Float!
|
The total cost after adjustments for this rate. Can be negative if the rate is below par. |
totalPoints - Float!
|
The total number of points after adjustments for this rate. |
Possible Types
| ProductStructure Types |
|---|
Example
{
"adjustments": [ProductPricingAdjustment],
"apor": ProductPricingApor,
"apr": 987.65,
"cashFromToBorrower": 987.65,
"cashOutAmount": 123.45,
"cashOutType": "CASH_OUT",
"closingCosts": 123.45,
"concessionPoints": 123.45,
"downPaymentAmount": 123.45,
"dti": 123.45,
"floodInsurance": 123.45,
"id": "4",
"interest": 123,
"loanTermYears": 123,
"lock": 123,
"ltv": 987.65,
"monthlyPayment": 123.45,
"mortgageInsurance": 123.45,
"pitia": Pitia,
"pointsCost": 123.45,
"pointsNeeded": 123.45,
"prepaidInterestDailyAmount": 123.45,
"prepaidInterestDaysPaid": 123.45,
"prepaidInterestTotalAmount": 123.45,
"principal": 123.45,
"product": Product,
"publishedOn": "2007-12-03",
"rate": 123.45,
"rateId": 4,
"ratePoints": 987.65,
"totalCost": 987.65,
"totalPoints": 123.45
}
ProductStructureIneligibilityDetails
Types
| Union Types |
|---|
Example
DebtToIncomeViolation
ProductStructureUnsatisfiabilityDetails
Types
| Union Types |
|---|
Example
GuidelineViolation
PropertyDisposition
Description
Disposition of a property
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"PENDING_SALE"
PropertyUsageType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"INVESTMENT"
PropertyValuationMethodType
Description
The method used to determine the property's value.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AUTOMATED_VALUATION_MODEL"
ProposedGrossRentForSubjectPropertyIncome
Description
Proposed gross rent for subject property income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
PublicAssistanceIncome
Description
Public assistance income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
PurchasePricingInput
Fields
| Input Field | Description |
|---|---|
concessions - NonNegativeInt!
|
|
fipsCountyCode - String!
|
|
isBorrowerSelfEmployed - Boolean!
|
|
isFirstTimeHomeBuyer - Boolean!
|
|
loanTermYears - Float!
|
|
monthlyDebt - Float!
|
|
monthlyIncome - Float!
|
|
neighborhoodHousingType - NeighborhoodHousingType!
|
|
objectiveIntent - PricingObjectiveIntent
|
Configure the objective function to optimize against. Default = MIN_PITIA |
outOfPocketMax - Float!
|
|
propertyUsageType - PropertyUsageType!
|
|
qualifyingFicoScore - Int
|
|
rateLockDays - Float!
|
|
salesContractAmount - NonNegativeInt!
|
The amount of money that the property will be purchased for. Also called the purchase price. |
Example
{
"concessions": 123,
"fipsCountyCode": "abc123",
"isBorrowerSelfEmployed": false,
"isFirstTimeHomeBuyer": false,
"loanTermYears": 123.45,
"monthlyDebt": 987.65,
"monthlyIncome": 987.65,
"neighborhoodHousingType": "CONDOMINIUM",
"objectiveIntent": "MIN_DOWN_PAYMENT",
"outOfPocketMax": 123.45,
"propertyUsageType": "INVESTMENT",
"qualifyingFicoScore": 987,
"rateLockDays": 123.45,
"salesContractAmount": 123
}
PurchasePricingNoRestructureInput
Fields
| Input Field | Description |
|---|---|
concessions - NonNegativeInt!
|
|
downPayment - NonNegativeInt!
|
|
fipsCountyCode - String!
|
|
isBorrowerSelfEmployed - Boolean!
|
|
isFirstTimeHomeBuyer - Boolean!
|
|
loanAmount - NonNegativeInt!
|
|
loanTermYears - Float!
|
|
monthlyDebt - Float!
|
|
monthlyIncome - Float!
|
|
neighborhoodHousingType - NeighborhoodHousingType!
|
|
objectiveIntent - PricingObjectiveIntent
|
Configure the objective function to optimize against. Default = MIN_PITIA |
propertyUsageType - PropertyUsageType!
|
|
qualifyingFicoScore - Int
|
|
rateLockDays - Float!
|
Example
{
"concessions": 123,
"downPayment": 123,
"fipsCountyCode": "abc123",
"isBorrowerSelfEmployed": true,
"isFirstTimeHomeBuyer": false,
"loanAmount": 123,
"loanTermYears": 987.65,
"monthlyDebt": 123.45,
"monthlyIncome": 123.45,
"neighborhoodHousingType": "CONDOMINIUM",
"objectiveIntent": "MIN_DOWN_PAYMENT",
"propertyUsageType": "INVESTMENT",
"qualifyingFicoScore": 987,
"rateLockDays": 987.65
}
QmFeeCapViolation
Description
Loan post-structuring violates QM fee cap.
Example
{"borrowerPaidFees": 123.45, "loanAmount": 123.45, "parRate": 123.45}
Race
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AM_INDIAN_ALASKAN"
RateLockDetails
Description
Rate lock related fields
Fields
| Field Name | Description |
|---|---|
comments - String
|
Rate lock comments |
expirationTime - DateTime
|
The expiration time of the lock |
lockedTime - DateTime
|
The time when the rate was locked |
period - NonNegativeInt
|
The rate lock period in days |
requestedTime - DateTime
|
The time when the rate lock was requested |
status - RateLockStatus
|
Rate lock status |
Example
{
"comments": "abc123",
"expirationTime": "2007-12-03T10:15:30Z",
"lockedTime": "2007-12-03T10:15:30Z",
"period": 123,
"requestedTime": "2007-12-03T10:15:30Z",
"status": "CANCELLED"
}
RateLockStatus
Description
Rate lock status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CANCELLED"
Rates
Fields
| Field Name | Description |
|---|---|
apor - Apor
|
|
Arguments
|
|
Example
{"apor": Apor}
RealEstateOwnedGrossRentalIncome
Description
Real estate owned gross rental income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
propertyId - ID!
|
The owned real estate associated with the income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"propertyId": 4,
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
ReassignTaskInput
Description
Input to the reassignTask mutation.
Example
{
"loanId": "4",
"newAssignee": "xyz789",
"taskId": "4"
}
ReassignTaskResponse
Description
Response of the reassignTask mutation.
Fields
| Field Name | Description |
|---|---|
assignedTo - String!
|
Who the task is now assigned to |
Example
{"assignedTo": "xyz789"}
RefinanceCashOutType
Description
Refinance cash out type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CASH_OUT"
RefinancePricingInput
Fields
| Input Field | Description |
|---|---|
cashOut - NonNegativeInt!
|
The amount of cash to be returned to the borrower from the equity. Default = 0 |
concessions - NonNegativeInt!
|
|
fipsCountyCode - String!
|
|
firstLienAmount - NonNegativeInt!
|
The remaining balance on the first lien of the property |
isBorrowerSelfEmployed - Boolean!
|
|
isFirstTimeHomeBuyer - Boolean
|
This field is irrelevant for refinance and will be ignored. |
loanTermYears - Float!
|
|
monthlyDebt - Float!
|
|
monthlyIncome - Float!
|
|
neighborhoodHousingType - NeighborhoodHousingType!
|
|
objectiveIntent - PricingObjectiveIntent
|
Configure the objective function to optimize against. Default = MIN_PITIA |
propertyUsageType - PropertyUsageType!
|
|
propertyValue - NonNegativeInt!
|
The value of the property being refinanced in dollars. |
qualifyingFicoScore - Int
|
|
rateLockDays - Float!
|
Example
{
"cashOut": 123,
"concessions": 123,
"fipsCountyCode": "abc123",
"firstLienAmount": 123,
"isBorrowerSelfEmployed": false,
"isFirstTimeHomeBuyer": false,
"loanTermYears": 123.45,
"monthlyDebt": 123.45,
"monthlyIncome": 987.65,
"neighborhoodHousingType": "CONDOMINIUM",
"objectiveIntent": "MIN_DOWN_PAYMENT",
"propertyUsageType": "INVESTMENT",
"propertyValue": 123,
"qualifyingFicoScore": 987,
"rateLockDays": 123.45
}
RejectDocumentInput
RejectDocumentResponse
Description
Response of the rejected document mutation.
Fields
| Field Name | Description |
|---|---|
taskId - ID!
|
Success of the rejected task |
Example
{"taskId": 4}
RentalIncome
Description
Rental income
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Income ID |
ownedProperty - OwnedProperty!
|
The associated owned property entity |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"id": "4",
"ownedProperty": OwnedProperty,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
RequestConcessionInput
Fields
| Input Field | Description |
|---|---|
amount - NonNegativeInt
|
|
loanId - ID
|
|
reason - String
|
Example
{
"amount": 123,
"loanId": 4,
"reason": "abc123"
}
RequestConcessionResponse
Fields
| Field Name | Description |
|---|---|
concession - Concession
|
Example
{"concession": Concession}
RequestRateLockInput
RequestRateLockResponse
Description
Response of the requestRateLock mutation.
Fields
| Field Name | Description |
|---|---|
loanId - ID!
|
The ID or friendly ID of the loan. |
Example
{"loanId": "4"}
ReservesNotMetViolation
Description
Optimizer could not find a solution with sufficient reserves.
Fields
| Field Name | Description |
|---|---|
additionalReserveRequirements - Float!
|
Minimum additional dollars needed to meet the reserve requirements. |
Example
{"additionalReserveRequirements": 987.65}
RetirementFundAsset
Description
Retirement fund asset
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset |
id - ID!
|
Asset ID |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": ["4"],
"id": "4",
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["xyz789"],
"notableActivities": [FinancialAccountActivity]
}
RetirementIncome
Description
Retirement income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
RevokeConcessionInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
revocationReason - ConcessionRevocationReason
|
Example
{
"id": "4",
"revocationReason": "BETTER_LOAN_STRUCTURE"
}
RevokeConcessionResponse
Fields
| Field Name | Description |
|---|---|
concession - Concession
|
Example
{"concession": Concession}
RoyaltiesIncome
Description
Royalties income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
RunLoanPreApprovalInput
Description
Input to the runLoanPreApproval mutation.
Fields
| Input Field | Description |
|---|---|
loanId - ID!
|
The ID or friendly ID of the loan. |
Example
{"loanId": 4}
RunLoanPreApprovalResponse
Description
Response of the runLoanPreApproval mutation.
Fields
| Field Name | Description |
|---|---|
preApprovalRun - PreApprovalRun
|
|
userErrors - [UserError!]!
|
Example
{
"preApprovalRun": PreApprovalRun,
"userErrors": [UserError]
}
SavingsAccountAsset
Description
Savings account asset
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset |
id - ID!
|
Asset ID |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": [4],
"id": 4,
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["abc123"],
"notableActivities": [FinancialAccountActivity]
}
Scenario
Fields
| Field Name | Description |
|---|---|
pricing - ProductPricingQuery!
|
|
Arguments
|
|
purchasePricing - ProductPricingQuery!
|
|
Arguments
|
|
purchasePricingNoRestructure - ProductPricingQuery!
|
|
Arguments |
|
refinancePricing - ProductPricingQuery!
|
|
Arguments
|
|
Example
{
"pricing": ProductPricingQuery,
"purchasePricing": ProductPricingQuery,
"purchasePricingNoRestructure": ProductPricingQuery,
"refinancePricing": ProductPricingQuery
}
SelfEmployment
Description
Self employment
Fields
| Field Name | Description |
|---|---|
business - BorrowerBusiness
|
The associated business |
employmentClassification - EmploymentClassificationType!
|
Whether this is the borrower's primary or secondary employer |
endDate - Date
|
End date. Will be null if the employment is current. |
id - ID!
|
Employment ID |
isCurrentEmployment - Boolean!
|
Is the employment current? |
numberOfMonthsInLineOfWork - NonNegativeInt
|
The total number of months the borrower has been employed in this line of work, regardless of employer |
position - String
|
A name or description of the employment position or job title |
startDate - Date
|
Start date |
Example
{
"business": BorrowerBusiness,
"employmentClassification": "PRIMARY",
"endDate": "2007-12-03",
"id": "4",
"isCurrentEmployment": false,
"numberOfMonthsInLineOfWork": 123,
"position": "xyz789",
"startDate": "2007-12-03"
}
SelfEmploymentBusinessInput
Description
Self employment business input
Fields
| Input Field | Description |
|---|---|
address - AddressInput!
|
Address |
name - String!
|
Name |
percentOwnership - NonNegativeFloat!
|
Percent of the business that the borrower owns. This field is expressed as a percent. As an example, 50.1% is expressed as 50.1. |
Example
{
"address": AddressInput,
"name": "xyz789",
"percentOwnership": 123.45
}
SelfEmploymentIncome
Description
Self-employment income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
employment - SelfEmployment!
|
The associated employment |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"employment": SelfEmployment,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
SelfEmploymentLossIncome
Description
Self employment loss
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
SendMessageInput
SendMessageResponse
Fields
| Field Name | Description |
|---|---|
advisorCompletionJob - AdvisorCompletionJob!
|
Example
{"advisorCompletionJob": AdvisorCompletionJob}
SendOrganizationUserInvitationEmailInput
Fields
| Input Field | Description |
|---|---|
email - String!
|
Example
{"email": "abc123"}
SendOrganizationUserInvitationEmailResponse
Fields
| Field Name | Description |
|---|---|
userErrors - [GenericUserError!]!
|
Example
{"userErrors": [GenericUserError]}
SeparateMaintenanceIncome
Description
Separate maintenance income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
SetBorrowerEmailVerifiedInput
SetBorrowerEmailVerifiedResponse
Fields
| Field Name | Description |
|---|---|
id - ID!
|
ID of the borrower that was updated |
Example
{"id": 4}
SetExclusionReasonInput
Description
Update a Liability. Fields with non-null values will be updated, the rest will be ignored.
Fields
| Input Field | Description |
|---|---|
exclusionReason - LiabilityExclusionReason
|
The reason why the liability is excluded |
id - ID!
|
Liability ID |
Example
{"exclusionReason": "ASSIGNED_TO_ANOTHER_PARTY", "id": 4}
SetExclusionReasonResponse
Description
Response of the setExclusionReason mutation.
Fields
| Field Name | Description |
|---|---|
liability - Liability!
|
The updated Liability |
Example
{"liability": Liability}
SetIntentInput
Description
Update a Liability. Fields with non-null values will be updated, the rest will be ignored.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Liability ID |
intent - LiabilityIntent
|
The intent regarding liability |
Example
{"id": "4", "intent": "DO_NOTHING"}
SetIntentResponse
Description
Response of the setIntent mutation.
Fields
| Field Name | Description |
|---|---|
liability - Liability!
|
The updated Liability |
Example
{"liability": Liability}
SetSubjectPropertyFirstLienInput
SetSubjectPropertyFirstLienResponse
Fields
| Field Name | Description |
|---|---|
subjectProperty - SubjectProperty!
|
Updated subject property |
Example
{"subjectProperty": SubjectProperty}
SetUseOwnTitleCompanyInput
SetUseOwnTitleCompanyResponse
Sex
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"FEMALE"
SocialSecurityIncome
Description
Social Security income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
SortDirection
Description
The direction in which to sort a collection of items (ascending or descending).
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ASC"
StandardEmployment
Description
Standard employment
Fields
| Field Name | Description |
|---|---|
borrowerHasSpecialRelationshipWithEmployer - Boolean!
|
When true, indicates that the borrower has a special relationship with the employer, such as familial ties |
employer - Employer!
|
The borrower's employer |
employmentClassification - EmploymentClassificationType!
|
Whether this is the borrower's primary or secondary employer |
endDate - Date
|
End date. Will be null if the employment is current. |
id - ID!
|
Employment ID |
incomePayType - IncomePayType
|
The type of pay (hourly or salaried) |
isCurrentEmployment - Boolean!
|
Is the employment current? |
numberOfMonthsInLineOfWork - NonNegativeInt
|
The total number of months the borrower has been employed in this line of work, regardless of employer |
position - String
|
A name or description of the employment position or job title |
startDate - Date
|
Start date |
Example
{
"borrowerHasSpecialRelationshipWithEmployer": true,
"employer": Employer,
"employmentClassification": "PRIMARY",
"endDate": "2007-12-03",
"id": "4",
"incomePayType": "HOURLY",
"isCurrentEmployment": false,
"numberOfMonthsInLineOfWork": 123,
"position": "abc123",
"startDate": "2007-12-03"
}
StandardEmploymentIncome
Description
Standard employment income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
employment - StandardEmployment!
|
The associated employment |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"employment": StandardEmployment,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
StartAnalyticsExportJobInput
Fields
| Input Field | Description |
|---|---|
format - AnalyticsExportFormat!
|
|
root - AnalyticsExportRoot!
|
Example
{"format": "CSV", "root": "LOAN_APPLICATIONS"}
StartAnalyticsExportJobResponse
Fields
| Field Name | Description |
|---|---|
job - AnalyticsExportJob!
|
Example
{"job": AnalyticsExportJob}
StartIndividualCreditPullJobInput
Description
Input to start a hard credit pull job for an individual
Fields
| Input Field | Description |
|---|---|
borrower - CreditPullBorrowerInput!
|
Credit pull borrower |
pullType - CreditPullType
|
Type of credit to pull (soft or hard) |
Example
{"borrower": CreditPullBorrowerInput, "pullType": "HARD"}
StartIndividualCreditPullJobResponse
Description
Response of the startIndividualHardCreditPullJob mutation
Fields
| Field Name | Description |
|---|---|
job - CreditPullJob
|
Credit pull job |
userErrors - [String!]
|
User errors preventing credit pull |
Example
{
"job": CreditPullJob,
"userErrors": ["abc123"]
}
StartJointCreditPullJobInput
Description
Input to start a joint hard credit pull job for a married couple of borrowers
Fields
| Input Field | Description |
|---|---|
borrower1 - CreditPullBorrowerInput!
|
The first of two borrowers to be included in the joint credit report. They should be the spouse of borrower2. |
borrower2 - CreditPullBorrowerInput!
|
The second of two borrowers to be included in the joint credit report. They should be the spouse of borrower1. |
pullType - CreditPullType
|
Type of credit to pull (soft or hard) |
Example
{
"borrower1": CreditPullBorrowerInput,
"borrower2": CreditPullBorrowerInput,
"pullType": "HARD"
}
StartJointCreditPullJobResponse
Description
Response of the startJointHardCreditPullJob mutation
Fields
| Field Name | Description |
|---|---|
job - CreditPullJob
|
Credit pull job |
userErrors - [String!]
|
User errors preventing credit pull |
Example
{
"job": CreditPullJob,
"userErrors": ["xyz789"]
}
StateAbbreviated
Description
US state in two-letter abbreviated format
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AK"
StateLicense
StateLicenseInput
StockAsset
Description
Stock asset
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset |
id - ID!
|
Asset ID |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": ["4"],
"id": "4",
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["abc123"],
"notableActivities": [FinancialAccountActivity]
}
StockOptionsAsset
Description
Stock options asset
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset |
id - ID!
|
Asset ID |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": ["4"],
"id": 4,
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["xyz789"],
"notableActivities": [FinancialAccountActivity]
}
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"abc123"
StructureValidation
Fields
| Field Name | Description |
|---|---|
experiment - StructureValidationDebugResult
|
|
Arguments
|
|
Example
{"experiment": StructureValidationDebugResult}
StructureValidationDebugResult
StructureValidationOverride
Fields
| Input Field | Description |
|---|---|
purchasePrice - PositiveInt
|
Example
{"purchasePrice": 123}
StructuringError
Fields
| Field Name | Description |
|---|---|
loanTermYears - PositiveInt!
|
The term length of the loan, in years |
lock - PositiveInt!
|
The number of days this rate can be locked for. |
product - Product!
|
The product to which these calculations apply. |
publishedOn - Date!
|
The date that rates for this product were published. |
rate - Float!
|
The interest rate as a percentage. |
rateId - ID!
|
The ID of the rate. |
unsatisfiabilityDetails - [ProductStructureUnsatisfiabilityDetails!]!
|
Example
{
"loanTermYears": 123,
"lock": 123,
"product": Product,
"publishedOn": "2007-12-03",
"rate": 123.45,
"rateId": "4",
"unsatisfiabilityDetails": [GuidelineViolation]
}
StructuringResult
Types
| Union Types |
|---|
Example
EligibleProductStructure
SubjectProperty
Fields
| Field Name | Description |
|---|---|
address - Address
|
US Address |
attachmentType - AttachmentEnum
|
Whether the property is physically attached to neighboring units |
avmEstimatedValue - NonNegativeInt
|
The model estimated value of the property |
avmProvider - String
|
The model that provided estimated value of the property |
borrowerSpecifiedMonthlyPropertyTaxes - NonNegativeInt
|
The borrower-specified monthly property taxes |
hoaDues - NonNegativeInt
|
The monthly HOA dues of the property |
homeInsuranceMonthlyAmount - NonNegativeInt
|
The monthly home insurance premium associated with this property |
id - ID!
|
|
isPlannedUnitDevelopment - Boolean
|
Marks a subject property as being part of a planned unit development |
liabilities - [Liability!]!
|
The liabilities associated with the subject property |
manuallyEstimatedValue - NonNegativeInt
|
The manually estimated value of the property |
neighborhoodHousingType - NeighborhoodHousingType
|
The type of property |
propertyTaxesAndInsuranceIncludedInPayment - Boolean
|
Is Property taxes and insurance included in payment |
rentalEstimatedGrossMonthlyRentAmount - NonNegativeInt
|
The estimated gross monthly rent amount (for investment properties) |
subjectPropertyIntent - SubjectPropertyIntent!
|
Example
{
"address": Address,
"attachmentType": "ATTACHED",
"avmEstimatedValue": 123,
"avmProvider": "xyz789",
"borrowerSpecifiedMonthlyPropertyTaxes": 123,
"hoaDues": 123,
"homeInsuranceMonthlyAmount": 123,
"id": 4,
"isPlannedUnitDevelopment": true,
"liabilities": [Liability],
"manuallyEstimatedValue": 123,
"neighborhoodHousingType": "CONDOMINIUM",
"propertyTaxesAndInsuranceIncludedInPayment": false,
"rentalEstimatedGrossMonthlyRentAmount": 123,
"subjectPropertyIntent": SubjectPropertyIntent
}
SubjectPropertyIntent
Description
SubjectPropertyIntent
Fields
| Field Name | Description |
|---|---|
county - County
|
The county in which the borrower(s) intend to purchase |
id - ID!
|
The ID of the SubjectPropertyIntent |
isPlannedUnitDevelopment - Boolean
|
Marks a subject property as being part of a planned unit development Use SubjectProperty to read and update this field |
neighborhoodHousingType - NeighborhoodHousingType
|
The type of housing |
propertyUsageType - PropertyUsageType
|
How the borrower(s) intend to use the property |
state - StateAbbreviated
|
Abbreviated US state name (including DC) |
Example
{
"county": County,
"id": 4,
"isPlannedUnitDevelopment": true,
"neighborhoodHousingType": "CONDOMINIUM",
"propertyUsageType": "INVESTMENT",
"state": "AK"
}
SubjectPropertyMutations
Fields
| Field Name | Description |
|---|---|
addSubjectPropertyIntent - AddSubjectPropertyIntentResponse
|
Update a SubjectPropertyIntent. Fields with non-null values will be updated, the rest will be ignored. |
Arguments
|
|
attachAddress - AttachSubjectPropertyAddressResponse
|
Attaches street-level address to a subject property. |
Arguments |
|
attachLiabilities - AttachSubjectPropertyLiabilitiesResponse
|
Attach liabilities to the subject property. |
Arguments |
|
create - CreateSubjectPropertyResponse
|
Create a new subject property |
Arguments
|
|
detachAddress - DetachSubjectPropertyAddressResponse
|
Detach the address from a subject property. |
Arguments |
|
detachLiabilities - DetachSubjectPropertyLiabilitiesResponse
|
Detach liabilities from the subject property. |
Arguments |
|
setFirstLien - SetSubjectPropertyFirstLienResponse
|
Add first lien to a subject property. |
Arguments |
|
unsetFirstLien - UnsetSubjectPropertyFirstLienResponse
|
Remove first lien from a subject property. |
Arguments |
|
update - UpdateSubjectPropertyResponse
|
Update a SubjectProperty. Fields with non-null values will be updated, the rest will be ignored. |
Arguments
|
|
updateSubjectPropertyIntent - UpdateSubjectPropertyIntentResponse
|
Update a SubjectPropertyIntent. Fields with non-null values will be updated, the rest will be ignored. |
Arguments |
|
Example
{
"addSubjectPropertyIntent": AddSubjectPropertyIntentResponse,
"attachAddress": AttachSubjectPropertyAddressResponse,
"attachLiabilities": AttachSubjectPropertyLiabilitiesResponse,
"create": CreateSubjectPropertyResponse,
"detachAddress": DetachSubjectPropertyAddressResponse,
"detachLiabilities": DetachSubjectPropertyLiabilitiesResponse,
"setFirstLien": SetSubjectPropertyFirstLienResponse,
"unsetFirstLien": UnsetSubjectPropertyFirstLienResponse,
"update": UpdateSubjectPropertyResponse,
"updateSubjectPropertyIntent": UpdateSubjectPropertyIntentResponse
}
SubjectPropertyNetCashFlowIncome
Description
Subject property net cash flow income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
SubmitUnderwritingNotesInput
SubmitUnderwritingNotesResponse
Description
Response of the submitUnderwritingNotes mutation.
Fields
| Field Name | Description |
|---|---|
notes - String
|
Notes submitted with the underwriting run |
Example
{"notes": "xyz789"}
TaskAssignee
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"BORROWER"
TaskEntityDetails
Description
Details about the entity associated with a task
Example
{
"borrowerId": "4",
"borrowerName": "abc123",
"entityDisplayName": "xyz789",
"entityKind": "abc123"
}
TaskStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AutomaticallyCancelled"
TaskType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DataVerification"
TaxIdentifierNumberType
Description
Tax identifier number type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER"
TemporaryLeaveIncome
Description
Temporary leave income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
ThawLoanInput
Description
Input to the thaw mutation.
Fields
| Input Field | Description |
|---|---|
loanId - ID!
|
The ID or friendly ID of the loan. |
Example
{"loanId": 4}
ThawLoanResponse
Description
Response of the thaw mutation.
Fields
| Field Name | Description |
|---|---|
loan - Loan!
|
The loan |
Example
{"loan": Loan}
TipIncome
Description
Tip income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
Title
Description
Information about the title associated with a loan.
Fields
| Field Name | Description |
|---|---|
agents - [Contact!]!
|
List of title agents. |
clearedToCloseAt - Date
|
Date the title was cleared to close. |
commitmentReceivedAt - DateTime
|
Date the title commitment was received from the title company. |
documents - [Document!]!
|
Documents associated with the title. |
orderedAt - DateTime
|
Date the title order was placed with the title company. |
policyEffectiveAt - Date
|
Effective date listed on the title insurance policy. |
policyReceivedAt - Date
|
Date the title insurance policy document was received. |
Example
{
"agents": [Contact],
"clearedToCloseAt": "2007-12-03",
"commitmentReceivedAt": "2007-12-03T10:15:30Z",
"documents": [Document],
"orderedAt": "2007-12-03T10:15:30Z",
"policyEffectiveAt": "2007-12-03",
"policyReceivedAt": "2007-12-03"
}
TitleVendor
Fields
| Field Name | Description |
|---|---|
contactInfo - TitleVendorContactInfo!
|
Contact information for the title vendor |
name - String!
|
The name of the title vendor company |
relationType - TitleVendorRelationType!
|
Type of services provided by this title vendor |
Example
{
"contactInfo": TitleVendorContactInfo,
"name": "abc123",
"relationType": "CLOSING_ONLY"
}
TitleVendorContactInfo
Fields
| Field Name | Description |
|---|---|
address - String
|
Street address of the title vendor |
city - String
|
City where the title vendor is located |
email - String
|
Email address of the title vendor |
licenseNumber - String
|
License number of the title vendor |
pointOfContact - TitleVendorPointOfContact
|
Point of contact information for the title vendor |
state - StateAbbreviated
|
State where the title vendor is located |
website - String
|
Website URL of the title vendor |
zip - String
|
ZIP code of the title vendor |
Example
{
"address": "abc123",
"city": "abc123",
"email": "abc123",
"licenseNumber": "abc123",
"pointOfContact": TitleVendorPointOfContact,
"state": "AK",
"website": "abc123",
"zip": "abc123"
}
TitleVendorPointOfContact
TitleVendorRelationType
Description
Type of services provided by the title vendor
Values
| Enum Value | Description |
|---|---|
|
|
Only provides closing/settlement/escrow service. A separate title agent would be necessary for title insurance. |
|
|
Full service title agent. Provides closing/settlement/escrow services and title insurance. No other agent is necessary for a closing. |
|
|
Title only. An escrow/closing/settlement agent will also be necessary. |
|
|
Unknown or unspecified relation type. |
Example
"CLOSING_ONLY"
TitleVendorsInput
Fields
| Input Field | Description |
|---|---|
addressLine - String
|
Property address |
county - String!
|
County where the property is located |
purpose - LoanPurposeType!
|
Purpose of the loan transaction |
state - StateAbbreviated!
|
State code where the property is located |
township - String
|
Township where the property is located |
Example
{
"addressLine": "abc123",
"county": "abc123",
"purpose": "PURCHASE",
"state": "AK",
"township": "xyz789"
}
TrailingCoBorrowerIncome
Description
Trailing co-borrower income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
TriggerAusRunInput
Fields
| Input Field | Description |
|---|---|
loanId - ID!
|
Example
{"loanId": "4"}
TriggerAusRunResponse
Fields
| Field Name | Description |
|---|---|
job - AusRunJob
|
|
userErrors - [AusUserError!]!
|
Example
{
"job": AusRunJob,
"userErrors": [NoAusForProduct]
}
TrustAccountAsset
Description
Trust account asset
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset |
id - ID!
|
Asset ID |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
trusteeName - String
|
The legal name of the trustee |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": [4],
"id": "4",
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["abc123"],
"notableActivities": [FinancialAccountActivity],
"trusteeName": "abc123"
}
TrustIncome
Description
Trust income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
UnemploymentIncome
Description
Unemployment income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
UnsetBorrowerMilitaryServiceInput
Description
Input to unset borrower military service.
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
ID of the borrower to update |
Example
{"borrowerId": "4"}
UnsetBorrowerMilitaryServiceResponse
Description
Response of the unset borrower military service mutation
Fields
| Field Name | Description |
|---|---|
militaryService - BorrowerMilitaryService
|
The updated borrower military service |
Example
{"militaryService": BorrowerMilitaryService}
UnsetSubjectPropertyFirstLienInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the subject property |
Example
{"id": 4}
UnsetSubjectPropertyFirstLienResponse
Fields
| Field Name | Description |
|---|---|
subjectProperty - SubjectProperty!
|
Updated subject property |
Example
{"subjectProperty": SubjectProperty}
UnsupportedUsStateError
UpdateAnyAssetInput
Description
Input for updating an Asset of any type. Includes only Asset interface fields.
Fields
| Input Field | Description |
|---|---|
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"amount": 123,
"id": "4",
"nonBorrowerOwnerNames": ["xyz789"]
}
UpdateAnyIncomeInput
Description
Input for updating an Income of any type. Includes only Income interface fields.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the income to update |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt
|
Stated monthly income amount in dollars |
Example
{
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
UpdateAssetInput
Description
Input to the updateAsset mutation. This is a 'oneOf' type where exactly one field must be populated.
Fields
Example
{
"any": UpdateAnyAssetInput,
"automobile": UpdateAutomobileAssetInput,
"bond": UpdateBondAssetInput,
"bridgeLoanNotDeposited": UpdateBridgeLoanNotDepositedAssetInput,
"cashOnHand": UpdateCashOnHandAssetInput,
"certificateOfDepositTimeDeposit": UpdateCertificateOfDepositTimeDepositAssetInput,
"checkingAccount": UpdateCheckingAccountAssetInput,
"gift": UpdateGiftAssetInput,
"grant": UpdateGrantAssetInput,
"individualDevelopmentAccount": UpdateIndividualDevelopmentAccountAssetInput,
"lifeInsurance": UpdateLifeInsuranceAssetInput,
"moneyMarketFund": UpdateMoneyMarketFundAssetInput,
"mutualFund": UpdateMutualFundAssetInput,
"other": UpdateOtherAssetInput,
"pendingNetSaleProceedsFromRealEstate": UpdatePendingNetSaleProceedsFromRealEstateAssetInput,
"proceedsFromSaleOfNonRealEstateAsset": UpdateProceedsFromSaleOfNonRealEstateAssetInput,
"proceedsFromSecuredLoan": UpdateProceedsFromSecuredLoanAssetInput,
"proceedsFromUnsecuredLoan": UpdateProceedsFromUnsecuredLoanAssetInput,
"retirementFund": UpdateRetirementFundAssetInput,
"savingsAccount": UpdateSavingsAccountAssetInput,
"stock": UpdateStockAssetInput,
"stockOptions": UpdateStockOptionsAssetInput,
"trustAccount": UpdateTrustAccountAssetInput
}
UpdateAssetResponse
Description
Response of the updateAsset mutation.
Fields
| Field Name | Description |
|---|---|
asset - Asset!
|
The updated asset |
Example
{"asset": Asset}
UpdateAutomobileAssetInput
Fields
| Input Field | Description |
|---|---|
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"amount": 123,
"id": "4",
"nonBorrowerOwnerNames": ["xyz789"]
}
UpdateBondAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"id": "4",
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["xyz789"]
}
UpdateBorrowerConsentInput
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
ID of the borrower to update |
hardCreditConsentDate - DateTime
|
|
hardCreditConsentType - CreditPullConsentType
|
|
softCreditConsentDate - DateTime
|
|
softCreditConsentType - CreditPullConsentType
|
Example
{
"borrowerId": 4,
"hardCreditConsentDate": "2007-12-03T10:15:30Z",
"hardCreditConsentType": "ELECTRONIC",
"softCreditConsentDate": "2007-12-03T10:15:30Z",
"softCreditConsentType": "ELECTRONIC"
}
UpdateBorrowerConsentResponse
Description
Response of the update borrower consent mutation.
Fields
| Field Name | Description |
|---|---|
borrowerId - ID!
|
ID of the borrower to update |
hardCreditConsentDate - DateTime
|
|
hardCreditConsentType - CreditPullConsentType
|
|
softCreditConsentDate - DateTime
|
|
softCreditConsentType - CreditPullConsentType
|
Example
{
"borrowerId": 4,
"hardCreditConsentDate": "2007-12-03T10:15:30Z",
"hardCreditConsentType": "ELECTRONIC",
"softCreditConsentDate": "2007-12-03T10:15:30Z",
"softCreditConsentType": "ELECTRONIC"
}
UpdateBorrowerDependentsInput
Description
Input to the update borrower dependents mutation. Fields with non-null values will be updated, the rest will be ignored.
Example
{
"borrowerId": "4",
"dependentAges": [987.65]
}
UpdateBorrowerDependentsResponse
Description
Response of the update borrower dependents mutation
Fields
| Field Name | Description |
|---|---|
dependentAges - [Float!]!
|
The updated borrower Dependents |
Example
{"dependentAges": [123.45]}
UpdateBorrowerFinancialDeclarationsInput
Description
Input to the update borrower financial declarations mutation. Fields with non-null values will be updated, the rest will be ignored.
Fields
| Input Field | Description |
|---|---|
bankruptcyChapterType - BankruptcyChapterType
|
The type of bankruptcy filed, if any. |
bankruptcyIndicator - Boolean
|
Indicates if the borrower has filed for bankruptcy. |
borrowerId - ID!
|
ID of the borrower to update |
homeownerPastThreeYears - Boolean
|
Indicates if the borrower has been a homeowner in the past three years. |
intentToOccupy - Boolean
|
Indicates if the borrower intends to occupy the property. |
outstandingJudgmentsIndicator - Boolean
|
Indicates if the borrower has outstanding judgments. |
partyToLawsuitIndicator - Boolean
|
Indicates if the borrower is currently a party to a lawsuit. |
presentlyDelinquentIndicator - Boolean
|
Indicates if the borrower is presently delinquent on any obligations. |
priorPropertyDeedInLieuConveyedIndicator - Boolean
|
Indicates if the borrower has conveyed a prior property deed in lieu of foreclosure. |
priorPropertyForeclosureCompletedIndicator - Boolean
|
Indicates if the borrower has completed a prior property foreclosure. |
priorPropertyShortSaleCompletedIndicator - Boolean
|
Indicates if the borrower has completed a prior property short sale. |
priorPropertyTitleType - PriorPropertyTitleType
|
Indicates the type of title ownership for the borrower's prior property, such as sole ownership or joint ownership. |
priorPropertyUsageType - PriorPropertyUsageType
|
Specifies how the borrower's prior property was used, such as primary residence, investment, or second home. |
undisclosedComakerOfNoteIndicator - Boolean
|
Indicates if the borrower is an undisclosed co-maker of a note. |
undisclosedCreditApplicationIndicator - Boolean
|
Indicates if the borrower has an undisclosed credit application. |
undisclosedMortgageApplicationIndicator - Boolean
|
Indicates if the borrower has an undisclosed mortgage application. |
Example
{
"bankruptcyChapterType": "CHAPTER_ELEVEN",
"bankruptcyIndicator": false,
"borrowerId": 4,
"homeownerPastThreeYears": false,
"intentToOccupy": true,
"outstandingJudgmentsIndicator": false,
"partyToLawsuitIndicator": false,
"presentlyDelinquentIndicator": false,
"priorPropertyDeedInLieuConveyedIndicator": false,
"priorPropertyForeclosureCompletedIndicator": true,
"priorPropertyShortSaleCompletedIndicator": false,
"priorPropertyTitleType": "JOINT_WITH_OTHER_THAN_SPOUSE",
"priorPropertyUsageType": "FHA_SECONDARY_RESIDENCE",
"undisclosedComakerOfNoteIndicator": false,
"undisclosedCreditApplicationIndicator": true,
"undisclosedMortgageApplicationIndicator": true
}
UpdateBorrowerFinancialDeclarationsResponse
Description
Response of the update borrower financial declarations mutation
Fields
| Field Name | Description |
|---|---|
financialDeclarations - BorrowerFinancialDeclarations!
|
The updated borrower declarations |
Example
{"financialDeclarations": BorrowerFinancialDeclarations}
UpdateBorrowerInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the borrower to update |
isFirstTimeHomeBuyer - Boolean
|
|
maritalStatus - MaritalStatusType
|
Example
{
"id": "4",
"isFirstTimeHomeBuyer": false,
"maritalStatus": "DIVORCED"
}
UpdateBorrowerMailingAddressInput
Example
{
"city": "xyz789",
"id": 4,
"line": "abc123",
"line2": "xyz789",
"state": "AK",
"zipCode": "abc123"
}
UpdateBorrowerMailingAddressResponse
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower that was updated |
Example
{"borrower": Borrower}
UpdateBorrowerMilitaryServiceInput
Description
Input to the update borrower military service mutation. Fields with non-null values will be updated, the rest will be ignored.
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
ID of the borrower to update |
militaryServiceExpectedCompletionDate - Date
|
|
militaryStatusType - MilitaryStatusType
|
|
survivingSpouseIndicator - Boolean
|
Example
{
"borrowerId": "4",
"militaryServiceExpectedCompletionDate": "2007-12-03",
"militaryStatusType": "ACTIVE_DUTY",
"survivingSpouseIndicator": false
}
UpdateBorrowerMilitaryServiceResponse
Description
Response of the update borrower military service mutation
Fields
| Field Name | Description |
|---|---|
militaryService - BorrowerMilitaryService
|
The updated borrower military service |
Example
{"militaryService": BorrowerMilitaryService}
UpdateBorrowerPersonalInformationInput
Fields
| Input Field | Description |
|---|---|
citizenshipResidencyType - CitizenshipResidencyType
|
|
dateOfBirth - Date
|
|
email - String
|
|
firstName - String
|
|
id - ID!
|
ID of the borrower to update |
lastName - String
|
|
middleName - String
|
|
taxIdentifierNumber - String
|
Tax identifier number |
taxIdentifierNumberType - TaxIdentifierNumberType
|
Tax identifier number type |
Example
{
"citizenshipResidencyType": "NON_PERMANENT_RESIDENT_ALIEN",
"dateOfBirth": "2007-12-03",
"email": "abc123",
"firstName": "abc123",
"id": 4,
"lastName": "abc123",
"middleName": "xyz789",
"taxIdentifierNumber": "xyz789",
"taxIdentifierNumberType": "INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER"
}
UpdateBorrowerPersonalInformationResponse
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower that was updated |
Example
{"borrower": Borrower}
UpdateBorrowerPhoneNumberInput
Description
A phone number
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Id of the phone number to update |
number - String
|
Phone Number |
type - PhoneNumberType
|
Phone number type |
Example
{
"id": 4,
"number": "abc123",
"type": "CELL"
}
UpdateBorrowerPhoneNumberResponse
Fields
| Field Name | Description |
|---|---|
phoneNumber - BorrowerPhoneNumber!
|
The phone number that was updated |
Example
{"phoneNumber": BorrowerPhoneNumber}
UpdateBorrowerPreferencesInput
Description
Input to the borrowerPreferences mutation.
Fields
| Input Field | Description |
|---|---|
closingCosts - NonNegativeFloat
|
The maximum allowable closing costs. |
downPaymentAmount - NonNegativeFloat
|
The down payment amount. |
loanId - ID!
|
The loan ID for borrower preferences. |
loanTermYears - NonNegativeInt
|
The loan term in years. Default = 30 |
maxDiscountPoints - Float
|
Limit number of rate point buys to not exceed this value. |
maxLtv - NonNegativeFloat
|
Max loan-to-value ratio allowed. Will not override takeout requirements. |
monthlyPayment - NonNegativeFloat
|
The maximum allowable monthly payment. |
mortgageInsurance - Boolean
|
Indicates whether mortgage insurance is required. |
principal - NonNegativeFloat
|
The maximum allowable principal amount. |
rate - NonNegativeFloat
|
The preferred interest rate. |
rateLockTerm - NonNegativeInt
|
The rate lock period in days. Default = 30 |
totalCost - NonNegativeFloat
|
The cost of points for the loan. |
totalPoints - NonNegativeFloat
|
The number of points required for the loan. |
Example
{
"closingCosts": 123.45,
"downPaymentAmount": 123.45,
"loanId": 4,
"loanTermYears": 123,
"maxDiscountPoints": 123.45,
"maxLtv": 123.45,
"monthlyPayment": 123.45,
"mortgageInsurance": false,
"principal": 123.45,
"rate": 123.45,
"rateLockTerm": 123,
"totalCost": 123.45,
"totalPoints": 123.45
}
UpdateBorrowerPreferencesResponse
Description
Response of the updateBorrowerPreferences mutation.
Fields
| Field Name | Description |
|---|---|
borrowerPreferences - BorrowerPreferences!
|
Updated borrower preferences. |
loanTermYears - NonNegativeInt!
|
Updated loan term in years |
rateLockTerm - NonNegativeInt!
|
Updated rate lock period |
Example
{
"borrowerPreferences": BorrowerPreferences,
"loanTermYears": 123,
"rateLockTerm": 123
}
UpdateBorrowerPropertyDeclarationsInput
Description
Input to the update borrower property declarations mutation. Fields with non-null values will be updated, the rest will be ignored.
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
ID of the borrower to update |
propertySubjectToPriorityLienIndicator - Boolean
|
Flag to indicate whether realtor tasks are complete on this loan |
specialBorrowerSellerRelationshipIndicator - Boolean
|
Flag to indicate whether realtor tasks are complete on this loan |
undisclosedBorrowedFundsAmount - Float
|
Flag to indicate whether realtor tasks are complete on this loan |
undisclosedBorrowedFundsIndicator - Boolean
|
Flag to indicate whether realtor tasks are complete on this loan |
Example
{
"borrowerId": "4",
"propertySubjectToPriorityLienIndicator": true,
"specialBorrowerSellerRelationshipIndicator": false,
"undisclosedBorrowedFundsAmount": 123.45,
"undisclosedBorrowedFundsIndicator": false
}
UpdateBorrowerPropertyDeclarationsResponse
Description
Response of the update borrower property declarations mutation
Fields
| Field Name | Description |
|---|---|
propertyDeclarations - BorrowerPropertyDeclarations!
|
The updated borrower declarations |
Example
{"propertyDeclarations": BorrowerPropertyDeclarations}
UpdateBorrowerResponse
Description
Response of the update borrower mutation.
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower that was updated |
Example
{"borrower": Borrower}
UpdateBridgeLoanNotDepositedAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"id": 4,
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["abc123"]
}
UpdateCashOnHandAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"id": 4,
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["abc123"]
}
UpdateCertificateOfDepositTimeDepositAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"id": 4,
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["xyz789"]
}
UpdateCheckingAccountAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"id": 4,
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["xyz789"]
}
UpdateCommsTemplateInput
UpdateCommsTemplateResponse
UpdateConcessionInput
Fields
| Input Field | Description |
|---|---|
amount - NonNegativeInt
|
|
id - ID!
|
|
reason - String
|
Example
{"amount": 123, "id": 4, "reason": "xyz789"}
UpdateConcessionResponse
Fields
| Field Name | Description |
|---|---|
concession - Concession
|
Example
{"concession": Concession}
UpdateContactInput
Fields
| Input Field | Description |
|---|---|
address - AddressInput
|
Optional U.S. address to create with the contact. |
companyLicenseNumber - String
|
License number of the company the contact represents |
companyLicenseState - StateAbbreviated
|
State where the company's license was issued |
companyName - String
|
Company which the contact is from |
email - String
|
Email address of the contact |
firstName - String
|
First name of the contact |
hazardInsuranceCoverage - HazardInsuranceCoverageType
|
Coverage provided by a hazard insurer |
id - ID!
|
ID of the contact to update. |
individualLicenseNumber - String
|
Professional license number of the individual contact |
individualLicenseState - StateAbbreviated
|
State where the individual's professional license was issued |
lastName - String
|
Last name of the contact |
middleName - String
|
Middle name of the contact |
phoneNumber - String
|
Phone number of the contact |
role - OrganizationContactRole
|
Contact's role, limited to currently supported values. |
Example
{
"address": AddressInput,
"companyLicenseNumber": "abc123",
"companyLicenseState": "AK",
"companyName": "abc123",
"email": "xyz789",
"firstName": "abc123",
"hazardInsuranceCoverage": "EARTHQUAKE",
"id": "4",
"individualLicenseNumber": "xyz789",
"individualLicenseState": "AK",
"lastName": "xyz789",
"middleName": "abc123",
"phoneNumber": "abc123",
"role": "ATTORNEY"
}
UpdateContactResponse
Fields
| Field Name | Description |
|---|---|
updated - Contact!
|
Updated contact details. |
Example
{"updated": Contact}
UpdateContributorContactInfoInput
UpdateContributorInput
Fields
| Input Field | Description |
|---|---|
contactInfo - UpdateContributorContactInfoInput
|
|
id - ID!
|
Example
{
"contactInfo": UpdateContributorContactInfoInput,
"id": "4"
}
UpdateContributorResponse
Fields
| Field Name | Description |
|---|---|
contributor - Contributor!
|
Example
{"contributor": Contributor}
UpdateCurrentBorrowerAddressInput
Description
Current Borrower Address Input
Fields
| Input Field | Description |
|---|---|
address - AddressInput
|
US address to update |
borrowerId - ID!
|
Borrower ID |
monthlyRentAmount - NonNegativeInt
|
The monthly rental amount in dollars |
moveInDate - Date
|
Move in date |
residencyBasis - BorrowerResidencyBasis
|
The basis on which the borrower lives/lived at this address |
Example
{
"address": AddressInput,
"borrowerId": 4,
"monthlyRentAmount": 123,
"moveInDate": "2007-12-03",
"residencyBasis": "LIVING_RENT_FREE"
}
UpdateCurrentBorrowerAddressResponse
Fields
| Field Name | Description |
|---|---|
address - Address!
|
US Address |
id - ID!
|
Borrower Address ID |
monthlyRentAmount - NonNegativeInt
|
The monthly rental amount in dollars |
moveInDate - Date
|
Move in date |
residencyBasis - BorrowerResidencyBasis
|
The basis on which the borrower lives/lived at this address |
Example
{
"address": Address,
"id": "4",
"monthlyRentAmount": 123,
"moveInDate": "2007-12-03",
"residencyBasis": "LIVING_RENT_FREE"
}
UpdateDemographicInfoInput
Fields
| Input Field | Description |
|---|---|
asianOther - String
|
|
asianRace - [AsianRace!]
|
|
ethnicity - [Ethnicity!]
|
|
ethnicityNotDisclosed - Boolean
|
|
hispanicOrigin - [HispanicOrigin!]
|
|
hispanicOther - String
|
|
id - ID!
|
ID of the borrower to update |
pacificIslanderOther - String
|
|
pacificIslanderRace - [PacificIslanderRace!]
|
|
race - [Race!]
|
|
raceNotDisclosed - Boolean
|
|
sex - [Sex!]
|
|
sexNotDisclosed - Boolean
|
|
tribe - String
|
Example
{
"asianOther": "abc123",
"asianRace": ["CHINESE"],
"ethnicity": ["HISPANIC"],
"ethnicityNotDisclosed": false,
"hispanicOrigin": ["CUBA"],
"hispanicOther": "abc123",
"id": "4",
"pacificIslanderOther": "abc123",
"pacificIslanderRace": ["GUAMANIAN_OR_CHAMORRO"],
"race": ["AM_INDIAN_ALASKAN"],
"raceNotDisclosed": true,
"sex": ["FEMALE"],
"sexNotDisclosed": false,
"tribe": "xyz789"
}
UpdateDemographicInfoResponse
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower |
Example
{"borrower": Borrower}
UpdateGiftAssetInput
Fields
| Input Field | Description |
|---|---|
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
dateOfTransfer - Date
|
The date when the gift/grant funds were transferred into the borrower's account |
donorEmployeeIdentificationNumber - String
|
Employer Identification Number (EIN) of the gift/grant donor |
donorName - String
|
Full name of the person providing the gift/grant |
donorPhoneNumber - String
|
The phone number of the person providing the gift/grant |
id - ID!
|
The ID of the asset to update |
isIncludedInAssetAccount - Boolean
|
Indicates whether the gift/grant funds have already been included as part of an asset account considered for the loan |
isSellerFunded - Boolean
|
Indicates whether the gift/grant is funded by the seller |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
source - GiftSource
|
Gift/Grant source |
Example
{
"amount": 123,
"dateOfTransfer": "2007-12-03",
"donorEmployeeIdentificationNumber": "xyz789",
"donorName": "abc123",
"donorPhoneNumber": "xyz789",
"id": 4,
"isIncludedInAssetAccount": true,
"isSellerFunded": true,
"nonBorrowerOwnerNames": ["abc123"],
"source": "COMMUNITY_NON_PROFIT"
}
UpdateGrantAssetInput
Fields
| Input Field | Description |
|---|---|
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
dateOfTransfer - Date
|
The date when the gift/grant funds were transferred into the borrower's account |
donorEmployeeIdentificationNumber - String
|
Employer Identification Number (EIN) of the gift/grant donor |
donorName - String
|
Full name of the person providing the gift/grant |
donorPhoneNumber - String
|
The phone number of the person providing the gift/grant |
id - ID!
|
The ID of the asset to update |
isIncludedInAssetAccount - Boolean
|
Indicates whether the gift/grant funds have already been included as part of an asset account considered for the loan |
isSellerFunded - Boolean
|
Indicates whether the gift/grant is funded by the seller |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
source - GiftSource
|
Gift/Grant source |
Example
{
"amount": 123,
"dateOfTransfer": "2007-12-03",
"donorEmployeeIdentificationNumber": "xyz789",
"donorName": "abc123",
"donorPhoneNumber": "xyz789",
"id": 4,
"isIncludedInAssetAccount": true,
"isSellerFunded": false,
"nonBorrowerOwnerNames": ["xyz789"],
"source": "COMMUNITY_NON_PROFIT"
}
UpdateIncomeInput
Description
Input to the updateIncome mutation. This is a 'oneOf' type where exactly one field must be populated.
Fields
| Input Field | Description |
|---|---|
any - UpdateAnyIncomeInput
|
Update an Income of any type that implements the Income interface |
mortgageCreditCertificate - UpdateMortgageCreditCertificateIncomeInput
|
|
other - UpdateOtherIncomeInput
|
|
selfEmployment - UpdateSelfEmploymentIncomeInput
|
|
standardEmployment - UpdateStandardEmploymentIncomeInput
|
Example
{
"any": UpdateAnyIncomeInput,
"mortgageCreditCertificate": UpdateMortgageCreditCertificateIncomeInput,
"other": UpdateOtherIncomeInput,
"selfEmployment": UpdateSelfEmploymentIncomeInput,
"standardEmployment": UpdateStandardEmploymentIncomeInput
}
UpdateIncomeResponse
Description
Response of the updateIncome mutation.
Fields
| Field Name | Description |
|---|---|
income - Income!
|
The updated income |
Example
{"income": Income}
UpdateIndividualDevelopmentAccountAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"id": 4,
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["xyz789"]
}
UpdateLifeInsuranceAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"id": 4,
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["abc123"]
}
UpdateLoanInput
Description
Input to the updateLoan mutation.
Fields
| Input Field | Description |
|---|---|
closingDate - Date
|
The date that the purchase is set to close. |
earnestMoneyDeposit - NonNegativeFloat
|
The total amount of earnest money deposit |
id - ID!
|
The ID or friendly ID of the loan. |
loanPurpose - LoanPurposeType
|
The purpose for which the loan proceeds will be used. |
loanTermYears - PositiveFloat
|
The term of this loan in years. |
outOfPocketMax - NonNegativeInt
|
The maximum amount of assets (in dollars) to be used towards the loan. |
purchasePrice - NonNegativeInt
|
The actual purchase price (in dollars). |
refinanceCashOutProceeds - NonNegativeInt
|
Refinance cash out proceeds not used towards paying off existing liens. |
sellerCredit - NonNegativeInt
|
The total seller credit to be applied towards closing costs |
Example
{
"closingDate": "2007-12-03",
"earnestMoneyDeposit": 123.45,
"id": 4,
"loanPurpose": "PURCHASE",
"loanTermYears": 123.45,
"outOfPocketMax": 123,
"purchasePrice": 123,
"refinanceCashOutProceeds": 123,
"sellerCredit": 123
}
UpdateLoanResponse
Description
Response of the updateLoan mutation.
Fields
| Field Name | Description |
|---|---|
loan - Loan!
|
The updated loan. |
Example
{"loan": Loan}
UpdateMoneyMarketFundAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"id": 4,
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["xyz789"]
}
UpdateMortgageCreditCertificateIncomeInput
Description
Input for updating a MortgageCreditCertificateIncome
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the income to update |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
percentageOfInterest - NonNegativeFloat
|
The percentage of interest that the mortgage credit certificate will cover. This field is expressed as a percent. As an example, 50.1% is expressed as 50.1. |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt
|
Stated monthly income amount in dollars |
Example
{
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"percentageOfInterest": 123.45,
"statedAmount": 123,
"statedMonthlyAmount": 123
}
UpdateMutualFundAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"id": "4",
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["abc123"]
}
UpdateNonBorrowingOwnerInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
personalInformation - PersonalInformationInput
|
Example
{
"id": "4",
"personalInformation": PersonalInformationInput
}
UpdateNonBorrowingOwnerResponse
Fields
| Field Name | Description |
|---|---|
nonBorrowingOwner - NonBorrowingOwner!
|
Example
{"nonBorrowingOwner": NonBorrowingOwner}
UpdateNotableActivityInput
Description
Input to the updateNotableActivity mutation.
Fields
| Input Field | Description |
|---|---|
activityType - FinancialAccountActivityType
|
Activity type |
amount - Int
|
The amount of money in dollars |
date - Date
|
The date when the activity occurred |
description - String
|
Description of the activity |
id - ID!
|
The ID of the FinancialAccountActivity |
Example
{
"activityType": "LARGE_DEPOSIT",
"amount": 987,
"date": "2007-12-03",
"description": "abc123",
"id": "4"
}
UpdateNotableActivityResponse
Description
Response of the updateNotableActivity mutation.
Fields
| Field Name | Description |
|---|---|
activity - FinancialAccountActivity!
|
The FinancialAccountActivity entity that was updated |
Example
{"activity": FinancialAccountActivity}
UpdateOrganizationInput
Example
{
"companyLegalName": "xyz789",
"companyName": "abc123",
"companySupportEmail": "xyz789",
"electronicCommunicationsConsentUrl": "abc123",
"nmlsId": "abc123",
"privacyPolicyUrl": "abc123",
"telephonicCommunicationsConsentUrl": "abc123",
"termsOfServiceUrl": "xyz789"
}
UpdateOrganizationLicensingInput
Fields
| Input Field | Description |
|---|---|
states - [OrganizationStateWithLicensesInput!]!
|
Example
{"states": [OrganizationStateWithLicensesInput]}
UpdateOrganizationLicensingResponse
Fields
| Field Name | Description |
|---|---|
licensing - OrganizationLicensing
|
|
userErrors - [GenericUserError!]!
|
Example
{
"licensing": OrganizationLicensing,
"userErrors": [GenericUserError]
}
UpdateOrganizationResponse
Fields
| Field Name | Description |
|---|---|
organization - Organization
|
Example
{"organization": Organization}
UpdateOrganizationRolePermissionsInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
permissions - [String!]!
|
Example
{"id": 4, "permissions": ["abc123"]}
UpdateOrganizationRolePermissionsResponse
Fields
| Field Name | Description |
|---|---|
organizationRole - OrganizationRole
|
|
userErrors - [GenericUserError!]!
|
Example
{
"organizationRole": OrganizationRole,
"userErrors": [GenericUserError]
}
UpdateOrganizationUserRolesInput
UpdateOrganizationUserRolesResponse
Fields
| Field Name | Description |
|---|---|
organizationUser - OrganizationUser
|
|
userErrors - [GenericUserError!]!
|
Example
{
"organizationUser": OrganizationUser,
"userErrors": [GenericUserError]
}
UpdateOtherAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
description - String
|
Description of the asset |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
isLiquid - Boolean
|
Indicates whether or not the asset is liquid |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"description": "xyz789",
"id": 4,
"institutionName": "xyz789",
"isLiquid": true,
"nonBorrowerOwnerNames": ["xyz789"]
}
UpdateOtherIncomeInput
Description
Input for updating an OtherIncome
Fields
| Input Field | Description |
|---|---|
description - String
|
Information about the income type |
id - ID!
|
The ID of the income to update |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt
|
Stated monthly income amount in dollars |
Example
{
"description": "abc123",
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
UpdateOwnedPropertyInput
Description
Input to the updateOwnedProperty mutation.
Fields
| Input Field | Description |
|---|---|
address - AddressInput
|
The address of the property |
borrowingOwnerIds - [ID!]
|
IDs of the borrowers who own this property. If this field is defined, it will replace the existing owner IDs. |
currentUsageType - PropertyUsageType
|
How the owner is using this property. |
homeInsuranceMonthlyPayment - NonNegativeInt
|
The dollar amount of monthly home insurance premium. |
id - ID!
|
The ID of the OwnedProperty |
intendedDisposition - PropertyDisposition
|
The intended disposition of the property. Indicates whether the borrowers will be retaining or selling (or sold) the property. |
intendedUsageType - PropertyUsageType
|
How the owner intends to use this property. |
monthlyAssociationDues - NonNegativeInt
|
Monthly association dues (in dollars) |
monthlyRentalIncome - NonNegativeInt
|
The expected monthly rental income (in dollars) |
mortgageInsuranceMonthlyPayment - NonNegativeInt
|
The dollar amount of monthly mortgage insurance monthly premium. |
neighborhoodHousingType - NeighborhoodHousingType
|
The type of housing (e.g. single or multi-family) |
propertyTaxMonthlyPayment - NonNegativeInt
|
The dollar amount of property taxes due per month. |
purchaseDate - Date
|
The date when the property was originally purchased. |
sellDate - Date
|
The date when the property was sold. Only relevant for previously owned properties. |
Example
{
"address": AddressInput,
"borrowingOwnerIds": [4],
"currentUsageType": "INVESTMENT",
"homeInsuranceMonthlyPayment": 123,
"id": 4,
"intendedDisposition": "PENDING_SALE",
"intendedUsageType": "INVESTMENT",
"monthlyAssociationDues": 123,
"monthlyRentalIncome": 123,
"mortgageInsuranceMonthlyPayment": 123,
"neighborhoodHousingType": "CONDOMINIUM",
"propertyTaxMonthlyPayment": 123,
"purchaseDate": "2007-12-03",
"sellDate": "2007-12-03"
}
UpdateOwnedPropertyResponse
Description
Response of the updateOwnedProperty mutation.
Fields
| Field Name | Description |
|---|---|
ownedProperty - OwnedProperty!
|
The updated OwnedProperty |
Example
{"ownedProperty": OwnedProperty}
UpdatePartyInput
Fields
| Input Field | Description |
|---|---|
address - AddressInput
|
US address to update. Fields with non-null values will be updated, the rest will be ignored. |
id - ID!
|
The unique ID of the Party. |
individual - PartyIndividualInput
|
Details about the individual associated with the party. |
legalEntity - PartyLegalEntityInput
|
Details about the party, if the party is a legal entity |
role - PartyRole
|
Indicates the type of relationship between the party and the loan. |
Example
{
"address": AddressInput,
"id": 4,
"individual": PartyIndividualInput,
"legalEntity": PartyLegalEntityInput,
"role": "ATTORNEY"
}
UpdatePartyResponse
Fields
| Field Name | Description |
|---|---|
party - Party
|
|
userErrors - [UserError!]!
|
Example
{
"party": Party,
"userErrors": [UserError]
}
UpdatePendingNetSaleProceedsFromRealEstateAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
ownedPropertyId - ID
|
The ID of the associated OwnedProperty that is pending sale |
salePrice - NonNegativeInt
|
Sale price of the property in dollars |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"id": 4,
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["xyz789"],
"ownedPropertyId": 4,
"salePrice": 123
}
UpdatePreviousBorrowerAddressInput
Description
Update previous borrower address input
Fields
| Input Field | Description |
|---|---|
address - AddressInput
|
US address to update |
id - ID!
|
Borrower Address ID |
monthlyRentAmount - NonNegativeInt
|
The monthly rental amount in dollars |
moveInDate - Date
|
Move in date |
moveOutDate - Date
|
Move out date |
residencyBasis - BorrowerResidencyBasis
|
The basis on which the borrower lives/lived at this address |
Example
{
"address": AddressInput,
"id": "4",
"monthlyRentAmount": 123,
"moveInDate": "2007-12-03",
"moveOutDate": "2007-12-03",
"residencyBasis": "LIVING_RENT_FREE"
}
UpdatePreviousBorrowerAddressResponse
Fields
| Field Name | Description |
|---|---|
address - Address!
|
US Address |
id - ID!
|
Borrower Address ID |
monthlyRentAmount - NonNegativeInt
|
The monthly rental amount in dollars |
moveInDate - Date
|
Move in date |
moveOutDate - Date
|
Move out date |
residencyBasis - BorrowerResidencyBasis
|
The basis on which the borrower lives/lived at this address |
Example
{
"address": Address,
"id": 4,
"monthlyRentAmount": 123,
"moveInDate": "2007-12-03",
"moveOutDate": "2007-12-03",
"residencyBasis": "LIVING_RENT_FREE"
}
UpdateProceedsFromSaleOfNonRealEstateAssetInput
Fields
| Input Field | Description |
|---|---|
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"amount": 123,
"id": 4,
"nonBorrowerOwnerNames": ["abc123"]
}
UpdateProceedsFromSecuredLoanAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"id": 4,
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["abc123"]
}
UpdateProceedsFromUnsecuredLoanAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"id": "4",
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["abc123"]
}
UpdateRetirementFundAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"id": 4,
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["abc123"]
}
UpdateSavingsAccountAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"id": "4",
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["abc123"]
}
UpdateSelfEmploymentBusinessInput
Description
Input for updating a self employment business
Fields
| Input Field | Description |
|---|---|
address - AddressInput
|
|
name - String
|
Name |
percentOwnership - NonNegativeFloat
|
Percent of the business that the borrower owns. This field is expressed as a percent. As an example, 50.1% is expressed as 50.1. |
Example
{
"address": AddressInput,
"name": "abc123",
"percentOwnership": 123.45
}
UpdateSelfEmploymentIncomeInput
Description
Input for updating a SelfEmploymentIncome
Fields
| Input Field | Description |
|---|---|
borrowerId - ID
|
The borrower associated with the income |
business - UpdateSelfEmploymentBusinessInput
|
The associated self-employment business (if one exists) |
employmentClassification - EmploymentClassificationType
|
Whether this is the borrower's primary or secondary employer. Default = PRIMARY |
endDate - Date
|
End date. A value of null indicates that the employment is current. |
id - ID!
|
The ID of the income to update |
isCurrentEmployment - Boolean
|
Is the employment current? |
numberOfMonthsInLineOfWork - NonNegativeInt
|
The total number of months the borrower has been employed in this line of work, regardless of employer |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
position - String
|
A name or description of the employment position or job title |
startDate - Date
|
Start date |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt
|
Stated monthly income amount in dollars |
Example
{
"borrowerId": "4",
"business": UpdateSelfEmploymentBusinessInput,
"employmentClassification": "PRIMARY",
"endDate": "2007-12-03",
"id": 4,
"isCurrentEmployment": true,
"numberOfMonthsInLineOfWork": 123,
"payPeriodFrequency": "ANNUALLY",
"position": "abc123",
"startDate": "2007-12-03",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
UpdateStandardEmploymentIncomeInput
Description
Input for updating a StandardEmploymentIncome
Fields
| Input Field | Description |
|---|---|
borrowerHasSpecialRelationshipWithEmployer - Boolean
|
When true, indicates that the borrower has a special relationship with the employer, such as familial ties. Default = false |
borrowerId - ID
|
The borrower associated with the income |
employer - EmployerInput
|
Employer details |
employmentClassification - EmploymentClassificationType
|
Whether this is the borrower's primary or secondary employer. Default = PRIMARY |
endDate - Date
|
End date. A value of null indicates that the employment is current. |
id - ID!
|
The ID of the income to update |
incomePayType - IncomePayType
|
The type of pay (hourly or salaried) |
isCurrentEmployment - Boolean
|
Is the employment current? |
numberOfMonthsInLineOfWork - NonNegativeInt
|
The total number of months the borrower has been employed in this line of work, regardless of employer |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
position - String
|
A name or description of the employment position or job title |
startDate - Date
|
Start date |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt
|
Stated monthly income amount in dollars |
Example
{
"borrowerHasSpecialRelationshipWithEmployer": false,
"borrowerId": 4,
"employer": EmployerInput,
"employmentClassification": "PRIMARY",
"endDate": "2007-12-03",
"id": 4,
"incomePayType": "HOURLY",
"isCurrentEmployment": true,
"numberOfMonthsInLineOfWork": 123,
"payPeriodFrequency": "ANNUALLY",
"position": "abc123",
"startDate": "2007-12-03",
"statedAmount": 123,
"statedMonthlyAmount": 123
}
UpdateStockAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"id": 4,
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["abc123"]
}
UpdateStockOptionsAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"id": "4",
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["xyz789"]
}
UpdateSubjectPropertyInput
Description
Input to the updateSubjectProperty mutation
Fields
| Input Field | Description |
|---|---|
attachmentType - AttachmentEnum
|
Whether the property is physically attached to neighboring units |
borrowerSpecifiedMonthlyPropertyTaxes - NonNegativeInt
|
The borrower-specified monthly property taxes |
city - String
|
City |
fipsCountyCode - String
|
County-level FIPS code |
hoaDues - NonNegativeInt
|
The monthly HOA dues of the property |
homeInsuranceMonthlyAmount - NonNegativeInt
|
The monthly home insurance premium associated with this property |
id - ID!
|
The ID of the SubjectProperty to update |
isPlannedUnitDevelopment - Boolean
|
Marks a subject property as being part of a planned unit development |
line - String
|
Street address line 1 |
line2 - String
|
Street address line 2 |
manuallyEstimatedValue - NonNegativeInt
|
The manually estimated value of the property |
neighborhoodHousingType - NeighborhoodHousingType
|
The type of property |
propertyTaxesAndInsuranceIncludedInPayment - Boolean
|
Is Property taxes and insurance included in payment |
rentalEstimatedGrossMonthlyRentAmount - NonNegativeInt
|
The estimated gross monthly rent amount (for investment properties) |
zipCode - String
|
Zip code |
Example
{
"attachmentType": "ATTACHED",
"borrowerSpecifiedMonthlyPropertyTaxes": 123,
"city": "xyz789",
"fipsCountyCode": "abc123",
"hoaDues": 123,
"homeInsuranceMonthlyAmount": 123,
"id": "4",
"isPlannedUnitDevelopment": true,
"line": "xyz789",
"line2": "xyz789",
"manuallyEstimatedValue": 123,
"neighborhoodHousingType": "CONDOMINIUM",
"propertyTaxesAndInsuranceIncludedInPayment": true,
"rentalEstimatedGrossMonthlyRentAmount": 123,
"zipCode": "abc123"
}
UpdateSubjectPropertyIntentInput
Description
Input to the updateSubjectPropertyIntent mutation
Fields
| Input Field | Description |
|---|---|
fipsCountyCode - String
|
County-level FIPS code |
id - ID!
|
The ID of the subject property intent to update |
isPlannedUnitDevelopment - Boolean
|
Marks a subject property as being part of a planned unit development |
neighborhoodHousingType - NeighborhoodHousingType
|
The type of housing |
propertyUsageType - PropertyUsageType
|
How the borrower(s) intend to use the property |
state - StateAbbreviated
|
Abbreviated US state name (including DC) |
Example
{
"fipsCountyCode": "xyz789",
"id": 4,
"isPlannedUnitDevelopment": false,
"neighborhoodHousingType": "CONDOMINIUM",
"propertyUsageType": "INVESTMENT",
"state": "AK"
}
UpdateSubjectPropertyIntentResponse
Description
Response of the updateSubjectPropertyIntent mutation
Fields
| Field Name | Description |
|---|---|
subjectPropertyIntent - SubjectPropertyIntent!
|
The updated SubjectPropertyIntent |
Example
{"subjectPropertyIntent": SubjectPropertyIntent}
UpdateSubjectPropertyResponse
Description
Response of the updateSubjectProperty mutation
Fields
| Field Name | Description |
|---|---|
subjectProperty - SubjectProperty!
|
The SubjectProperty that was updated |
Example
{"subjectProperty": SubjectProperty}
UpdateTaskNameInput
UpdateTaskNameResponse
Description
Response of the updateTaskName mutation.
Fields
| Field Name | Description |
|---|---|
assignedTo - TaskAssignee!
|
Who the task is assigned to |
assigneeBorrowerId - ID
|
The id of the borrower that this task is related to |
completedAt - DateTime
|
The timestamp of when the task was completed |
createdOn - DateTime!
|
The timestamp of when the task was created |
customTaskName - String
|
The custom name override of the task |
deletedAt - DateTime
|
An optional timestamp for when the task was deleted |
details - TaskEntityDetails
|
Details about the entity this task is associated with |
documentRequiredCondition - [DocumentRequiredCondition!]
|
The required document conditions on the task |
dueDate - DateTime
|
The due date of the task |
id - ID!
|
The Id of the task |
priority - Int
|
The priority level of the task |
status - TaskStatus!
|
The status of task |
taskDescription - String
|
The description of the task |
taskName - String
|
The name of the task |
type - TaskType!
|
The type of task |
Example
{
"assignedTo": "BORROWER",
"assigneeBorrowerId": "4",
"completedAt": "2007-12-03T10:15:30Z",
"createdOn": "2007-12-03T10:15:30Z",
"customTaskName": "abc123",
"deletedAt": "2007-12-03T10:15:30Z",
"details": TaskEntityDetails,
"documentRequiredCondition": [
DocumentRequiredCondition
],
"dueDate": "2007-12-03T10:15:30Z",
"id": 4,
"priority": 987,
"status": "AutomaticallyCancelled",
"taskDescription": "xyz789",
"taskName": "abc123",
"type": "DataVerification"
}
UpdateTaskStatusInput
Description
Input to the updateTaskStatus mutation.
Example
{
"loanId": 4,
"newStatus": "abc123",
"taskId": "4"
}
UpdateTaskStatusResponse
Description
Response of the updateTaskStatus mutation.
Fields
| Field Name | Description |
|---|---|
assignedTo - TaskAssignee!
|
Who the task is assigned to |
assigneeBorrowerId - ID
|
The id of the borrower that this task is related to |
completedAt - DateTime
|
The timestamp of when the task was completed |
createdOn - DateTime!
|
The timestamp of when the task was created |
customTaskName - String
|
The custom name override of the task |
deletedAt - DateTime
|
An optional timestamp for when the task was deleted |
details - TaskEntityDetails
|
Details about the entity this task is associated with |
documentRequiredCondition - [DocumentRequiredCondition!]
|
The required document conditions on the task |
dueDate - DateTime
|
The due date of the task |
id - ID!
|
The Id of the task |
priority - Int
|
The priority level of the task |
status - TaskStatus!
|
The status of task |
taskDescription - String
|
The description of the task |
taskName - String
|
The name of the task |
type - TaskType!
|
The type of task |
Example
{
"assignedTo": "BORROWER",
"assigneeBorrowerId": "4",
"completedAt": "2007-12-03T10:15:30Z",
"createdOn": "2007-12-03T10:15:30Z",
"customTaskName": "xyz789",
"deletedAt": "2007-12-03T10:15:30Z",
"details": TaskEntityDetails,
"documentRequiredCondition": [
DocumentRequiredCondition
],
"dueDate": "2007-12-03T10:15:30Z",
"id": "4",
"priority": 987,
"status": "AutomaticallyCancelled",
"taskDescription": "xyz789",
"taskName": "xyz789",
"type": "DataVerification"
}
UpdateTrustAccountAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
trusteeName - String
|
The legal name of the trustee |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"id": "4",
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["abc123"],
"trusteeName": "abc123"
}
UsCounty
UsState
Fields
| Field Name | Description |
|---|---|
abbreviation - String!
|
Two-letter abbreviation |
counties - [UsCounty!]!
|
|
name - String!
|
Example
{
"abbreviation": "abc123",
"counties": [UsCounty],
"name": "abc123"
}
UserError
Description
User error interface
Fields
| Field Name | Description |
|---|---|
message - String!
|
Possible Types
| UserError Types |
|---|
Example
{"message": "abc123"}
VaBenefitsNonEducationalIncome
Description
Veteran's Association benefits that are not related to education
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}
WarehousingCost
WarehousingCosts
Fields
| Field Name | Description |
|---|---|
products - [WarehousingCost!]
|
A list of products and their warehouse margins |
Example
{"products": [WarehousingCost]}
WithdrawLoanInput
Description
Input to the withdrawLoan mutation.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the loan to withdraw |
Example
{"id": 4}
WithdrawLoanResponse
Types
| Union Types |
|---|
Example
LoanClosedError
WithdrawLoanSuccess
Description
A successful response after a loan has been archived.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
ID of the withdrawn loan |
Example
{"id": "4"}
WorkersCompensationIncome
Description
Workers compensation income
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeInt
|
The qualified amount determined from this income |
statedAmount - NonNegativeInt
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
verifiedAmount - NonNegativeInt
|
The verified amount of this income |
Example
{
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123,
"statedAmount": 123,
"statedMonthlyAmount": 123,
"verifiedAmount": 123
}