fino.sign API v1

Introduction

REST-API documentation of fino.sign API v1

Base URL: https://api.finosign.de

Welcome to the API documentation for the fino.sign API version 1. This documentation is designed to provide developers with essential information for the seamless integration of our digital signature service into their applications.

For a comprehensive implementation guide, please refer to our usage guide.

Resource Identifiers

Similar to other RESTful APIs, our API comprises resources that can be manipulated using the provided CRUD endpoints. Each resource accessible via the API is distinguished by a unique identifier. The type of identifier employed for our API resources is known as a Nano ID, which is characterized by a 12-character fixed length and is composed of alphanumeric characters within the range of A-Za-z0-9_-.

Rate Limiting

The API is rate limited to 100 requests per second per app. If this limit is exceeded any request to the API by the rate limited app will be declined with status 429 - Too Many Requests.

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {API_TOKEN}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

To acquire an API token, please contact us directly, and our team will be happy to assist you in obtaining the necessary credentials.

Note: the API tokens used are considered confidential and must not be exposed to end users. If an API token is exposed by accident, it must be revoked immediately.

Signatures

A Signature resource serves as the foundational element within the API, representing the process by which entities affix their signatures to documents. This resource forms the cornerstone of the signature API, and all other resources within this API are related to it.

List all signatures

GET

https://api.finosign.de

/v1/signatures

requires authentication

List all signatures created by the authenticated app.

Headers

Authorization

Example:

Bearer {API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

page

string

Page number. Defaults to 1

Example:

sort

string

Sort the result according to the provided fields. Prepend '-' to sort in descending order. Defaults to created_at.

Allowed sorting fields are: created_at, updated_at

Example:

created_at,updated_at

Response Fields

data

object[]

An array containing the signatures of this page. Limited to 20 signatures per page.

string

The public id of this signature.

quality

string

The signature quality that will be used for this signature process.

Must be one of:

SES
AES
QES

status

string

The current status of this signature.

Must be one of:

preparation
failed
declined
open
withdrawn
signed

withdraw_reason

string|null

The reason of withdrawal when status is withdrawn.

title

string|null

The optional title of this signature that gets shown to signers.

webhook_url

string|null

An optional webhook URL that will be used instead of the webhook URL of the app.

created_at

string

ISO-8601 formatted timestamp of when this resource has been created.

updated_at

string

ISO-8601 formatted timestamp of when this resource has last been updated.

signers

object[]

An array of signers associated with this signature.

The public ID of this signer.

order

The order index that this signer belongs to (starting at 1). Signers with the same order index are able to sign in parallel.

title

string|null

The title of the signer.

firstname

The firstname of the signer.

lastname

The lastname of the signer.

The E-Mail address of the signer.

mobile_number

string|null

The mobile phone number of the signer. This number will be used for verification depending on the signature quality.

ident_method

The method of identification used by the signer.

status

The signature status for this signer.

decline_reason

string|null

An optional reason of why the signer has declined their signature. This value may still be null even if the status is declined indicating that the user did not provide a reason when declining.

redirect_url_success

A URL that the signer will be redirected to once the signature process has been finished successfully.

redirect_url_error

A URL that the signer will be redirected to in case an error occurred while signing the documents.

redirect_url_declined

A URL that the signer will be redirected to after they have declined their signature.

certificate_serial_number

string|null

The X.509 serial number of the certificate created after the signer has finished signing the documents represented in hexadecimal. This number should not be considered globally unique. For identification purposes use the certificate_fingerprint.

certificate_fingerprint

string|null

A SHA-256 fingerprint across the whole certificate created after the signer has finished signing the documents. This fingerprint may be used to uniquely identify the signer.

created_at

ISO-8601 formatted timestamp of when this resource has been created.

updated_at

ISO-8601 formatted timestamp of when this resource has last been updated.

links

object

Pagination links

Create signature

POST

https://api.finosign.de

/v1/signatures

requires authentication

Create a new signature for starting a new signing process.

Headers

Authorization

Example:

Bearer {API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

quality

string

required

The quality of this signature. Must be a quality supported by the currently authenticated app.

Must be one of:

SES
AES
QES

Example:

SES

title

string

An optional title for this signature that will be shown to users. Must be between 2 and 100 characters.

Example:

My Signature Title

webhook_url

string

An optional webhook URL that will be used instead of the webhook URL of the app. Must be a valid URL.

Example:

https://myapp.test/webhook

signers

object[]

An array of signer-resources that represents entities that are prompted to fulfill the signing process.

order

integer

The order index that this signer belongs to (starting at 1). Signers with the same order index are able to sign in parallel. Must be between 1 and 255.

Example:

title

string

The title of the signer. Must not be greater than 200 characters.

Example:

Prof.

firstname

string

required

The firstname of the signer. Must be between 2 and 200 characters.

Example:

Katheryn

lastname

string

required

The lastname of the signer. Must be between 2 and 200 characters.

Example:

Langworth

string

The E-Mail address of the signer. Mutually exclusive with mobile_number when signature quality is SES. This field is required when signers.*.mobile_number is not present. Must be a valid email address. Must not be greater than 200 characters.

Example:

kayla.wiegand@yahoo.com

mobile_number

string

The mobile phone number of the signer. This number will be used for verification depending on the signature quality. Mutually exclusive with email when signature quality is SES. This field is required when signers.*.email is not present.

Example:

+4915228817386

redirect_url_success

string

required

A URL that the signer will be redirected to once the signature process has been finished successfully. Must use HTTPS protocol. Must be a valid URL.

Example:

https://example.test/success

redirect_url_error

string

required

A URL that the signer will be redirected to in case an error occurred while signing the documents. Must use HTTPS protocol. Must be a valid URL.

Example:

https://example.test/error

redirect_url_declined

string

required

A URL that the signer will be redirected to after they have declined their signature. Must use HTTPS protocol. Must be a valid URL.

Example:

https://example.test/declined

Response Fields

data

object

The created signature resource.

string

The public id of this signature.

quality

string

The signature quality that will be used for this signature process.

Must be one of:

SES
AES
QES

status

string

The current status of this signature.

Must be one of:

preparation
failed
declined
open
withdrawn
signed

withdraw_reason

string|null

The reason of withdrawal when status is withdrawn.

title

string|null

The optional title of this signature that gets shown to signers.

webhook_url

string|null

An optional webhook URL that will be used instead of the webhook URL of the app.

created_at

string

ISO-8601 formatted timestamp of when this resource has been created.

updated_at

string

ISO-8601 formatted timestamp of when this resource has last been updated.

signers

object[]

An array of signers associated with this signature.

The public ID of this signer.

order

The order index that this signer belongs to (starting at 1). Signers with the same order index are able to sign in parallel.

title

string|null

The title of the signer.

firstname

The firstname of the signer.

lastname

The lastname of the signer.

The E-Mail address of the signer.

mobile_number

string|null

The mobile phone number of the signer. This number will be used for verification depending on the signature quality.

ident_method

The method of identification used by the signer.

status

The signature status for this signer.

decline_reason

string|null

An optional reason of why the signer has declined their signature. This value may still be null even if the status is declined indicating that the user did not provide a reason when declining.

redirect_url_success

A URL that the signer will be redirected to once the signature process has been finished successfully.

redirect_url_error

A URL that the signer will be redirected to in case an error occurred while signing the documents.

redirect_url_declined

A URL that the signer will be redirected to after they have declined their signature.

certificate_serial_number

string|null

certificate_fingerprint

string|null

A SHA-256 fingerprint across the whole certificate created after the signer has finished signing the documents. This fingerprint may be used to uniquely identify the signer.

created_at

ISO-8601 formatted timestamp of when this resource has been created.

updated_at

ISO-8601 formatted timestamp of when this resource has last been updated.

Auth

Bearer

Headers

Body

{ "quality": "SES", "title": "My Signature Title", "webhook_url": "https:\/\/myapp.test\/webhook", "signers": [ { "order": 1, "title": "Prof.", "firstname": "Katheryn", "lastname": "Langworth", "email": "kayla.wiegand@yahoo.com", "mobile_number": "+4915228817386", "redirect_url_success": "https:\/\/example.test\/success", "redirect_url_error": "https:\/\/example.test\/error", "redirect_url_declined": "https:\/\/example.test\/declined" } ] }

Received response

Example request:

curl --request POST \
    "https://api.finosign.de/v1/signatures" \
    --header "Authorization: Bearer {API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"quality\": \"SES\",
    \"title\": \"My Signature Title\",
    \"webhook_url\": \"https:\\/\\/myapp.test\\/webhook\",
    \"signers\": [
        {
            \"order\": 1,
            \"title\": \"Prof.\",
            \"firstname\": \"Katheryn\",
            \"lastname\": \"Langworth\",
            \"email\": \"kayla.wiegand@yahoo.com\",
            \"mobile_number\": \"+4915228817386\",
            \"redirect_url_success\": \"https:\\/\\/example.test\\/success\",
            \"redirect_url_error\": \"https:\\/\\/example.test\\/error\",
            \"redirect_url_declined\": \"https:\\/\\/example.test\\/declined\"
        }
    ]
}"

