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

Create Prospects Orders

Request

Endpoint to create a new prospect order based on search criteria. This endpoint allows you to order a list of companies matching specific criteria for prospecting and business development purposes.

Security
bearerToken
Bodyapplication/jsonrequired
searchCriteriaobject(ProspectSearchCriteria)

Search criteria for filtering prospect companies

amountPerCountryobject

Number of prospects to order per country and registered type

namestring

Name for the prospect order

Example:"Q1 2024 Marketing Campaign"
descriptionstring

Description of the prospect order purpose

Example:"Target companies in manufacturing sector for new product launch"
exportLangstring

Language code for export (e.g., 'en', 'fr', 'de')

Example:"en"
previewCountinteger, (int32)

Number of preview results to return before creating the full order

Example:100
curl -i -X POST \
  https://connect.sandbox.creditsafe.com/v1/prospects/orders \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "searchCriteria": {
      "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
    },
    "amountPerCountry": {
      "property1": {
        "property1": 0,
        "property2": 0
      },
      "property2": {
        "property1": 0,
        "property2": 0
      }
    },
    "name": "Q1 2024 Marketing Campaign",
    "description": "Target companies in manufacturing sector for new product launch",
    "exportLang": "en",
    "previewCount": 100
  }'

Responses

Prospect order created successfully

Bodyapplication/json
idstring, (uuid)

Unique identifier for the created prospect order

Example:"550e8400-e29b-41d4-a716-446655440000"
Response
{
  "id": "550e8400-e29b-41d4-a716-446655440000"
}