API Reference
Log In
API Reference

Glossary

Jump to:

  7. G
  10. J
  11. K
  21. U
  24. X
  25. Y
  26. Z

ℹ️

Understanding our naming conventions

You may see some entity names followed by another name in parentheses, like this:

Drawer (sidedrawer)

All this means is that the term we actually use to refer to the entity, like "Drawer", is not how the parameter is named in the API endpoints.

So if you're looking for the Drawer name in an endpoint's response body, the parentheses tell you that you should be looking for a parameter called something like sidedrawerName (as opposed to drawerName).

Note: Sometimes the name used in the endpoint is a more complex name, like in the case of "Drawer" and sidedrawer, and sometimes it'll just be the same name given in camel case. For example, you might also see something like this:

Agreements (agreements)

SideDrawer Terminology

A

Account

A contributor who has created a SideDrawer Account has accepted the agreements, configured their settings, and provided some more information (i.e. phone number, as well as optional information such as primary residence, identity provider, etc).


Affiliate code | brandCode

An identifier for the "brand" or "affiliate" within a Tenant. The affiliate code is the version of the brand name that appears in the URL. A brand name may be "Corporate ABC", for example. Then the affiliate code might be something like "corporate-abc".


Agreements | agreements

These are agreements that must be accepted when a SideDrawer Account is created. Newer versions may also be sent out when required. There are three agreement types: terms of service (tos), privacy policies (privacy_policies), and anti-spam (anti_spam).


B

Blocks

Blocks are used to more efficiently upload and/or download large files.
See the guide on Blocks to learn more.


Brand (brand name)

A "brand" within a Tenant. A brand name may be "Corporate ABC", for example. Then the affiliate code (brandCode) might be something like "corporate-abc", as this will appear in the URL.


brandCode

see Affiliate code


C

Checksum

Determines the integrity of the file. Calculated using the SHA256 algorithm.


cobrandId

The cobrandId is the unique identifier for the brand/affiliate – it is associated with both the brand name and affiliate code (brandCode).


Collaboration Network (or Network)

A collaboration network is created whenever a Collaborator is added to an entity. The network describes the linkage between the User and the entity.


Content, descriptions & instructions

see Item

A Plan Item type that does not ask for information from the recipient. This could be used for providing information, Plan instructions, etc.


Correlation ID | correlationId

A correlation ID is a unique parameter specifying the upload details of a file. This is used to "group" files uploaded as part of the same process.


Currency | currency

The currency in which to operate. For example, "cad" or "usd".


Customer

This is a parameter inherited from Stripe, where the Customer entity stores billing and tax information for Subscriptions. In SideDrawer, a Customer entity contains the customer's name and billing details and is used to create a Subscription.


D

Database region | dataBaseRegion (or Region)

This is the region in which the data should be stored: the US, Canada, or the EU.


Date

see Field

A Plan Item of "field" type that uses a calendar widget to allow recipients to enter a date.


Decimal

see Field

A Plan Item of "field" type that accepts a decimal number input.


Display value | displayValue

displayValue entities allow for built-in translation. Values can be set depending on the possible locales, so that the associated information can be displayed in the appropriate language for a locale.


Drawer | sidedrawer

A Drawer is the main "container" for files and information. Within a Drawer, you can have Hangers (and these can contain Folders, which contain files).


Drive | driveId

A cloud Drive, identified by the driveId.


E

Email

see Field

A Plan Item of "field" type that accepts an email address.


Ending before | endingBefore

An object ID that defines a list object's position in the list by identifying the list object(s) appearing after it.


Entity

An "entity" is a SideDrawer structure or object, such as a Filing Cabinet, Drawer, Collaborator, etc. See the list and descriptions of each entity here.


Envelope ID |envelopeId

An envelope ID is used to identify signatures added to a document. This allows for the changes/signatures to be tracked and the completed (or most complete) document to be identified.


External keys | externalKeys

Additional key-value data.


F

Fact | fact

Methods or constants registered with the engine prior to runtime and referenced within Rule conditions. Each fact method should be a pure function that may return either a computed value, or a promise that resolves to a computed value. As rule conditions are evaluated during runtime, they retrieve fact values dynamically and use the condition operator to compare the fact result with the condition value.


Federation ID | federationId

This is only applicable for enterprise implementations. The federationId identifies the institution.


Field

see Item

A Plan Item type that asks for recipients to add information (not as a file upload).


File | recordFile

A file is the file uploaded to or created in a Folder. Files can be specified in the API using the file name or using a file token, depending on the endpoint.


File name | fileName (legacy)

A legacy file identification option. For example, fileName = myfile.


File name with extension | fileNameWithExtension

One of the file identification options. For example, fileNameWithExtension = myfile.docx.


File token | fileToken

One of the file identification options. A string produced by the system.


Filing Cabinet | filingCabinet

A Filing Cabinet contains Drawers. For example, you could have Filing Cabinets for different lines of business, containing their different Drawers.


