Get Fresh Investigations

Request

Returns a list of your submitted Fresh Investigation Orders.

Security

bearerToken

Query

pageinteger

Starting page number.

Default:1

pageSizeinteger

Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

transactionIdstring

Fresh Investigation Identifier used internally and with our data partners.

reportCreatedAfterstring

Returns Fresh Investigations processed after this date

Example:reportCreatedAfter=2020-01-01T11:23:56Z

reportCreatedBeforestring

Returns ordered Fresh Investigations that were processed before this date

Example:reportCreatedBefore=2020-01-01T11:23:56Z

createdBeforestring

Returns Fresh Investigations created before this date

createdSincestring

Returns ordered Fresh Investigations created after this date

lookUpOrderBystring

Use to search for your Fresh Investigations by either the returned Company Details in the GET freshInvestigations/{orderId} endpoint or your supplied Search Criteria in the POST /freshInvestigations endpoint

Enum:"CompanyDetails""SearchCriteria"

companyDetailsCountrystring

Looks for your returned Fresh Investigations where the returned Company Country is named this. Use with lookUpOrderBy=CompanyDetails

companyDetailsNamestring

Looks for your returned Fresh Investigations where the returned Company Name is named this. Use with lookUpOrderBy=CompanyDetails

searchCriteriaCountrystring

Looks for your returned Fresh Investigations where your submitted Search Criteria Company Country is this. Use with lookUpOrderBy=searchCriteria

searchCriteriaNamestring

Looks for your Fresh Investigations where your submitted Search Criteria Company Name is this. Use with lookUpOrderBy=searchCriteria

sortBystring

Sorts returned Fresh Investigations by this field

Enum:"creationDate""lastStatusChangeDate""orderID""status"

sortDirstring

The direction that you wish to sort results by.

Default:"asc"

Enum:"asc""desc"

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/freshinvestigations?page=1&pageSize=0&transactionId=string&reportCreatedAfter=2020-01-01T11%3A23%3A56Z&reportCreatedBefore=2020-01-01T11%3A23%3A56Z&createdBefore=string&createdSince=string&lookUpOrderBy=CompanyDetails&companyDetailsCountry=string&companyDetailsName=string&searchCriteriaCountry=string&searchCriteriaName=string&sortBy=creationDate&sortDir=asc' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

totalCountinteger

ordersArray of objects

Response

{
  "totalCount": 0,
  "orders": [
    { … }
  ]
}