> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt. # Entrust Signhost REST API A comprehensive REST API for creating, managing, and processing digital document signing transactions. This API enables developers to integrate secure electronic signature workflows into their applications, supporting multiple authentication methods, verification types, and document management features. **Key Features** - Create and configure signing transactions with multiple signers and receivers - Support for various authentication methods (DigiD, SMS, itsme, etc.) - Multiple verification options including digital certificates and biometric verification - File upload and download with metadata support - Real-time transaction status tracking and webhook notifications - Multi-language support for international use cases - Comprehensive audit trails and receipt generation **Important Notes** - All input strings should be UTF-8 encoded - Optional JSON properties should be omitted when not used - Do not provide null values - Do not perform active polling for transactions status updates. Use the postback service instead. For detailed integration guides and examples, visit the [Signhost Developer Documentation](https://evidos.github.io/). ### Contact | Name | Email | URL | | ---------------- | --------------------------------------------------- | ------------------------------------------------------------------------ | | Signhost Support | [support@signhost.com](mailto:support@signhost.com) | [https://intercom.help/signhost/en/](https://intercom.help/signhost/en/) | ### Servers | URL | | -------------------------- | | `https://api.signhost.com` | ### Authentication | HTTP Header Name | Description | | ---------------- | ----------------------------------------------------------------- | | `Authorization` | The User Token. Header value must be prefixed with `APIKey`. | | `Application` | The Application Key. Header value must be prefixed with `APPKey`. | ### API Operations | Operation | Method | Path | Description | | --------------------------------------------------------------- | -------- | ------------------------------------------------ | ---------------------------------- | | [createTransaction](/openapi/transactions/createTransaction.md) | `POST` | `/api/transaction` | Create Transaction | | [startTransaction](/openapi/transactions/startTransaction.md) | `PUT` | `/api/transaction/{transactionId}/start` | Start a transaction | | [getTransaction](/openapi/transactions/getTransaction.md) | `GET` | `/api/transaction/{transactionId}` | Get a transaction by ID | | [deleteTransaction](/openapi/transactions/deleteTransaction.md) | `DELETE` | `/api/transaction/{transactionId}` | Delete / Cancel a Transaction | | [getReceipt](/openapi/files/getReceipt.md) | `GET` | `/api/file/receipt/{transactionId}` | Download receipt for a transaction | | [downloadFile](/openapi/files/downloadFile.md) | `GET` | `/api/transaction/{transactionId}/file/{fileId}` | Download a file from a transaction | | [uploadFile](/openapi/files/uploadFile.md) | `PUT` | `/api/transaction/{transactionId}/file/{fileId}` | Upload PDF file or file metadata | ### API Models | Model | Description | | ------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [CreateTransactionRequest](/openapi/models/CreateTransactionRequest.md) | Transaction creation data including signers, receivers, files, and configuration. This is the request body for creating a new transaction. | | [Transaction](/openapi/models/Transaction.md) | Complete transaction data returned when retrieving or creating a transaction. Includes all configuration, current status, and file information. | | [CreateSignerRequest](/openapi/models/CreateSignerRequest.md) | Request object for creating a new signer in a transaction. Defines the signer's identity, authentication/verification requirements, notification preferences, and signing behavior. **Key Requirements:** - Email address is mandatory - Either Authentications or Verifications must be provided (or both) - Signers with AllowDelegation enabled cannot have Authentications - SendSignRequest determines if sign request emails are sent automatically | | [Signer](/openapi/models/Signer.md) | Signer information with current status (based on SignerGetDto which extends SignerBaseDto) | | [CreateReceiverRequest](/openapi/models/CreateReceiverRequest.md) | Receiver configuration for getting copies of signed documents | | [Receiver](/openapi/models/Receiver.md) | Receiver information (based on ReceiverGetDto which extends ReceiverBaseDto) | | [SignerAuthentication](/openapi/models/SignerAuthentication.md) | Authentication methods used to verify signer identity before document access. These methods must be completed before the signer can view documents. **Important:** The "Type" property is case-sensitive and must be capitalized. | | [SignerVerification](/openapi/models/SignerVerification.md) | Verification methods used to confirm signer identity before document signing. These methods must be completed before the signer can sign documents. **Important:** The "Type" property is case-sensitive and must be capitalized. **Critical Requirement:** You **must** use one of the following verification methods as the **last** verification in your verifications list: - Consent - PhoneNumber - Scribble - CSC Qualified\* **Rules for CSC Qualified:** - This method **must always be the absolute final verification** - nothing can come after it **Rules for Consent, PhoneNumber, and Scribble:** - These three can be used as the final verification method - They are commonly used when you want additional verification steps before the final consent/signature **Common Mistakes:** - Using only authentication methods (e.g., iDIN) without a final verification method - Placing verifications after CSC Qualified **Valid Examples:** - `[Consent]` ✓ - `[iDIN, Consent]` ✓ - `[iDIN, PhoneNumber]` ✓ - `[iDIN, CSC Qualified]` ✓ - `[CSC Qualified, Consent]` ✗ (Nothing can come after CSC Qualified) - `[iDIN]` ✗ (Missing required final verification) | | [SignerScribbleVerification](/openapi/models/SignerScribbleVerification.md) | Handwritten signature verification | | [SignerPhoneNumberIdentification](/openapi/models/SignerPhoneNumberIdentification.md) | SMS phone number verification | | [SignerDigidIdentification](/openapi/models/SignerDigidIdentification.md) | Dutch DigiD verification | | [SignerIDealVerification](/openapi/models/SignerIDealVerification.md) | iDEAL bank verification | | [SignerSurfnetVerification](/openapi/models/SignerSurfnetVerification.md) | SURFnet academic verification | | [SignerIDINVerification](/openapi/models/SignerIDINVerification.md) | iDIN bank identification verification | | [SignerIPAddressVerification](/openapi/models/SignerIPAddressVerification.md) | IP address verification | | [SignerEHerkenningVerification](/openapi/models/SignerEHerkenningVerification.md) | eHerkenning business identity verification | | [SignerItsmeIdentificationVerification](/openapi/models/SignerItsmeIdentificationVerification.md) | itsme identification verification | | [SignerConsentVerification](/openapi/models/SignerConsentVerification.md) | Consent-based verification | | [SignerCscVerification](/openapi/models/SignerCscVerification.md) | Cloud Signature Consortium (CSC) verification | | [SignerOidcIdentification](/openapi/models/SignerOidcIdentification.md) | OpenID Connect identification | | [SignerOnfidoIdentification](/openapi/models/SignerOnfidoIdentification.md) | Onfido identity verification | | [FileEntry](/openapi/models/FileEntry.md) | File information and metadata associated with a transaction. Contains details about uploaded documents including display properties, download links, and current processing status. Files are referenced by their unique identifier within the transaction and can include PDFs, receipts, and other document types. | | [Link](/openapi/models/Link.md) | URI link with relationship and type information | | [Activity](/openapi/models/Activity.md) | Activity/event information for a signer (based on ActivityGetDto) | | [FileMetadata](/openapi/models/FileMetadata.md) | Comprehensive metadata information for a file in a transaction. This metadata defines how the file should be displayed, processed, and what form fields and signing areas it contains. The metadata can be uploaded before or after the actual PDF file. | | [FileSignerData](/openapi/models/FileSignerData.md) | Configuration data specific to a signer for a particular file. This determines which form sets the signer needs to complete when signing the document. | | [FileField](/openapi/models/FileField.md) | Represents an individual form field or signing area within a document. Fields define where and how users interact with the document during the signing process. | | [FileFieldType](/openapi/models/FileFieldType.md) | Specifies the type of interaction or data entry required for this field. Different types have different behaviors and validation rules in the signing interface. | | [FileFieldLocation](/openapi/models/FileFieldLocation.md) | Defines the precise positioning and sizing of a field within the PDF document. Fields can be positioned using absolute coordinates or by searching for specific text anchors within the document. | | [TransactionDeleteOptions](/openapi/models/TransactionDeleteOptions.md) | Options for cancelling a transaction | | [ErrorResponse](/openapi/models/ErrorResponse.md) | Error response object based on RFC 7807 Problem Details for HTTP APIs. See [https://datatracker.ietf.org/doc/html/rfc7807](https://datatracker.ietf.org/doc/html/rfc7807) for details. **Response Format:** A response is either in the new RFC 7807 Problem Details format OR the legacy Message format, but never both. - **New Format (RFC 7807):** Contains the `type` property and standard problem detail properties (`title`, `detail`, `status`). May also include additional extension members. - **Legacy Format:** Contains only the `Message` property. This format is used for some existing error responses during our transition to full RFC 7807 compliance. **Usage:** Check if the `type` property is present. If it exists, the response is in RFC 7807 format. If `type` is absent, fall back to reading the `Message` property. |