Finalizar documento

📘
Requisição para finalização dos documentos na Clicksign. Após a finalização do documento, não poderão ser realizadas novas assinaturas. Esse é uma requisição PATCH para /api/v1/documents/:key/finish, sendo :key a chave do documento na Clicksign.

PATCH /api/v1/documents/:key/finish?access_token={{access_token}} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/json
Accept: application/json

❗️
Se a requisição para a Clicksign falhar
Sempre verifique o BODY da resposta. O retorno da requisição mostrará o motivo pelo qual a requisição não foi aceita pelos servidores da Clicksign. Confira mais detalhes em Mensagens de erro.

Exemplo completo

Request

PATCH /api/v1/documents/c0e4796b-a342-43ef-b682-e4985d822e05/finish?access_token={{access_token}} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/json
Accept: application/json

Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "document": {
    "key": "c0e4796b-a342-43ef-b682-e4985d822e05",
    "path": "/Contrato de Prestação de Serviços-123.pdf",
    "filename": "Contrato de Prestação de Serviços-123.pdf",
    "uploaded_at": "2018-06-24T14:15:57.630Z",
    "updated_at": "2018-06-24T15:16:14.990Z",
    "finished_at": "2018-06-24T15:16:14.761Z",
    "deadline_at": "2018-09-20T02:59:00.000Z",
    "status": "closed",
    "auto_close": false,
    "locale": "pt-BR",
    "block_after_refusal": true,
    "downloads": {
      "original_file_url": "https://clicksign-content-sandbox.s3.amazonaws.com/2018/06/24/14/15/57/12404274-1456-4d2e-8b74-524a5738ef45/file.pdf?X-Amz-Expires=302&X-Amz-Date=20180624T151613Z&X-Amz-Security-Token=FQoDYXdzEHcaDPlTeYgvR7eSWVZwEiK3AxK7PYweRTEw/mbWd72M/boGX9YM2WJL1SDZDsxwdBmol2ufYhOP3Z3Ogl9zBOgVl04/NsBt9nKJteB2O9IFFW8TNVmr4ET2Wbpu%2BPGppM73lHvN76p%2B0FsydTFIEdRVngUkUw9AL3vhF37fs1CgV9E5I%2BFb/fQ90PalYxnBl70cCB56plGKaqhm%2BSIkx0utIbhtS/9Kn7oRzmVQuyfZxKn8Yp76ZZGe605VTBw5qh8nBv0x0GpN8ZVUBt4q4ifT4TzTXuu0KG90w/SzN7NiAu1BMVWMOVBh1v/huiG51lwhO%2BOKEsum01TpgOxL%2BkeBpTqm0MVOcyEdn/pyLmoGoU8J6%2B235I0%2BHsJgH29tnA1oKYvaK6%2BOWmtttHkkOY2CAxp6w8E0sIs6vF4oVYu4mCTszoCw8C8SZHkvjGnyNxsRMDq2nzq6ZELZD8cedDm%2BfmFmOLR1Phkq8SeJxIL3h4u5zqxMQ5yMBozUGXczktjU0v3WdIhex45C0ND16ZzZU87JOX5qdBlH5ftLzBk9YN2x78C9FFZuSei0csg6CVVjxoBmgFaF38Q0LDgxPbVhpYIZNwxl/tAohsi%2B2QU%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAII6GUYBPA6YHE3BA/20180624/us-east-1/s3/aws4_request&X-Amz-SignedHeaders=host&X-Amz-Signature=bf1a9e6065b4c7d5c4df4de52e61b75f4469ec56756369018540c5f2a4b8113b"
    },
    "signers": [
      {
        "key": "4b051286-ca35-4938-ac41-f8a48108cad7",
        "email": "[email protected]",
        "name": "Marcos Zumba",
        "has_documentation": true,
        "documentation": "123.321.123-40",
        "birthday": "1983-03-31",
        "phone_number": "11999999999",
        "sign_as": "sign",
        "url": "https://sandbox.clicksign.com/sign/4b051286-ca35-4938-ac41-f8a48108cad7",
        "auths": [
          "email"
        ],
        "created_at": "2018-06-24T14:15:57.641Z",
        "signature": {
          "name": "Marcos Zumba",
          "email": "[email protected]",
          "birthday": "1983-03-31",
          "documentation": "123.321.123-40",
          "validation": {
            "status": "pending",
            "name": "Marcos Zumba"
          },
          "ip_address": "200.148.122.227"
        }
      }
    ],
    "events": [
      {
        "name": "close",
        "data": {
          "user": {
            "email": "[email protected]",
            "name": "Ajuda Clicksign"
          },
          "account": {
            "key": "5552e2a8-895f-4f13-afa8-c405f5eb84e4"
          }
        },
        "occurred_at": "2018-06-24T15:16:15.025Z"
      },
      {
        "name": "sign",
        "data": {
          "signer": {
            "name": "Marcos Zumba",
            "documentation": "123.321.123-40",
            "birthday": "1983-03-31",
            "address": "200.148.122.227",
            "key": "4b051286-ca35-4938-ac41-f8a48108cad7",
            "email": "[email protected]",
            "has_documentation": true,
            "created_at": "2018-06-24T11:15:57.641-03:00",
            "sign_as": "sign",
            "auths": [
              "email"
            ],
            "url": "https://sandbox.clicksign.com/sign/4b051286-ca35-4938-ac41-f8a48108cad7"
          },
          "account": {
            "key": "5552e2a8-895f-4f13-afa8-c405f5eb84e4"
          },
          "log_version": "1.6",
          "url": "https://sandbox.clicksign.com"
        },
        "occurred_at": "2018-06-24T15:16:04.564Z"
      },
      {
        "name": "update_auto_close",
        "data": {
          "user": {
            "email": "[email protected]",
            "name": "Ajuda Clicksign"
          },
          "account": {
            "key": "5552e2a8-895f-4f13-afa8-c405f5eb84e4"
          },
          "auto_close": false
        },
        "occurred_at": "2018-06-24T15:12:46.630Z"
      },
      {
        "name": "update_deadline",
        "data": {
          "user": {
            "email": "[email protected]",
            "name": "Ajuda Clicksign"
          },
          "account": {
            "key": "5552e2a8-895f-4f13-afa8-c405f5eb84e4"
          },
          "deadline_at": "2018-09-19T23:59:00.000-03:00"
        },
        "occurred_at": "2018-06-24T15:12:46.586Z"
      },
      {
        "name": "add_signer",
        "data": {
          "user": {
            "email": "[email protected]",
            "name": "Ajuda Clicksign"
          },
          "account": {
            "key": "5552e2a8-895f-4f13-afa8-c405f5eb84e4"
          },
          "signers": [
            {
              "key": "4b051286-ca35-4938-ac41-f8a48108cad7",
              "email": "[email protected]",
              "name": "Marcos Zumba",
              "birthday": "1983-03-31",
              "documentation": "123.321.123-40",
              "has_documentation": true,
              "created_at": "2018-06-24T11:15:57.641-03:00",
              "sign_as": "sign",
              "auths": [
                "email"
              ],
              "url": "https://sandbox.clicksign.com/sign/4b051286-ca35-4938-ac41-f8a48108cad7"
            }
          ]
        },
        "occurred_at": "2018-06-24T14:15:57.727Z"
      },
      {
        "name": "upload",
        "data": {
          "user": {
            "email": "[email protected]",
            "name": "Ajuda Clicksign"
          },
          "account": {
            "key": "5552e2a8-895f-4f13-afa8-c405f5eb84e4"
          },
          "deadline_at": "2018-06-28T14:30:59.000-03:00",
          "auto_close": true,
          "locale": "pt-BR",
          "block_after_refusal": true
        },
        "occurred_at": "2018-06-24T14:15:57.691Z"
      }
    ]
  }
}