# Company Image Documents

Returns the available Images for a given Company connectId.

Endpoint: GET /images/companies
Version: 1.0.0
Security: bearerToken

## Query parameters:

  - `page` (integer)
    Starting page number.

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

  - `id` (string)
    The company's connectId.

## Response 200 fields (application/json):

  - `correlationId` (string)
    Unique identifier for tracing this request, enabling tracking and debugging.

  - `totalSize` (integer)
    Total number of image records available based on the query criteria.

  - `data` (array)

  - `data.imageId` (string)
    Unique identifier for the image document, allowing direct retrieval and reference.

  - `data.company` (object)
    Contains information about the company associated with the image. This includes identifiers, 
the registered country, legal type, and other basic details specific to the company in question.

  - `data.company.id` (string)
    Unique identifier for the company.

  - `data.company.localId` (string)
    Company identifier specific to the country or jurisdiction.

  - `data.company.country` (string)
    ISO code representing the country where the company is registered.

  - `data.company.name` (string)
    Official registered name of the company.

  - `data.company.type` (string)
    Legal structure or type of the company, such as "Ltd" for limited companies.

  - `data.company.additionalInformation` (object)

  - `data.company.additionalInformation.legalGroup` (string)
    Classification indicating the company's legal grouping or ownership structure.
    Example: "OVR"

  - `data.document` (object)
    Provides details about the specific document or image associated with the company, 
such as its type, code, and a description that may include filing information or updates.

  - `data.document.imageType` (string)
    Type of document image, e.g., "AnnualReturns" or "ConfirmationStatement."

  - `data.document.imageTypeCode` (string)
    Code associated with the document type for internal or regulatory identification.

  - `data.document.imageTypeDescription` (string)
    Detailed description of the document, often including information about its contents or updates.

  - `data.filingDate` (string)
    Date when the document was officially filed or recorded.

  - `data.startDate` (string)
    Start date of the time period covered by the document.

  - `data.endDate` (string)
    End date of the time period covered by the document.

  - `data.language` (string)
    ISO language code representing the document's primary language.

  - `data.consolidated` (boolean)
    Indicates if the document contains consolidated information, typically applicable to financial statements.

  - `data.publicationDate` (string)
    Date and time when the document was published or made available.

  - `data.status` (string)
    Document or image status, currently only available for Netherlands .

  - `data.availableFormats` (array)
    List of available formats for the image, currently only available for Denmark .

  - `data.additionalInformation` (object)
    Additional details about the document. Note that properties within  may vary depending on the country.
Not all properties listed below are available for every country, and some properties may not appear at all in certain responses. 
Integrations should allow flexibility to handle missing or variable properties.

  - `data.additionalInformation.annotations` (string)
    Annotations related to the image

  - `data.additionalInformation.barcode` (string)
    Unique barcode for tracking or inventory purposes, associated with the document.

  - `data.additionalInformation.category` (string)
    Main category of the document, such as "confirmation-statement."

  - `data.additionalInformation.descriptionValues` (object)
    Description values (object structure may vary by country)

  - `data.additionalInformation.imageStatus` (string)
    Current processing status of the image, e.g., "Pending" or "Completed."

  - `data.additionalInformation.pages` (integer)
    Number of pages in the document

  - `data.additionalInformation.paperFiled` (boolean)
    Indicates if the image was filed on paper

  - `data.additionalInformation.resolutions` (array)
    List of resolutions related to the image

  - `data.additionalInformation.sourceType` (string)
    Specific source or origin type for the document, providing additional context (e.g., "confirmation-statement-with-no-updates").

  - `data.additionalInformation.subcategory` (string)
    Further classification within the main category; may be blank if not applicable.

  - `data.additionalInformation.transactionId` (string)
    Transaction ID related to the image

## 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