Retrieve FreshInvestigation Order

Request

Returns a specific Fresh Investigation order.

Security

bearerToken

Path

orderIdstringrequired

Query

sectionsstring

Specify a value to return a single section, or multiple-comma separated sections of the completed Fresh Investigation. Leave null to return all sections. Available sections; - companyIdentification - creditScore - contactInformation - directors - otherInformation - groupStructure - extendedGroupStructure - financialStatements - negativeInformation - additionalInformation- directorships - localFinancialStatements - paymentData - companySummary - alternateSummary

Example:sections=companyIdentification,creditScore

commentsstring

Selects number of comments which should be returned with the order details.

Default:"last"

Enum:"last""recent""none"

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/freshinvestigations/{orderId}?sections=companyIdentification%2CcreditScore&comments=last' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Returns a specific Fresh Investigation Order. For completed orders this will contain the Investigation content as Report Sections.

Bodyapplication/json

chargeReferencestring

contactDetailsobject

creationDatestring

lastStatusChangeDatestring

orderIDinteger

reportDatestring

searchCriteriaobject

sectionsArray of any

statusobject

transactionIDinteger

Response

{
  "chargeReference": "string",
  "contactDetails": {
    "emailAddress": "string",
    "name": "string",
    "telephoneNumber": "string"
  },
  "creationDate": "string",
  "lastStatusChangeDate": "string",
  "orderID": 0,
  "reportDate": "string",
  "searchCriteria": {
    "additionalInfo": "string",
    "address": { … },
    "countryCode": "string",
    "name": "string",
    "regNo": "string",
    "vatNo": "string"
  },
  "sections": [
    { … }
  ],
  "status": {
    "code": "string",
    "description": "string"
  },
  "transactionID": 0
}