Skip to content

uwResults

Query

fetch Underwriting Results with various filtering and pagination options.

Query Signature

query {
uwResults(where: UwResultWhereInput, order: [UwResultOrder!], skip: Int, search: String, after: String, first: Int, before: String, last: Int): UwResultsResponse
}

Example Request

query UwResults($where: UwResultWhereInput, $order: [UwResultOrder!], $skip: Int, $search: String, $after: String, $first: Int, $before: String, $last: Int) {
uwResults(where: $where, order: $order, skip: $skip, search: $search, after: $after, first: $first, before: $before, last: $last) {
# Add fields you want to retrieve
}
}

Example Variables:

{
"where": {
"leadId": "lead-67890"
},
"first": 10,
"order": [
{
"field": "createdAt",
"direction": "DESC"
}
]
}

Example Response

{
"data": {
"uwResults": {
"data": {
"totalCount": 2,
"pageInfo": {
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": "cursor-1",
"endCursor": "cursor-2"
},
"edges": [
{
"cursor": "cursor-1",
"node": {
"id": "uw-xyz789",
"revision": 2,
"applicationUwResult": {
"applicantPrequalified": true,
"applicationType": "SINGLE",
"totalDebt": 13500,
"totalEligibleDebt": 13500
},
"applicantUwResult": {
"id": "uw-xyz789",
"creditReportId": "cr-abc123def456",
"leadId": "lead-67890",
"creditReportSource": "CRS_EQUIFAX"
},
"maxTerm": 48,
"createdAt": "2025-01-15T11:00:00.000Z"
},
"errors": null
},
{
"cursor": "cursor-2",
"node": {
"id": "uw-xyz789",
"revision": 1,
"applicationUwResult": {
"applicantPrequalified": true,
"applicationType": "SINGLE",
"totalDebt": 25000,
"totalEligibleDebt": 22500
},
"applicantUwResult": {
"id": "uw-xyz789",
"creditReportId": "cr-abc123def456",
"leadId": "lead-67890",
"creditReportSource": "CRS_EQUIFAX"
},
"maxTerm": 48,
"createdAt": "2025-01-15T10:30:00.000Z"
},
"errors": null
}
]
},
"errors": null
}
}
}

Arguments

ArgumentTypeDescription
whereUwResultWhereInputWhere conditions for filtering Uw Results.
order[UwResultOrder!]Ordering options for UwResults.

Input Types

UwResultWhereInput

Where conditions for filtering Uw Results.

Optional Fields:

FieldTypeDescription
reqOrgIdStringFilter by requesting organization ID
reqOrgContactIdStringFilter by requesting organization contact ID
leadIdStringFilter by lead ID
uwResultIdStringFilter by underwriting result ID
revisionIntFilter by specific revision number

UwResultOrder

Ordering options for UwResults.

Required Fields:

FieldTypeDescription
fieldUwResultOrderField!Field to order by
directionOrderDirection!Direction of ordering (ASC or DESC)

Response Type

Returns: UwResultsResponse

UwResultsResponse

UwResultsResponse

FieldTypeDescription
dataUwResultConnectionUw Result Connection.
errors[UwResultsResponseError]Error(s) list

UwResultConnection

Pagination connection for Uw Results.

FieldTypeDescription
pageInfoPageInfo!Pagination information
edges[UwResultEdge]!List of result edges
totalCountInt!Total count of results matching the query
PageInfo

Page information for navigating collections.

FieldTypeDescription
hasNextPageBoolean!Whether there are more items after the current page
startCursorStringCursor for the first item in the current page
endCursorStringCursor for the last item in the current page
UwResultEdge

Edge type for Uw Results.

