View Categories

Envelope info complete

0:00 4:41

This section describes how to retrieve complete information about an envelope using the Signatus 2 API. It provides access to all available details, including documents, participants, statuses, and process-related data, offering a full overview of the envelope and its lifecycle.

Retrieves the complete data for an envelope, including all its documents and associated processes.

Service specifications: #

URL/api/envelope/complete/{id}
MethodGET
AuthenticationBearer access token
Response typeapplication/json

Request description #

Request path variable:

KeyTypeDescription
idpathThe envelope id retrieved from the response body of the Create envelope service
HTTP- Click to view HTTP code snippet 
GET /app/api/envelope/complete/9ec82484-8af0-45ef-9c52-c80895905379 HTTP/1.1
Host: signatus.ana.sk
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJJTGNWSnp4SFkyd1RDcGlLZU5Oa2VmbWZHa1ljUnBtQ1lMMUhsNG13Zm5VIn0.eyJleHAiOjE3NTM5NTIzNzEsImlhdCI6MTc1Mzk1MjA3MSwianRpIjoiYWI1YTJlYmEtNTZkZi00Y2ZkLTkyOGYtMTU3ZWMyYzU1N2RlIiwiaXNzIjoiaHR0cHM6Ly9vYXV0aC5hbmEuc2svcmVhbG1zL1NpZ25hdHVzIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImYzYmUxYTY2LTU1M2YtNGFlOC04OTUyLTY3OGQ4NTU2ZDAxYiIsInR5cCI6IkJlYXJlciIsImF6cCI6InNpZ25hdHVzIiwic2lkIjoiYTczMTkzMmItOTAyNC00ZWU5LWFlOTEtNWZlNTJmYWIzNjliIiwiYWNyIjoiMSIsImFsbG93ZWQtb3JpZ2lucyI6WyIvKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsiUk9MRV9QUk9YWSIsImRlZmF1bHQtcm9sZXMtc2lnbmF0dXMiLCJST0xFX1BPUlRBTCIsIlJPTEVfVVNFUiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoicGhvbmUgZ3JvdXBzIHRlbmFudGlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsInRlbmFudGlkIjoiZGVtbyIsIm5hbWUiOiJQYXZvbCBQdW5hIiwicHJlZmVycmVkX3VzZXJuYW1lIjoiZGVtby5hcGkiLCJnaXZlbl9uYW1lIjoiUGF2b2wiLCJmYW1pbHlfbmFtZSI6IlB1bmEiLCJlbWFpbCI6InBhdm9sLnB1bmFAYW5hc29mdC5jb20ifQ.PP-jqR34m5dLEzpLNKK0hgk2PM9L3Q2WqR9aZjFRRG7mPZJ538gqlyh9WZU8R33njAjIq6Uo4Ty8qTrwGgRrpqnA8lVRvPnKimLzN8qDmAzBE29JxitQ3AYLC4VFpvp2zU0WTugypE84X1Km3Dd5O8efhDe2M41LNtsaT1ys2Y8qZb6dZVkTOexQ2YAqycCE4TCD1bPXYRQzI2miiuiz2Ik0KK-3ommk7C4JM83jw1ZxZF3ZLka7xmILxKZcHqIkahPDltmF-yxox5yPKIwnbbgvu8M8oqgsZp33fEH-6I4p8jInzymDseYze0O0hDdHzb58aV-cmoDXb5YBQ5VDtQ

Response description #

Status codeDescription
200 OKEnvelope metadata
401 UnauthorizedWhen user is not authenticated
403 ForbiddenWhen user lacks required permissions
404 Not FoundIf the envelope with the specified id does not exist.
500 Internal Server ErrorServer processing error

Success response example :

{
    "id": "9ec82484-8af0-45ef-9c52-c80895905379",
    "userId": "demo.api",
    "created": 1753434716882,
    "updated": 1753434716882,
    "state": "ready",
    "envelopetypeid": 4,
    "expirationtime": 1830395240000,
    "extension": {},
    "processes": [
        {
            "id": "48a1aa4f-7951-40e4-9869-50c481e36ad2",
            "userId": "demo.api",
            "created": 1753434716893,
            "updated": 1753434716893,
            "envelopeid": "9ec82484-8af0-45ef-9c52-c80895905379",
            "signer": "user",
            "state": "ready",
            "extension": {},
            "sigtype": "bio",
            "documentsProcess": [
                {
                    "created": 1753434716904,
                    "updated": 1753434716904,
                    "documentid": "948db662-44fa-43db-8811-a5e2f8898890",
                    "processid": "48a1aa4f-7951-40e4-9869-50c481e36ad2",
                    "envelopeid": "9ec82484-8af0-45ef-9c52-c80895905379",
                    "state": "ready",
                    "method": "write",
                    "data": {},
                    "filename": "file1"
                }
            ],
            "envelopetypeid": 4,
            "tenant": "demo"
        }
    ],
    "type": "menu1",
    "folder": "Contract",
    "name": "Contract no. 1245726",
    "source": "api",
    "product": [],
    "contact": {},
    "tenant": "demo",
    "rules": {
        "lang": "en",
        "resulturl": "https://signatus.com"
    }
}

Error response example :

{
    "message": "err.envelope.load",
    "value": ""
}