Fields

isRequired : Boolean

Whether a credit check is required for the account user.
reason : String

Human-readable explanation of the decision, for display to support staff. The wording may change, so use reasonCode to branch on the decision.
reasonCode : CreditCheckReason

Machine-readable reason for the decision.
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "isRequired": true, "reason": "that-if-quickly-per-month", "reasonCode": "NO_MEANINGFUL_AGREEMENTS" }