FieldTypeDescription
nodeUwEligibilityResultThe underwriting eligibility result
errors[EligibilityResponseError]List of eligibility errors for this result
cursorString!Cursor for pagination
UwEligibilityResult
FieldTypeDescription
idID!Underwriting document ID
revisionInt!Revision number of this underwriting document. Each time the document is edited the revision number is incremented
applicationUwResultApplicationUwResultUnderwriting result for the application as a whole.
applicantUwResultUwResultApplicant’s debts (tradeline) specific underwriting results
coApplicantUwResultUwResultCo-applicant’s debts (tradeline) specific underwriting results. Only applicable to JOINT application.
jointUwResultJointUwResultJoint debts (tradeline) specific underwriting results. Only applicable to JOINT application.
tradelineMetadataTradelineMetadataAdditional metadata about UW application
maxTermIntMaximum term (in months) calculated for this underwriting application
createdAtDateDate and time this underwriting document revision was created
ApplicationUwResult
FieldTypeDescription
applicantPrequalifiedBoolean!True/False flag to identify if this application passed all underwriting criteria
applicationTypeStringType of application can be SINGLE or JOINT
rootFiltersApplicationRootFilters!Application level filters
totalDebtFloatTotal selected debts balance
totalEligibleDebtFloatTotal eligible and selected debts balance
tradelineMetadataTradelineMetadataAdditional metadata about UW application
ApplicationRootFilters
FieldTypeDescription
totalDebtValueCheckBooleanTrue/False flag to identify if this underwriting check passed
tenPercentRuleCheckBooleanTrue/False flag to identify if this underwriting check passed
agentAssignedCheckBooleanTrue/False flag to identify if this underwriting check passed
creditReport30DaysCheckBooleanTrue/False flag to identify if this underwriting check passed
psStateServiceCheckBooleanTrue/False flag to identify if this underwriting check passed
uniqueEmailPhoneCheckBooleanTrue/False flag to identify if this underwriting check passed
programTermCheckBooleanTrue/False flag to identify if this underwriting check passed
budgetHardshipCheckBooleanTrue/False flag to identify if this underwriting check passed
TradelineMetadata
FieldTypeDescription
enrolledUpstartDebtAccountNumbers[String]List of externalDebtsId’s that belong to selected Upstart debts, if empty then none
enrolledCapitalOneDebtAccountNumbers[String]List of externalDebtsId’s that belong to selected Catipal One debts, if empty then none
enrolledDiscoverDebtAccountNumbers[String]List of externalDebtsId’s that belong to selected Discover debts, if empty then none
UwResult
FieldTypeDescription
idID!Underwriting document ID
uwOrgIdStringThe organization underwriting rules used for this application. Values: - ALV - GLG
reqOrgIdStringRequesting organization ID. Based on the credentials of the system making the request.
revisionInt!Document revision number. Each time the document is edited the revision number is incremented
reqOrgContactIdStringRequesting organization contact ID
creditReportIdStringApplicant normalized credit report ID from the credit report service
coCreditReportIdStringCo-Applicant normalized credit report ID from the credit report service
leadIdStringApplicant leadId set by the integrating CRM to identify the lead in its system.
applicationTypeStringType of application can be SINGLE or JOINT
applicantInfoApplicantInfo!Applicant information.
rootFiltersApplicantRootFilters!Root level filters (All underwriting filters that are not specific to a debt)
debts[UwResultDebt]!List of debts. Each debt will have additional underwriting pass/fail information
creditReportSourceString!Credit report source Values: - SPINWHEEL - CRS_TRANSUNION - CRS_EQUIFAX
rootHistory[UwResultHistory]Audit history of edits applied to the top level fields of this application
createdAtDateDate and time this underwriting document revision was created
ApplicantInfo
FieldTypeDescription
publicRecords[PublicRecord]Public records from the credit report.
applicantContactInfoApplicantContactInfoApplicant’s contact information
coApplicantContactInfoApplicantContactInfoCo-applicant’s contact information
agentAssignedStringAgent userId set by the integrating CRM to identify the agent in its system.
planPlanEnrollment plan.
budgetBudgetBudget.
additionalInfoAdditionalInfoAdditional info
ApplicantRootFilters
FieldTypeDescription
stateServiceCheckBooleanTrue/False flag to identify if this underwriting check passed
bankruptcyCheckBooleanTrue/False flag to identify if this underwriting check passed
ssnCheckBooleanTrue/False flag to identify if this underwriting check passed
dobCheckBooleanTrue/False flag to identify if this underwriting check passed
phoneCheckBooleanTrue/False flag to identify if this underwriting check passed
firstNameCheckBooleanTrue/False flag to identify if this underwriting check passed
lastNameCheckBooleanTrue/False flag to identify if this underwriting check passed
applicantEmployerCheckBooleanTrue/False flag to identify if this underwriting check passed
jobTitleCheckBooleanTrue/False flag to identify if this underwriting check passed
addressCheckBooleanTrue/False flag to identify if this underwriting check passed
emailCheckBooleanTrue/False flag to identify if this underwriting check passed
coApplicantFirstNameCheckBooleanTrue/False flag to identify if this underwriting check passed
coApplicantLastNameCheckBooleanTrue/False flag to identify if this underwriting check passed
coApplicantEmployerCheckBooleanTrue/False flag to identify if this underwriting check passed
coApplicantJobTitleCheckBooleanTrue/False flag to identify if this underwriting check passed
coApplicantSsnCheckBooleanTrue/False flag to identify if this underwriting check passed
coApplicantDobCheckBooleanTrue/False flag to identify if this underwriting check passed
coApplicantPhoneCheckBooleanTrue/False flag to identify if this underwriting check passed
coApplicantCellPhoneCheckBooleanTrue/False flag to identify if this underwriting check passed
hardshipCheckBooleanTrue/False flag to identify if this underwriting check passed
duplicateSsnCheckBooleanTrue/False flag to identify if this underwriting check passed
duplicateCoApplicantSsnCheckBooleanTrue/False flag to identify if this underwriting check passed
routingNumberCheckBooleanTrue/False flag to identify if this underwriting check passed
bankNameCheckBooleanTrue/False flag to identify if this underwriting check passed
bankAccountNumberCheckBooleanTrue/False flag to identify if this underwriting check passed
bankAccountHolderNameCheckBooleanTrue/False flag to identify if this underwriting check passed
bankAccountTypeCheckBooleanTrue/False flag to identify if this underwriting check passed
debtsBackedByUsFedGovCheckBooleanTrue/False flag to identify if this underwriting check passed
eligibilityReqMilitaryCheckBooleanTrue/False flag to identify if this underwriting check passed
eligibilityReqCreditCounsellingCheckBooleanTrue/False flag to identify if this underwriting check passed
eligibilityReqBankruptcyCheckBooleanTrue/False flag to identify if this underwriting check passed
eligibilityReqFederalGovDebtCheckBooleanTrue/False flag to identify if this underwriting check passed
eligibilityReqSecuredDebtCheckBooleanTrue/False flag to identify if this underwriting check passed
frequencyMinimumPaymentCheckBooleanTrue/False flag to identify if this underwriting check passed
budgetAffordabilityCheckBooleanTrue/False flag to identify if this underwriting check passed
firstDraftDateCheckBooleanTrue/False flag to identify if this underwriting check passed
feeValidationCheckBooleanTrue/False flag to identify if this underwriting check passed
secondDraftDateCheckBooleanTrue/False flag to identify if this underwriting check passed
companyIsAuthorizedCheckBooleanTrue/False flag to identify if this underwriting check passed
enrollmentPlanCheckBooleanTrue/False flag to identify if this underwriting check passed
termExtensionExceptionCheckBooleanTrue/False flag to identify if this underwriting check passed
caStateFileCheckBooleanTrue/False flag to identify if the co-applicant has ssn when state is CA and application type is JOINT
UwResultDebt

