Custom document data (metadata) (API)

You can store custom data with a document — for example an order ID, a note, or anything from your system. Signi doesn't process it in any way, it just keeps it and returns it to you. Ideal for matching a document in Signi with a record on your side.

How to do it

When creating a document, add the metadata field. The value must be JSON (written as text with escaped quotes) — the individual items are then displayed in the Signi app in the document overview as well as in the document detail, each separately:

{
    "people": [
        { "is_proposer": true, "email": "vas@email.cz", "contract_role": "approve" },
        { "is_proposer": false, "email": "protistrana@email.cz", "contract_role": "sign",
          "first_name": "Jan", "last_name": "Novák", "person_type": "nature",
          "positions": [ { "x": 50, "y": 80, "page": 0 } ] }
    ],
    "metadata": "{\"poznámka\": \"nějaká dlouhá poznámka s hodně slovy.\",\"barva\": \"modrá\",\"velikost bot\": \"34\"}",
    "file": "uploaded_file_key"
}

Where you get it back

In the document detail via API:

curl -H "x-api-key: VAS_API_KLIC" https://api.signi.com/api/v1/contract/ID_DOKUMENTU

{
    "contract_id": "1234567",
    "contract_name": "Smlouva o dílo",
    "state": "pending",
    "metadata": "{\"poznámka\": \"nějaká dlouhá poznámka s hodně slovy.\",\"barva\": \"modrá\",\"velikost bot\": \"34\"}"
}

And in the Signi app — in the document overview and in the document detail, broken down into individual items.

Where to next

• JSON for creating a document — overview of all fields
• Document lifecycle