Example response:

{
    "data": {
        "id": "Cz7wWKv4ose9",
        "quality": "SES",
        "status": "preparation",
        "withdraw_reason": null,
        "title": null,
        "webhook_url": null,
        "created_at": "2024-10-17T09:37:08.000000Z",
        "updated_at": "2024-10-17T09:37:08.000000Z",
        "signers": [
            {
                "id": "pTG41YEDE8bk",
                "order": 1,
                "title": null,
                "firstname": "Josiane",
                "lastname": "Schulist",
                "fullname": "Josiane Schulist",
                "email": "fay.kane@example.org",
                "mobile_number": null,
                "status": "signed",
                "decline_reason": null,
                "signing_url": "http://api.finosign.de/v1/signatures/Cz7wWKv4ose9/sign/b7ejQZ2RZe",
                "redirect_url_success": null,
                "redirect_url_error": null,
                "redirect_url_declined": null,
                "certificate_serial_number": "286d1184487d",
                "certificate_fingerprint": "3e7320b60d3949f6b1a24ed3ac82b289fd9bdd8d0969ea6f455b9b0fb33c8285",
                "created_at": "2024-10-17T09:37:08.000000Z",
                "updated_at": "2024-10-17T09:37:08.000000Z"
            },
            {
                "id": "6KiAliy0qCZX",
                "order": 1,
                "title": null,
                "firstname": "Jordi",
                "lastname": "Robel",
                "fullname": "Jordi Robel",
                "email": "loren.schmidt@example.net",
                "mobile_number": null,
                "status": "open",
                "decline_reason": null,
                "signing_url": "http://api.finosign.de/v1/signatures/Cz7wWKv4ose9/sign/EFtPddjnJw",
                "redirect_url_success": null,
                "redirect_url_error": null,
                "redirect_url_declined": null,
                "certificate_serial_number": "1622e23992d4208a4e6a336e0db5b82b1834eac1",
                "certificate_fingerprint": "f8096ea83498f4186aeadea6cd08e026d5c806bd1d494871f1e7c57df0a15b3b",
                "created_at": "2024-10-17T09:37:08.000000Z",
                "updated_at": "2024-10-17T09:37:08.000000Z"
            }
        ]
    }
}

Show signature

GET

https://api.finosign.de

/v1/signatures/{signature}

requires authentication

Retrieve an existing signature by the provided ID.

Headers

Authorization

Example:

Bearer {API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

signature

string

required

The public ID of the signature resource.

Example:

zHQAQwQpBDmq

Response Fields

data

object

The signature resource found by the provided ID.

string

The public id of this signature.

quality

string

The signature quality that will be used for this signature process.

Must be one of:

SES
AES
QES

status

string

The current status of this signature.

Must be one of:

preparation
failed
declined
open
withdrawn
signed

withdraw_reason

string|null

The reason of withdrawal when status is withdrawn.

title

string|null

The optional title of this signature that gets shown to signers.

webhook_url

string|null

An optional webhook URL that will be used instead of the webhook URL of the app.

created_at

string

ISO-8601 formatted timestamp of when this resource has been created.

updated_at

string

ISO-8601 formatted timestamp of when this resource has last been updated.

signers

object[]

An array of signers associated with this signature.

The public ID of this signer.

order

The order index that this signer belongs to (starting at 1). Signers with the same order index are able to sign in parallel.

title

string|null

The title of the signer.

firstname

The firstname of the signer.

lastname

The lastname of the signer.

The E-Mail address of the signer.

mobile_number

string|null

The mobile phone number of the signer. This number will be used for verification depending on the signature quality.

ident_method

The method of identification used by the signer.

status

The signature status for this signer.

decline_reason

string|null

An optional reason of why the signer has declined their signature. This value may still be null even if the status is declined indicating that the user did not provide a reason when declining.

redirect_url_success

A URL that the signer will be redirected to once the signature process has been finished successfully.

redirect_url_error

A URL that the signer will be redirected to in case an error occurred while signing the documents.

redirect_url_declined

A URL that the signer will be redirected to after they have declined their signature.

certificate_serial_number

string|null

certificate_fingerprint

string|null

A SHA-256 fingerprint across the whole certificate created after the signer has finished signing the documents. This fingerprint may be used to uniquely identify the signer.

created_at

ISO-8601 formatted timestamp of when this resource has been created.

updated_at

ISO-8601 formatted timestamp of when this resource has last been updated.

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.finosign.de/v1/signatures/zHQAQwQpBDmq" \
    --header "Authorization: Bearer {API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": {
        "id": "7BcBmWTFqlBp",
        "quality": "SES",
        "status": "preparation",
        "withdraw_reason": null,
        "title": null,
        "webhook_url": null,
        "created_at": "2024-10-17T09:37:08.000000Z",
        "updated_at": "2024-10-17T09:37:08.000000Z",
        "signers": [
            {
                "id": "DbC8ZDzeorsd",
                "order": 1,
                "title": null,
                "firstname": "Ana",
                "lastname": "Hagenes",
                "fullname": "Ana Hagenes",
                "email": "agottlieb@example.org",
                "mobile_number": null,
                "status": "open",
                "decline_reason": null,
                "signing_url": "http://api.finosign.de/v1/signatures/7BcBmWTFqlBp/sign/dtC4jIAfEc",
                "redirect_url_success": null,
                "redirect_url_error": null,
                "redirect_url_declined": null,
                "certificate_serial_number": "1fcd18510b44b7",
                "certificate_fingerprint": "dd77a6742b7710baa9df1606a9c5368b5c6929d9c0b1feaa7c8df7f3f98817f8",
                "created_at": "2024-10-17T09:37:08.000000Z",
                "updated_at": "2024-10-17T09:37:08.000000Z"
            },
            {
                "id": "B8j5FEi6LaWl",
                "order": 1,
                "title": null,
                "firstname": "Justina",
                "lastname": "Gutmann",
                "fullname": "Justina Gutmann",
                "email": "brendon.brakus@example.net",
                "mobile_number": null,
                "status": "open",
                "decline_reason": null,
                "signing_url": "http://api.finosign.de/v1/signatures/7BcBmWTFqlBp/sign/Fkf06Gmy5d",
                "redirect_url_success": null,
                "redirect_url_error": null,
                "redirect_url_declined": null,
                "certificate_serial_number": "795075b0ee6b19d99e",
                "certificate_fingerprint": "77c8b9e27dad4a2aed0168df28a9c15e5a297c907d85e0a21d1f479e07550612",
                "created_at": "2024-10-17T09:37:08.000000Z",
                "updated_at": "2024-10-17T09:37:08.000000Z"
            }
        ]
    }
}

