v1

latestOpenAPI 3.1.02026-07-24560263.9 KB

Criar Requisito de Autenticação

Criar Requisito de Autenticaçã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/{envelopeid}/requirements

Path parameters

envelopeidstring 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": "620221cd-f08b-44ee-a128-b892c89d1c7e",
    "type": "requirements",
    "links": {
      "self": "https://sandbox.clicksign.com/api/v3/envelopes/5900df2b-2677-43cd-8379-07b42688245f/requirements/620221cd-f08b-44ee-a128-b892c89d1c7e"
    },
    "attributes": {
      "action": "provide_evidence",
      "auth": "email",
      "created": "2024-03-21T10:19:07.799-03:00",
      "modified": "2024-03-21T10:19:07.799-03:00"
    }
  }
}