Hiding an attachment from a signer (API)

Sometimes one party shouldn't see a particular document in the set — for example in three-party agreements. Set "is_visible": false for the given person on the attachment, and the attachment will be hidden from them.

Only attachments can be hidden. The main document must always be visible to everyone — is_visible: false for a person on the main document will result in an error.

Example

Two documents in the set; the counterparty should not see the attachment:

{
    "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 } ] }
    ],
    "file": "uploaded_file_key",
    "attachments": [
        {
            "people": [
                { "email": "vas@email.cz", "contract_role": "approve" },
                { "email": "protistrana@email.cz", "contract_role": "sign", "is_visible": false,
                  "positions": [ { "x": 50, "y": 80, "page": 0 } ] }
            ],
            "file": "priloha_1"
        }
    ]
}

curl -X POST "https://api.signi.com/api/v1/contract/" \
  -H "x-api-key: VAS_API_KLIC" \
  -F "data=@dokument.json;type=application/json" \
  -F "uploaded_file_key=@hlavni-dokument.pdf" \
  -F "priloha_1=@priloha.pdf"

The hidden signer won't see the attachment in the signing wizard and won't sign it — they don't appear at all in its list of signers.

Note: even a hidden person must have a role specified on the attachment, and for the sign role also positions — without them the API returns the error "Invalid positions".

Where to go next

• Document with attachments
• Who has already signed