Skip to content
Developers

Developer platform

With the bb-sign API, your systems create and send envelopes, receive a signed notification each time an envelope changes status, and download the signed document without manual steps. The JavaScript and Java SDKs cover the API and webhook verification.

Value
API base URL https://sign-api.binarybridges.co
Token URL (OAuth2 client credentials) https://auth.binarybridges.co/realms/bbsign/protocol/openid-connect/token
OpenAPI contract https://sign-api.binarybridges.co/v3/api-docs
API reference /sign/api/

Set the first two as environment variables in every service that calls bb-sign. A token is valid for 300 s; both SDKs fetch and refresh it automatically.

Contract version 2026-08-09 has 17 paths (19 operations) organized in five areas:

Area Operations Credential required
Documents Upload a PDF before creating the envelope Yes
Envelopes Create, list, read, attach documents, add signers, send, cancel, count by status Yes
Signing ceremony Open a link, request and verify a one-time code, sign, download the signed copy, record open and close No: the link token is the credential
Verify Check a seal from the QR code on a signed document No
Workspaces List the workspaces the credential can access Yes

The token scopes every call to the credential’s organization and, within it, to its workspace roles. Machine authentication explains both levels.

Organizations, users, certificates, quotas, API credentials, webhooks and workspaces are managed in Settings by an organization admin. The pages under Administer the organization describe each one. Webhooks, in particular, are registered in Settings, tab Webhooks.