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

Rocket Lawyer Binders API

The Binders API from Rocket Lawyer — 19 operation(s) for binders.

Rocket Lawyer Binders API is one of 8 APIs that Rocket Lawyer publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Binders. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and release notes.

This API exposes 28 operations across 19 paths, and defines 68 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api-sandbox.rocketlawyer.com/partners/v1/auth, https://api.rocketlawyer.com/partners/v1/auth.

28 operations 19 paths 68 schemas 5 DELETE6 GET4 PATCH12 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.rocketlawyer.com/partners/v1/auth
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Rocket Lawyer Binders API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerTokenAuth).

Paths & Operations 28

Across 19 paths, the API surfaces 28 operations — 5 DELETE, 6 GET, 4 PATCH, 12 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Binders 28
POST
/binders
Allowed roles: BACKEND Creates the new Binder Creates full binder with documents, inputs and parties. Note that binder status is still INPREPARATION as document(s) need to be uploaded.
POST_binders 1 param body → 201
GET
/binders
Allowed roles: BACKEND List of Binders
GET_binders 4 params → 200
GET
/binders/{binderId}
Allowed roles: FRONTEND (all parties), BACKEND Retrieves binder
GET_binders-binderId 3 params → 200
DELETE
/binders/{binderId}
Allowed roles: BACKEND Deletes binder
DELETE_binders-binderId 1 param → 204
PATCH
/binders/{binderId}
Allowed roles: FRONTEND (OWNER only), BACKEND Updates binder A binder can be updated only when it is in the INPREPARATION status. Updates comply as per RFC-7396
PATCH_binders-binderId 2 params body → 200
GET
/binders/{binderId}/status
Allowed roles: FRONTEND (all parties), BACKEND Series of validations (preflight check) is performed on binder with status INPREPARATION. Response clearly indicates if binder is ready to be FINALISED…
GET_binders-binderId-status 2 params → 200
POST
/binders/{binderId}/locks
Allowed roles: BACKEND Creates of lock preventing certain actions on the binder. In example having a cancellation lock on a binder will prevent signing from being cancelled.
POST_binders-binderId-locks 2 params body → 201
DELETE
/binders/{binderId}/locks/{lockId}
Allowed roles: BACKEND Delete a lock from the binder. Locks can be deleted only by the client that acquired the lock
DELETE_binders-binderId-locks-lockId 3 params → 204
GET
/binders/{binderId}/parties
Allowed roles: FRONTEND (OWNER only), BACKEND Get party represented by service token.
GET_binders-binderId-parties 2 params → 200400403
POST
/binders/{binderId}/parties
Allowed roles: FRONTEND (OWNER only), BACKEND Add a party to a binder Normally a party can be added only when the binder is in the INPREPARATION state. A party with the VIEWER role can be added even…
POST_binders-binderId-parties 2 params body → 201
PATCH
/binders/{binderId}/parties/{partyId}
Allowed roles: FRONTEND (OWNER only), BACKEND Update party. A party can be updated only when binder is in the INPREPARATION state. Updates comply with RFC-7396
PATCH_binders-binderId-parties-partyId 3 params body → 200
DELETE
/binders/{binderId}/parties/{partyId}
Allowed roles: FRONTEND (OWNER only), BACKEND Delete a party. Normally a party can only be deleted when binder is in the INPREPARATION state. If the party has the VIEWER role, it may be deleted even…
DELETE_binders-binderId-parties-partyId 2 params → 204
POST
/binders/{binderId}/documents
Allowed roles: FRONTEND (OWNER only), BACKEND Adds a document to a binder.
POST_binders-binderId-documents 2 params body → 201
GET
/binders/{binderId}/documents/{documentId}
Allowed roles: FRONTEND, BACKEND Retrieves a document in the format defined by Accept header. If the file type is not supported, a status code of 412 (Precondition Failed) is returned.
GET_binders-binderId-documents-documentId 4 params → 303
PUT
/binders/{binderId}/documents/{documentId}
Allowed roles: FRONTEND (OWNER only), BACKEND Uploads content of document
PUT_binders-binderId-documents-documentId 3 params body → 200
PATCH
/binders/{binderId}/documents/{documentId}
Allowed roles: FRONTEND (OWNER only), BACKEND Update document: A document can be updated only when the binder containing it is in the INPREPARATION state. Non-editable parts are: id, originalContentC…
PATCH_binders-binderId-documents-documentId 3 params body → 200
DELETE
/binders/{binderId}/documents/{documentId}
Allowed roles: FRONTEND (OWNER only), BACKEND Delete document: A document can be deleted only when the binder containing it is in the INPREPARATION state.
DELETE_binders-binderId-documents-documentId 2 params → 204
POST
/binders/{binderId}/documents/{documentId}/inputs
Allowed roles: FRONTEND (OWNER only), BACKEND Adds a new input to the given document
POST_binders-binderId-documents-documentId-inputs 3 params body → 201
PATCH
/binders/{binderId}/documents/{documentId}/inputs/{inputId}
Allowed roles: FRONTEND (OWNER only), BACKEND Update input. An input can be updated only when the binder that contains it is in the INPREPARATION state. Updates comply with RFC-7396
PATCH_binders-binderId-documents-documentId-inputs-inputId 4 params body → 200
DELETE
/binders/{binderId}/documents/{documentId}/inputs/{inputId}
Allowed roles: FRONTEND (OWNER only), BACKEND Delete input. A input can be deleted only when the binder that contains it is in the INPREPARATION status.
DELETE_binders-binderId-documents-documentId-inputs-inputId 3 params → 204
GET
/binders/{binderId}/documents/{documentId}/pages/{pageId}
Allowed roles: FRONTEND (all parties), BACKEND Retrieves single page in specified format. Only supported format is PNG for now.
GET_binders-binderId-documents-documentId-pages-pageId 5 params → 303
POST
/binders/{binderId}/requests/finalisations
Allowed roles: FRONTEND (only document owner), BACKEND Performs pre-flight checks and moves binder into REVIEWANDSHARE state. Invitations are also sent to VIEWERs
POST_binders-binderId-requests-finalisations 2 params body → 201
POST
/binders/{binderId}/requests/invitations
Allowed roles: FRONTEND (OWNER only), BACKEND Starts the signing process by creating invitations Collect signers as recipients if not provided in request Change binder status changed to SIGNINPROGRES…
POST_binders-binderId-requests-invitations 2 params body → 201
POST
/binders/{binderId}/requests/cancellations
Allowed roles: FRONTEND (OWNER only), BACKEND Stops the signing process by cancelling invitations Capture signers as notification recipients if recipients not specified in request Bring binder and do…
POST_binders-binderId-requests-cancellations 2 params body → 201
POST
/binders/{binderId}/requests/signatures
Allowed roles: FRONTEND (all parties), BACKEND Records signature inputs provided by a signer. All inputs provided should reference same party (related to a single signer).
POST_binders-binderId-requests-signatures 2 params body → 201
POST
/binders/{binderId}/requests/declines
Allowed roles: FRONTEND (all parties with SIGNER role), BACKEND Records that the signer declined to sign. The OWNER will be notified that this SIGNER has declined.
POST_binders-binderId-requests-declines 2 params body → 201
POST
/binders/{binderId}/requests/reminders
Allowed roles: FRONTEND (only document owner), BACKEND Sends a reminders to sign or view the document to the given signers and/or viewers. It is possible to send the reminder only if the binder state…
POST_binders-binderId-requests-reminders 2 params body → 201
POST
/binders/{binderId}/requests/viewers
Allowed roles: FRONTEND (only document owner), BACKEND Adds a party with the VIEWER role to a binder and sends view invitation notifications. A VIEWER may be added during any binder state except in I…
POST_binders-binderId-requests-viewers 2 params body → 201

