Start Envelope Signature

Start Signature

Initiates the signing process for an envelope, and upon successful initiation, it provides a signing URL that the recipient can use to access the document for signing.

---

API Description

POST {environment_url}/core/external-api/rest/v1/envelope/{envelope_id}/start-signature

---

Headers

Name	Type	Description
Content-Type*	String	application/json
Authorization*	String	Bearer Access Token Get the access token by calling the Authentication API

---

Path Parameters

Name	Type	Description
envelope_id*	UUID	The envelope ID from Create Envelope API

---

Response Body

Start Signature process initiated successfully

HTTP Status Code: 200

Status : SUCCESS

JSON Response:

{
    "success": true,
    "data": {
        "envelope_id": "{uuid}",
        "envelope_status": "PENDING",
        "signature_links": [
            {
                "email": "[e-mail]",
                "signature_link": "https://sign.vida.id/signEnvelope/{code}"
            },
            {
                "email": "[e-mail]",
                "signature_link": "https://sign.vida.id/signEnvelope/{code}"
            }
        ]
    }
}

Bad Request - envelope in completed state

The envelope is already in signed or completed state.

HTTP Status Code: 400

Status : ERROR

JSON Response

{
    "message": "Unable to execute, the envelope is already in signing or completed state.",
    "code": "ER.10113"
}

Forbidden - Disabled Open API Feature

The Open API 'send' endpoint is not available for use.

HTTP Status Code: 403

Status : ERROR

JSON Response

{
    "message": "Unable to operate via the integration API.",
    "code": "ES.105011"
}

Forbidden

Incase when Envelope authorization is forbidden.

HTTP Status Code: 403

Status : ERROR

JSON Response

{
    "message":"Envelope Authorization Forbidden",
    "code":"MG.10379"
}

Forbidden - Disbale Open API Feature

You cannot use Open API send endpoint

HTTP Status Code: 403

Status : ERROR

{
    "message": "You’re not allowed to send envelopes from VIDA Sign OpenAPI.",
    "code": "AS.11002"
}

---

Get Envelope Signature Links

GET /core/external-api/rest/v1/envelope/{envelope_id}/signature-links

---

Path Parameters

Name	Type	Description
envelope_id*	UUID	The envelope Id.

---

Headers

Name	Type	Description
Content-Type*	String	*/*
Authorization*	String	Bearer Access Token

---

Response Body

Signature link requested successfully

HTTP Status Code: 200

Status : SUCCESS

{
    "success": true,
    "data": {
        "envelope_id": "{uuid}",
        "envelope_status": "PENDING",
        "signature_links": [
            {
                "email": "[e-mail]",
                "signature_link": "https://sign.vida.id/signEnvelope/{code}"
            },
            {
                "email": "[e-mail]",
                "signature_link": "https://sign.vida.id/signEnvelope/{code}"
            }
        ]
    }
}

Bad Request - envelope does not exist

The requested envelope does not exist.

HTTP Status Code: 400

Status : ERROR

{
    "code":"ES.10501",
    "message":"Envelope not found."
}

Forbidden

Incase when Envelope authorization is forbidden.

HTTP Status Code: 403

Status : ERROR

{
    "message":"Envelope Authorization Forbidden",
    "code":"MG.10379"
}