Criar Requisitos Autenticação Tokenless

POST Criar Requisitos Autenticação Tokenless

📘
Criação do requisito de autenticação embedded_signature para o signatário. Esta é uma requisição POST para /api/v3/envelopes/{envelope_id}/requirements.

Atributo	Descrição	Exemplo
`action` Obrigatório	Ação que será executada pelo requisito. Deve ser `provide_evidence` para evidência presencial.	provide_evidence
`auth` Obrigatório	Tipo de autenticação a ser utilizado. Deve ser `embedded_signature` para assinatura embedded.	embedded_signature
`relationships.document` Obrigatório	Relacionamento com o documento. Deve conter o `document_key` do documento criado.	Ver estrutura abaixo
`relationships.signer` Obrigatório	Relacionamento com o signatário. Deve conter o `signer_key` do signatário criado.	Ver estrutura abaixo

Exemplo de solicitação HTTP

HEADER

POST /api/v3/envelopes/{envelope_id}/requirements HTTP/1.1
Host: sandbox.clicksign.com
Authorization: Bearer {access_token}
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

BODY

{
  "data": {
    "type": "requirements",
    "attributes": {
      "action": "provide_evidence",
      "auth": "embedded_signature"
    },
    "relationships": {
      "document": {
        "data": { 
          "type": "documents", 
          "id": "{document_key}" 
        }
      },
      "signer": {
        "data": { 
          "type": "signers", 
          "id": "{signer_key}" 
        }
      }
    }
  }
}

Exemplo de resposta HTTP (201)

{
  "data": {
    "type": "requirements",
    "id": "{requirement_key}",
    "attributes": {
      "action": "provide_evidence",
      "auth": "embedded_signature"
    },
    "relationships": {
      "document": {
        "data": {
          "type": "documents",
          "id": "{document_key}"
        }
      },
      "signer": {
        "data": {
          "type": "signers",
          "id": "{signer_key}"
        }
      }
    }
  }
}


Formatei seguindo o mesmo padrão:
- Callout explicativo no topo
- Tabela HTML com os atributos principais
- Seção "Exemplo de solicitação HTTP" com HEADER e BODY separados
- "Exemplo de resposta HTTP (201)" com a estrutura esperada de retorno

Updated 6 days ago