Adicionar múltiplos requisitos
POST /api/v3/envelopes/{{envelopeid}}/bulk_requirements
Requisição para criar múltiplos requisitos em um envelope na plataforma Clicksign. Um requisito é uma condição que deve ser cumprida por um signatário para que ele possa assinar. Há o requisito de qualificação (que serve para indicar como o signatário deve assinar o documento) e há o requisito de autenticação (que indica a necessidade do signatário enviar uma prova de identidade para assinar). Essa é uma requisição
POSTpara/envelopes/{{envelopeid}}/bulk_requirements, sendo{{envelopeid}}a variávelidgerada na criação do envelope. EmAuthorizationadicione oaccess tokende sua conta. No body, deverão ser enviados os atributos listados abaixo.
POST /api/v3/envelopes/{{envelopeid}}/bulk_requirements HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Authorization: access tokenAtributo de operação
| Atributo | Descrição | Obrigatório |
|---|---|---|
op | A operação a ser realizada. Para adicionar múltiplos requisitos, o valor deve ser add. Esse atributo deve estar incluso no array atomic:operations, conforme o exemplo da request. | Sim |
Tipo de dados
| Atributo | Descrição | Obrigatório |
|---|---|---|
type | Determina o tipo de dados, que aqui deve ser requirements. | Sim |
Atributos do requisito de autenticação
| Atributo | Descrição | Obrigatório | Padrão | Exemplo |
|---|---|---|---|---|
action | Determina a ação que o signatário deve realizar para cumprir o requisito, que aqui deve ser provide_evidence. | Sim | provide_evidence | provide_evidence |
auth | Determina o tipo de autenticação para realizar assinatura. Opções:
| Sim | Sem valor padrão | sms |
Atributos do requisito de qualificação
| Atributo | Descrição | Obrigatório | Padrão | Exemplo |
|---|---|---|---|---|
action | Determina a ação que o signatário deve realizar para cumprir o requisito, que aqui deve ser agree. | Sim | agree | agree |
role | A que título será realizada a assinatura. Opções:
role diferentes. No momento da assinatura, ele realizará todas as assinaturas de uma única vez. | Sim | Sem valor padrão | partner |
Relações do requisito
Para cada requisito adicionado, suas relações devem ser inclusas. Em relationships deve ser indicado o signer e o document, descritos a seguir:
| Atributo | Descrição | Obrigatório | Padrão | Exemplo |
|---|---|---|---|---|
document | Um objeto com as relações do requisito com outros recursos. Em | Sim | Sem valor padrão | { "data": { "type": "documents", "id": "6793c70a-360a-42a8-966c-473998c9a2ed"} } |
signers | Um objeto com as relações do requisito com outros recursos. Em | Sim | Sem valor padrão | { "data": { "type": "signers", "id": "8b3ec0c2-16f8-4fb9-9c2b-cbf51abc9e87"} } |
Se a requisição para a Clicksign falharSempre 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
POST /api/v3/envelopes/{{envelopeid}}/bulk_requirements HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Authorization: access token{
"atomic:operations": [
{
"op": "add",
"data": {
"type": "requirements",
"attributes": {
"action": "provide_evidence",
"auth": "email"
},
"relationships": {
"document": {
"data": { "type": "documents", "id": "72c22af6-5e3a-4789-a273-e4a563f777ff" }
},
"signer": {
"data": { "type": "signers", "id": "555f4d94-8d6b-46b2-b3bd-f52bf0fd8e7f" }
}
}
}
},
{
"op": "add",
"data": {
"type": "requirements",
"attributes": {
"action": "agree",
"role": "party"
},
"relationships": {
"document": {
"data": { "type": "documents", "id": "72c22af6-5e3a-4789-a273-e4a563f777ff" }
},
"signer": {
"data": { "type": "signers", "id": "555f4d94-8d6b-46b2-b3bd-f52bf0fd8e7f" }
}
}
}
}
]
}Response
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json; charset=utf-8{
"atomic:results": [
{
"data": {
"id": "4ba04cd3-effc-42f2-98c6-8ccfb038be83",
"type": "requirements",
"links": {
"self": "https://3.clicksign.dev/api/v3/envelopes/e538b354-cf69-412d-b6ab-014f24440db5/requirements/4ba04cd3-effc-42f2-98c6-8ccfb038be83"
},
"attributes": {
"action": "provide_evidence",
"auth": "email",
"created": "2023-10-23T09:03:42.743-03:00",
"modified": "2023-10-23T09:03:42.743-03:00"
}
}
},
{
"data": {
"id": "16e34166-9652-436d-b56f-1a56163128b8",
"type": "requirements",
"links": {
"self": "https://3.clicksign.dev/api/v3/envelopes/e538b354-cf69-412d-b6ab-014f24440db5/requirements/16e34166-9652-436d-b56f-1a56163128b8"
},
"attributes": {
"action": "agree",
"role": "party",
"rubric_pages": null,
"created": "2023-10-23T09:03:42.780-03:00",
"modified": "2023-10-23T09:03:42.780-03:00"
}
}
}
]
}