Return Prospects Orders

Request

Retrieve details of a specific prospect order by its unique identifier. Returns order status, progress information, search criteria used, and results summary when the order is completed.

Security

bearerToken

Path

idstring, (uuid)required

Unique identifier (GUID) of the prospect order to retrieve

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/prospects/orders/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Prospect order details retrieved successfully

Bodyapplication/json

correlationIdstring

A unique ID assigned to this request

idstring, (uuid)

Unique identifier of the prospect order

createdAtstring, (date-time)

Timestamp when the order was created

modifiedAtstring, (date-time)

Timestamp when the order was last modified

exportedAtstring, (date-time)

Timestamp when the order was exported (null if not exported)

expiresAtstring, (date-time)

Timestamp when the order expires

userIdinteger, (int32)

User ID who created the order

customerIdinteger, (int32)

Customer ID associated with the order

statusstring

Current status of the order

Enum:"pending""completed""failed"

namestring

Name of the prospect order

descriptionstring

Detailed description of the prospect order

searchCriteriaobject(ProspectSearchCriteria)

Search criteria used for the prospect order

orderAmountsobject

Breakdown of order amounts by country and registration type

portfolioIdstring, (uuid)

Portfolio ID associated with the order, used to organize and manage prospect orders

portfolioNamestring

Portfolio name associated with the order

isLegacyboolean

Indicates if this is a legacy order

previewCountinteger, (int32)

Number of preview records available for this order

Response

{
  "correlationId": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "createdAt": "2019-08-24T14:15:22Z",
  "modifiedAt": "2019-08-24T14:15:22Z",
  "exportedAt": "2019-08-24T14:15:22Z",
  "expiresAt": "2019-08-24T14:15:22Z",
  "userId": 0,
  "customerId": 0,
  "status": "pending",
  "name": "string",
  "description": "string",
  "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": [ … ],
    "companyStatus": [ … ],
    "excludePortfolios": [ … ],
    "locations": [ … ],
    "excludeLocations": [ … ],
    "registeredTypes": [ … ],
    "internationalActivities": [ … ],
    "localActivities": [ … ],
    "excludeInternationalActivities": [ … ],
    "excludeLocalActivities": [ … ],
    "countries": [ … ],
    "internationalScores": [ … ],
    "legalForms": [ … ],
    "businessClassifications": [ … ],
    "companyAuditors": [ … ],
    "caExports": [ … ],
    "postCodeSearchType": "startsWith",
    "postcodes": [ … ],
    "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
  },
  "orderAmounts": {
    "property1": { … },
    "property2": { … }
  },
  "portfolioId": "2a9b0ad6-e5de-4239-a282-527c92c7c0f1",
  "portfolioName": "string",
  "isLegacy": true,
  "previewCount": 0
}