FP Sign Developer Center

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:

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 e.g. by submitting your DMS document id. All batch- or intent-creation-endpoints allow it.
Intent	A type 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 e.g. create signature requests.
Batch	Signature request with one or multiple documents.
Workflow	One document to be signed inside a batch.
Attachment	Documents that are provided to recipients for reference only and do not require any action. A workflow can contain up to 10 attachments.
Job	One step with x recipients inside a workflow.
Recipient	Account that needs to confirm or sign the document.
Observer	Account that receives notifications about a workflow but is not required to perform any actions.
Participant	Participant is an API-object which contains all names and master-data for recipients.
Technical user	Dedicated account and permission in FP Sign for a service or integration. The technical user cannot receive signature requests. The technical user is used for creating signature request on behalf of 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 license.
Workflow creator	Permission required to initiate signature requests and initiate signature services (self-uploading and signing documents). Users without this role can only act on workflows received from other users, may sign or approve documents. An assigned permission workflow-creator is one user license.
Signature position	Predefined signature field for a recipient. A recipient may have one or multiple signature positions assigned within a job. For Qualified Electronic Signatures (QES), only one signature position is allowed, as each qualified signature is charged separately. Predefined signature positions are optional. If none are provided, the recipient can place their signature at a location of their choice.
Signature level Signature setting	Id which determines the required action for a recipient, such as confirmation, Advanced Electronic Signature (AES), or Qualified Electronic Signature (QES). The Id's are analog in staging and production environments and can be retrieved using GET /api/rest/v3/participants/info
Confirmation	Signature-level that requires a recipient to acknowledge and confirm a document. A confirmation records that the recipient has reviewed and approved the document without applying a signature. If the workflow originator is assigned the confirmation signature level, the confirmation is performed automatically. No confirmation task is created for the originator, as they initiated the workflow.
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 e.g. 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.

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.

Dokumententypen

FP Sign Developer Center

Connect your application to FP Sign services

Welcome to the FP Sign API

New to FP Sign?

Requirements

Ready to build your own FP Sign integration?