Boldsign Elixir Client

Unofficial Elixir client for BoldSign.

Built with Req.

Quick Start with LiveBook

The easiest way to get started is through our interactive LiveBook examples:

Embedded Signing

Complete working demonstration of BoldSign embedded signing:

Installation

The package can be installed by adding boldsign to your list of dependencies in mix.exs:

def deps do
  [
    {:boldsign, "~> 0.6.0"}
  ]
end

Usage

Configuration

client = Boldsign.new(api_key: "your_api_key")

# OAuth access token
oauth_client = Boldsign.new(access_token: "your_oauth_access_token")

# or provide both when you want to support either credential source
hybrid_client = Boldsign.new(
  api_key: "your_api_key",
  access_token: "your_oauth_access_token"
)

# regional endpoints
client = Boldsign.new(api_key: "your_api_key", region: :eu)
client = Boldsign.new(api_key: "your_api_key", region: :ca)
client = Boldsign.new(api_key: "your_api_key", region: :au)

List and filter params are forwarded as-is, so use the query parameter names from the official BoldSign API docs for each endpoint.

Documents

Send a Document with Text Tags

Text tags are the best way to place fields in generated PDFs without using coordinates.

params = %{
  title: "Agreement",
  useTextTags: true,
  textTagDefinitions: [
    %{
      definitionId: "SignHere",
      signerIndex: 1,
      type: "Signature"
    }
  ],
  signers: [%{name: "John Doe", email: "john@example.com"}]
}

Boldsign.Document.send(client, params)

List Documents

documents = Boldsign.Document.list(client, page: 1, pageSize: 10)
team_documents = Boldsign.Document.team_list(client, [{"TeamId", "team_id"}])
behalf_documents = Boldsign.Document.behalf_list(client, [{"EmailAddress", "sender@example.com"}])

Templates

Send Document from Template

Boldsign.Template.send(client, "template_id", %{
  roles: [%{roleIndex: 1, name: "John Doe", email: "john@example.com"}]
})

Boldsign.Template.create_embedded_request_url(client, "template_id", %{
  redirectUrl: "https://example.com/return"
})

Users & Teams

users = Boldsign.User.list(client)
teams = Boldsign.Team.list(client)

Boldsign.User.update_metadata(client, %{
  userId: "user_id",
  metaData: %{department: "Legal"}
})

Contacts & Contact Groups

contacts = Boldsign.Contact.list(client, [{"Page", 1}])
contact = Boldsign.Contact.get(client, "contact_id")

groups = Boldsign.ContactGroup.list(client, [{"Page", 1}])
group = Boldsign.ContactGroup.get(client, "group_id")

Custom Fields & Plan

fields = Boldsign.CustomField.list(client, "brand_id")
embed_url = Boldsign.CustomField.create_embedded_url(client, "brand_id")

credits = Boldsign.Plan.api_credits_count(client)

Identity Verification

Boldsign.IdentityVerification.create_embedded_verification_url(client, "document_id", %{
  emailId: "signer@example.com"
})

Boldsign.IdentityVerification.get_report(client, "document_id", %{
  emailId: "signer@example.com"
})

Webhooks

Verify Signature

# In your Phoenix controller
payload = conn.assigns[:raw_body]
signature = get_req_header(conn, "x-boldsign-signature") |> List.first()
secret = "your_webhook_secret"

if Boldsign.Webhook.verify_signature(payload, signature, secret) do
  # Valid
else
  # Invalid
end

Credits

This project is inspired by the Dashbit blog post on building SDKs with Req. Formatting and CI structure borrowed from docusign_elixir. Uses Quokka for formatting.

Next Page → Changelog