Create Signature Request Links with Batch Intents
Prepare a FP Sign link for the creator to configure and send the signature request. This makes the integration much easier since the only required data is the document and the owner of the signature request. All process details can be entered manually by the user.
-
You are sending the document(s) and some configuration to FP Sign.
-
The signature of the originator before sending is optional.
-
-
You'll receive a token.
-
The token gets opened in a browser by the user. There you can.
-
self-sign and send document to recipients
-
not-sign and send the document to recipients
-
configure every signature workflow
-
-
The user creates the FP Sign batch.
-
The user gets redirected to the given redirect url.
-
The recipients sign.
-
You are checking the status and waiting for the batch to finish.
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.
Create a batch
This endpoint creates a batch intent.
The low amount of required data allows flexibility and different processes within one integration. There's no need to self-build an user-interface or validate processes. The process creation gets "delegated" to FP Sign's UI.
*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
navigationDetails Redirect and button-naming after batch-intent has been created and send
Once created, the returned token is analog to your batchId.
Open the browser
You have received a token. Open the token in a browser using this link:
/tokens/batch-intents/{token}
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.
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.
