Download a file from a transaction

    Method: GET

    Path: /api/transaction/{transactionId}/file/{fileId}

    Retrieves a specific file from a transaction. The file is returned as a PDF document. The user must be the creator of the transaction to access the file.

    Parameters

    NameInTypeRequiredDescription
    transactionIdpathstringYes

    The unique identifier of the transaction containing the file

    fileIdpathstringYes

    The unique identifier of the file within the transaction

    Responses

    200

    File retrieved successfully

    Content-Type: application/pdf

    Type: string

    401

    Unauthorized - user not creator of transaction

    Content-Type: application/json

    Schema: ErrorResponse

    Properties

    NameTypeDescription
    typeString

    A URI reference identifying the problem type. This property is always present in RFC 7807 responses.

    titleString

    A short, human-readable summary of the problem

    detailString

    A human-readable explanation specific to this occurrence of the problem

    statusInteger

    The HTTP status code

    instanceString

    A URI reference that identifies the specific occurrence of the problem

    MessageString

    Deprecated (Legacy Format Only): Contains the error message in the old response format. This property appears alone in legacy error responses and is mutually exclusive with the RFC 7807 properties above. Will be phased out as we complete our transition to RFC 7807.

    403

    Forbidden - user is not the creator of the transaction

    Content-Type: application/json

    Properties

    NameTypeDescription
    MessageString

    404

    File not found or not yet processed

    Content-Type: application/json

    Schema: ErrorResponse

    Properties

    NameTypeDescription
    typeString

    A URI reference identifying the problem type. This property is always present in RFC 7807 responses.

    titleString

    A short, human-readable summary of the problem

    detailString

    A human-readable explanation specific to this occurrence of the problem

    statusInteger

    The HTTP status code

    instanceString

    A URI reference that identifies the specific occurrence of the problem

    MessageString

    Deprecated (Legacy Format Only): Contains the error message in the old response format. This property appears alone in legacy error responses and is mutually exclusive with the RFC 7807 properties above. Will be phased out as we complete our transition to RFC 7807.

    Example:

    {
  "Message": "Either the file or transaction does not exist or the file has not yet been processed."
}

    410

    Gone - the document is no longer available (archived or deleted)

    Content-Type: application/json

    Schema: ErrorResponse

    Properties

    NameTypeDescription
    typeString

    A URI reference identifying the problem type. This property is always present in RFC 7807 responses.

    titleString

    A short, human-readable summary of the problem

    detailString

    A human-readable explanation specific to this occurrence of the problem

    statusInteger

    The HTTP status code

    instanceString

    A URI reference that identifies the specific occurrence of the problem

    MessageString

    Deprecated (Legacy Format Only): Contains the error message in the old response format. This property appears alone in legacy error responses and is mutually exclusive with the RFC 7807 properties above. Will be phased out as we complete our transition to RFC 7807.

    Example:

    {
  "Message": "The document is no longer available"
}

    500

    Internal server error

    Content-Type: application/json

    Schema: ErrorResponse

    Properties

    NameTypeDescription
    typeString

    A URI reference identifying the problem type. This property is always present in RFC 7807 responses.

    titleString

    A short, human-readable summary of the problem

    detailString

    A human-readable explanation specific to this occurrence of the problem

    statusInteger

    The HTTP status code

    instanceString

    A URI reference that identifies the specific occurrence of the problem

    MessageString

    Deprecated (Legacy Format Only): Contains the error message in the old response format. This property appears alone in legacy error responses and is mutually exclusive with the RFC 7807 properties above. Will be phased out as we complete our transition to RFC 7807.