Skip to content
Connect API Catalog/
/
/
Create Prospects Orders P...

Create Prospects Orders Preview

Request

Preview the number of matching companies for prospect search criteria before creating an order. Returns a breakdown by country and registration type to help estimate the scope and cost of the prospect order.

Security
bearerToken
Bodyapplication/jsonrequired
creditLimitIncludeNotFiledboolean

Include companies with no credit limit filed

creditScoreIncludeNotFiledboolean

Include companies with no credit score filed

employeesIncludeNotFiledboolean

Include companies with no employee count filed

financialAvailableboolean

Filter for companies with financial data available

incorporationIncludeNotFiledboolean

Include companies with no incorporation date filed

marketingAllowedboolean

Filter for companies that allow marketing contact

phoneAvailableboolean

Filter for companies with phone numbers available

postcodeAvailableboolean

Filter for companies with postcode available

uniqueTelephoneNumberboolean

Filter for companies with unique telephone numbers

excludeHasCCJboolean

Exclude companies with County Court Judgements

creditScoreTrendstring

Credit score trend filter

Enum:"increase""decrease"
incorporationEndDatestring, (date-time)

Maximum incorporation date for filtering

incorporationStartDatestring, (date-time)

Minimum incorporation date for filtering

addressTypesArray of strings

Types of company addresses to filter by

Items Enum:"headOffice""branch""legalPerson"
companyStatusArray of strings

Company status filters

Items Enum:"active""inactive""other""suppressInProspects"
excludePortfoliosArray of strings, (uuid)

Portfolio IDs to exclude from results

locationsArray of objects

Geographic locations to include

excludeLocationsArray of objects

Geographic locations to exclude

registeredTypesArray of strings

Company registration types

Items Enum:"limited""nonLimited""total"
internationalActivitiesArray of objects

International activity codes to filter by

localActivitiesArray of objects

Local activity codes to filter by

excludeInternationalActivitiesArray of objects

International activity codes to exclude

excludeLocalActivitiesArray of objects

Local activity codes to exclude

countriesArray of strings

Country codes to filter by (ISO-2 format)

Example:
[
  "GB"
]
internationalScoresArray of strings

International credit scores to filter by

legalFormsArray of strings

Legal forms to filter by

businessClassificationsArray of strings

Business classifications to filter by

companyAuditorsArray of strings

Company auditors to filter by

caExportsArray of strings

Canadian export classifications

postCodeSearchTypestring

Type of postcode search

Enum:"startsWith""exactMatch"
postcodesArray of strings

Postcodes to filter by

creditLimitMaxinteger, (int64)

Maximum credit limit filter

creditLimitMininteger, (int64)

Minimum credit limit filter

creditScoreMaxinteger, (int64)

Maximum credit score filter

creditScoreMininteger, (int64)

Minimum credit score filter

currentDebtRatioMaxinteger, (int64)

Maximum current debt ratio

currentDebtRatioMininteger, (int64)

Minimum current debt ratio

currentRatioMaxnumber, (double)

Maximum current ratio

currentRatioMinnumber, (double)

Minimum current ratio

dbtMaxinteger, (int64)

Maximum days beyond terms

dbtMininteger, (int64)

Minimum days beyond terms

employeesMaxinteger, (int64)

Maximum number of employees

employeesMininteger, (int64)

Minimum number of employees

netWorthMaxinteger, (int64)

Maximum net worth

netWorthMininteger, (int64)

Minimum net worth

pretaxProfitMarginMaxinteger, (int64)

Maximum pretax profit margin percentage

pretaxProfitMarginMininteger, (int64)

Minimum pretax profit margin percentage

pretaxProfitMaxinteger, (int64)

Maximum pretax profit

pretaxProfitMininteger, (int64)

Minimum pretax profit

profitMaxinteger, (int64)

Maximum profit

profitMininteger, (int64)

Minimum profit

returnCapitalEmployedMaxinteger, (int64)

Maximum return on capital employed percentage

returnCapitalEmployedMininteger, (int64)

Minimum return on capital employed percentage

shareCapitalMaxinteger, (int64)

Maximum share capital

shareCapitalMininteger, (int64)

Minimum share capital

shareholderFundsMaxinteger, (int64)

Maximum shareholder funds

shareholderFundsMininteger, (int64)

Minimum shareholder funds

totalCurrentAssetsMaxinteger, (int64)

Maximum total current assets

totalCurrentAssetsMininteger, (int64)

Minimum total current assets

totalCurrentLiabilitiesMaxinteger, (int64)

Maximum total current liabilities

totalCurrentLiabilitiesMininteger, (int64)

Minimum total current liabilities

totalDebtRatioMaxinteger, (int64)

Maximum total debt ratio percentage

totalDebtRatioMininteger, (int64)

Minimum total debt ratio percentage

totalFixedAssetsMaxinteger, (int64)

