runCreditCheck
Mutation for running a credit check.
Arguments
Possible Errors
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1199: Too many requests.
- KT-CT-7899: An internal error occurred.
- KT-US-3812: Unexpected error when running credit check.
- KT-US-3814: Received invalid data. Unable to store credit score.
- KT-US-3815: Unable to complete the credit check process.
- KT-US-4119: You are not authorized to use the credit engine.
Allowed Viewers
Required Permissions
Can create accounts Can run credit checkRate Limits
| Key | Steps |
|---|---|
ip |
['5/7d', '3/360d'] |
ssn_graphql_variable |
['5/d'] |
Query Complexity
1Examples
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.
mutation RunCreditCheck($input: RunCreditCheckInput!) {
runCreditCheck(input: $input) {
id
passedCreditCheck
}
}
Variables
{
"input": RunCreditCheckInput
}
Response
{
"data": {
"runCreditCheck": {
"id": "57711960",
"passedCreditCheck": true
}
}
}