Run Decision Tree

Runs the provided decision tree for the given company, optionally using the data provided in the body of the call.

SecuritybearerToken
Request
path Parameters
provenirId
required
string

The unique identifier of the decision tree to run, obtained from /GUID.

query Parameters
companyId
required
string

The Connect ID for the company that you wish to run the decision tree on. Obtained from /companies search results. A Connect ID is the primary Company identifier that is used to uniquely identify all companies across Creditsafe's Universe and Partner Network.

Example: companyId=GB-0-03836192
originationId
string

An optional field that will allow text passed through to be stored against the decision. Typically used for internal identifiers (e.g. SalesForce IDs).

Example: originationId=SFC-1976
Request Body schema: application/json
object

The POST body should contain the User Data Fields for the decision tree you want to run obtained via the /{guid}/userDataFields endpoint.

Responses
200
400
401
post/decisionEngine/{provenirId}
Request samples
application/json
{
  • "productType": "Product A",
  • "isCustomer": "Yes",
  • "salesValue": 197600
}
Response samples
application/json
{
  • "Decision": "Reject",
  • "DecisionText": "The Sales Value requested is greater than Creditsafe's recommended credit limit.",
  • "Audits": [
    ],
  • "originationId": "SFC-1976",
  • "statusCode": 3
}
➔ Next to Decision Outcome / Return Decision Outcome