v1

latestOpenAPI 3.1.02026-07-24560263.9 KB

Criar Requisito de Qualificação

Criar Requisito de Qualificação, relacionando um signatário a um documento.<br>Em caso de falhas consulte a <Anchor target="_blank" href="https://developers.clicksign.com/docs/veja-como-funciona-na-pr%C3%A1tica">documentação teórica informando o passo a passo.</Anchor><br>Ainda ficou com dúvidas? <Anchor target="_blank" href="https://www.clicksign.com/suporte">Entre em contato com o suporte.</Anchor>

post/envelopes/{envelope_id}/requirements

Path parameters

envelope_idstring required

ID do Envelope que receberá o requisito

Headers

Authorizationstring required

Access Token gerado pelo gestor da conta

Content-type'application/vnd.api+json' required

Content-type padrão para todas requisições JSON:API

Response

201

Example response

{
  "data": {
    "id": "0cac29fb-f0b0-49cb-a476-f3ea0b28d9aa",
    "type": "requirements",
    "links": {
      "self": "https://sandbox.clicksign.com/api/v3/envelopes/658ab351-0b30-4482-9126-2a12fed5bdba/requirements/0cac29fb-f0b0-49cb-a476-f3ea0b28d9aa"
    },
    "attributes": {
      "action": "agree",
      "role": "sign",
      "created": "2024-03-20T14:48:26.016-03:00",
      "modified": "2024-03-20T14:48:26.016-03:00"
    }
  }
}