Unterschreiben mit FP Sign
Geschäftsdokumente unterschreiben, versenden und tracken.
Create and Send Signature Requests via API
Send a batch to recipients without using the FP Sign UI as the sender.
-
You are sending the document(s) and configuration to FP Sign.
-
The signature of the originator before sending is optional.
-
-
You'll receive one batch ID AND a workflow ID per document to be signed.
-
You start every workflow inside of this one batch.
-
The recipients sign.
-
You are checking the status and waiting for the batch to finish.
TABLE OF CONTENTS
loading...
Step 1
Check recipients signature capabilities
Before sending a signature request, it is recommended to verify the recipient’s available signature methods. This endpoint returns information about a user’s registered authentication and signing capabilities.
Using this check helps avoid errors, for example when requesting a signature with mobile TAN for a recipient who does not have a mobile number stored in their account OR requesting a qualified signature without having the capabilities for it.
Step 2
Create a batch
These endpoints create a signature request (batch).
When calling these endpoints, all required data for the signature process must be provided, including documents, signers, signer details, signing order, and signature level (optionally also the signature positions). Once created, the batch represents the complete definition of the signature workflow and can be sent to the recipients.
Within a batch, certain settings can be defined individually per document, including:
Recipients, attachments, signature levels (signatureType), signature positions and messages, etc.
This flexibility allows different documents within the same batch to follow tailored configurations while still being part of a single signature request.
*required
originator* Owner of the signature process
name* Name of the batch used for mailings and overview
workflows* List of documents and workflows for the signature request
document* Document name and Base64-content of the workflow
originatorSignatureSettingId Setting of the originator when opening the intent. Standard should be confirmation.
steps* The order of each participant for this workflow
observers Participants with no actions
participants* Master-data (Names, contact data and security settings) for the workflow recipients
Using your own account
This endpoint creates a signature request (batch). To use this you must be authenticated as a workflow-creator. The signature request will be created for yourself.
Sending on behalf-of someone
This endpoint creates a signature request (batch) on behalf of an originator. The request is submitted by a service or application account, while the originator represents a regular FP Sign user who owns the signature process.
Authentication must be performed using a technical (service) user, and the originator must be specified as part of the request. The originator is the workflow-creator of the request. It is recommended to use "confirmation" as the originator's signature-setting.
If the originator is required to sign the document, additional API calls are necessary, and authentication must be performed as the respective signer. Alternatively, it is often simpler to include the originator as the first recipient in the signature workflow, allowing them to sign as part of the standard process without requiring separate authentication steps.
Step 3
Start a batch
Launch each workflow inside the batch using the workflowId.
This is always possible when the originator has "Confirmation" as a "signatureType". Check the response: If the "jobState" is completed the workflow started. If "jobState" not changes to completed, then the signer and/or the API needs to enter authentication by using further API calls.
Step 4
Get batch status
Get the current status of a batch. It allows you to determine whether the batch has finished or moved into another state such as paused, rejected, failed, or expired. Getting the status by polling can later be reduced by f.e. implementing webhooks and/or optimizing the logic: The older the batch the less you can poll for it's status.
In addition, the endpoint returns the individual status of each workflow within the batch, providing insight into the progress of each document inside the signature process.
Optional
Get workflow details
Get the detailed history of a workflow. Retrieve insight in completed steps, timings, and to-do's for a document.
Ready to build your own FP Sign integration?
Find an online appointment with our FP Sign consultants. Solve necessary integration steps instantly.