Debt information with underwriting check results

FieldTypeDescription
idID!Unique identifier for the debt
applicantIdStringPrimary applicant ID
coApplicantIdStringSecondary applicant ID, if applicable (For JOINT application only)
externalDebtIdIDThis is replaced by accountNumber @deprecated Use accountNumber instead
accountNumberStringDebt account number
externalCrmIdStringOptional field to identify the debt in the requesting CRM
isSelectedBoolean!True/False flag to identify if this debt is selected for program enrollment
coApplicantIsSelectedBooleanOnly applicable to JOINT debt. True/False flag to identify if this debt is selected by the co-applicant
eligibilityStatusEligibilityStatus!Identify the eligibility status
isOverriddenBooleanTrue/False flag to identify if the eligiblity status is being overriden
exceptions[String]List of reasons the eligibility status is being overridden
history[UwResultDebtHistory]History of all the updates made to this debt
sourceString!Source of the debt entry can be MANUAL or CREDIT_REPORT
creditorNameStringcreditor name
parentCreditorNameStringParent creditor name
parentCreditorIdStringParent creditor ID
originalCreditorNameStringOriginal creditor name
creditorIdIDCreditor ID from Forth
creditorTypeStringcreditor type
ecoaCodeStringECOA Code
accountTypeStringAccount type
portfolioTypeStringPortfolio type
debtTypeStringDebt type
openDateStringDate debt was opened
lastPaymentDateStringDate of the last payment
hasLastPaymentBooleanTrue/False flag to identify if last payment was amde
narrativeCodes[String]Narrative codes that might include bankcruptcy codes
bankruptcyDateFiledStringBankruptcy Record Date. This come from the credit report and does not need to be updated.
currentBalanceFloatCurrent debt balance
originalBalanceFloatOriginal debt balance
nawSignedDateDateOnly applicable to JOINT debt. The date when the non-applicant waiver has been signed.
nawUrlStringOnly applicable to JOINT debt. The url to the non-applicant waiver document’s file
hasProofOfLiabilityBooleanHas provided proof of liability
forthDebtTypeIdStringForth Debt Type ID
remarks[String]Remarks
isCollectionBooleanFlag to show if the debt is in collection
approvedAccountTypeCheckBooleanTrue/False flag to identify if this underwriting check passed
unacceptableCreditorCheckBooleanTrue/False flag to identify if this underwriting check passed
creditUnionAndStateCheckBooleanTrue/False flag to identify if this underwriting check passed
debtOwnershipCheckBooleanTrue/False flag to identify if this underwriting check passed
minimumDebtValueCheckBooleanTrue/False flag to identify if this underwriting check passed
duplicateDebtsCheckBooleanTrue/False flag to identify if this debt is selected and a duplicate debt
multipleCreditUnionCheckBooleanTrue/False flag to identify if this underwriting check passed
paymentHistoryCheckBooleanTrue/False flag to identify if this underwriting check passed
unsecuredDebtCheckBooleanTrue/False flag to identify if this underwriting check passed
bankruptcyCheckBooleanTrue/False flag to identify if this underwriting check passed
employerIsCreditorCheckBooleanTrue/False flag to identify if the creditor is the same as employer
standaloneDebtsCheckBooleanTrue/False flag to identify if the creditor is a standalone debt
coApplicantCheckBooleanOnly applicable to JOINT debt. True/False flag to identify if this underwriting check passed
currAndOgBalanceCheckBooleanCurrent and original balance check
proofOfLiabilityCheckBooleanProof of liability
delinquencyStringaccount rating /delinquency value
monthlyPaymentFloatMonthly payment
notes[String]Debt Notes
UwResultHistory