Update signature

PATCH

https://api.finosign.de

/v1/signatures/{signature}

requires authentication

Update an existing signature with the provided values.

Note: Updating a signature is no longer possible once the signature has left preparation stage.

Headers

Authorization

Example:

Bearer {API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

signature

string

required

The public ID of the signature resource.

Example:

zHQAQwQpBDmq

Body Parameters

quality

string

required

The quality of this signature. Must be a quality supported by the currently authenticated app.

Must be one of:

SES
AES
QES

Example:

SES

title

string

An optional title for this signature that will be shown to users. Must be between 2 and 100 characters.

Example:

My Signature Title

webhook_url

string

An optional webhook URL that will be used instead of the webhook URL of the app. Must be a valid URL.

Example:

https://myapp.test/webhook

Response Fields

data

object

The updated signature resource.

string

The public id of this signature.

quality

string

The signature quality that will be used for this signature process.

Must be one of:

SES
AES
QES

status

string

The current status of this signature.

Must be one of:

preparation
failed
declined
open
withdrawn
signed

withdraw_reason

string|null

The reason of withdrawal when status is withdrawn.

title

string|null

The optional title of this signature that gets shown to signers.

webhook_url

string|null

An optional webhook URL that will be used instead of the webhook URL of the app.

created_at

string

ISO-8601 formatted timestamp of when this resource has been created.

updated_at

string

ISO-8601 formatted timestamp of when this resource has last been updated.

signers

object[]

An array of signers associated with this signature.

The public ID of this signer.

order

The order index that this signer belongs to (starting at 1). Signers with the same order index are able to sign in parallel.

title

string|null

The title of the signer.

firstname

The firstname of the signer.

lastname

The lastname of the signer.

The E-Mail address of the signer.

mobile_number

string|null

The mobile phone number of the signer. This number will be used for verification depending on the signature quality.

ident_method

The method of identification used by the signer.

status

The signature status for this signer.

decline_reason

string|null

An optional reason of why the signer has declined their signature. This value may still be null even if the status is declined indicating that the user did not provide a reason when declining.

redirect_url_success

A URL that the signer will be redirected to once the signature process has been finished successfully.

redirect_url_error

A URL that the signer will be redirected to in case an error occurred while signing the documents.

redirect_url_declined

A URL that the signer will be redirected to after they have declined their signature.

certificate_serial_number

string|null

certificate_fingerprint

string|null

A SHA-256 fingerprint across the whole certificate created after the signer has finished signing the documents. This fingerprint may be used to uniquely identify the signer.

created_at

ISO-8601 formatted timestamp of when this resource has been created.

updated_at

ISO-8601 formatted timestamp of when this resource has last been updated.

Auth

Bearer

Headers

URL Parameters

Body

{ "quality": "SES", "title": "My Signature Title", "webhook_url": "https:\/\/myapp.test\/webhook" }

Received response

Example request:

curl --request PATCH \
    "https://api.finosign.de/v1/signatures/zHQAQwQpBDmq" \
    --header "Authorization: Bearer {API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"quality\": \"SES\",
    \"title\": \"My Signature Title\",
    \"webhook_url\": \"https:\\/\\/myapp.test\\/webhook\"
}"

Example response:

{
    "data": {
        "id": "Cz7wWKv4ose9",
        "quality": "SES",
        "status": "preparation",
        "withdraw_reason": null,
        "title": null,
        "webhook_url": null,
        "created_at": "2024-10-17T09:37:08.000000Z",
        "updated_at": "2024-10-17T09:37:08.000000Z",
        "signers": [
            {
                "id": "YEDE8bk6KiAl",
                "order": 1,
                "title": null,
                "firstname": "Josiane",
                "lastname": "Schulist",
                "fullname": "Josiane Schulist",
                "email": "eldridge.ankunding@example.com",
                "mobile_number": null,
                "status": "signed",
                "decline_reason": null,
                "signing_url": "http://api.finosign.de/v1/signatures/Cz7wWKv4ose9/sign/TvNHQSDb9L",
                "redirect_url_success": null,
                "redirect_url_error": null,
                "redirect_url_declined": null,
                "certificate_serial_number": "ea104b617e46509305feef1a93fe46d321a13748",
                "certificate_fingerprint": "4bb02de1dabe2e27cf33ae3af57c0d1bcabea4fdfb9f2fdf4f415ed8149cdd4f",
                "created_at": "2024-10-17T09:37:08.000000Z",
                "updated_at": "2024-10-17T09:37:08.000000Z"
            },
            {
                "id": "iy0qCZX4DbC8",
                "order": 1,
                "title": null,
                "firstname": "Kirk",
                "lastname": "Zulauf",
                "fullname": "Kirk Zulauf",
                "email": "haven33@example.com",
                "mobile_number": null,
                "status": "signed",
                "decline_reason": null,
                "signing_url": "http://api.finosign.de/v1/signatures/Cz7wWKv4ose9/sign/bArkDgPHoA",
                "redirect_url_success": null,
                "redirect_url_error": null,
                "redirect_url_declined": null,
                "certificate_serial_number": "b01f22390a42191b43fb",
                "certificate_fingerprint": "97108345cd5f318242998cfe33e527819a35e5d4e4bf110c9cee09c89c9d2314",
                "created_at": "2024-10-17T09:37:08.000000Z",
                "updated_at": "2024-10-17T09:37:08.000000Z"
            }
        ]
    }
}

Delete signature

DELETE

https://api.finosign.de

/v1/signatures/{signature}

requires authentication

Delete an existing signature and all its associated resources by the provided ID.

Note: Deleting a signature is no longer possible once the signature has reached signed stage.

Headers

Authorization

