Unterschreiben mit FP Sign
Geschäftsdokumente unterschreiben, versenden und tracken.
FP Sign Developer Center
Connect your application to FP Sign services
Welcome to the FP Sign API
This site is for developers who want to integrate FP Sign into their applications, services, or business workflows. Here you’ll find everything you need to understand on how to connect FP Sign programmatically using our API.
Whether you’re building a web application, automating document workflows, or integrating signing capabilities into an existing system, this documentation is designed to help you get started quickly and implement reliably.
The complete API reference can be found here:
TABLE OF CONTENTS
loading...
New to FP Sign?
Schedule a free demo and get a first overview of the solution.
For using FP Sign's API the following requirements must be fulfilled
Requirements
Important wordings and glossary
License your API usage
Administrate and prepare users
Check the documentation and use cases
Important wordings are marked bold
| Word | Description |
| customIdentifier | Your submitted identifier when getting data from FP Sign. You can identify your documents with it. All batch- or intent-creation-endpoints allow it. |
| Intent | A special form of integration where your application submits some data to FP Sign and prepares a link. This link can be used by a person to use FP Sign's UI to f.e. create signature requests. |
| Batch | Signature request with one or multiple documents. |
| Workflow | One document to be signed inside a batch. |
| Attachment | Documents simply send with, but have no further do-do. A workflow can have up to ten attachments. |
| Job | One step with x recipients inside a workflow. |
| Recipient | Account that needs to confirm or sign the document. |
| Observer | Account that gets a notification or an information for a workflow, but has no actual to-do. |
| Participant | Participant is an API-object which contains all names and master-data for recipients. |
| Technical user |
An account in FP Sign for a service or integration. The technical user cannot receive signature requests. The technical user is used for creating signature request in behalf for real workflow creators. A user cannot have the role of technical user and workflow-creator at the same time. This role does not require a licence. |
| Workflow creator |
You need the workflow-creator role to create and send a signature request. This role is also required to use the signature services (own signature). Users without Workflow Creator can log in and only answer requests that they receive from others. This means that a user without Workflow Creator does not need a licence to countersign. The Workflow Creator role requires a licence. |
| Signature-position |
A recipient is allowed to have multiple signature positions. Except QES only allows one, since a qualified electronic costs 1,50€ per signature. |
| Signature-level Signature-setting |
Signature-level are submitted with signature-setting-Ids. The Id's are analog in prod and staging environments. The Id's can be fetched using GET /api/rest/v3/users/participant-info They are required since FP Sign needs to know whether a recipients needs to confirm, sign advanced or sign qualified in a workflow. |
| Confirmation |
A signature-level for a person to receive a task to confirm a document. An originator automatically confirms as this person is the sender of the request. |
| Advanced electronic signature (AES)* |
The advanced signature is sufficient for signing the majority of documents (e.g. for offers and orders, broker documents, delivery notes, procurements, holiday applications, etc.). You can additionaly secure an AES and the signers identity by using the mobile-TAN procedure at no extra cost. |
| Qualified electronic signature (QES)* |
The highest and most secure signature level in Europe. In order to apply such a signature to a digital document, the signatory must uniquely identify themselves once. Depending on the provider and country, this can f.e. be done using the VideoIdent or an electronic ID card (eID). A QES costs extra per signature and per ident. |
* This glossary is provided for informational purposes only and does not claim to be complete. No guarantee is given that the information is legally accurate or remains up to date. We strongly recommend seeking qualified legal advice where necessary. The responsibility for any decisions based on this information lies solely with the respective company.
To use the FP Sign REST API, you need an active FP Sign subscription. Your subscription must include the Add-on API access.
Licensing the API provides access to the staging and development environment, webhooks and the usage of API keys. Please verify your subscription with your FP Sign administrator in the Admin Portal under Billing and contract: https://admin.v2.fp-sign.com/login or check our bundles and pricing page.
The FP Sign administrator is able to manage the users inside of your FP Sign tenant. It is necessary to manage user rights.
Workflow creator
At the beginning of any FP Sign signature process you need a user with the right "workflow creator". At first this may be the same user as the administrator. The user must complete the registration and confirm the terms of service and the data protection agreement before working with FP Sign.
Technical user
The technical user is used to process any requests with the API. The main advantage is the ability to manage workflows over the whole FP Sign tenant.
If you’re not using a technical user you need the authorization information of each FP Sign user who is supposed to interact with the FP Sign API (f.e. start a process, download documents, etc.).
FP Sign's Rest-API allows you to connect your application to the FP Sign services for send and signing documents digitally. There's several different use-cases which the API can fulfill. Please refer to the description of each use case. F.e.:
-
Your application prepares a FP Sign link. This link can opened by a user for refining the signature process, enter and edit data and send out the signature request.
-
Your application creates signature requests automatically. So prepare all the required data before and start processes full autonome.
-
Your application manages other use-cases like administrate FP Sign users, sending signature reminders, manage workflow documents, etc.
Ready to build your own FP Sign integration?
Find an online appointment with our FP Sign consultants. Solve necessary integration steps instantly.