Historical record of changes made to the underwriting result

FieldTypeDescription
applicantInfoApplicantInfoApplicant information at this revision
leadIdStringLead ID at this revision
updatedByIDUser ID who made this update
fromRevisionIntThe revision number this history entry was created from
UwResult
FieldTypeDescription
idID!Underwriting document ID
uwOrgIdStringThe organization underwriting rules used for this application. Values: - ALV - GLG
reqOrgIdStringRequesting organization ID. Based on the credentials of the system making the request.
revisionInt!Document revision number. Each time the document is edited the revision number is incremented
reqOrgContactIdStringRequesting organization contact ID
creditReportIdStringApplicant normalized credit report ID from the credit report service
coCreditReportIdStringCo-Applicant normalized credit report ID from the credit report service
leadIdStringApplicant leadId set by the integrating CRM to identify the lead in its system.
applicationTypeStringType of application can be SINGLE or JOINT
applicantInfoApplicantInfo!Applicant information.
rootFiltersApplicantRootFilters!Root level filters (All underwriting filters that are not specific to a debt)
debts[UwResultDebt]!List of debts. Each debt will have additional underwriting pass/fail information
creditReportSourceString!Credit report source Values: - SPINWHEEL - CRS_TRANSUNION - CRS_EQUIFAX
rootHistory[UwResultHistory]Audit history of edits applied to the top level fields of this application
createdAtDateDate and time this underwriting document revision was created
ApplicantInfo
FieldTypeDescription
publicRecords[PublicRecord]Public records from the credit report.
applicantContactInfoApplicantContactInfoApplicant’s contact information
coApplicantContactInfoApplicantContactInfoCo-applicant’s contact information
agentAssignedStringAgent userId set by the integrating CRM to identify the agent in its system.
planPlanEnrollment plan.
budgetBudgetBudget.
additionalInfoAdditionalInfoAdditional info
ApplicantRootFilters
FieldTypeDescription
stateServiceCheckBooleanTrue/False flag to identify if this underwriting check passed
bankruptcyCheckBooleanTrue/False flag to identify if this underwriting check passed
ssnCheckBooleanTrue/False flag to identify if this underwriting check passed
dobCheckBooleanTrue/False flag to identify if this underwriting check passed
phoneCheckBooleanTrue/False flag to identify if this underwriting check passed
firstNameCheckBooleanTrue/False flag to identify if this underwriting check passed
lastNameCheckBooleanTrue/False flag to identify if this underwriting check passed
applicantEmployerCheckBooleanTrue/False flag to identify if this underwriting check passed
jobTitleCheckBooleanTrue/False flag to identify if this underwriting check passed
addressCheckBooleanTrue/False flag to identify if this underwriting check passed
emailCheckBooleanTrue/False flag to identify if this underwriting check passed
coApplicantFirstNameCheckBooleanTrue/False flag to identify if this underwriting check passed
coApplicantLastNameCheckBooleanTrue/False flag to identify if this underwriting check passed
coApplicantEmployerCheckBooleanTrue/False flag to identify if this underwriting check passed
coApplicantJobTitleCheckBooleanTrue/False flag to identify if this underwriting check passed
coApplicantSsnCheckBooleanTrue/False flag to identify if this underwriting check passed
coApplicantDobCheckBooleanTrue/False flag to identify if this underwriting check passed
coApplicantPhoneCheckBooleanTrue/False flag to identify if this underwriting check passed
coApplicantCellPhoneCheckBooleanTrue/False flag to identify if this underwriting check passed
hardshipCheckBooleanTrue/False flag to identify if this underwriting check passed
duplicateSsnCheckBooleanTrue/False flag to identify if this underwriting check passed
duplicateCoApplicantSsnCheckBooleanTrue/False flag to identify if this underwriting check passed
routingNumberCheckBooleanTrue/False flag to identify if this underwriting check passed
bankNameCheckBooleanTrue/False flag to identify if this underwriting check passed
bankAccountNumberCheckBooleanTrue/False flag to identify if this underwriting check passed
bankAccountHolderNameCheckBooleanTrue/False flag to identify if this underwriting check passed
bankAccountTypeCheckBooleanTrue/False flag to identify if this underwriting check passed
debtsBackedByUsFedGovCheckBooleanTrue/False flag to identify if this underwriting check passed
eligibilityReqMilitaryCheckBooleanTrue/False flag to identify if this underwriting check passed
eligibilityReqCreditCounsellingCheckBooleanTrue/False flag to identify if this underwriting check passed
eligibilityReqBankruptcyCheckBooleanTrue/False flag to identify if this underwriting check passed
eligibilityReqFederalGovDebtCheckBooleanTrue/False flag to identify if this underwriting check passed
eligibilityReqSecuredDebtCheckBooleanTrue/False flag to identify if this underwriting check passed
frequencyMinimumPaymentCheckBooleanTrue/False flag to identify if this underwriting check passed
budgetAffordabilityCheckBooleanTrue/False flag to identify if this underwriting check passed
firstDraftDateCheckBooleanTrue/False flag to identify if this underwriting check passed
feeValidationCheckBooleanTrue/False flag to identify if this underwriting check passed
secondDraftDateCheckBooleanTrue/False flag to identify if this underwriting check passed
companyIsAuthorizedCheckBooleanTrue/False flag to identify if this underwriting check passed
enrollmentPlanCheckBooleanTrue/False flag to identify if this underwriting check passed
termExtensionExceptionCheckBooleanTrue/False flag to identify if this underwriting check passed
caStateFileCheckBooleanTrue/False flag to identify if the co-applicant has ssn when state is CA and application type is JOINT
UwResultDebt

