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 receipt for a transaction

Method: GET

Path: /api/file/receipt/{transactionId}

Downloads the receipt for a completed transaction (Status=30). The receipt contains information about the signing process and serves as proof of the completed transaction.

#Parameters

NameInTypeRequiredDescription
transactionIdpathstringYes

The transaction ID for which to download the receipt

#Responses

#200

Receipt file successfully retrieved

Content-Type: application/pdf

Type: string

#401

Authorization denied - user not authorized to access this transaction

Content-Type: application/json

Schema: ErrorResponse

#Properties

NameTypeDescription
MessageStringRequired.

Human-readable error message

Example:

{
  "Message": "Authorization has been denied for this request."
}

#404

Receipt not found

Content-Type: application/json

Schema: ErrorResponse

#Properties

NameTypeDescription
MessageStringRequired.

Human-readable error message

Example:

{
  "Message": "receipt not found."
}

Content-Type: text/plain

Type: string

Example:

receipt not found.

#406

Not Acceptable - unsupported Accept header

Content-Type: application/json

Schema: ErrorResponse

#Properties

NameTypeDescription
MessageStringRequired.

Human-readable error message

Example:

{
  "Message": "The requested content type is not supported."
}

#410

Gone - receipt is no longer available (archived or deleted)

Content-Type: application/json

Schema: ErrorResponse

#Properties

NameTypeDescription
MessageStringRequired.

Human-readable error message

Example:

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

#500

Internal server error

Content-Type: application/json

Schema: ErrorResponse

#Properties

NameTypeDescription
MessageStringRequired.

Human-readable error message

Example:

{
  "Message": "An internal error occurred while processing the request."
}