How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

BoldSign User API

The User API from BoldSign — 8 operation(s) for user.

BoldSign User API is one of 11 APIs that BoldSign publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

This API exposes 8 operations across 8 paths, and defines 9 schemas. It is described by OpenAPI 3.0.3, at version 1.

Requests are made against 4 base URLs: https://api.boldsign.com, https://eu.boldsign.com, https://ca.boldsign.com, https://au.boldsign.com.

8 operations 8 paths 9 schemas 2 GET3 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1
Base URL
https://api.boldsign.com
Authentication
API Key, API Key
Terms of Service
Resource Areas
1

Authentication & Security 2

BoldSign User API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (Bearer). An API key is passed in the header as X-API-KEY (X-API-KEY). By default, every request must be authenticated.

  • Bearer — Format 'Bearer' [space] [TOKEN]. Ex: 'Bearer eyJhbGciOiJIUzI1N'
  • X-API-KEY — Format [API-KEY]. Ex: 'abcdef12345'

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 2 GET, 3 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

User 8
POST
/v1/users/create
Create the user.
CreateUser body → 204401403
PUT
/v1/users/update
Update new User role.
UpdateUser body → 200401403
POST
/v1/users/resendInvitation
Resend the users invitation.
ResendInvitation 1 param → 200401403
POST
/v1/users/cancelInvitation
Cancel the users invitation.
CancelInvitation 1 param → 200401403
GET
/v1/users/list
List user documents.
ListUsers 4 params → 200401
GET
/v1/users/get
Get summary of the user.
GetUser 1 param → 200401403
PUT
/v1/users/updateMetaData
Update new User meta data details.
updateMetaData body → 200401403
PUT
/v1/users/changeTeam
Change users to other team.
ChangeTeam 1 param body → 200401403

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are UserProperties (11 properties), UsersDetails (11 properties), CreateUser (4 properties), UpdateUser (4 properties). Each schema is shown below with its type and property counts.

UpdateUser
object
4 properties 1 required
UserRecords
object
2 properties
ErrorResult
object
1 property
UpdateUserMetaData
object
2 properties 2 required
CreateUser
object
4 properties 1 required
UsersDetails
object
11 properties
UserPageDetails
object
2 properties
ChangeTeamRequest
object
2 properties 1 required
UserProperties
object
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

boldsign-user-api-openapi.yml Raw ↑

Other APIs BoldSign publishes across the network.

BoldSign Branding API
BoldSign Contacts API
BoldSign Custom Field API
BoldSign Document API
BoldSign GroupContacts API
BoldSign Identity Verification API
BoldSign Plan API
BoldSign Sender Identities API
BoldSign Teams API
BoldSign Template API
Where this information came from

This is an independent, third-party profile of BoldSign User API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.