Debt information with underwriting check results

FieldTypeDescription
idID!Unique identifier for the debt
applicantIdStringPrimary applicant ID
coApplicantIdStringSecondary applicant ID, if applicable (For JOINT application only)
externalDebtIdIDThis is replaced by accountNumber @deprecated Use accountNumber instead
accountNumberStringDebt account number
externalCrmIdStringOptional field to identify the debt in the requesting CRM
isSelectedBoolean!True/False flag to identify if this debt is selected for program enrollment
coApplicantIsSelectedBooleanOnly applicable to JOINT debt. True/False flag to identify if this debt is selected by the co-applicant
eligibilityStatusEligibilityStatus!Identify the eligibility status
isOverriddenBooleanTrue/False flag to identify if the eligiblity status is being overriden
exceptions[String]List of reasons the eligibility status is being overridden
history[UwResultDebtHistory]History of all the updates made to this debt
sourceString!Source of the debt entry can be MANUAL or CREDIT_REPORT
creditorNameStringcreditor name
parentCreditorNameStringParent creditor name
parentCreditorIdStringParent creditor ID
originalCreditorNameStringOriginal creditor name
creditorIdIDCreditor ID from Forth
creditorTypeStringcreditor type
ecoaCodeStringECOA Code
accountTypeStringAccount type
portfolioTypeStringPortfolio type
debtTypeStringDebt type
openDateStringDate debt was opened
lastPaymentDateStringDate of the last payment
hasLastPaymentBooleanTrue/False flag to identify if last payment was amde
narrativeCodes[String]Narrative codes that might include bankcruptcy codes
bankruptcyDateFiledStringBankruptcy Record Date. This come from the credit report and does not need to be updated.
currentBalanceFloatCurrent debt balance
originalBalanceFloatOriginal debt balance
nawSignedDateDateOnly applicable to JOINT debt. The date when the non-applicant waiver has been signed.
nawUrlStringOnly applicable to JOINT debt. The url to the non-applicant waiver document’s file
hasProofOfLiabilityBooleanHas provided proof of liability
forthDebtTypeIdStringForth Debt Type ID
remarks[String]Remarks
isCollectionBooleanFlag to show if the debt is in collection
approvedAccountTypeCheckBooleanTrue/False flag to identify if this underwriting check passed
unacceptableCreditorCheckBooleanTrue/False flag to identify if this underwriting check passed
creditUnionAndStateCheckBooleanTrue/False flag to identify if this underwriting check passed
debtOwnershipCheckBooleanTrue/False flag to identify if this underwriting check passed
minimumDebtValueCheckBooleanTrue/False flag to identify if this underwriting check passed
duplicateDebtsCheckBooleanTrue/False flag to identify if this debt is selected and a duplicate debt
multipleCreditUnionCheckBooleanTrue/False flag to identify if this underwriting check passed
paymentHistoryCheckBooleanTrue/False flag to identify if this underwriting check passed
unsecuredDebtCheckBooleanTrue/False flag to identify if this underwriting check passed
bankruptcyCheckBooleanTrue/False flag to identify if this underwriting check passed
employerIsCreditorCheckBooleanTrue/False flag to identify if the creditor is the same as employer
standaloneDebtsCheckBooleanTrue/False flag to identify if the creditor is a standalone debt
coApplicantCheckBooleanOnly applicable to JOINT debt. True/False flag to identify if this underwriting check passed
currAndOgBalanceCheckBooleanCurrent and original balance check
proofOfLiabilityCheckBooleanProof of liability
delinquencyStringaccount rating /delinquency value
monthlyPaymentFloatMonthly payment
notes[String]Debt Notes
UwResultHistory