Example:

Bearer {API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

signature

string

required

The public ID of the signature resource.

Example:

zHQAQwQpBDmq

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.finosign.de/v1/signatures/zHQAQwQpBDmq" \
    --header "Authorization: Bearer {API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

[Empty response]

Open Signature

POST

https://api.finosign.de

/v1/signatures/{signature}/open

requires authentication

Finalizes the preparation stage, making the documents ready to be signed.

Note: To finalize the preparation stage, at least one document and one signer is required.

Headers

Authorization

Example:

Bearer {API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

signature

string

required

The public ID of the signature resource.

Example:

zHQAQwQpBDmq

Response Fields

data

object

The opened signature resource.

string

The public id of this signature.

quality

string

The signature quality that will be used for this signature process.

Must be one of:

SES
AES
QES

status

string

The current status of this signature.

Must be one of:

preparation
failed
declined
open
withdrawn
signed

withdraw_reason

string|null

The reason of withdrawal when status is withdrawn.

title

string|null

The optional title of this signature that gets shown to signers.

webhook_url

string|null

An optional webhook URL that will be used instead of the webhook URL of the app.

created_at

string

ISO-8601 formatted timestamp of when this resource has been created.

updated_at

string

ISO-8601 formatted timestamp of when this resource has last been updated.

signers

object[]

An array of signers associated with this signature.

The public ID of this signer.

order

The order index that this signer belongs to (starting at 1). Signers with the same order index are able to sign in parallel.

title

string|null

The title of the signer.

firstname

The firstname of the signer.

lastname

The lastname of the signer.

The E-Mail address of the signer.

mobile_number

string|null

The mobile phone number of the signer. This number will be used for verification depending on the signature quality.

ident_method

The method of identification used by the signer.

status

The signature status for this signer.

decline_reason

string|null

An optional reason of why the signer has declined their signature. This value may still be null even if the status is declined indicating that the user did not provide a reason when declining.

redirect_url_success

A URL that the signer will be redirected to once the signature process has been finished successfully.

redirect_url_error

A URL that the signer will be redirected to in case an error occurred while signing the documents.

redirect_url_declined

A URL that the signer will be redirected to after they have declined their signature.

certificate_serial_number

string|null

certificate_fingerprint

string|null

A SHA-256 fingerprint across the whole certificate created after the signer has finished signing the documents. This fingerprint may be used to uniquely identify the signer.

created_at

ISO-8601 formatted timestamp of when this resource has been created.

updated_at

ISO-8601 formatted timestamp of when this resource has last been updated.

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.finosign.de/v1/signatures/zHQAQwQpBDmq/open" \
    --header "Authorization: Bearer {API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": {
        "id": "7BcBmWTFqlBp",
        "quality": "SES",
        "status": "preparation",
        "withdraw_reason": null,
        "title": null,
        "webhook_url": null,
        "created_at": "2024-10-17T09:37:08.000000Z",
        "updated_at": "2024-10-17T09:37:08.000000Z",
        "signers": [
            {
                "id": "DzeorsdB8j5F",
                "order": 1,
                "title": null,
                "firstname": "Ana",
                "lastname": "Hagenes",
                "fullname": "Ana Hagenes",
                "email": "gutmann.justina@example.org",
                "mobile_number": null,
                "status": "signed",
                "decline_reason": null,
                "signing_url": "http://api.finosign.de/v1/signatures/7BcBmWTFqlBp/sign/GTKRugxdLw",
                "redirect_url_success": null,
                "redirect_url_error": null,
                "redirect_url_declined": null,
                "certificate_serial_number": "de1dd5839b5132",
                "certificate_fingerprint": "5f28dd4e147ba15c7616d52cd9cfc5b2433b720323fe8b8dec2da793f83b141f",
                "created_at": "2024-10-17T09:37:08.000000Z",
                "updated_at": "2024-10-17T09:37:08.000000Z"
            },
            {
                "id": "Ei6LaWlEO_4B",
                "order": 1,
                "title": null,
                "firstname": "Keeley",
                "lastname": "Howell",
                "fullname": "Keeley Howell",
                "email": "tyrel47@example.net",
                "mobile_number": null,
                "status": "signed",
                "decline_reason": null,
                "signing_url": "http://api.finosign.de/v1/signatures/7BcBmWTFqlBp/sign/uaLc3SwLOc",
                "redirect_url_success": null,
                "redirect_url_error": null,
                "redirect_url_declined": null,
                "certificate_serial_number": "ecd2bc7529",
                "certificate_fingerprint": "93a2dfbcafe8ef5c20157f8d041cf7596e69b5bd5bb25da7fc5aeeef74d768c9",
                "created_at": "2024-10-17T09:37:08.000000Z",
                "updated_at": "2024-10-17T09:37:08.000000Z"
            }
        ]
    }
}

Signature Signers

A signer is an entity that is able to sign the documents in a signature process.

List all signers List all signing entities associated with the provided signature ID.

GET

https://api.finosign.de

/v1/signatures/{signature}/signers

requires authentication

Headers

Authorization

Example:

Bearer {API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

signature

string

required

The public ID of the signature resource.

Example:

zHQAQwQpBDmq

Response Fields

data

object[]

An array containing all signers associated with the provided signature ID.

string

The public ID of this signer.

order

integer

The order index that this signer belongs to (starting at 1). Signers with the same order index are able to sign in parallel.

title

string|null

The title of the signer.

firstname

string

The firstname of the signer.

lastname

string

The lastname of the signer.

string

The E-Mail address of the signer.

mobile_number

string|null

The mobile phone number of the signer. This number will be used for verification depending on the signature quality.

ident_method

The method of identification used by the signer.

Must be one of:

robo-ident
bank
video
eID

status

string

The signature status for this signer.

Must be one of:

preparation
failed
declined
open
withdrawn
signed

decline_reason

string|null

An optional reason of why the signer has declined their signature. This value may still be null even if the status is declined indicating that the user did not provide a reason when declining.

redirect_url_success

A URL that the signer will be redirected to once the signature process has been finished successfully.

redirect_url_error

A URL that the signer will be redirected to in case an error occurred while signing the documents.

redirect_url_declined

A URL that the signer will be redirected to after they have declined their signature.

certificate_serial_number

string|null

certificate_fingerprint

string|null

A SHA-256 fingerprint across the whole certificate created after the signer has finished signing the documents. This fingerprint may be used to uniquely identify the signer.

created_at

string

ISO-8601 formatted timestamp of when this resource has been created.

updated_at

string

ISO-8601 formatted timestamp of when this resource has last been updated.

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.finosign.de/v1/signatures/zHQAQwQpBDmq/signers" \
    --header "Authorization: Bearer {API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": "8bk6KiAliy0q",
            "order": 1,
            "title": null,
            "firstname": "Katheryn",
            "lastname": "Langworth",
            "fullname": "Katheryn Langworth",
            "email": "abbigail.lehner@example.com",
            "mobile_number": null,
            "status": "signed",
            "decline_reason": null,
            "signing_url": "http://api.finosign.de/v1/signatures/qlBpTG41YEDE/sign/2w76PQHZwD",
            "redirect_url_success": null,
            "redirect_url_error": null,
            "redirect_url_declined": null,
            "certificate_serial_number": "13ae1d7baf2859a8f23da0104d",
            "certificate_fingerprint": "07bfa58f550c1f72a8b241c9d77fce60556abe15ce8b243c5c6136e9981a0e83",
            "created_at": "2024-10-17T09:37:08.000000Z",
            "updated_at": "2024-10-17T09:37:08.000000Z"
        },
        {
            "id": "U4Uy3Vfi_EP6",
            "order": 1,
            "title": null,
            "firstname": "Georgianna",
            "lastname": "Kiehn",
            "fullname": "Georgianna Kiehn",
            "email": "satterfield.caitlyn@example.net",
            "mobile_number": null,
            "status": "open",
            "decline_reason": null,
            "signing_url": "http://api.finosign.de/v1/signatures/SoU2bGyyReuv/sign/ioOvOTeaCP",
            "redirect_url_success": null,
            "redirect_url_error": null,
            "redirect_url_declined": null,
            "certificate_serial_number": "1a62a4dec9",
            "certificate_fingerprint": "f1d5a2bed27b8fc3af6d541e9757c3e8d70ddc46b3034a459c4b28517b2f35d5",
            "created_at": "2024-10-17T09:37:08.000000Z",
            "updated_at": "2024-10-17T09:37:08.000000Z"
        }
    ]
}

Create signer(s) Create one more multiple new signing entities for the signing process of the provided signature ID.

POST

https://api.finosign.de

/v1/signatures/{signature}/signers

requires authentication

Note: Creating new signers is no longer possible once the signature has left preparation stage.

Headers

Authorization

Example:

Bearer {API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

signature

string

required

The public ID of the signature resource.

Example:

zHQAQwQpBDmq

Body Parameters

signers

object[]

An array of signer-resources that represents entities that are prompted to fulfill the signing process.

order

integer

The order index that this signer belongs to (starting at 1). Signers with the same order index are able to sign in parallel. Must be between 1 and 255.

Example:

title

string

The title of the signer. Must not be greater than 200 characters.

Example:

Prof.

firstname

string

required

The firstname of the signer. Must be between 2 and 200 characters.

Example:

Katheryn

lastname

string

required

The lastname of the signer. Must be between 2 and 200 characters.

Example:

Langworth

string

Example:

kayla.wiegand@yahoo.com

mobile_number

string

Example:

+4915228817386

two_factor_identifier

string

The two factor identifier of the signer. This identifier will be placed onto the signature certificate. Usually a user id from your system. Requires activiation - contact support. This field is required when signers..two_factor_method or signers..two_factor_confirmed_at is present. Must be between 2 and 200 characters.

Example:

two_factor_method

string

The two factor method of the signer. Requires activiation - contact support. This field is required when signers..two_factor_identifier or signers..two_factor_confirmed_at is present. Must be between 2 and 200 characters.

Example:

2FA Authenticator

two_factor_confirmed_at

string

The two factor confirmation at date of the signer. Must be in the past. Requires activiation - contact support. This field is required when signers..two_factor_identifier or signers..two_factor_method is present. Must be a valid date in the format Y-m-d\TH:i:sP. Must be a date before or equal to now.

Example:

2024-01-01T12:00:00+0000

redirect_url_success

string

A URL that the signer will be redirected to once the signature process has been finished successfully. Must use HTTPS protocol. Must be a valid URL.

Example:

https://example.test/success

redirect_url_error

string

A URL that the signer will be redirected to in case an error occurred while signing the documents. Must use HTTPS protocol. Must be a valid URL.

Example:

https://example.test/error

redirect_url_declined

string

A URL that the signer will be redirected to after they have declined their signature. Must use HTTPS protocol. Must be a valid URL.

Example:

https://example.test/declined

Response Fields

data

object[]

The created signer resource.

string

The public ID of this signer.

order

integer

The order index that this signer belongs to (starting at 1). Signers with the same order index are able to sign in parallel.

title

string|null

The title of the signer.

firstname

string

The firstname of the signer.

lastname

string

The lastname of the signer.

string

The E-Mail address of the signer.

mobile_number

string|null

The mobile phone number of the signer. This number will be used for verification depending on the signature quality.

ident_method

The method of identification used by the signer.

Must be one of:

robo-ident
bank
video
eID

status

string

The signature status for this signer.

Must be one of:

preparation
failed
declined
open
withdrawn
signed

decline_reason

string|null

An optional reason of why the signer has declined their signature. This value may still be null even if the status is declined indicating that the user did not provide a reason when declining.

redirect_url_success

A URL that the signer will be redirected to once the signature process has been finished successfully.

redirect_url_error

A URL that the signer will be redirected to in case an error occurred while signing the documents.

redirect_url_declined

A URL that the signer will be redirected to after they have declined their signature.

certificate_serial_number

string|null

certificate_fingerprint

string|null

A SHA-256 fingerprint across the whole certificate created after the signer has finished signing the documents. This fingerprint may be used to uniquely identify the signer.

created_at

string

ISO-8601 formatted timestamp of when this resource has been created.

updated_at

string

ISO-8601 formatted timestamp of when this resource has last been updated.

Auth

Bearer

Headers

URL Parameters

Body

{ "signers": [ { "order": 1, "title": "Prof.", "firstname": "Katheryn", "lastname": "Langworth", "email": "kayla.wiegand@yahoo.com", "mobile_number": "+4915228817386", "two_factor_identifier": "1", "two_factor_method": "2FA Authenticator", "two_factor_confirmed_at": "2024-01-01T12:00:00+0000", "redirect_url_success": "https:\/\/example.test\/success", "redirect_url_error": "https:\/\/example.test\/error", "redirect_url_declined": "https:\/\/example.test\/declined" } ] }

Received response

Example request:

curl --request POST \
    "https://api.finosign.de/v1/signatures/zHQAQwQpBDmq/signers" \
    --header "Authorization: Bearer {API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"signers\": [
        {
            \"order\": 1,
            \"title\": \"Prof.\",
            \"firstname\": \"Katheryn\",
            \"lastname\": \"Langworth\",
            \"email\": \"kayla.wiegand@yahoo.com\",
            \"mobile_number\": \"+4915228817386\",
            \"two_factor_identifier\": \"1\",
            \"two_factor_method\": \"2FA Authenticator\",
            \"two_factor_confirmed_at\": \"2024-01-01T12:00:00+0000\",
            \"redirect_url_success\": \"https:\\/\\/example.test\\/success\",
            \"redirect_url_error\": \"https:\\/\\/example.test\\/error\",
            \"redirect_url_declined\": \"https:\\/\\/example.test\\/declined\"
        }
    ]
}"

