Run Decision Tree

Request

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

Security

bearerToken

Path

provenirIdstringrequired

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

Query

companyIdstringrequired

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

originationIdstring

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

Bodyapplication/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.

curl -i -X POST \
  'https://connect.sandbox.creditsafe.com/v1/decisionEngine/{provenirId}?companyId=GB-0-03836192&originationId=SFC-1976' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "productType": "Product A",
    "isCustomer": "Yes",
    "salesValue": 197600
  }'

Responses

Bodyapplication/json

Decisionstring or null

The decision returned by the automated decision model.

Example:"Reject"

DecisionTextstring or null

The text output to accompany the decision returned by the decision model.

Example:"The Sales Value requested is greater than Creditsafe's recommended credit limit."

AuditsArray of objects or null

An array of audit values. The parameters output for audit are tailored and bespoke to each decision tree.

originationIdstring or null

Displays the optional text passed through to be stored against the decision in the original call to /{provenirId}. Typically used for internal identifiers (e.g. SalesForce IDs).

Example:"SFC-1976"

statusCodestring or null

The status of the decision. typically, 1 is reserved for positive outcomes, 2 for pending status and 3 for negative outcomes.

Example:"3"

Response

{
  "Decision": "Reject",
  "DecisionText": "The Sales Value requested is greater than Creditsafe's recommended credit limit.",
  "Audits": [
    { … }
  ],
  "originationId": "SFC-1976",
  "statusCode": "3"
}