Historical record of changes made to the underwriting result

FieldTypeDescription
applicantInfoApplicantInfoApplicant information at this revision
leadIdStringLead ID at this revision
updatedByIDUser ID who made this update
fromRevisionIntThe revision number this history entry was created from
JointUwResult

Joint underwriting result containing shared debts between applicants

FieldTypeDescription
idID!Unique identifier for the joint underwriting result
primaryApplicantUwResultApplicantUwResultInfoPrimary applicant uw result id
coApplicantUwResultApplicantUwResultInfoCo-applicant uw result id
uwOrgIdStringThe organization underwriting rules used for this application. For example alv or glg
reqOrgIdStringRequesting organization ID
revisionInt!Document revision number. Each time the document is edited the revision number is incremented
leadIdStringSigma lead ID
creditReportIdStringPrimary applicant credit report ID
coCreditReportIdStringSecondary applicant credit report ID, if applicable (For JOINT application only)
applicantInfoJointUwApplicantInfo!Applicant information needed for the root filters
debts[UwResultDebt]!List of debts. Each debt will have additional underwriting pass/fail information
creditReportSourceString!Source can be SPINWHEEL, CRS_TRANSUNION, or CRS_EQUIFAX
rootHistory[JointUwResultHistory]History of edits applied to the top level fields of this application
createdAtDateDate and time this joint underwriting result was created
ApplicantUwResultInfo

