API Reference
Log In
API Reference

Customer Vaults

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


{
  "name": "Vault",
  "filingCabinetName": "FilingCabinet",
  "owner": {
    "federationId": "",
    "invitationCode": "",
    "openId": "auth0|12345abcde",
    "fullName": "Jane Smith",
    "firstName": "Jane",
    "lastName": "Smith",
    "emailAddress": "[email protected]",
    "brandCode": "mybrand",
    "region": "CA",
    "locale": "en-CA"
  },
  "collaborators": [
    {
      "federationId": "",
      "invitationCode": "",
      "openId": "",
      "fullName": "",
      "firstName": "",
      "lastName": "",
      "emailAddress": "",
      "brandCode": "",
      "region": "",
      "locale": "en-CA"
    }
  ],
  "sidedrawers": [
    {
      "name": "MyDrawer",
      "type": "individual",
      "typeOtherName": "",
      "brandCode": "mybrand",
      "region": "CA",
      "externalKeys": [
        {
          "key": "",
          "value": ""
        }
      ],
      "contributorRole": "",
      "contributorRelation": "",
      "contributorRoleOther": "",
      "predefinedSdOwner": "",
      "applyTemplates": [
        {
          "sidedrawerTemplateId": "",
          "region": "CA",
          "copyRecordsName": true,
          "copyPlanRequests": false,
          "copySidedrawerCollaborators": false
        }
      ]
    }
  ]
}

Customer Vault entity

name string required
Vault name.

filingCabinetName string required
Filing Cabinet name.

owner Federation ID entity required
Vault owner info.

collaborators array of Federation ID entities required
Vault Collaborator info.

sidedrawers array of Drawer Vault entities
List of Drawers.


Federation (federationIds) entity

federationId string
Federation ID.

invitationCode string
Invitation code.

openId string
OpenId.

fullName string
Full name.

firstName string
First name.

lastName string
Last name.

emailAddress string required
Email address.

brandCode string
Branding code.

region string
Region.

locale enum
Locale. Possible values: en-CA, fr-CA, en-US, es-US.


Drawer Vault (sidedrawersVault) entity

name string required
Drawer name.

type string required
Drawer type.

typeOtherName string
Drawer type if type = other.

brandCode string
Branding code.

region string
Data storage region. Possible values: "US", "CA", "EU".

externalKeys array of External Keys entities
Key-value pairs.

contributorRole string required
Contributor role.

contributorRelation enum required
Contributor relationship. 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.

contributorRoleOther string
Contributor role if contributorRole = other.

predefinedSdOwner string
Predefined owner OpenID.

applyTemplates array of Drawer Template entities
List of Drawer templates to apply to the new Drawer.


Drawer Template entity

sidedrawerTemplateId string required
Drawer template ID.

region string
Drawer template region. Possible values: "US", "CA", "EU".

copyRecordsName boolean
True if Folder names should be copied over.

copyPlanRequests boolean
True if Plan Requests should be copied over.

copySidedrawerCollaborators boolean
True if Drawer Collaborators should be copied over. Default: false.