Connect API Catalog
/
Check and Decide
/
API Documentation
/
Decision Logs

Check and Decide (1.0.0)

Introduction

Endpoints to access pre-configured decision trees to automate credit decisions. Decision Engine can help you save time and money across your company by automating time consuming processes which drain your company's resources. This can free you and your staff to spend more time to work on achieving your business goals.

A full audit trail of previous decisions is maintained for user access and decisions in a pending state can be manually approved or declined.

Download OpenAPI description
checkAndDecide.json
checkAndDecide.yaml
Languages
Servers
Mock server
https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/checkdecide/checkanddecide/
Sandbox server
https://connect.sandbox.creditsafe.com/v1/
Production server
https://connect.creditsafe.com/v1/

Authentication

Operations

Instance Management

Operations

Decision Trees

Operations

Decision Logs

Operations

Decision History

Request

Returns a log of all previously ran decisions that the user has permission to access, optionally filtered.

Query
provenirIdstring

Filter the returned usage log by the GUID for the associated decision trees, obtained from /GUID.

Example: provenirId=repoObj_0ed6a4aa_16e17d977e9_07ffb16e17d977e9
companyIdstring

Filter the returned usage log by the Connect ID for the associated companies for each decision.

Example: companyId=US001-X-US60521352
companyNamestring

Filter the returned usage log by the Company Name for the associated companies for each decision.

Example: companyName=CREDITSAFE
statusnumber

Filter the returned usage log by the status for each decision.

Example: status=1
fromDatestring(date-time)

Filter the returned usage log by the date the the decision was run.

toDatestring(date-time)

Filter the returned usage log by the date the the decision was run.

pageinteger

Starting page number.

Default 1
pageSizeinteger

Number of items to return per Page.

curl -i -X GET \
  'https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/checkdecide/checkanddecide/decisionEngine/usageLog?companyId=US001-X-US60521352&companyName=CREDITSAFE&fromDate=2019-08-24T14%3A15%3A22Z&page=1&pageSize=0&provenirId=repoObj_0ed6a4aa_16e17d977e9_07ffb16e17d977e9&status=1&toDate=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
totalCountnumber

The total number of previous decisions matching the defined filter criteria.

Example: 3108
usageLogArray of objects
Response
application/json
{
  "totalCount": 3108,
  "usageLog": [
    { … }
  ]
}

Get Decision Log

Request

Returns a specified decision log for a previously ran decision.

Path
decisionLogIdstringrequired

The unique identifier of the decision log to retrieve, obtained from /usageLog.

curl -i -X GET \
  'https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/checkdecide/checkanddecide/decisionEngine/usageLog/{decisionLogId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
decisionLogIdnumber

The unique identifier for the decision log.

Example: 64492
provenirIdstring

The unique identifier of the decision tree.

Example: "repoObj_0ed6a4aa_16e17d977e9_07ffb16e17d977e9"
friendlyNamestring

The name of the decision tree.

Example: "Check & Decide Demo"
userIdnumber

The unique identifier for the user's account, used across the Creditsafe product suite.

Example: 101445010
companyIdstring

The connectId of the company that the decision was ran on. A connectId is the primary Company identifier that is used to uniquely identify all companies across Creditsafe's Universe and Partner Network.

Example: "US001-X-US60521352"
companyNamestring or null

The name of the company that the decision was ran on.

Example: "CREDITSAFE USA INC."
responseobject
decisionDatestring(date-time)

The timestamp that the decision model was run.

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"
statusnumber

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

Example: 3
notesstring or null

The notes associated with this decision.

modifiedDatestring(date-time)

The timestamp that this decision was last modified.

correlationIdstringDeprecated

A unique ID assigned to this request.

Example: "23921650-c073-11ea-860f-06bc8182190e"
Response
application/json
{
  "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  "decisionLogId": 64492,
  "provenirId": "repoObj_0ed6a4aa_16e17d977e9_07ffb16e17d977e9",
  "friendlyName": "Check & Decide Demo",
  "userId": 101445010,
  "companyId": "US001-X-US60521352",
  "companyName": "CREDITSAFE USA INC.",
  "response": {
    "Decision": "Reject",
    "DecisionText": "The Sales Value requested is greater than Creditsafe's recommended credit limit.",
    "Audits": [ … ],
    "statusCode": 3
  },
  "decisionDate": "2019-08-24T14:15:22Z",
  "originationId": "SFC-1976",
  "status": 3,
  "notes": "string",
  "modifiedDate": "2019-08-24T14:15:22Z"
}

Update Decision Log

Request

Updates the status and/or notes for a specified decision.

Path
decisionLogIdstringrequired

The unique identifier of the decision log to retrieve, obtained from /usageLog.

Bodyapplication/json
any(ConnectDecisionEngineUpdateDecisionRequest)
curl -i -X PATCH \
  'https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/checkdecide/checkanddecide/decisionEngine/usageLog/{decisionLogId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json'

Responses

Bodyapplication/json
decisionLogIdnumber

The unique identifier for the decision log.

Example: 64492
provenirIdstring

The unique identifier of the decision tree.

Example: "repoObj_0ed6a4aa_16e17d977e9_07ffb16e17d977e9"
friendlyNamestring

The name of the decision tree.

Example: "Check & Decide Demo"
userIdnumber

The unique identifier for the user's account, used across the Creditsafe product suite.

Example: 101445010
companyIdstring

The connectId of the company that the decision was ran on. A connectId is the primary Company identifier that is used to uniquely identify all companies across Creditsafe's Universe and Partner Network.

Example: "US001-X-US60521352"
companyNamestring or null

The name of the company that the decision was ran on.

Example: "CREDITSAFE USA INC."
responseobject
decisionDatestring(date-time)

The timestamp that the decision model was run.

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"
statusnumber

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

Example: 3
notesstring or null

The notes associated with this decision.

modifiedDatestring(date-time)

The timestamp that this decision was last modified.

correlationIdstringDeprecated

A unique ID assigned to this request.

Example: "23921650-c073-11ea-860f-06bc8182190e"
Response
application/json
{
  "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  "decisionLogId": 64492,
  "provenirId": "repoObj_0ed6a4aa_16e17d977e9_07ffb16e17d977e9",
  "friendlyName": "Check & Decide Demo",
  "userId": 101445010,
  "companyId": "US001-X-US60521352",
  "companyName": "CREDITSAFE USA INC.",
  "response": {
    "Decision": "Reject",
    "DecisionText": "The Sales Value requested is greater than Creditsafe's recommended credit limit.",
    "Audits": [ … ],
    "statusCode": 3
  },
  "decisionDate": "2019-08-24T14:15:22Z",
  "originationId": "SFC-1976",
  "status": 3,
  "notes": "string",
  "modifiedDate": "2019-08-24T14:15:22Z"
}

Run Decision

Operations

Decision Outcome

Operations