Reference information for an applicant’s underwriting result

FieldTypeDescription
idIDUnderwriting result ID
revisionIntCurrent revision number of the underwriting result
ApplicantUwResultInfo

Reference information for an applicant’s underwriting result

FieldTypeDescription
idIDUnderwriting result ID
revisionIntCurrent revision number of the underwriting result
JointUwApplicantInfo
FieldTypeDescription
applicantContactInfoApplicantContactInfoApplicant’s contact information
coApplicantContactInfoApplicantContactInfoCo-applicant’s contact information
UwResultDebt

Debt information with underwriting check results

FieldTypeDescription
idID!Unique identifier for the debt
applicantIdStringPrimary applicant ID
coApplicantIdStringSecondary applicant ID, if applicable (For JOINT application only)
externalDebtIdIDThis is replaced by accountNumber @deprecated Use accountNumber instead
accountNumberStringDebt account number
externalCrmIdStringOptional field to identify the debt in the requesting CRM
isSelectedBoolean!True/False flag to identify if this debt is selected for program enrollment
coApplicantIsSelectedBooleanOnly applicable to JOINT debt. True/False flag to identify if this debt is selected by the co-applicant
eligibilityStatusEligibilityStatus!Identify the eligibility status
isOverriddenBooleanTrue/False flag to identify if the eligiblity status is being overriden
exceptions[String]List of reasons the eligibility status is being overridden
history[UwResultDebtHistory]History of all the updates made to this debt
sourceString!Source of the debt entry can be MANUAL or CREDIT_REPORT
creditorNameStringcreditor name
parentCreditorNameStringParent creditor name
parentCreditorIdStringParent creditor ID
originalCreditorNameStringOriginal creditor name
creditorIdIDCreditor ID from Forth
creditorTypeStringcreditor type
ecoaCodeStringECOA Code
accountTypeStringAccount type
portfolioTypeStringPortfolio type
debtTypeStringDebt type
openDateStringDate debt was opened
lastPaymentDateStringDate of the last payment
hasLastPaymentBooleanTrue/False flag to identify if last payment was amde
narrativeCodes[String]Narrative codes that might include bankcruptcy codes
bankruptcyDateFiledStringBankruptcy Record Date. This come from the credit report and does not need to be updated.
currentBalanceFloatCurrent debt balance
originalBalanceFloatOriginal debt balance
nawSignedDateDateOnly applicable to JOINT debt. The date when the non-applicant waiver has been signed.
nawUrlStringOnly applicable to JOINT debt. The url to the non-applicant waiver document’s file
hasProofOfLiabilityBooleanHas provided proof of liability
forthDebtTypeIdStringForth Debt Type ID
remarks[String]Remarks
isCollectionBooleanFlag to show if the debt is in collection
approvedAccountTypeCheckBooleanTrue/False flag to identify if this underwriting check passed
unacceptableCreditorCheckBooleanTrue/False flag to identify if this underwriting check passed
creditUnionAndStateCheckBooleanTrue/False flag to identify if this underwriting check passed
debtOwnershipCheckBooleanTrue/False flag to identify if this underwriting check passed
minimumDebtValueCheckBooleanTrue/False flag to identify if this underwriting check passed
duplicateDebtsCheckBooleanTrue/False flag to identify if this debt is selected and a duplicate debt
multipleCreditUnionCheckBooleanTrue/False flag to identify if this underwriting check passed
paymentHistoryCheckBooleanTrue/False flag to identify if this underwriting check passed
unsecuredDebtCheckBooleanTrue/False flag to identify if this underwriting check passed
bankruptcyCheckBooleanTrue/False flag to identify if this underwriting check passed
employerIsCreditorCheckBooleanTrue/False flag to identify if the creditor is the same as employer
standaloneDebtsCheckBooleanTrue/False flag to identify if the creditor is a standalone debt
coApplicantCheckBooleanOnly applicable to JOINT debt. True/False flag to identify if this underwriting check passed
currAndOgBalanceCheckBooleanCurrent and original balance check
proofOfLiabilityCheckBooleanProof of liability
delinquencyStringaccount rating /delinquency value
monthlyPaymentFloatMonthly payment
notes[String]Debt Notes
JointUwResultHistory