Maximum total fixed assets

totalFixedAssetsMininteger, (int64)

Minimum total fixed assets

totalLongTermLiabilitiesMaxinteger, (int64)

Maximum total long term liabilities

totalLongTermLiabilitiesMininteger, (int64)

Minimum total long term liabilities

turnoverMaxinteger, (int64)

Maximum turnover/revenue

turnoverMininteger, (int64)

Minimum turnover/revenue

workingCapitalMaxinteger, (int64)

Maximum working capital

workingCapitalMininteger, (int64)

Minimum working capital

activityTypestring

Activity code classification type

currencystring

Currency code for financial filters (e.g., 'GBP', 'EUR', 'USD')

excludePreviousOrdersDurationstring

Duration to exclude companies from previous orders (e.g., '30d', '90d', '1y')

directorAgeMaxinteger, (int32)

Maximum director age

directorAgeMininteger, (int32)

Minimum director age

curl -i -X POST \
  https://connect.sandbox.creditsafe.com/v1/prospects/orders/preview \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "creditLimitIncludeNotFiled": true,
    "creditScoreIncludeNotFiled": true,
    "employeesIncludeNotFiled": true,
    "financialAvailable": true,
    "incorporationIncludeNotFiled": true,
    "marketingAllowed": true,
    "phoneAvailable": true,
    "postcodeAvailable": true,
    "uniqueTelephoneNumber": true,
    "excludeHasCCJ": true,
    "creditScoreTrend": "increase",
    "incorporationEndDate": "2019-08-24T14:15:22Z",
    "incorporationStartDate": "2019-08-24T14:15:22Z",
    "addressTypes": [
      "headOffice"
    ],
    "companyStatus": [
      "active"
    ],
    "excludePortfolios": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "locations": [
      {
        "key": "string"
      }
    ],
    "excludeLocations": [
      {
        "key": "string"
      }
    ],
    "registeredTypes": [
      "limited"
    ],
    "internationalActivities": [
      {
        "code": "string",
        "activityType": "string",
        "parentPath": "string",
        "isParent": true
      }
    ],
    "localActivities": [
      {
        "code": "string",
        "activityType": "string",
        "parentPath": "string",
        "isParent": true
      }
    ],
    "excludeInternationalActivities": [
      {
        "code": "string"
      }
    ],
    "excludeLocalActivities": [
      {
        "code": "string"
      }
    ],
    "countries": [
      "GB"
    ],
    "internationalScores": [
      "string"
    ],
    "legalForms": [
      "string"
    ],
    "businessClassifications": [
      "string"
    ],
    "companyAuditors": [
      "string"
    ],
    "caExports": [
      "string"
    ],
    "postCodeSearchType": "startsWith",
    "postcodes": [
      "string"
    ],
    "creditLimitMax": 0,
    "creditLimitMin": 0,
    "creditScoreMax": 0,
    "creditScoreMin": 0,
    "currentDebtRatioMax": 0,
    "currentDebtRatioMin": 0,
    "currentRatioMax": 0.1,
    "currentRatioMin": 0.1,
    "dbtMax": 0,
    "dbtMin": 0,
    "employeesMax": 0,
    "employeesMin": 0,
    "netWorthMax": 0,
    "netWorthMin": 0,
    "pretaxProfitMarginMax": 0,
    "pretaxProfitMarginMin": 0,
    "pretaxProfitMax": 0,
    "pretaxProfitMin": 0,
    "profitMax": 0,
    "profitMin": 0,
    "returnCapitalEmployedMax": 0,
    "returnCapitalEmployedMin": 0,
    "shareCapitalMax": 0,
    "shareCapitalMin": 0,
    "shareholderFundsMax": 0,
    "shareholderFundsMin": 0,
    "totalCurrentAssetsMax": 0,
    "totalCurrentAssetsMin": 0,
    "totalCurrentLiabilitiesMax": 0,
    "totalCurrentLiabilitiesMin": 0,
    "totalDebtRatioMax": 0,
    "totalDebtRatioMin": 0,
    "totalFixedAssetsMax": 0,
    "totalFixedAssetsMin": 0,
    "totalLongTermLiabilitiesMax": 0,
    "totalLongTermLiabilitiesMin": 0,
    "turnoverMax": 0,
    "turnoverMin": 0,
    "workingCapitalMax": 0,
    "workingCapitalMin": 0,
    "activityType": "string",
    "currency": "string",
    "excludePreviousOrdersDuration": "string",
    "directorAgeMax": 0,
    "directorAgeMin": 0
  }'

Responses

Preview of matching companies generated successfully

Bodyapplication/json
amountPerCountryobject

Breakdown of matching companies by country and registration type

totalinteger, (int32)

Total number of matching companies across all countries

Response
{
  "amountPerCountry": {
    "property1": { … },
    "property2": { … }
  },
  "total": 0
}