📘
Requisição para permitir a assinatura presencial de signatários na Clicksign. Esta é uma requisição POST para /api/v1/signers. No body, deverão ser enviados os atributos do signatário.
Importante: o passo seguinte precisa ocorrer após a criação do documento. Ver detalhes aqui.

POST /api/v1/signers?access_token={{access_token}} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/json
Accept: application/json

🚧
Atenção
Não é permitido usar assinatura presencial com biometria facial em conjunto ao Widget Embedded nesta versão.

Atributos para cadastrar a assinatura presencial de signatários

Atributo	Descrição	Exemplo
`email` Obrigatório	E-mail do signatário que deverá assinar o documento. Se o campo `delivery` for igual a `email`, o campo `email` se torna obrigatório. Se este campo for enviado, o signatário não poderá realizar a alteração do email no momento da assinatura. Necessário ser um email válido.	[email protected]
`auths` Obrigatório	Tipo de autenticação para realizar assinatura. O valor para autenticação presencial é `presential`.	presential
`name` Obrigatório	Nome completo do signatário. Atenção na grafia do nome, pois o signatário não poderá realizar a alteração do nome no momento da assinatura. Necessário enviar ao menos duas palavras. Não permite o envio de números.	Maria Silva
`has_documentation`	Não é solicitado o campo de CPF para assinatura presencial. Valor padrão é `false`.	true
`documentation`	CPF do signatário. Se este campo for enviado, o signatário não poderá realizar a alteração do CPF no momento da assinatura. Necessário ser um CPF válido.	123.321.123-40
`selfie_enabled`	Define a solicitação de selfie como ponto de autenticação ao signatário no momento da assinatura, utilizando a câmera do dispositivo. Algumas incompatibilidades podem ocorrer como: caso o navegador não tenha suporte ao plugin; dispositivo não possua câmera instalada corretamente ou usuário tenha bloqueado acesso à câmera. Valor padrão é `false`.	true
`handwritten_enabled`	Define a solicitação de assinatura manuscrita como ponto de autenticação no momento da assinatura. Valor padrão é `false`.	false
`official_document_enabled`	Define a solicitação da foto (frente e verso) do documento oficial como ponto de autenticação do signatário no momento da assinatura. Valor padrão é `false`.	false
`liveness_enabled`	Define a solicitação de reconhecimento facial como ponto de autenticação adicional para o signatário. Valor padrão é `false`.	false
`facial_biometrics_enabled`	Define a solicitação de biometria facial como ponto de autenticação adicional para o signatário. Não é permitido usar assinatura com biometria facial em conjunto ao Widget Embedded nesta versão. Valor padrão é `false`. Nos campos adicionais `official_document_enabled`, `liveness_enabled`, devem ser obrigatoriamente igual a `false` quando `facial_biometrics_enabled` for igual a `true`.	false

❗️
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

POST /api/v1/signers?access_token={{access_token}} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/json
Accept: application/json

{
  "signer": {
    "email": "[email protected]",
    "auths": [
      "presential"
    ],
    "name": "Maria Silva",
    "has_documentation": true,
    "documentation": "123.321.123-40",
    "birthday": "1983-03-31",
    "selfie_enabled": "true",
    "delivery": "email"
  }
}

Response

HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8

🚧
Veja em Visualizar signatários a explicação detalhada do JSON de retorno dos signatários.

{
  "signer": {
    "key": "0a122d4c-b3e7-44dc-9e3c-518a30f1ffbf",
    "email": "[email protected]",
    "auths": [
      "presential"
    ],
    "name": "Maria Silva",
    "documentation": "123.321.123-40",
    "birthday": "1983-03-31",
    "has_documentation": true,
    "selfie_enabled": false,
    "handwritten_enabled": false,
    "official_document_enabled": false,
    "liveness_enabled": false,
    "facial_biometrics_enabled": false,
    "created_at": "2020-06-21T16:47:32.123Z",
    "updated_at": "2020-06-21T16:47:32.123Z"
  }
}

📘
Passo 2/3
Vincular os signatários na lista de assinatura presencial