# List documents

List all the uploaded documents for a specific entity ID and type.

Endpoint: GET /v2/documents
Version: v2
Security: Bearer

## Query parameters:

  - `entityType` (string, required)
    Entity type against which document is associated.
    Enum: "PNR", "COMPANY", "AIR_ITINERARY", "EVENT", "LOCATION_IMAGE"

  - `entityId` (string, required)
    Entity Id for the given entity type.
    Example: "123124"

## Response 200 fields (application/json):

  - `documents` (array, required)
    List of documents.

  - `documents.url` (string, required)
    S3 location of the document.
    Example: "https://s3.amazonaws.com/bucket-name/folder-name/file-name"

  - `documents.documentId` (string, required)
    Unique identifier of the document.
    Example: "f49d00fe-1eda-4304-ba79-a980f565281d"

  - `documents.documentMetadata` (object, required)
    Metadata related to document.

  - `documents.documentMetadata.documentType` (string, required)
    Document type.
    Enum: "BOARDING_PASS", "CONFIRMATION", "INVOICE", "VISA", "MISCELLANEOUS", "OTHERS", "TASK_PROCESSOR", "EVENT_COVER_IMAGE", "LOGO_IMAGE"

  - `documents.documentMetadata.entityType` (string, required)
    Entity type against which the document is to uploaded.
    Enum: "PNR", "COMPANY", "AIR_ITINERARY", "EVENT", "LOCATION_IMAGE"

  - `documents.documentMetadata.entityId` (string, required)
    Entity Id for the given entity type.
    Example: "123124"

  - `documents.documentMetadata.entityMetadata` (any, required)

  - `documents.documentMetadata.name` (string, required)
    Document name.
    Example: "BoardingPass.pdf"

## Response 401 fields (application/json):

  - `debugIdentifier` (string)
    Link to debug the error internally.

  - `errorMessages` (array)

  - `errorMessages.errorCode` (string)
    Error code to identify the specific errors.

  - `errorMessages.message` (string)
    Message containing details of error.

  - `errorMessages.errorParameters` (array)
    Error message parameters.

  - `errorMessages.errorParameters.name` (string)
    Parameter name

  - `errorMessages.errorParameters.value` (string)
    Parameter value

  - `errorMessages.errorDetail` (string)
    More details about the error.

## Response 403 fields (application/json):

  - `debugIdentifier` (string)
    Link to debug the error internally.

  - `errorMessages` (array)

  - `errorMessages.errorCode` (string)
    Error code to identify the specific errors.

  - `errorMessages.message` (string)
    Message containing details of error.

  - `errorMessages.errorParameters` (array)
    Error message parameters.

  - `errorMessages.errorParameters.name` (string)
    Parameter name

  - `errorMessages.errorParameters.value` (string)
    Parameter value

  - `errorMessages.errorDetail` (string)
    More details about the error.

## Response 404 fields (application/json):

  - `debugIdentifier` (string)
    Link to debug the error internally.

  - `errorMessages` (array)

  - `errorMessages.errorCode` (string)
    Error code to identify the specific errors.

  - `errorMessages.message` (string)
    Message containing details of error.

  - `errorMessages.errorParameters` (array)
    Error message parameters.

  - `errorMessages.errorParameters.name` (string)
    Parameter name

  - `errorMessages.errorParameters.value` (string)
    Parameter value

  - `errorMessages.errorDetail` (string)
    More details about the error.