GB Finance Agreements

This endpoint provides tools for acquiring and verifying finance agreement information.

Operations

Request Finance Agreements

Request

This tool provides a detailed view of data supplied via the CCDS scheme(Commercial Credit Data Sharing ). It's tailored for users needing immediate access to current and accurate financial agreement information, enhancing decision-making with up-to-date data insights.

1. Full CCDS Access - Gain in-depth insights with access to up to 48 months of historical data on current accounts, loans, and credit card facilities. This tool is perfect for comprehensive long-term financial analysis, offering a thorough understanding of credit history and trends.

2. Financial Footprint - Get a summarized view of non performance related credit activity data. This tool simplifies the complex data into an easily understandable summary, ideal for quick assessments and initial screenings.

3. Finance Performance Indicator - A predictive tool that evaluates the likelihood of a company defaulting on payments within the next 90 days. This tool is crucial for risk assessment and mitigation, offering foresight and preparation for potential financial challenges.

Security

bearerToken

Path

companyIdstringrequired

The connectId or safeNumber of the company

Example:GB-0-X9999999

Query

excludeCutOffDateboolean

Default:false

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/localSolutions/GB/CCDS/GB-0-X9999999?excludeCutOffDate=false' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful response

Bodyapplication/json

One of:

correlationIdstring

A unique ID assigned to this request.

safeNumberstring

Safe Number - Identifier for Companies in Creditsafe's Home Countries.

Example:"UK08368892"

creditSafeobject

overallAggregationsobject(ConnectCcdsOverallAggregations)

A summarisation of the companies account details.

Example:

{
  "totalAccounts": -1,
  "totalBalance": 0,
  "totalOverdraftOrCreditLimit": 0,
  "remainingBalance": 0,
  "totalAverageBalance": 0
}

historyArray of objects(ConnectCcdsHistory)

List of accounts connected to the company, snapshot of account at point in time each month.

Example:

[
  {
    "businessTypeIndicator": "L",
    "businessName": "POTS & CO LTD",
    "businessAddress": { … },
    "additionalTradingStyle": null,
    "businessTelephoneNumber": null,
    "companyRegistrationNumber": null,
    "vatNumber": null,
    "specialInstructionIndicator": null,
    "startDateOfAgreement": "2017-05-15T00:00:00",
    "currentBalance": 0,
    "currentBalanceCreditIndicator": null,
    "actualCurrentBalance": 0,
    "facilityStatus": "0",
    "originalDefaultBalance": 0,
    "creditOrOverdraftLimit": 0,
    "flagSettings": "",
    "transferredToConsolidatedDebtAccount": null,
    "repaymentPeriod": 0,
    "paymentAmount": 0,
    "paymentFrequencyIndicator": null,
    "numberOfCashAdvances": 0,
    "valueOfCashAdvances": 0,
    "minimumBalance": 0,
    "minimumBalanceCreditIndicator": null,
    "actualMinimumBalance": 0,
    "maximumBalance": 0,
    "maximumBalanceCreditIndicator": null,
    "actualMaximumBalance": 0,
    "averageBalance": 0,
    "averageBalanceCreditIndicator": null,
    "actualAverageBalance": 0,
    "creditTurnover": 0,
    "creditTurnoverNetOrGrossIndicator": null,
    "debitTurnover": 0,
    "debitTurnoverNetOrGrossIndicator": null,
    "rejectedPayments": 0,
    "maximumDurationOfExcess": 0,
    "currentAccountReportingLevelIndicator": null,
    "facilityType": "01",
    "facilityTypeCategory": "LOAN",
    "batchDate": "20220131",
    "date": "20220131",
    "facilityId": "baffec1bd22b1f30ec6ebce04c9c1ad158d7fce6c9f693c53f880b5db631dd9a"
  }
]

footprintDataobject

A version of a summarisation of companies account details which omits any sensitive data and can be shown to non-CCDS members.

Example:

{
  "2023": {
    "10": { … },
    "11": { … }
  }
}

indicatorDataobject

Example:

{
  "2023": {
    "10": { … },
    "11": { … }
  }
}

Response

{
  "correlationId": "string",
  "safeNumber": "UK08368892",
  "creditSafe": {
    "creditSafeCompanyId": "NI008172"
  },
  "overallAggregations": {
    "totalAccounts": -1,
    "totalBalance": 0,
    "totalOverdraftOrCreditLimit": 0,
    "remainingBalance": 0,
    "totalAverageBalance": 0
  },
  "history": [
    { … }
  ],
  "footprintData": {
    "2023": { … }
  },
  "indicatorData": {
    "2023": { … }
  }
}