This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock

Create vault

POST

https://api.signater.com/v1/ecm/vaults

Last modified:2026-11-11 04:07:33

Creates a new vault in the system. A vault is a secure storage container used to organize and store templates and envelopes. Vaults can have different access levels: personal vaults, which are accessible only to the user who created them; account vaults, which are accessible to all users within the account; and member based vaults, where access can be granted to specific members, allowing for granular control over who can view or modify the contents. The optional accessPolicy sets, for this vault only, how long completed envelopes stay open to anyone holding their link or QR code and whether signers may request a one-time code afterwards; omitted, the vault follows the account policy. Members may only set a policy as strict as or stricter than the account's (400 with code VaultAccessPolicyExceedsAccount otherwise); setting a policy requires a paid plan (402).

Request

Authorization

Add parameter in header

x-api-token

Example:

x-api-token: ********************

Body Params application/json

Example

{
    "name": "My Vault",
    "description": "My Vault Description",
    "type": "UserAccountGroup",
    "memberIds": [
        "852012cd-6aea-42d3-8428-a10c6dc73a7f",
        "414e5307-4cfb-42ff-8958-1b735a5eabc9"
    ],
    "accessPolicy": null
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://api.signater.com/v1/ecm/vaults' \
--header 'x-api-token: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "My Vault",
    "description": "My Vault Description",
    "type": "UserAccountGroup",
    "memberIds": [
        "852012cd-6aea-42d3-8428-a10c6dc73a7f",
        "414e5307-4cfb-42ff-8958-1b735a5eabc9"
    ],
    "accessPolicy": null
}'

Responses

🟢201Created

application/json

Vault created successfully; the body is the vault as GET /v1/ecm/vaults/{vaultId} answers it

Bodyapplication/json

Example

{
    "id": "17fcfd79-78c4-46e6-8495-f246f398e67c",
    "name": "Example Vault",
    "type": "UserAccount",
    "description": "This is an example of a vault used for demonstration purposes.",
    "accessPolicy": {
        "openDays": 7,
        "allowSignerAccess": true
    },
    "userAccountMembers": [
        {
            "id": "ce41e53f-09f8-4852-9ca7-241a52503088",
            "name": "John Doe",
            "avatar": null
        },
        {
            "id": "e3844c0c-60dc-4773-b02e-f87026b5915e",
            "name": "Jane Smith",
            "avatar": "https://example.com/avatars/janesmith.png"
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠402Forbidden

🟠403Forbidden

🟠429

Modified at 2026-11-11 04:07:33

List template envelopes

Update vault