Connect API Catalog
/
Creditsafe Connect
/
API Documentation
/
Decision Logs
/
Return Decision Log

Creditsafe Connect (1.10.9)

Metadata

KeyValue
tagsFeatured

Introduction

The Creditsafe Connect API is a REST API that provides access to the Creditsafe Global Company Database. This allows you to:

  • Control your master data
  • Utilize up-to-date Business and Director information, enhancing your onboarding and qualification processes
  • Receive alerts when your customer's and supplier's Credit Report changes

Quick Start

To start your Creditsafe Connect API integration you will need to have activated your account and set a password by following the instructions in your Welcome Email. If you have not received a Welcome Email please contact your Creditsafe Account Manager.

By default, you will have been setup on our Sandbox environment.

Using a REST API client construct an /authenticate POST request and enter your username & password (case-sensitive) into the POST body. A successful response will return an authentication token.

Use the authentication token in an Authorization header on all other Creditsafe Connect calls as proof of your authenticity.

Download OpenAPI description
connectAPI.json
connectAPI.yaml
Languages
Servers
Sandbox server

https://connect.sandbox.creditsafe.com/v1/

Production server

https://connect.creditsafe.com/v1/

Authentication

Endpoints for user authentication into the Connect API.

Operations

User Administration

Endpoints for user management.

Operations

Schema Structure

Endpoints to retrieve the structure of the Company and Director Search Criteria's and Reports.
The JSON schema is a blueprint of the data structure that will be returned in the response of the Company and Director Report endpoints. The schema can be used to validate the response data and understand the structure of the data returned. The schema is available for all countries and is a superset of all country's JSON schemas.

Companies

Endpoints to search for Companies in the Creditsafe Global Company Database. Companies are uniquely identified by the connectId - the identifier used to order a Company Credit Report. The Company Credit Report is a JSON object comprising of key business and financial data points such as Credit Score & Limit, Industry Code, Directors, Balance Sheet and Negative Information. A full list of Company data points can be found in the Data Matrix, in the help resources.

Operations

People/Directors

Endpoints to find People/Directors and order Director Reports. A Director Report will contain a person's registered information and Active & Previous Directorships, where available. This endpoint is not advised to get a list of directors for a specific Company. Instead, order a Company Credit Report using the /companies/{id} endpoint, and use the directors section in the response.

Operations

GB Consumers and AML

Operations

Images

Endpoints to order official Company Image/Filing Documents from

source. Company Filings such as Annual Account Statements, Annual Returns,

Liquidations and Changes of Registered Information can be downloaded as

PDFs, and are typically used as a resource in extended company

auditing/compliance.

Operations

Fresh Investigations

Endpoints to manage Fresh Investigation requests. With the need for accurate data, you can check on any company that is not available within our instant online database by placing a Fresh Investigation (Offline Order). Depending on the market, the information we obtain will vary. Using official sources and registries we are able to quickly answer questions about a company's stability and financial health. Where official information is not available we will conduct a direct interview with the business.

Operations

User Details

Operations

Create and View All Portfolios

Operations

Importing Portfolios

Operations

User Management of Portfolios

Operations

Individual Portfolio Management

Operations

Event Rules and Notifications

Operations

Instance Management

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

Operations

Decision Trees

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

Operations

Decision Logs

Endpoints for retrieving and managing logs of past decisions.

Operations

Return Decision History

Request

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

Security
bearerToken
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://connect.sandbox.creditsafe.com/v1/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": [
    { … }
  ]
}

Return Decision Log

Request

Returns a specified decision log for a previously ran decision.

Security
bearerToken
Path
decisionLogIdstringrequired

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

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/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.

Security
bearerToken
Path
decisionLogIdstringrequired

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

Bodyapplication/json
any(ConnectDecisionEngineUpdateDecisionRequest)
curl -i -X PATCH \
  'https://connect.sandbox.creditsafe.com/v1/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

Endpoints for executing decision trees to automate credit decisions.

Operations

Decision Outcome

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

Operations

Audit (Legacy)

Operations

IDV (Legacy)

Operations

GB Bank Match

Operations

GB Bank Verification

Operations

GB Land Registry

Operations

GB Finance Agreements

Operations

FR Bank Match

This endpoint provides tools for matching bank information in France.

Operations

DE NonLtd Companies

This endpoint provides the tools for searching non-limited companies in Germany and acquiring company reports.

Operations

NL KVK Extract

This endpoint provides tools for extracting information from the Dutch Chamber of Commerce (KVK).

Operations

US Search Support

Operations

Verify

Verify is an exclusive add-on to Creditsafe's company credit reports, designed to assist businesses in making smarter, quicker, and more informed credit decisions. For new or small companies that lack a detailed financial footprint, Verify offers unparalleled insights by screening company directors and the individuals behind businesses for their personal financial stability and identity.

Using Verify, you can confidently assess a company's leadership, using trusted public datasets that highlight potential financial concerns, such as CCJs or Insolvencies and confirm that they reside at an address on the Electoral roll.

Operations

Create and View All Jobs

Create a Data Cleaning job and view all jobs in the system.

Operations

Individual Job Management

Manage individual Data Cleaning jobs. Including updating required mappings and enrichment processes.

Operations

Administrator Resources

Operations

Audit

Operations

Profile Management

Operations

Profile Updates

Operations

Profile Key Parties

Operations

Batch Uploads

Operations

Profile Business / Individual Details

Operations

AML Screening - Profile Management

Operations

AML Screening - Businesses

Operations

AML Screening - Individuals

Operations

AML Bulk Screening

Operations

AML Monitoring Management

Operations

Async AML

Operations

Global Monitoring

Operations

Reporting

Operations

Consumers

Update this description.

Operations