Schemas 68

The contract defines 68 schemas that model the data the API accepts and returns. The most detailed are CreateInputPositionIn (14 properties), BinderOut (14 properties), InputPositionOut (12 properties), InputOut (10 properties). Each schema is shown below with its type and property counts.

DocumentOut
object
9 properties 5 required
ReminderRecipientOut
object
4 properties 3 required
RecipientIn
object
4 properties 1 required
Status
string
Supported states for binders: INPREPARATION - When binder is created then initial status is INPREPARATION and binder stays in this status until parties are inv…
InputPositionUpdateIn
object
9 properties 1 required
UpdateBinderIn
object
6 properties
UUID
string
A unique ID. Generated by system, Read-only .
RequestOut
object
7 properties 4 required
InputPositionOut
object
12 properties 1 required
PatchBinderUpdatePartyIn
object
6 properties
SignCancellationIn
object
3 properties
SignInvitationIn
object
3 properties
PatchPartyIn
object
5 properties
PatchDocumentIn
object
5 properties
DataDeclines
object
1 property 1 required
InputFont
object
5 properties 1 required
SendReminderIn
object
2 properties
LockOut
object
3 properties 3 required
PatchInputIn
object
7 properties
Event
object
7 properties 5 required
SignaturesOut
object
5 properties 5 required
RequestType
string
Supported types of sign requests: SIGNINVITATION - Request that starts the signing process by sending invitations to signer-type parties FINALISATION - Request…
InputOut
object
10 properties 5 required
Locale
object
2 properties
SignaturesIn
object
2 properties 1 required
DeclinesIn
object
3 properties 1 required
StatusOut
object
3 properties 3 required
CreatePartyIn
object
7 properties 3 required
LockIn
object
2 properties 2 required
DataInputs
object
1 property 1 required
CreateDocumentIn
object
5 properties 2 required
CreateViewersIn
object
3 properties 1 required
UpdateInputIn
object
8 properties
Unit
string
Supported unit types for postion coordinates: PCT - Coordinates are in percent as fraction of container size
ReminderRecipientIn
object
2 properties 1 required
InputType
string
Supported types of input: SIGNATURETEXT - input used for rendering signature text (name) into the document DATESIGNED - input used for rendering a date (day of…
PartyRole
string
Supported types of party roles: OWNER - Creator of the binder who can prepare documents for signing, invite signers, cancel signing SIGNER - A person who can r…
EventDetails
object
4 properties
ConditionOut
object
For a detailed overview visit https://jsonapi.org/format/error-objects
5 properties 4 required
InputConfiguration
object
1 property
SendReminderOut
object
5 properties 2 required
PartyOut
object
10 properties 6 required
Json
string
A free-form JSON object.
CreateViewerIn
object
6 properties 2 required
CreateBinderIn
object
8 properties 3 required
SignInvitationOut
object
6 properties 4 required
InputPositionType
string
Supported types of input position: ABSOLUTE - position is specified by page, XY-coordinates, units of coordinates PLACEHOLDER - the signature position is marke…
PageOut
object
1 property 1 required
BinderConfiguration
object
1 property
ClientConfigurationOut
object
2 properties
RecipientOut
object
4 properties 3 required
FontType
string
Supported font types
DeclinesOut
object
6 properties 5 required
CreateInputPositionIn
object
14 properties 1 required
FontWeight
string
Supported font weights
BinderOut
object
14 properties 8 required
LockStatus
string
Supported statuses of Lock: CANCELLATION - Binder cannot be cancelled until all Locks of this type are removed.
UpdateDocumentIn
object
6 properties
PartyStatus
string
Supported statuses of party: PENDING - either the binder is in the preparation phase, or the party no longer has permission to access it INVITED - the party ha…
PatchUUID
string
Unique id generated by server.
FinalisationIn
object
3 properties
SignCancellationOut
object
6 properties 4 required
FinalisationOut
object
5 properties 4 required
CreateViewersOut
object
5 properties 5 required
CreateInputIn
object
7 properties 3 required
SignatureInputIn
object
5 properties 2 required
EventType
string
BINDERCREATED - Begin of binder history. Binder was created FINALISATION - Binder owner finished editing binder and is ready to sent invitation INVITATIONTOSIG…
InputStatus
string
Supported statuses of input: PENDING - input is initialized COMPLETED - input was completed by the party (text entered, checkbox checked, ...) DECLINED - the p…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rocket-lawyer-binders-api-openapi.yml Raw ↑

Other APIs Rocket Lawyer publishes across the network.

Rocket Lawyer Accesstoken API
Rocket Lawyer Documents API
Rocket Lawyer Event Consumption API
Rocket Lawyer Interviews API
Rocket Lawyer Servicetoken API
Rocket Lawyer Subscription Management API
Rocket Lawyer Templates API
Where this information came from

This is an independent, third-party profile of Rocket Lawyer Binders 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.