# Get Fresh Investigations

Returns a list of your submitted Fresh Investigation Orders.

Endpoint: GET /freshinvestigations
Version: 1.0.0
Security: bearerToken

## Query parameters:

  - `page` (integer)
    Starting page number.

  - `pageSize` (integer)
    Number of items to return per Page.

  - `transactionId` (string)
    Fresh Investigation Identifier used internally and with our data partners.

  - `reportCreatedAfter` (string)
    Returns Fresh Investigations processed after this date
    Example: "2020-01-01T11:23:56Z"

  - `reportCreatedBefore` (string)
    Returns ordered Fresh Investigations that were processed before this date
    Example: "2020-01-01T11:23:56Z"

  - `createdBefore` (string)
    Returns Fresh Investigations created before this date

  - `createdSince` (string)
    Returns ordered Fresh Investigations created after this date

  - `lookUpOrderBy` (string)
    Use to search for your Fresh Investigations by either the returned Company Details in the   endpoint or your supplied Search Criteria in the   endpoint
    Enum: "CompanyDetails", "SearchCriteria"

  - `companyDetailsCountry` (string)
    Looks for your returned Fresh Investigations where the returned Company Country is named this. Use with lookUpOrderBy=CompanyDetails

  - `companyDetailsName` (string)
    Looks for your returned Fresh Investigations where the returned Company Name is named this. Use with lookUpOrderBy=CompanyDetails

  - `searchCriteriaCountry` (string)
    Looks for your returned Fresh Investigations where your submitted Search Criteria Company Country is this. Use with lookUpOrderBy=searchCriteria

  - `searchCriteriaName` (string)
    Looks for your Fresh Investigations where your submitted Search Criteria Company Name is this. Use with lookUpOrderBy=searchCriteria

  - `sortBy` (string)
    Sorts  returned Fresh Investigations by this field
    Enum: "creationDate", "lastStatusChangeDate", "orderID", "status"

  - `sortDir` (string)
    The direction that you wish to sort results by.
    Enum: "asc", "desc"

## Response 200 fields (application/json):

  - `totalCount` (integer)

  - `orders` (array)

  - `orders.orderID` (integer)
    Fresh Investigation Unique Identifier

  - `orders.userID` (string)
    Fresh Investigation user Identifier

  - `orders.creationDate` (string)
    Fresh Investigation Creation Date

  - `orders.lastStatusChangeDate` (string)
    Fresh Investigation Last Status Change Date

  - `orders.transactionID` (integer)
    Fresh Investigation Internal Identifier

  - `orders.chargeReference` (string)

  - `orders.contactDetails` (object)
    Contact details of the person who requested the investigation, and where the information will be sent.

  - `orders.contactDetails.name` (string)
    Contact name of the person who requested the investigation

  - `orders.contactDetails.emailAddress` (string)
    The address to which the investigation report will be sent

  - `orders.contactDetails.telephoneNumber` (string)
    Your telephone number

  - `orders.sectionNames` (string)

  - `orders.status` (object)
    The status of the investigation

  - `orders.status.code` (string)

  - `orders.status.description` (string)

  - `orders.consent` (boolean)
    Whether permission was granted by the requesting company to disclose the identity of the investigating party to the target company.

  - `orders.searchCriteria` (object)
    The search criteria used to perform the investigation

  - `orders.searchCriteria.name` (string)
    Target company name

  - `orders.searchCriteria.vatNo` (string)

  - `orders.searchCriteria.regNo` (string)

  - `orders.searchCriteria.additionalInfo` (string)

  - `orders.searchCriteria.address` (object)

  - `orders.searchCriteria.address.type` (string)
    Address type description. Examples - "Registered Office", "Trading Address", "Postal Address", "Service Address" etc.

  - `orders.searchCriteria.address.simpleValue` (string)
    (Optionally populated) Registered address of the company. Whole string address if Creditsafe is unable to accurately assign values to specific address fields, or when specific local address formats need to be observed.

  - `orders.searchCriteria.address.street` (string)
    Street portion of the address line. Can also, optionally contain, the house number alongside the street.

  - `orders.searchCriteria.address.houseNumber` (string)
    House number portion of the address line.

  - `orders.searchCriteria.address.additionToAddress` (string)
    Additional details for a specified address, such as a PO Box number, or a unit number at the specified address location.

  - `orders.searchCriteria.address.city` (string)
    City portion of the address line.

  - `orders.searchCriteria.address.postalCode` (string)
    Postal code portion of the address line.

  - `orders.searchCriteria.address.province` (string)
    Province portion of the address line.

  - `orders.searchCriteria.address.region` (string)
    May contain the geographical region, for example "South-East" or a territorial division.

  - `orders.searchCriteria.address.telephone` (string)
    Registered telephone number.

  - `orders.searchCriteria.address.directMarketingOptOut` (boolean,null)
    Boolean [true/false]. Where set to true, the subject has "opted out" via a central register, and they must not be contacted for commercial marketing purposes.

  - `orders.searchCriteria.address.directMarketingOptIn` (boolean,null)

  - `orders.searchCriteria.address.country` (string)
    Country where the company is registered.
    Enum: "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KP", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VA", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "XK", "SS", "SX", "CW", "BQ", "WW", "PLC"

  - `orders.reportDate` (string)

## Response 400 fields (application/json):

  - `correlationId` (string)
    A unique ID assigned to this request.

  - `message` (string)

  - `details` (string)
    Provides further information on why the request was rejected

## Response 401 fields (application/json):

  - `error` (string)

## Response 403 fields (application/json):

  - `message` (string)
    Example: "Access forbidden"

## Response 404 fields (application/json):

  - `correlationId` (string)
    A unique ID assigned to this request.

  - `message` (string)

  - `details` (string)
    Provides further information on why the request was rejected