Flavor

A branding style option within a brand.


Folder | record

A Folder belongs to a Hanger and Drawer, and contains files.


Frequency | frequency

see Reminder

The frequency with which the Reminder should be repeated: Daily, Weekly, Monthly, or Yearly.


H

Hanger | recordType

A Hanger contains a collection of Folders within a Drawer.


Hard delete | hardDelete

Permanently and completely delete the data from SideDrawer. This cannot be undone.


I

Id | id

Most of our identifier parameters are named in the format: {entity}Id. You may occasionally find parameters simply called id in some response bodies. In those cases, id represents either:

  • The identifier of the entity of the enclosing JSON element, or
  • The entity indicated by the end of the endpoint URL.

A response body for the endpoint /api/v2/networks/sidedrawer/sidedrawer-id/{sidedrawerId}/networks is shown below: 

{
  "data": [
    {
      "id": "string",
      "relation": {},
      "sidedrawer": "string",
      "sidedrawerRole": "string",
      "record": "string",
      "recordRole": "string",
      "teamNetwork": {
        "id": "string",
        "teamId": "string",
        "logo": "string",
        "name": "string"
      },
      "contributorType": "string",,
      "members": []
    }
  ]
}

In this response body, the key id appearing as the first parameter is not enclosed by a JSON element defining a SideDrawer entity. The final section of the endpoint URL is /networks, so this key id refers to the network identifier.

Meanwhile, the other key id appears within the JSON element teamNetwork. So this id refers to the team network identifier.


Inactive

Entities that have been deleted but not "hard deleted" are "inactive". These will be displayed when the displayInactive boolean (where given as an option) is set to true.


Info Request

The empty form created by a Tenant that should be sent and filled out by Users. Once a User has received this form in their own Drawer, it is a Plan Request or Smart Form.
See the guide for more information.


Integer

see Field

A Plan Item of "field" type that accepts an integer input.


Integration

Cloud integrations, including: Google Drive, OneDrive, Sharepoint, Dropbox, DocuSign, Acrobat Sign, Addepar.


Item

see Plan, Info Request

A question/section within a Plan.


Iteration | iteration

see Recurrent

A parameter of the Recurrent entity that describes how often the Frequency is considered for cases in which Reminder schedules are more complex than the options provided by the Frequency entity.

For example:

  • To send a Reminder every two weeks, set frequency = Weekly and iteration = 2
  • To send a Reminder every quarter, set frequency = Monthly and iteration = 3 - a reminder will be sent every three months
  • To send a Reminder every 6 months, set frequency = Monthly and iteration = 6.

L

Link URL

see Field

A Plan Item of "field" type that allows redirection from the Plan.


Locale | locale

Describes the User's region and language. This is used to display translations where applicable. Possible values: en-CA, fr-CA, en-US, es-US.


Long text

see Field

A Plan Item of "field" type that accepts text of over 255 characters and that accepts Rich Text Format (.rtf) documents.


M

Metadata | metadata

Additional key-value data. We recommend the use of External keys over this parameter as it is more flexible.


Method | method

The HTTP method. Possible values: "get", "post", "put", "delete", "patch", "all", "options", "head".


Monetary

see Field

A Plan Item of "field" type that accepts monetary numerical input.


Multiple choice

see Field

A Plan Item of "field" type that allows recipients to choose one of multiple provided answers.


Multiple option

see Field

A Plan Item of "field" type that allows recipients to choose one or more of multiple provided answers.


N

Network (or Collaboration Network)

A network is created whenever a Collaborator is added to an entity. The network describes the linkage between the User and the entity.


O

OpenID | openId

OpenID is an open standard authentication method used as identification for Users, like a username or email might be used.


P

Password

see Field

A Plan Item of "field" type that hides sensitive inputs.


Pattern | pattern

see Reminder

Describes specifically when a Reminder will recur. This is not applicable when frequency = Daily.

  • For frequency = Weekly, the possible values for pattern are enums describing the day(s) of the week the Reminder should be sent. Possible values: Sun, Mon, Tue, Wed, Thu, Fri, Sat.
  • For frequency = Monthly, the possible values for pattern are days of the month in the format "dd". Possible values range from 01 to 28. Not supported: 29, 30, and 31.
  • For frequency = Yearly, the possible values for pattern represent a specific day of the year in the format "mm/dd". Note: using 02/29 will cause the Reminder to be sent only on leap years.

Percentage

see Field

A Plan Item of "field" type that accepts percentage values.


Personal | personal

Contributor personal relationship by which to filter. Possible values: spouse, partner, friend, sibling, child, grand_child, parent, grand_parent, in_law, relative, other.


PKI

Public Key Infrastructure. An encryption method requiring the use of a public key and a private key. The private key ensures that only the intended recipient can open the message or file. When you "seal" a file in SideDrawer, it is encrypted with PKI.


Plan (info request)

A finalized Info Request is then given a planId, which is used to identify the Info Request being sent to users.
See the guide for more information.