Example response:

{
    "data": [
        {
            "id": "iB7BcBmWTFql",
            "order": 1,
            "title": null,
            "firstname": "Myron",
            "lastname": "Vandervort",
            "fullname": "Myron Vandervort",
            "email": "mueller.nelle@example.org",
            "mobile_number": null,
            "status": "signed",
            "decline_reason": null,
            "signing_url": "http://api.finosign.de/v1/signatures/4ose9LJrby6-/sign/KPUlnGVzFG",
            "redirect_url_success": null,
            "redirect_url_error": null,
            "redirect_url_declined": null,
            "certificate_serial_number": "b13d8dd6",
            "certificate_fingerprint": "e0bd2ac1e95f2ee3131917eb40e4ef44c21b5e2deb057ba928ba6b139747aefa",
            "created_at": "2024-10-17T09:37:08.000000Z",
            "updated_at": "2024-10-17T09:37:08.000000Z"
        },
        {
            "id": "0qgY5lgs5GiS",
            "order": 1,
            "title": null,
            "firstname": "Haven",
            "lastname": "Weber",
            "fullname": "Haven Weber",
            "email": "dorris.heaney@example.org",
            "mobile_number": null,
            "status": "open",
            "decline_reason": null,
            "signing_url": "http://api.finosign.de/v1/signatures/4YYSruY1AqJ-/sign/4bW6j9RRbg",
            "redirect_url_success": null,
            "redirect_url_error": null,
            "redirect_url_declined": null,
            "certificate_serial_number": "098300eab51c3e034463b899e7260ec3",
            "certificate_fingerprint": "54ea3a4ee2fb2a1baf794cef5b3bc9dff84e7f60bf50a0b334630777be300bba",
            "created_at": "2024-10-17T09:37:08.000000Z",
            "updated_at": "2024-10-17T09:37:08.000000Z"
        }
    ]
}

