Resources
This page documents the JSON:API resource schemas related to credit decisions.
Credit Application Decision Resources
ManualReviewCreditApplicationDecision
Represents a manual review credit decision for a credit application request (before a customer exists).
For the complete resource schema including all attributes and relationships, see ManualReviewCreditApplicationDecision.
ApprovedCreditApplicationDecision
Represents an approved credit decision for a credit application request (before a customer exists).
For the complete resource schema including all attributes and relationships, see ApprovedCreditApplicationDecision.
DeniedCreditApplicationDecision
Represents a denied credit decision for a credit application request (before a customer exists).
For the complete resource schema including all attributes and relationships, see DeniedCreditApplicationDecision.
Credit Limit Decision Resources
ManualReviewCreditLimitDecision
Represents a manual review credit decision for an existing customer.
For the complete resource schema including all attributes and relationships, see ManualReviewCreditLimitDecision.
ApprovedCreditLimitDecision
Represents an approved credit decision for an existing customer.
For the complete resource schema including all attributes and relationships, see ApprovedCreditLimitDecision.
DeniedCreditLimitDecision
Represents a denied credit decision for an existing customer.
For the complete resource schema including all attributes and relationships, see DeniedCreditLimitDecision.
Common Attributes
All credit decision resources share these common attributes:
| Attribute | Type | Description |
|---|---|---|
| externalApplicationId | string | Identifier for client's credit evaluation related to this decision. Max 200 char. |
| submissionTimestamp | timestamp | Timestamp when the corresponding credit application was submitted. |
| decisionTimestamp | timestamp | Timestamp when the credit decision was made. |
| policyException | boolean | One of true or false. |
| policyExceptionReason | string | Conditional if policyException is true. Brief description of reason. |
| additionalUnderwritingData | json | Object containing key-value pairs of underwriting data per credit policy. |
| createdAt | timestamp | The date the resource was created. |
Additional Attributes for Approved Decisions
| Attribute | Type | Description |
|---|---|---|
| creditLimit | Integer (Cents) | Credit limit for application as evaluated per policy. |
Additional Attributes for Denied Decisions
| Attribute | Type | Description |
|---|---|---|
| decisionReason | string | Reason for denial per credit policy. Max 200 char. |
| adverseActionReasons | Array of strings | Array of strings representing Adverse action reasons (must have at least one). Max 200 char per reason. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| creditApplication | CreditApplication | The credit application for which this credit decision applies to. |
| org | Org | The organization that owns the credit decision. |
| customer | Customer | Optional. The customer associated with the credit decision. |