Historical record of changes made to a joint underwriting result

FieldTypeDescription
applicantInfoJointUwApplicantInfoApplicant information at this revision
leadIdStringLead ID at this revision
updatedByIDUser ID who made this update
fromRevisionIntThe revision number this history entry was created from
TradelineMetadata
FieldTypeDescription
enrolledUpstartDebtAccountNumbers[String]List of externalDebtsId’s that belong to selected Upstart debts, if empty then none
enrolledCapitalOneDebtAccountNumbers[String]List of externalDebtsId’s that belong to selected Catipal One debts, if empty then none
enrolledDiscoverDebtAccountNumbers[String]List of externalDebtsId’s that belong to selected Discover debts, if empty then none
EligibilityResponseError

Includes a list of reasons why the underwriting did not pass

Possible reason are Ineligible, Condition, and Update Needed.

If an error does not include a debtId then it is an application level error.

FieldTypeDescription
debtIdStringThe debtId of the debt that caused the error.
filterNameStringThe name of the underwriting check that caused the error.
message[String]The list of reasons why the underwriting check did not pass.

UwResultsResponseError

UwResultsResponse Error

FieldTypeDescription
messageStringError message

Additional Enums

EligibilityStatus

Eligibility status for a debt

ValueDescription
ELIGIBLEDebt meets all underwriting criteria and can be enrolled
INELIGIBLEDebt does not meet underwriting criteria and cannot be enrolled
CONDITIONALDebt requires additional conditions to be met before enrollment
UPDATE_NEEDEDDebt requires additional information to determine eligibility
UNABLE_TO_PROCESSUnable to process the debt eligibility check

UwResultOrderField

Fields that can be ordered in Uw Results.

ValueDescription
createdAtOrder by creation date
reqOrgContactIdOrder by requesting organization contact ID

OrderDirection

Direction of ordering.

ValueDescription
ASCAscending order (A-Z, 0-9, oldest to newest)
DESCDescending order (Z-A, 9-0, newest to oldest)

Error Types

The response may include the following error types:

UwResultsResponseError

UwResultsResponse Error

FieldTypeDescription
messageStringError message

Common Errors

Error CodeDescriptionResolution
VALIDATION_ERRORInput validation failedCheck required fields and formats
UNAUTHORIZEDInvalid or expired tokenRe-authenticate and retry
NOT_FOUNDResource not foundVerify the ID or reference