Show signer Retrieve a single signer associated with the provided signature ID.

GET

https://api.finosign.de

/v1/signatures/{signature}/signers/{signer}

requires authentication

Headers

Authorization

Example:

Bearer {API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

signature

string

required

The public ID of the signature resource.

Example:

zHQAQwQpBDmq

signer

string

required

The public ID of the signer resource.

Example:

hT1XfmsMNvsy

Response Fields

data

object

The signer resource found by the provided ID.

string

The public ID of this signer.

order

integer

The order index that this signer belongs to (starting at 1). Signers with the same order index are able to sign in parallel.

title

string|null

The title of the signer.

firstname

string

The firstname of the signer.

lastname

string

The lastname of the signer.

string

The E-Mail address of the signer.

mobile_number

string|null

The mobile phone number of the signer. This number will be used for verification depending on the signature quality.

ident_method

The method of identification used by the signer.

Must be one of:

robo-ident
bank
video
eID

status

string

The signature status for this signer.

Must be one of:

preparation
failed
declined
open
withdrawn
signed

decline_reason

string|null

An optional reason of why the signer has declined their signature. This value may still be null even if the status is declined indicating that the user did not provide a reason when declining.

redirect_url_success

A URL that the signer will be redirected to once the signature process has been finished successfully.

redirect_url_error

A URL that the signer will be redirected to in case an error occurred while signing the documents.

redirect_url_declined

A URL that the signer will be redirected to after they have declined their signature.

certificate_serial_number

string|null

certificate_fingerprint

string|null

A SHA-256 fingerprint across the whole certificate created after the signer has finished signing the documents. This fingerprint may be used to uniquely identify the signer.

created_at

string

ISO-8601 formatted timestamp of when this resource has been created.

updated_at

string

ISO-8601 formatted timestamp of when this resource has last been updated.

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.finosign.de/v1/signatures/zHQAQwQpBDmq/signers/hT1XfmsMNvsy" \
    --header "Authorization: Bearer {API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": {
        "id": "liy0qCZX4DbC",
        "order": 1,
        "title": null,
        "firstname": "Katheryn",
        "lastname": "Langworth",
        "fullname": "Katheryn Langworth",
        "email": "merlin.gibson@example.org",
        "mobile_number": null,
        "status": "signed",
        "decline_reason": null,
        "signing_url": "http://api.finosign.de/v1/signatures/1YEDE8bk6KiA/sign/wwqGxGw5pA",
        "redirect_url_success": null,
        "redirect_url_error": null,
        "redirect_url_declined": null,
        "certificate_serial_number": "1310d4",
        "certificate_fingerprint": "3216f719a078681569bddb4ae416043d7faa19a506e938d1510f6c747a08cae4",
        "created_at": "2024-10-17T09:37:08.000000Z",
        "updated_at": "2024-10-17T09:37:08.000000Z"
    }
}

Update signer Update information of an existing signer associated with the provided signature ID.

PATCH

https://api.finosign.de

/v1/signatures/{signature}/signers/{signer}

requires authentication

Note: Updating a signer is no longer possible once the associated signature has left preparation stage.

Headers

Authorization

Example:

Bearer {API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

signature

string

required

The public ID of the signature resource.

Example:

zHQAQwQpBDmq

signer

string

required

The public ID of the signer resource.

Example:

hT1XfmsMNvsy

Body Parameters

order

integer

The order index that this signer belongs to (starting at 1). Signers with the same order index are able to sign in parallel. Must be between 1 and 255.

Example:

title

string

The title of the signer. Must not be greater than 200 characters.

Example:

Prof.

firstname

string

The firstname of the signer. Must be between 2 and 200 characters.

Example:

Katheryn

lastname

string

The lastname of the signer. Must be between 2 and 200 characters.

Example:

Langworth

string

The E-Mail address of the signer. Must be a valid email address. Must not be greater than 200 characters.

Example:

kayla.wiegand@yahoo.com

mobile_number

string

The mobile phone number of the signer. This number will be used for verification depending on the signature quality. This field is required when two_factor_identifier is not present.

Example:

+4915228817386

two_factor_identifier

string

The two factor identifier of the signer. This identifier will be placed onto the signature certificate. Usually a user id from your system. Requires activiation - contact support. This field is required when two_factor_method or two_factor_confirmed_at is present. Must be between 2 and 200 characters.

Example:

two_factor_method

string

The two factor method of the signer. Requires activiation - contact support. This field is required when two_factor_identifier or two_factor_confirmed_at is present. Must be between 2 and 200 characters.

Example:

2FA Authenticator

two_factor_confirmed_at

string

The two factor confirmation at date of the signer. Must be in the past. Requires activiation - contact support. This field is required when two_factor_identifier or two_factor_method is present. Must be a valid date in the format Y-m-d\TH:i:sP. Must be a date before or equal to now.

Example:

2024-01-01T12:00:00+0000

redirect_url_success

string

A URL that the signer will be redirected to once the signature process has been finished successfully. Must use HTTPS protocol. Must be a valid URL.

Example:

https://example.test/success

redirect_url_error

string

A URL that the signer will be redirected to in case an error occurred while signing the documents. Must use HTTPS protocol. Must be a valid URL.

Example:

https://example.test/error

redirect_url_declined

string

A URL that the signer will be redirected to after they have declined their signature. Must use HTTPS protocol. Must be a valid URL.

Example:

https://example.test/declined

Response Fields

data

object

The updated signer resource.

string

The public ID of this signer.

order

integer

The order index that this signer belongs to (starting at 1). Signers with the same order index are able to sign in parallel.

title

string|null

The title of the signer.

firstname

string

The firstname of the signer.

lastname

string

The lastname of the signer.

string

The E-Mail address of the signer.

mobile_number

string|null

The mobile phone number of the signer. This number will be used for verification depending on the signature quality.

ident_method

The method of identification used by the signer.

Must be one of:

robo-ident
bank
video
eID

status

string

The signature status for this signer.

Must be one of:

preparation
failed
declined
open
withdrawn
signed

decline_reason

string|null

An optional reason of why the signer has declined their signature. This value may still be null even if the status is declined indicating that the user did not provide a reason when declining.

redirect_url_success

A URL that the signer will be redirected to once the signature process has been finished successfully.

redirect_url_error

A URL that the signer will be redirected to in case an error occurred while signing the documents.

redirect_url_declined

A URL that the signer will be redirected to after they have declined their signature.

certificate_serial_number

string|null

certificate_fingerprint

string|null

A SHA-256 fingerprint across the whole certificate created after the signer has finished signing the documents. This fingerprint may be used to uniquely identify the signer.

created_at

string

ISO-8601 formatted timestamp of when this resource has been created.

updated_at

string

ISO-8601 formatted timestamp of when this resource has last been updated.

Auth

Bearer

Headers

URL Parameters

Body

{ "order": 1, "title": "Prof.", "firstname": "Katheryn", "lastname": "Langworth", "email": "kayla.wiegand@yahoo.com", "mobile_number": "+4915228817386", "two_factor_identifier": "1", "two_factor_method": "2FA Authenticator", "two_factor_confirmed_at": "2024-01-01T12:00:00+0000", "redirect_url_success": "https:\/\/example.test\/success", "redirect_url_error": "https:\/\/example.test\/error", "redirect_url_declined": "https:\/\/example.test\/declined" }

Received response

Example request:

curl --request PATCH \
    "https://api.finosign.de/v1/signatures/zHQAQwQpBDmq/signers/hT1XfmsMNvsy" \
    --header "Authorization: Bearer {API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"order\": 1,
    \"title\": \"Prof.\",
    \"firstname\": \"Katheryn\",
    \"lastname\": \"Langworth\",
    \"email\": \"kayla.wiegand@yahoo.com\",
    \"mobile_number\": \"+4915228817386\",
    \"two_factor_identifier\": \"1\",
    \"two_factor_method\": \"2FA Authenticator\",
    \"two_factor_confirmed_at\": \"2024-01-01T12:00:00+0000\",
    \"redirect_url_success\": \"https:\\/\\/example.test\\/success\",
    \"redirect_url_error\": \"https:\\/\\/example.test\\/error\",
    \"redirect_url_declined\": \"https:\\/\\/example.test\\/declined\"
}"

