# Check and Decide


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.</br></br>A full audit trail of
previous decisions is maintained for user access and decisions in a
pending state can be manually approved or declined.


Version: 1.0.0
Metadata:
  - tags: ["Featured"]

## Servers

Sandbox server
```
https://connect.sandbox.creditsafe.com/v1
```

Production server
```
https://connect.creditsafe.com/v1
```

## Security

### bearerToken

This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the `Authorization` header of each request.

Type: http
Scheme: bearer
Bearer Format: JWT

## Download OpenAPI description

[Check and Decide](https://doc.creditsafe.com/_spec/connect-apis-catalog/product-catalog/Check&Decide/checkAndDecide.yaml)

## Authentication

Endpoint for a user authentication and token management.

### Authenticate

 - [POST /authenticate](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/checkdecide/checkanddecide/authentication/authenticate.md): Supply username and password to generate Authentication Token.
  


## Instance Management

Endpoints for managing decision engine instances, including retrieval, and updating.

### Return All Available Instances

 - [GET /decisionEngine/instances](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/checkdecide/checkanddecide/instance-management/returnallinstances.md): Returns all instances (Decision Trees) a user has permission to access.

### Return Instance Configuration

 - [GET /decisionEngine/instance/{guid}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/checkdecide/checkanddecide/instance-management/instanceconfiguration.md): Returns instance user has permission to access.

### Update Instance Configuration

 - [PUT /decisionEngine/instance/{guid}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/checkdecide/checkanddecide/instance-management/updateinstanceconfiguration.md): Update the instances information.You will need to call the  endpoint to get the current configuration and then update the fields you want to change.

## Decision Trees

Endpoints for accessing and managing pre-configured decision trees used for automated credit decisions.

### Return Decision Trees

 - [GET /decisionEngine/GUID](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/checkdecide/checkanddecide/decision-trees/decisiontrees.md): Returns all decision trees that the user has permission to access.

### Return User Data Fields

 - [GET /decisionEngine/{provenirId}/userDataFields](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/checkdecide/checkanddecide/decision-trees/userdatafields.md): Returns the user data fields defined for the given decision tree GUID.

## Decision Logs

Endpoints for retrieving and managing logs of past decisions.

### Return Decision History

 - [GET /decisionEngine/usageLog](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/checkdecide/checkanddecide/decision-logs/decisionhistory.md): Returns a log of all previously ran decisions that the user has permission to access, optionally filtered.

### Return Decision Log

 - [GET /decisionEngine/usageLog/{decisionLogId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/checkdecide/checkanddecide/decision-logs/getdecisionlog.md): Returns a specified decision log for a previously ran decision.

### Update Decision Log

 - [PATCH /decisionEngine/usageLog/{decisionLogId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/checkdecide/checkanddecide/decision-logs/updatedecisionlog.md): Updates the status and/or notes for a specified decision.

## Run Decision

Endpoints for executing decision trees to automate credit decisions.

### Run Decision Tree

 - [POST /decisionEngine/{provenirId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/checkdecide/checkanddecide/run-decision/rundecisiontree.md): Runs the provided decision tree for the given company, optionally using the data provided in the body of the call.

## Decision Outcome

Endpoints for retrieving the outcomes of executed decisions, including detailed results.

### Return Decision Outcome

 - [GET /decisionEngine/decisionOutcome/{guid}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/checkdecide/checkanddecide/decision-outcome/decisionoutcome.md): Returns decision outcomes which is set for decision tree.

### Update Decision Outcome

 - [PATCH /decisionEngine/decisionOutcome/{guid}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/checkdecide/checkanddecide/decision-outcome/updatedecisionenginedecisionoutcomedetails.md): This allows the user to manually update the decision outcome