for developers
https://sandbox-api.bink.fi
INTEGRATION GUIDE

Documents & signing

Understand the document lifecycle before sending your first production request.

Upload fields

title is optional and defaults to the uploaded filename. folderId must identify a folder in the same tenant that the key owner can access; invalid folders are rejected. Provide signees as a non-empty JSON array. Each entry must contain a valid email address and a name.

Signing methods and order

signingMethod is email (default) or strong. signingOrderEnabled=true makes the signees array order determine the signing sequence. emailLanguage accepts fi, en, or sv and otherwise follows the tenant setting. signingMessage is optional and limited to 500 characters.

Optional personal identity code matching

Strong signing does not require you to supply a personal identity code (pic). Include pic for a signee only when you want to match their verified identity against a code you already know. This additional check applies when signingMethod is strong.

  • With pic: Bink compares the expected code with the personal identity code returned by strong identification. Signing is blocked if the verified code is missing or does not match.
  • Without pic: the signer still completes strong identification. Bink does not require a match against a sender-supplied personal identity code.
  • The choice is per signee: you can provide pic for some signees and omit it for others. Personal identity codes are not included in signee responses.

Signing URLs

Signing URLs depend on the document’s signingMethod, selected when creating the document. Choose the Strong signing or Email signing scenario in the response reference to compare the actual response shapes.

  • Send-for-signing: for strong signing, result[] includes signeeId and signingUrl for each applicable delivery result. Email-signing results omit both fields.
  • Get-document: signees[].signingUrl is included for strong-signing documents with status in_process, pending_seal, or signed. Each signee is identified by its id field.
  • Draft documents and email-signing documents omit signingUrl. Quick-create does not return signing URLs, even when signingMethod is strong.

Lifecycle and deletion

Document states are draft, in_process, pending_seal, and signed. Individual signee states are pending, signed, or declined. Deletion is permanent and also removes the stored PDF. Documents pending sealing cannot be deleted. Store any signed document you need before deletion.

Try it in the API console →

Authorize sandbox

Sent directly to https://sandbox-api.bink.fi as X-Api-Key. Kept in memory until you refresh.