Plan (subscription)

This is a parameter inherited from Stripe to define a Subscription, which has now been replaced in Stripe with the "Prices" entity. On the SideDrawer end, a plan entity still refers to the type of Subscription.


Plan Request (or Smart Form)

A Plan or Info Request that has been delivered to a User and is now specific to them. The User can now fill out this Plan Request they have received.
See the guide for more information.


Profession | profession

Contributor profession by which to filter. Possible values: estate_lawyer, vip_client, client, lawyer, real_estate_agent, mortgage_broker, insurance_broker, investment_advisor, banking_relationship, manager, accountant, financial_planner, bookkeeper, executor, executor_advisor, sponsor, other, portfolio_manager.


Provider

A cloud storage provider. For example, Google Drive or OneDrive.


Q

Quarantine

Send a file to quarantine if you are concerned about its integrity, to ensure that it cannot infect other files.


R

record

see Folder


Record subtype

A pre-defined category of Folder that acts as a "tag" for further organizing files.


Record subtype specific field

A pre-defined field of a Record subtype.


recordFile

see File


Records, documents & files

see Item

A Plan Item type that asks recipients to upload files.


recordType

see Hanger


Recurrent | recurrent

see Schedule

Describes the recurrent nature of the Schedule entity, if applicable.


Region | region (or Database region)

This is the region in which the data should be stored: the US, Canada, or the EU.


Relation | relation

The contributor's relationship to the entity owner.


Reminder

A Reminder is a message that is sent at a given date and time (as described by the Schedule entity) to certain users (described by the To entity). A Reminder can be linked to an entity at the Drawer (sidedrawer) level, the Folder (record) level, or the Plan Request level.


Resource | resource

see Reminders

Path of the entity to which the Reminder is linked. There are three available "levels" of resources:

  1. The Drawer (sidedrawer) level: the path root will be sidedrawer/sidedrawerId
  2. The Folder (record) level: the path root will be sidedrawer/sidedrawerId/record/recordId
  3. The Plan Request level: the path root will be sidedrawer/sidedrawerId/plan-request/planRequestId

Role | role

The User's role within the entity (Drawer or Folder). For example, "sd_editor" or "rec_viewer".


Rules | rules

A Rules entity contains conditions any, all, and not as well as an outcome entity that determine whether the rule "succeeds" or "fails". These are used in Smart Form Screens.


S

Schedule | schedule

see Reminder

Describes when a Reminder should be sent.


Screen (Smart Form)

A Screen in a Smart Form has definable Facts and Rules that are evaluated.


Section (Smart Form)

Smart Form Sections exist within Screens and also have definable Facts and Rules that are evaluated.


Seal

When a file is "sealed", it is encrypted using PKI so only the intended recipient can open it.


Settings | settings

Account settings options, such as the notification method, communication language, multi-factor authentication settings, etc.


sidedrawer

see Drawer


Signer | signers

A User whose signature is required.


Smart Form (or Plan Request)

A Plan or Info Request that has been delivered to a User and is now specific to them. The User can now fill out this Smart Form they have received.


Starting after | startingAfter

An object ID that defines a list object's position in the list by identifying the list object(s) appearing before it.


Storage location | storageLocation

Physical location in which the data will be stored.


Subscription

A Tenant's SideDrawer Plan and amount of licenses acquired.


Survey table

see Field

A Plan Item of "field" type that asks recipients to answer multiple questions with the same response options. For example, use this for a questionnaire where multiple questions should accept answers of: "strongly disagree", "disagree", "somewhat disagree", "neutral", "somewhat agree", "agree", and "strongly agree", as shown below.

Three questions provided which each have the same answer options provided in the header row. These options are "Strongly disagree", "Disagree", "Somewhat disagree", "Neutral", "Somewhat agree", "Agree", and "Strongly agree".

Example survey table with questions from 16Personalities test.


T

Table

see Field

A Plan Item of "field" type that asks recipients to fill out information for different components. You can pre-fill some of the table cells so recipients know for which areas they need to provide information. For example, ask recipients John, Jane, and Joe to provide their last names and dates of birth, as shown below.

First column "First name" has filled-in values: "John", "Jane", and "Joe". Second column "Last name" is all blank, as is the third column "Date of birth".

Example table


Tenant

An instance of SideDrawer obtained by an organization/line of business.


Text

see Field

A Plan Item of "field" type that accepts text of up to 255 characters.


To | to

see Reminder

Describes to whom a Reminder is sent.


To do

see Field

A Plan Item of "field" type that sets a "to do" list task.


V

Vault

A Tenant can create a Vault for a Customer, containing their Drawers related to that Tenant.


vCard | vCard

A vCard or Virtual Contact File (VCF) is a file format for electronic contact information.


W

Webhook

Webhook subscriptions ensure that a notification is sent when a certain action occurs with respect to a certain entity. For example, you could create a Webhook that notifies you when someone creates a Folder within a Tenant or Subscription that you own.