📘
Requisição para a criação 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.

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

Atributos para a criação de signatários

Atributo	Descrição	Exemplo
`auths` Obrigatório	Tipo de autenticação para realizar assinatura. Opções: `email`: envio de token por e-mail. `sms`: envio de token por SMS. `whatsapp`: envio de token por Whatsapp. `pix`: autenticação via transação com Pix, essa opção substitui o Token. (CPF do signatário é obrigatória) Veja mais sobre o Pix como autenticação. `api`: assinatura via API. Consulte Assinar documentos via API. `icp_brasil`: assinatura via certificado digital. Nos campos adicionais `selfie_enabled`, `handwritten_enabled`, `official_document_enabled`, `liveness_enabled`, `facial_biometrics_enabled`, devem ser obrigatoriamente igual a false quando `auths` for igual a `icp_brasil`.Só é permitido enviar uma das opções.	📘
`birthday`	Data de nascimento do signatário. Se este campo for enviado, o signatário não poderá realizar a alteração da data de nascimento no momento da assinatura. O formato deverá ser AAAA-MM-DD. É necessário enviar uma data válida.	1983-03-31
`communicate_by`	Informa como o signatário receberá a solicitação de assinatura e o documento assinado. Opções disponíveis `email` e `whatsapp`. Valor padrão é `email`. O envio dessas notificações possui um custo adicional (por documento) e demanda uma configuração específica na conta. Lembre-se: Notificações de cancelamento de documento só serão enviadas via e-mail.	email
`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
`email`	E-mail do signatário que indica como o notificaremos ou enviaremos o token de autenticação. Campo obrigatório quando `auths` contém "email" ou "api" ou `communicate_by` é igual a "email".	[email protected]
`facial_biometrics_enabled`	Define a solicitação de biometria facial como ponto de autenticação adicional para o signatário. Valor padrão é `false`. Nos campos adicionais `official_document_enabled`, `liveness_enabled` e `selfie_enabled` devem ser obrigatoriamente igual a false quando `facial_biometrics_enabled` for igual a `true`.	true
`handwritten_enabled`	Define a solicitação de assinatura manuscrita como ponto de autenticação no momento da assinatura. Valor padrão é `false`.	true
`has_documentation`	Não solicita os campos CPF e data de nascimento do signatário no momento da assinatura. Útil para signatários que não possuem CPF. Se for `false`, não é possível enviar os campos `documentation` e `birthday`. Valor padrão é `true`. Quando o `auths` escolhido é `icp_brasil`, `pix` ou `facial_biometrics_enabled`, deve estar igual a `true`.	true
`liveness_enabled`	Define a solicitação de selfie dinâmica como ponto de autenticação adicional para o signatário. Valor padrão é `false`.	true
`location_required_enabled`	Determina a necessidade do signatário compartilhar a sua localização para assinar um documento. Se `true`, o signatário é impedido de assinar sem compartilhar a localização. Se `false`, o signatário tem permissão para assinar sem compartilhar a localização. Essa opção não pode ser utilizada quando a assinatura ocorrer por meio de widget para assinatura sem token. Valor padrão é `false`.	true
`name`	Nome completo do signatário. Se este campo for enviado, 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.	Marcos Zumba
`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`.	true
`phone_number`	Número de telefone para o envio do Whatsapp ou SMS. O número de celular deve ter no mínimo 10 dígitos e no máximo 11 dígitos, variando de acordo com a localidade ou o padrão do número. Campo obrigatório se `auths=["sms"]` ou `["whatsapp"]`.	11987654321
`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

❗️
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]",
    "phone_number": "11999999999",
    "auths": [
      "email"
    ],
    "name": "Marcos Zumba",
    "documentation": "123.321.123-40",
    "birthday": "1983-03-31",
    "has_documentation": true,
    "selfie_enabled": false,
    "handwritten_enabled": false,
    "location_required_enabled": false,
    "official_document_enabled": false,
    "liveness_enabled": false,
    "facial_biometrics_enabled": false
  }
}

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": [
      "email"
    ],
    "name": "Marcos Zumba",
    "documentation": "123.321.123-40",
    "birthday": "1983-03-31",
    "phone_number": "11999999999",
    "has_documentation": true,
    "selfie_enabled": false,
    "handwritten_enabled": false,
    "location_required_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"
  }
}