Reference

Environments and prerequisites

Environments

EnvironmentHost
Pre-production (acceptance)https://connect.acc.cleverbase.com
Productionhttps://connect.cleverbase.com

Build against acceptance. Signatures made there use test certificates and are not qualified. Every call in this documentation works identically on both hosts; only the client and the signer's account are per environment.

A third host, the service stub, answers the same calls with no signer, no app and no real signature, and takes the shared development credentials from Registering your client.

What you need

  1. An OAuth 2.0 client for the Signing API: a client_id, a client_secret and one or more registered redirect_uri values. Request it through your Cleverbase contact; the client is per environment. See Registering your client.
  2. A signer with a Cleverbase account on the environment you use, who has completed identification and therefore holds a credential (a qualified certificate with its key in our hardware security module (HSM)).
  3. A phone with the Cleverbase app, registered on the environment you use. There is no emulator and no test mode that skips the app; on desktop you scan a QR code with it, on mobile it opens directly.
  4. A PDF library that supports external signing, that is, one that can compute the to-be-signed bytes first and accept the signature value later. DSS 6.x and pyHanko both do; so do iText and PDFBox with more manual work. Libraries that only offer "sign with this private key" cannot be used with a remote key.
  5. If you serve several customers through one client, an account token per signature, so we can attribute it to the right account. See Account tokens.