A Ruby client for the BoldSign e-signature API.

Wraps every public endpoint of the BoldSign v1 REST API: documents, templates, contacts, contact groups, custom fields, sender identities, brands, teams, users, identity verification, and plan info.

gem "boldsign"

The client authenticates with either an API key or OAuth 2.0.

Register an OAuth app in the BoldSign dashboard (API → OAuth Apps) and configure its client_id / client_secret. The client fetches a bearer token from the region's account host, caches it until shortly before it expires, and refreshes automatically — no token plumbing on your side.

Boldsign.configure do |c|
  c.client_id     = ENV["BOLDSIGN_CLIENT_ID"]
  c.client_secret = ENV["BOLDSIGN_CLIENT_SECRET"]
  c.region        = :us   # :us, :eu, :ca, :au
  # c.scope       = "BoldSign.Documents.All"  # optional; empty grants all the app allows
end

You can also pass a token you obtained yourself (used as-is, not refreshed):

Boldsign::Client.new(access_token: "…", region: :us)

Boldsign.configure do |c|
  c.api_key = ENV["BOLDSIGN_API_KEY"]
  c.region  = :us   # :us, :eu, :ca, :au  (or set c.base_url directly)
end

Or instantiate a client directly:

client = Boldsign::Client.new(api_key: "…", region: :us)

Region hosts:

The token endpoint is the account host + /connect/token; override the full URL with token_url: if a region differs.

client = Boldsign.client

# Send a document
client.documents.send_document(
  title: "NDA",
  signers: [{ name: "Jane Doe", emailAddress: "jane@example.com", signerOrder: 1 }],
  files: [...] # see BoldSign docs for the full schema
)

# List documents
client.documents.list(page: 1, pageSize: 50)

# Properties / download
client.documents.properties("DOCUMENT_ID")
File.binwrite("signed.pdf", client.documents.download("DOCUMENT_ID"))

# Templates
client.templates.list
client.templates.send_template("TEMPLATE_ID", roles: [...])

# Contacts / contact groups
client.contacts.create(contacts: [{ name: "Jane", emailAddress: "jane@example.com" }])
client.contact_groups.list

# Users & teams
client.users.list
client.teams.create(teamName: "Sales")

# Brands
client.brand.list

# Plan
client.plan.api_credits_count

Each resource on Boldsign::Client maps to a group of BoldSign endpoints:

All methods accept Ruby hashes (with camelCase keys matching the BoldSign API) and return parsed JSON. Binary endpoints (download*) return raw bytes.

HTTP errors raise a typed subclass of Boldsign::Error:

BadRequestError (400), AuthenticationError (401), ForbiddenError (403), NotFoundError (404), UnprocessableEntityError (422), RateLimitError (429), ServerError (5xx). Each carries #status, #body, and #response.

Full YARD API documentation is auto-built and hosted at rubydoc.info/github/kleinjm/boldsign-ruby/main.

To generate locally:

bundle exec yard doc
open doc/index.html

bundle install
bundle exec rspec        # run tests (enforces 100% line + branch coverage)
bundle exec yard doc     # build local API docs to ./doc

MIT