logologo
Docs
API
Reference
Live API
About
Blog
Docs
Reference
Live API
About
Blog
logologo
Introduction

Transactions

Create Transaction
Start a transaction
Get a transaction by ID
Delete / Cancel a Transaction

Files

Download receipt for a transaction
Download a file from a transaction
Upload PDF file or file metadata

Models

CreateTransactionRequest
Transaction
CreateSignerRequest
Signer
CreateReceiverRequest
Receiver
SignerAuthentication
SignerVerification
SignerScribbleVerification
SignerEmailVerification
SignerPhoneNumberIdentification
SignerDigidIdentification
SignerIDealVerification
SignerSurfnetVerification
SignerIDINVerification
SignerIPAddressVerification
SignerEHerkenningVerification
SignerEidasLoginVerification
SignerItsmeIdentificationVerification
SignerConsentVerification
SignerSigningCertificateVerification
SignerCscVerification
SignerOidcIdentification
SignerOnfidoIdentification
FileEntry
Link
Activity
FileMetadata
FileSignerData
FileField
FileFieldType
FileFieldLocation
TransactionDeleteOptions
ErrorResponse

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

Human-readable error message

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

Human-readable error message

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
MessageStringRequired.

Human-readable error message

Example:

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

#500

Internal server error

Content-Type: application/json

Schema: ErrorResponse

#Properties

NameTypeDescription
MessageStringRequired.

Human-readable error message