Example response:

{
    "data": {
        "id": "TFqlBpTG41YE",
        "order": 1,
        "title": null,
        "firstname": "Myron",
        "lastname": "Vandervort",
        "fullname": "Myron Vandervort",
        "email": "winona.hermiston@example.com",
        "mobile_number": null,
        "status": "signed",
        "decline_reason": null,
        "signing_url": "http://api.finosign.de/v1/signatures/by6-iB7BcBmW/sign/anyui372GU",
        "redirect_url_success": null,
        "redirect_url_error": null,
        "redirect_url_declined": null,
        "certificate_serial_number": "0562b6d2e130252a3c3c2699604983311dfdc2",
        "certificate_fingerprint": "73b934e11a52b0611b1166b661e822cc471763028c7c56a9e3efc95fe08c73f2",
        "created_at": "2024-10-17T09:37:08.000000Z",
        "updated_at": "2024-10-17T09:37:08.000000Z"
    }
}

Delete signer Deletes a signer associated with the provided signature ID.

DELETE

https://api.finosign.de

/v1/signatures/{signature}/signers/{signer}

requires authentication

Note: Deleting a signer is no longer possible once the associated signature has left preparation stage.

Headers

Authorization

Example:

Bearer {API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

signature

string

required

The public ID of the signature resource.

Example:

zHQAQwQpBDmq

signer

string

required

The public ID of the signer resource.

Example:

hT1XfmsMNvsy

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.finosign.de/v1/signatures/zHQAQwQpBDmq/signers/hT1XfmsMNvsy" \
    --header "Authorization: Bearer {API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

[Empty response]

Signature Documents

A Signature Document represents any document that will be part of the signing process of the associated signature.

List all documents

GET

https://api.finosign.de

/v1/signatures/{signature}/documents

requires authentication

List all documents associated with the provided signature ID.

Headers

Authorization

Example:

Bearer {API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

signature

string

required

The public ID of the signature resource.

Example:

zHQAQwQpBDmq

Response Fields

data

object[]

An array containing all documents associated with the provided signature ID.

string

The public id of this document.

filename

string

The name of the file of this document (without extension).

extension

string

The file extension of this document.

name

string

filename and extension combined forming the full filename.

mime_type

string

The MIME-Type of this document.

bytes

integer

The size of the document in bytes.

file_hash

string

A SHA-256 hash of the file.

created_at

string

ISO-8601 formatted timestamp of when this resource has been created.

updated_at

string

ISO-8601 formatted timestamp of when this resource has last been updated.

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.finosign.de/v1/signatures/zHQAQwQpBDmq/documents" \
    --header "Authorization: Bearer {API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": "TG41YEDE8bk6",
            "filename": "UZW6YKmJvY",
            "extension": "pdf",
            "name": "UZW6YKmJvY.pdf",
            "mime_type": "application/pdf",
            "bytes": 374363,
            "file_hash": "123b4bb3e0669bbf2b1247903c00a702876c9f88338f5a4e3738f2318d1e26f6",
            "created_at": "2024-10-17T09:37:08.000000Z",
            "updated_at": "2024-10-17T09:37:08.000000Z"
        },
        {
            "id": "s5GiSoU2bGyy",
            "filename": "XBshJPECmE",
            "extension": "pdf",
            "name": "XBshJPECmE.pdf",
            "mime_type": "application/pdf",
            "bytes": 648758,
            "file_hash": "119148ec799432966de6fc43730a362a826c90d1f2e66e64c1a709b88209564c",
            "created_at": "2024-10-17T09:37:08.000000Z",
            "updated_at": "2024-10-17T09:37:08.000000Z"
        }
    ]
}

Upload document(s)

POST

https://api.finosign.de

/v1/signatures/{signature}/documents

requires authentication

Upload one or multiple new documents that will become part of the signing process of the provided signature ID.

Note: Uploading new documents is no longer possible once the associated signature has left preparation stage.

Headers

Authorization

Example:

Bearer {API_TOKEN}

Content-Type

Example:

multipart/form-data

Example:

application/json

URL Parameters

signature

string

required

The public ID of the signature resource.

Example:

zHQAQwQpBDmq

Body Parameters

files

file[]

The file representing the document that shall be uploaded. The filename must contain an extension. Must be a file. Must not be greater than 51200 kilobytes.

Example:

Response Fields

data

object[]

The created document resource.

string

The public id of this document.

filename

string

The name of the file of this document (without extension).

extension

string

The file extension of this document.

name

string

filename and extension combined forming the full filename.

mime_type

string

The MIME-Type of this document.

bytes

integer

The size of the document in bytes.

file_hash

string

A SHA-256 hash of the file.

created_at

string

ISO-8601 formatted timestamp of when this resource has been created.

updated_at

string

ISO-8601 formatted timestamp of when this resource has last been updated.

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request POST \
    "https://api.finosign.de/v1/signatures/zHQAQwQpBDmq/documents" \
    --header "Authorization: Bearer {API_TOKEN}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "files[]=@/tmp/phpuH1TMr"

Example response:

{
    "data": [
        {
            "id": "Jrby6-iB7BcB",
            "filename": "J5PcqopqyS",
            "extension": "pdf",
            "name": "J5PcqopqyS.pdf",
            "mime_type": "application/pdf",
            "bytes": 932763,
            "file_hash": "c23ead84681b271c452b1555345278f5dcf812e332069e82f757cfc3954b5b44",
            "created_at": "2024-10-17T09:37:08.000000Z",
            "updated_at": "2024-10-17T09:37:08.000000Z"
        },
        {
            "id": "YYSruY1AqJ-0",
            "filename": "niNO8DkIqF",
            "extension": "pdf",
            "name": "niNO8DkIqF.pdf",
            "mime_type": "application/pdf",
            "bytes": 68120,
            "file_hash": "413bafa18c77a5febddfb205ac565f65d43fdbc7ee32e636593fe9213bdd25a0",
            "created_at": "2024-10-17T09:37:08.000000Z",
            "updated_at": "2024-10-17T09:37:08.000000Z"
        }
    ]
}

Show document

GET

https://api.finosign.de

/v1/signatures/{signature}/documents/{document}

requires authentication

Retrieve information about a document associated with the provided signature ID.

Headers

Authorization

Example:

Bearer {API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

signature

string

required

The public ID of the signature resource.

Example:

zHQAQwQpBDmq

document

string

required

The public ID of the document resource.

Example:

hT1XfmsMNvsy

Response Fields

data

object

The document resource found by the provided ID.

string

The public id of this document.

filename

string

The name of the file of this document (without extension).

extension

string

The file extension of this document.

name

string

filename and extension combined forming the full filename.

mime_type

string

The MIME-Type of this document.

bytes

integer

The size of the document in bytes.

file_hash

string

A SHA-256 hash of the file.

created_at

string

ISO-8601 formatted timestamp of when this resource has been created.

updated_at

string

ISO-8601 formatted timestamp of when this resource has last been updated.

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.finosign.de/v1/signatures/zHQAQwQpBDmq/documents/hT1XfmsMNvsy" \
    --header "Authorization: Bearer {API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": {
        "id": "TG41YEDE8bk6",
        "filename": "suwYjPTtZQ",
        "extension": "pdf",
        "name": "suwYjPTtZQ.pdf",
        "mime_type": "application/pdf",
        "bytes": 374363,
        "file_hash": "32058892680405bb7f13df7a7c4c0071eb314979209abb0b2338a9f5e781bd90",
        "created_at": "2024-10-17T09:37:08.000000Z",
        "updated_at": "2024-10-17T09:37:08.000000Z"
    }
}

Delete document

DELETE

https://api.finosign.de

/v1/signatures/{signature}/documents/{document}

requires authentication

Delete a document associated with the provided signature ID.

Note: Deleting a document is no longer possible once the associated signature has left preparation stage.

Headers

Authorization

Example:

Bearer {API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

signature

string

required

The public ID of the signature resource.

Example:

zHQAQwQpBDmq

document

string

required

The public ID of the document resource.

Example:

hT1XfmsMNvsy

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.finosign.de/v1/signatures/zHQAQwQpBDmq/documents/hT1XfmsMNvsy" \
    --header "Authorization: Bearer {API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

[Empty response]

Download Document

GET

https://api.finosign.de

/v1/signatures/{signature}/documents/{document}/download

requires authentication

Retrieve a signed document of a completed signature process.

Headers

Authorization

Example:

Bearer {API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

signature

string

required

The public ID of the signature resource.

Example:

zHQAQwQpBDmq

document

string

required

The public ID of the document resource.

Example:

hT1XfmsMNvsy

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.finosign.de/v1/signatures/zHQAQwQpBDmq/documents/hT1XfmsMNvsy/download" \
    --header "Authorization: Bearer {API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

[Binary data] -  The requested document

Signature Logs

Actions performed in a signature process are logged per signature. A signature log represents a single action taken by an entity regarding a signature.

List logs of Signature

GET

https://api.finosign.de

/v1/signatures/{signature}/logs

requires authentication

List all logs associated with the provided signature ID.

Headers

Authorization

Example:

Bearer {API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

signature

string

required

The public ID of the signature resource.

Example:

zHQAQwQpBDmq

Response Fields

data

object[]

An array containing all logs associated with the provided signature ID.

string

The public id of this log entry.

ip_address

string|null

The IPv4 or IPv6 address of the entity performing the action. May be null indicating that the action has been performed by internal systems.

user_agent

string|null

The user-agent of the entity performing the action May be null indicating that the action has been performed by internal systems.

user_agent_hash

string|null

A SHA-256 hash of the user_agent field that can be used for fingerprinting.

message

string|null

A message describing the log entry.

data

object|null

An optional payload for the specific log entry containing metadata.

created_at

string

ISO-8601 formatted timestamp of when this resource has been created.

updated_at

string

ISO-8601 formatted timestamp of when this resource has last been updated.

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.finosign.de/v1/signatures/zHQAQwQpBDmq/logs" \
    --header "Authorization: Bearer {API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": "dB8j5FEi6LaW",
            "ip_address": "5e58:8b51:e6a5:4219:6b4d:9848:1b09:9794",
            "user_agent": "Mozilla/5.0 (X11; Linux i686) AppleWebKit/536.1 (KHTML, like Gecko) Chrome/97.0.4631.50 Safari/536.1 EdgA/97.01095.73",
            "user_agent_hash": "5f47c1162a758cc1f6b6412f8dec7f96f1df0d2bf3c64a33cc14face823da083",
            "message": "signature_declined",
            "data": {},
            "created_at": "2024-10-17T09:37:08.000000Z",
            "updated_at": "2024-10-17T09:37:08.000000Z"
        },
        {
            "id": "yfHJgXpdKynz",
            "ip_address": "4.121.110.94",
            "user_agent": "Mozilla/5.0 (compatible; MSIE 7.0; Windows NT 6.0; Trident/5.0)",
            "user_agent_hash": "90163883f95ca8f099366c790343cdb2f7fad7fde5f66408181bb8372cb7ffde",
            "message": "signature_signed",
            "data": {},
            "created_at": "2024-10-17T09:37:08.000000Z",
            "updated_at": "2024-10-17T09:37:08.000000Z"
        }
    ]
}

Endpoints

GET v1/signatures/{signature}/sign/{token}/message

GET

https://api.finosign.de

/v1/signatures/{signature}/sign/{token}/message

requires authentication

Headers

Authorization

Example:

Bearer {API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

signature

string

required

The public ID of the signature resource.

Example:

zHQAQwQpBDmq

token

string

required

Example:

illum

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.finosign.de/v1/signatures/zHQAQwQpBDmq/sign/illum/message" \
    --header "Authorization: Bearer {API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response: