Veja a lista de endpoints de signatários

Endpoints Signatários

🚧
Importante
Não esqueça de enviar o tokenAPI e cryptKey em sua requisição.
Ex.: https://secure.d4sign.com.br/api/v1/safes?tokenAPI={SEU-TOKEN}&cryptKey={SEU-CRYPT-KEY}

Listar signatários de um documento

`GET` /documents/{UUID-DOCUMENT}/list

Testar endpoint 🧪

Esse objeto retornará todos os signatários de um documento.

{
    "Content-Type": "application/json"
}

{
    "uuidDoc": "9f08bf18-bf4b-410f-9701-c286e5b1cad1",
    "nameDoc": "teste.pdf",
    "type": "application/pdf",
    "size": "118990",
    "pages": "6",
    "uuidSafe": "06b3ddb1-abc9-4ab8-b944-0d7c940486af",
    "safeName": "Atendimento",
    "statusId": "3",
    "statusName": "Aguardando Assinaturas",
    "statusComment": "Comentário sobre cancelamento",
    "whoCanceled": "E-mail de quem cancelou o documento",
    "list": {
    	"key_signer": "NwYj=",
    	"user_name": "Signatario 1",
    	"user_document": "000000000000 (CPF)",
    	"email": "[email protected]",
    	"signed": "1",
    	"sign_info": {
    		"ip": "192.168.0.1",
    		"ip_reverser": "bfb467a6.virtua.com.br porta: 33421",
    		"geolocation": "-23 -23",
    		"user_agent": "Mozilla",
    		"date_signed": "2038-03-29 11:05:34",
    		"date_signed_atom": "2038-03-29T11:05:34-03:00"
    	},
    	"type": "1",
    	"foreign": "0",
    	"certificadoicpbr": "0",
    	"assinatura_presencial": "0",
    	"assinatura_presencial_link": "LINK PARA ASSINATURA PRESENCIAL" - O link só será exibido depois que o documento for enviado para assinatura,
    	"embed_methodauth": "email",
    	"embed_smsnumber": "",
    	"email_sent": "1",
    	"email_sent_status": "Delivery",
    	"email_sent_message": "Mensagem entregue com sucesso.",
    	"upload_allowed": "0",
    	"upload_obs": "Descricao dos documentos",
    	"documents_attached": "[]",
    	"date": "2016-04-17 13:56:21",
    	"docauth": "1",
    	"docauth_text": "DADOS CAPTURADOS DO DOCUMENTO REGISTRADO (SOLICITE ESSE RECURSO EM NOSSO [email protected])",
    	"password_code": "Código de acesso do signatário"
    	
	}
}

Parâmetro	Descrição
UUID-DOCUMENT (obrigatório)	UUID do documento que deverá ser listado.

Listar Grupos de Assinaturas

`GET` /groups/{UUID-SAFE}

Testar endpoint 🧪

Este método listará todos os grupos de assinatura do cofre

{
    "Content-Type": "application/json"
}

{
    "uuid_grupo": "018715xc-054b-409f-b122-f683951e5460",
    "nome": "Grupo Jurídico"
}

Parâmetro	Descrição
UUID-SAFE (obrigatório)	UUID do COFRE que deverá ser listado.

Cadastrar signatários

`POST`/documents/{UUID-DOCUMENT}/createlist

Testar endpoint 🧪

Esse objeto realizará o cadastro dos signatários do documento, ou seja, quais pessoas precisam assinar esse documento.

{
    "signers" : [
        {
            "email": "[email protected]",
            "act": "1",
            "foreign": "1",
            "certificadoicpbr": "0",
            "assinatura_presencial": "0",
            "docauth": "0",
            "docauthandselfie": "0",
       	    "embed_methodauth": "email",
      	    "embed_smsnumber": "",
      	    "upload_allow": "0",
      	    "upload_obs": "Contrato Social e Conta de Luz",
      	    "whatsapp_number": "+5511981876540" (opcional),
      	    "uuid_grupo": "UUID DO GRUPO" (opcional),
      	    "certificadoicpbr_tipo": "2" (opcional),
      	    "certificadoicpbr_cpf": "CPF" (opcional),
      	    "certificadoicpbr_cnpj": "CNPJ" (opcional),
      	    "password_code": "Código de acesso" (opcional),
      	    "auth_pix": "0" (opcional),
      	    "auth_pix_nome": "Nome do signatário" (opcional),
      	    "auth_pix_cpf": "21917876280" (opcional),
      	    "videoselfie": "0" (opcional),
      	    "d4sign_score": "0" (opcional),
      	    "d4sign_score_nome": "Nome do signatário" (opcional),
      	    "d4sign_score_cpf": "21917876280" (opcional),
      	    "d4sign_score_similarity": "90" (min 70 - max 90),
        },
        {...}
        ]
}

{
    "key_signer": "NwYu=",
    "email": "[email protected]",
    "act": "1",
    "foreign": "0",
    "certificadoicpbr": "0",
    "assinatura_presencial": "0",
    "assinatura_presencial_link": "LINK PARA ASSINATURA PRESENCIAL" - O link só será exibido depois que o documento for enviado para assinatura,
    "doc_auth": "0",
    "embed_methodauth": "email",
    "embed_smsnumber": "",
    "upload_allow": "0",
    "upload_obs": "Contrato Social e Conta de Luz",
    "docauthandselfie": "0",
    "skipemail": "0",
    "whatsapp": "",
    "password_code": "",
    "status": "created"
}

Parâmetro	Descrição
email (obrigatório)	E-mail do signatário
act (obrigatório)	Ação da assinatura. Valores permitidos:<br>1 = Assinar<br>2 = Aprovar<br>3 = Reconhecer<br>4 = Assinar como parte<br>5 = Assinar como testemunha<br>6 = Assinar como interveniente<br>7 = Acusar recebimento<br>8 = Assinar como Emissor, Endossante e Avalista<br>9 = Assinar como Emissor, Endossante, Avalista, Fiador<br>10 = Assinar como fiador<br>11 = Assinar como parte e fiador<br>12 = Assinar como responsável solidário<br>13 = Assinar como parte e responsável solidário
foreign (obrigatório)	Indica se o signatário é estrangeiro. 0 = Possui CPF; 1 = Não possui CPF
foreign_lang	Idioma do estrangeiro: en = Inglês, es = Espanhol, pt = Português
certificadoicpbr (obrigatório)	0 = Assinatura padrão D4Sign<br>1 = Assinatura com Certificado ICP-Brasil
assinatura_presencial (obrigatório)	1 = Assinatura presencial<br>0 = Não presencial
docauth (opcional)	1 = Exige documento com foto<br>0 = Não exige
docauthandselfie (opcional)	1 = Documento + selfie<br>0 = Não exige selfie
embed_methodauth (opcional)	Método de autenticação: email, password, sms, whats
embed_smsnumber (opcional)	Número do SMS ou WhatsApp no padrão (ex.: +5511953020202)
upload_allow (opcional)	Indica se o signatário pode enviar outros documentos
upload_obs (opcional)	Quais documentos o signatário deve enviar (se upload_allow = 1)
after_position (opcional)	Define a posição após a qual o signatário será inserido na ordem
skipemail (opcional)	1 = Não enviar e-mails ao signatário
whatsapp_number (opcional)	Número de WhatsApp para assinatura
uuid_grupo (opcional)	UUID do grupo de assinatura
certificadoicpbr_tipo (opcional)	1 = Qualquer certificado<br>2 = e-CPF<br>3 = e-CNPJ
certificadoicpbr_cpf (opcional)	CPF do signatário. Em branco = qualquer e-CPF
certificadoicpbr_cnpj (opcional)	CNPJ do signatário. Em branco = qualquer e-CNPJ
password_code (opcional)	Código de acesso do signatário. Em branco remove código anterior
auth_pix (opcional)	1 = Autenticação via PIX
auth_pix_nome	Nome obrigatório se auth_pix = 1
auth_pix_cpf	CPF obrigatório se auth_pix = 1
sms-number (obrigatório)	NOVO número de SMS do signatário
key-signer	Chave do signatário
videoselfie	1 = Exige vídeo selfie
d4sign_score (opcional)	Ativa D4Sign Score. Requer CNH + docauthandselfie = 1 ou videoselfie = 1
d4sign_score_nome	Nome obrigatório se d4sign_score = 1
d4sign_score_cpf	CPF obrigatório se d4sign_score = 1
d4sign_score_similarity	Nível de similaridade exigida (min: 70, max: 90)

Alterar signatário

`POST`/documents/{UUID-DOCUMENT}/changeemail

Testar endpoint 🧪

Esse objeto atualizará o e-mail do signatário.

{
    "Content-Type": "application/json"
}

{
"email-before": "[email protected]" ou "+5511981764321",
"email-after": "[email protected]" ou "+5511981764321",
"key-signer": "NyWx="
},

{
    "message": "E-mail changed"
}

Parâmetro	Descrição
email-before (obrigatório)	ANTIGO e-mail ou número de WhatsApp do signatário
email-after (obrigatório)	NOVO e-mail ou número de WhatsApp do signatário
key-signer	Chave do signatário (anterior - before)

O "key-signer", é encontrado listando os signatários de um documento.

Alterar número do SMS

`POST`/documents/{UUID-DOCUMENT}/changesmsnumber

Testar endpoint 🧪

Esse objeto atualizará o número do SMS do signatário

{
    "Content-Type": "application/json"
}

{
    "email": "[email protected]",
    "sms-number": "+5511953874555",
    "key-signer": "NyWx="
}

{
    "message": "SMS number changed"
}

Parâmetro	Descrição
email (obrigatório)	E-mail do signatário
sms-number (obrigatório)	NOVO número de SMS do signatário
key-signer	Chave do signatário

Alterar código de acesso do signatário

`POST`/documents/{UUID-DOCUMENT}/changepasswordcode

Testar endpoint 🧪

Esse objeto atualizará o código de acesso do signatário

{
    "Content-Type": "application/json"
}

{
    "email": "[email protected]",
    "password-code": "Código para acessar o documento",
    "key-signer": "NyWx="
}

{
    "message": "Password code changed",
}

Parâmetro	Descrição
email (obrigatório)	E-mail do signatário
password-code	Código para acessar o documento. Deixe em branco para remover o código atual.
key-signer	Chave do signatário

Remover signatário

`POST`/documents/{UUID-DOCUMENT}/removeemaillist

Testar endpoint 🧪

{
    "Content-Type": "application/json"
}

{
    "email-signer": "[email protected]",
    "key-signer": "NyWx="
}

{
    "message": "E-mail has removed"
}

Parâmetro	Descrição
email-signer (obrigatório)	E-mail do signatário
key-signer (obrigatório)	Chave do signatário

Adicionar assinatura posicionada no documento principal ou anexo com pins de rubrica

`POST`/documents/{UUID-MAIN-DOCUMENT}/addpins

Testar endpoint 🧪

Esse objeto irá adicionar uma assinatura a posição que for definida no documento.

{
    "Content-Type": "application/json"
}

{
"pins": [
{ 
"document": "uuid-do-documento",
"email" : "[email protected]",
"page_width": 794,
"page_height":1123,
"page":1,
"position_x":397,
"position_y":560,
"type":0
}
]
}

{
  "message": "success"
}

Parâmetro	Descrição
document (obrigatório)	uuid do doc principal ou slave/anexo
email (obrigatório)	E-mail do signatário que terá o pin adicionado. Ele deve estar já deve ter sido adicionado como signatário no documento.
page_height (obrigatório)	Altura da página do documento em px
page_width (obrigatório)	Largura da página do documento em px
page (obrigatório)	Página que ficará o pin no documento selecionado no parâmetro 1
position_x (obrigatório)	Posição X da assinatura em px
position_y (obrigatório)	Posição Y da assinatura em px
type	0 para assinatura, 1 para rubrica e 2 para selo

Lembrando que o modelo abaixo segue o padrão de uma folha A4 retrato.

*Para saber o uuid do slave, é preciso fazer a seguinte requisição já apresentada anteriormente na documentação:

`GET`/documents/{uuid-main-document}/listslaves

Testar endpoint 🧪

Após a mensagem de sucesso, atualize a tela da viewblob e o pin deve estar na página e posição definida no body da requisição.

Remover assinatura posicionada ao documento

`POST`/documents/{UUID-DOCUMENT}/removepins

Esse objeto irá remover uma assinatura a posição que for definida no documento

{
    "Content-Type": "application/json"
}

{
  "pins": [
    {
      "email": "[email protected]",
      "page": 1,
      "position_x": 30,
      "position_y": 30
    }
  ]
}

{
  "message": "success"
}

Parâmetro	Descrição
email (obrigatório)	E-mail do signatário
page (obrigatório)	A página
position_x (obrigatório)	Posição X da assinatura
position_y (obrigatório)	Posição Y da assinatura

Listar assinaturas posicionadas ao documento

`GET`/documents/{UUID-DOCUMENT}/listpins

Esse objeto irá listar as assinaturas e suas posições em um documento

{
    "Accept": "application/json"
}

{
  "pins": [
    {
      "page_height": "300",
      "page_width": "500",
      "pagina": "1",
      "position_x": "1",
      "position_y": "1",
      "email": "[email protected]"
    }
  ]
}

Cadastrar informações do signatário

`POST`/documents/{UUID-DOCUMENT}/addinfo

Testar endpoint 🧪

🚧
Importante
APENAS PARA ASSINATURA PRESENCIAL

Esse objeto cadastrará as informações (nome, cpf e data de nascimento) no signatário criado. Você poderá utilizar esse objeto para as assinaturas presenciais. Se você souber os dados do signatário, cadastre-os para evitar que o signatário precise informá-los no momento da assinatura.

{
    "Content-Type": "application/json"
}

{
    "key_signer": "NwYj=",
    "email": "[email protected]",
    "display_name": "Nome do Signatário",
    "documentation": "CPF do Signatário",
    "birthday": "Data de Nascimento do Signatário",
    "tokenAPI": "{token-user}"
}

{
    "uuid-doc": 00004fa2-a361-42e3-a923-bb088b1809fe,
    "email": "[email protected]",
    "name": "Nome do signatário",
    "documentation": "CPF do signatário",
    "birthday": "Data de nascimento do signatário",
    "status": "changed"
}

Parâmetro	Descrição
key_signer	Chave do signatário
email (obrigatório)	E-mail do signatário cadastrado
display_name (opcional)	Informar o nome do signatário
documentation (opcional)	Informar o CPF do signatário
birthday (opcional)	Informar a data de nascimento do signatário

Criação de Nomenclatura em Assinar Como

`POST` documents/{UUID-USUARIO}/addsignaturetype

Testar endpoint 🧪

O novo endpoint retorna um número “Act” usado para cadastrar signatários, modificando a descrição da assinatura (Assinar como).

A verificação do uuid do usuário, está disponível em [Verificar usuários.](A verificação do uuid do usuário, está disponível em https://docapi.d4sign.com.br/docs/usu%C3%A1rios)

{
    "tipo": "Testemunha Teste"
}

{
    "act": 373,
    "tipo_assinatura": "Testemunha Teste",
    "sucesso": 1
}

Parâmetros de requisição

Parâmetro	Descrição
tipo	Nome/Título que será adicionado ao Assinar como

Nossa Documentação disponibiliza 13 números de Act:

Após usar o novo Endpoint e gerar um numero de Act (347), deve-se vinculá-lo a um novo signatário usando o endpoint Cadastrar Signatários. Disponível em Cadastro de signatário.

O novo numero de Act é vinculado à plataforma, e não ao usuário. Qualquer conta que queira utilizar o número tem permissão para fazê-lo, contanto que conheça o número que já foi cadastrado.

É possível cadastrar um novo Assinar como que já exista (cadastrar um Nome repetido), e cada vez que o cadastro é realizado ele gera um novo número de Act.

Após cadastrar um novo Act que possua o mesmo nome de um que existia previamente, os dois funcionam normalmente (Não há conflito).

A Act cadastrado deverá estar disponível na plataforma para utilização.

Listar detalhes de Grupo de assinatura

`GET`/groups/{UUID-COFRE}/groupdetails/{UUID-GROUP}

Testar endpoint 🧪

Esse objeto irá listar os detalhes de um grupo de assinatura apenas se o tokenAPI é o dono da conta do uuid_grupo, ou se há algum compartilhamento do grupo no uuid_cofre informado.

{
    "Content-Type": "application/json"
}

{
    "name_group": "[email protected]",
    "group_details": [
        {
            "uuid_conta": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "uuid_grupo": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "email": "[email protected]",
            "tipo_assinatura": "1",
            "certificado_digital": "0",
            "doc_auth": "0",
            "assinatura_presencial": "0",
            "estrangeiro": "0",
            "removido": "0",
            "dt_cadastro": "2024-01-04 11:48:31",
            "desativar_remocao": "0",
            "signatario_editavel": "0",
            "doc_authselfie": "0",
            "sequencia": "1",
            "upload_permitido": "0",
            "upload_obs": null,
            "clausula_destaque": "0",
            "nome_tipo_assinatura": "Assinar"
        },
        {
            "uuid_conta": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "uuid_grupo": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "email": "[email protected]",
            "tipo_assinatura": "1",
            "certificado_digital": "0",
            "doc_auth": "0",
            "assinatura_presencial": "0",
            "estrangeiro": "0",
            "removido": "0",
            "dt_cadastro": "2024-01-04 11:48:41",
            "desativar_remocao": "0",
            "signatario_editavel": "0",
            "doc_authselfie": "0",
            "sequencia": "2",
            "upload_permitido": "0",
            "upload_obs": null,
            "clausula_destaque": "0",
            "nome_tipo_assinatura": "Assinar"
        },
        {
            "uuid_conta": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "uuid_grupo": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "email": "[email protected]",
            "tipo_assinatura": "1",
            "certificado_digital": "0",
            "doc_auth": "0",
            "assinatura_presencial": "0",
            "estrangeiro": "0",
            "removido": "0",
            "dt_cadastro": "2024-01-04 11:49:02",
            "desativar_remocao": "0",
            "signatario_editavel": "0",
            "doc_authselfie": "0",
            "sequencia": "3",
            "upload_permitido": "0",
            "upload_obs": null,
            "clausula_destaque": "0",
            "nome_tipo_assinatura": "Assinar"
        }
    ]
}

Parâmetro	Descrição
uuid-cofre	UUID de algum cofre que esteja compartilhado com o grupo.
uuid-group	UUID do grupo que deseja listar.

Copiar Link de Assinatura

`GET`/documents/{UUID-DOCUMENTO}/signaturelink/{ID_LINKASSINATURA}

Testar endpoint 🧪

Esse objeto irá permitir que o usuário copie o link de assinatura de um signatário específico de um documento específico via API.

{
    "Content-Type": "application/json"
}

{
    "link": "https://sandbox.d4sign.com.br/w/i/{uuid-documento}/xxxxxxxxxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx/xxxx"
}

Parâmetro	Descrição
uuid-documento	UUID do documento
ID_linkassinatura	ID do link de assinatura do signatário que deve assinar (key-signer decodificado em base 64)

O link de assinatura disponível após o envio para o signatário.

Portanto, deve-se trazer um retorno de erro, caso a requisição seja feita em alguma outra fase aonde não exista o link.

Apenas as seguintes permissões podem realizar a consulta:

Dono do cofre;
Permissão administrador, no caso do cofre ser compartilhado;
Permissão padrão, no caso do cofre ser compartilhado.

Inserir pin de rubrica do grupo de assinatura no documento.

Iremos dividir em 3 passos:

Inserir grupos de signatários a um documento;
Listar os grupos adicionados como signatários de um documento para descobrir o e-mail que foi criado para designar esse grupo;
Inserir pins de rubrica da assinatura diretamente vinculados aos grupos inseridos no documento.

Inserir grupos de signatários a um documento;

O primeiro passo é permitir que um grupo de signatário possa ser vinculado a um documento como signatário. As únicas restrições existentes, além das restrições básicas de permissão, são: o documento deve estar na fase de “Aguardando Signatários” e o grupo deve estar disponível para seleção no mesmo cofre onde o documento foi inserido.

Com estas regras satisfeitas, é possível utilizar o endpoint abaixo para inserir um grupo ao documento

`POST`/documents/{UUID-DOCUMENT}/createlist

Testar endpoint 🧪

Esse objeto realizará o cadastro dos signatários do documento, ou seja, quais pessoas precisam assinar esse documento.

{
    "signers" : [
        {
            "email": "[email protected]",
            "act": "1",
            "foreign": "1",
            "certificadoicpbr": "0",
            "assinatura_presencial": "0",
            "docauth": "0",
            "docauthandselfie": "0",
       	    "embed_methodauth": "email",
      	    "embed_smsnumber": "",
      	    "upload_allow": "0",
      	    "upload_obs": "Contrato Social e Conta de Luz",
      	    "whatsapp_number": "+5511981876540"(opcional),
      	    "uuid_grupo": "UUID DO GRUPO" (opcional),
      	    "certificadoicpbr_tipo": "2" (opcional),
      	    "certificadoicpbr_cpf": "CPF" (opcional),
      	    "certificadoicpbr_cnpj": "CNPJ" (opcional)
      	    "password_code": "Código de acesso" (opcional),
      	    "auth_pix": "0" (opcional),
      	    "auth_pix_nome": "Nome do signatário" (opcional),
      	    "auth_pix_cpf": "21917876280" (opcional),
      	    "videoselfie": "0" (opcional),
      	    "d4sign_score": "0" (opcional),
      	    "d4sign_score_nome": "Nome do signatário" (opcional),
      	    "d4sign_score_cpf": "21917876280" (opcional),
      	    "d4sign_score_similarity": "90" (min 70 - max 90),
        },
        {...}
        ]
}

{
    "key_signer": "NwYu=",
    "email": "[email protected]",
    "act": "1",
    "foreign": "0",
    "certificadoicpbr": "0",
    "assinatura_presencial": "0",
    "assinatura_presencial_link": "LINK PARA ASSINATURA PRESENCIAL" - O link só será exibido depois que o documento for enviado para assinatura,
    "doc_auth": "0",
    "embed_methodauth": "email",
    "embed_smsnumber": "",
    "upload_allow": "0",
    "upload_obs": "Contrato Social e Conta de Luz",
    "docauthandselfie": "0",
    "skipemail": "0",
    "whatsapp": "",
    "password_code": "",
    "status": "created"
}

Parâmetro	Descrição
email (obrigatório)	E-mail do signatário
act (obrigatório)	Ação da assinatura. Valores permitidos:<br>1 = Assinar<br>2 = Aprovar<br>3 = Reconhecer<br>4 = Assinar como parte<br>5 = Assinar como testemunha<br>6 = Assinar como interveniente<br>7 = Acusar recebimento<br>8 = Assinar como Emissor, Endossante e Avalista<br>9 = Assinar como Emissor, Endossante, Avalista, Fiador<br>10 = Assinar como fiador<br>11 = Assinar como parte e fiador<br>12 = Assinar como responsável solidário<br>13 = Assinar como parte e responsável solidário
foreign (obrigatório)	Indica se o signatário é estrangeiro. 0 = Possui CPF; 1 = Não possui CPF
foreign_lang	Idioma do estrangeiro: en = Inglês, es = Espanhol, pt = Português
certificadoicpbr (obrigatório)	0 = Assinatura padrão D4Sign<br>1 = Assinatura com Certificado ICP-Brasil
assinatura_presencial (obrigatório)	1 = Assinatura presencial<br>0 = Não presencial
docauth (opcional)	1 = Exige documento com foto<br>0 = Não exige
docauthandselfie (opcional)	1 = Documento + selfie<br>0 = Não exige selfie
embed_methodauth (opcional)	Método de autenticação: email, password, sms, whats
embed_smsnumber (opcional)	Número do SMS ou WhatsApp no padrão (ex.: +5511953020202)
upload_allow (opcional)	Indica se o signatário pode enviar outros documentos
upload_obs (opcional)	Quais documentos o signatário deve enviar (se upload_allow = 1)
after_position (opcional)	Define a posição após a qual o signatário será inserido na ordem
skipemail (opcional)	1 = Não enviar e-mails ao signatário
whatsapp_number (opcional)	Número de WhatsApp para assinatura
uuid_grupo (opcional)	UUID do grupo de assinatura
certificadoicpbr_tipo (opcional)	1 = Qualquer certificado<br>2 = e-CPF<br>3 = e-CNPJ
certificadoicpbr_cpf (opcional)	CPF do signatário. Em branco = qualquer e-CPF
certificadoicpbr_cnpj (opcional)	CNPJ do signatário. Em branco = qualquer e-CNPJ
password_code (opcional)	Código de acesso do signatário. Em branco remove código anterior
auth_pix (opcional)	1 = Autenticação via PIX
auth_pix_nome	Nome obrigatório se auth_pix = 1
auth_pix_cpf	CPF obrigatório se auth_pix = 1
sms-number (obrigatório)	NOVO número de SMS do signatário
key-signer	Chave do signatário
videoselfie	1 = Exige vídeo selfie
d4sign_score (opcional)	Ativa D4Sign Score. Requer CNH + docauthandselfie = 1 ou videoselfie = 1
d4sign_score_nome	Nome obrigatório se d4sign_score = 1
d4sign_score_cpf	CPF obrigatório se d4sign_score = 1
d4sign_score_similarity	Nível de similaridade exigida (min: 70, max: 90)

Conforme imagem acima (onde act significa o tipo de ação que este grupo terá no processo de assinatura, como assinar, aprovar, etc; e uuid_grupo é o uuid do grupo presente no mesmo cofre que este documento, que pode ser consultado a partir de outro endpoint já existente e funcional na documentação:

`GET` /groups/{UUID-SAFE}

Testar endpoint 🧪

Este método listará todos os grupos de assinatura do cofre

{
    "Content-Type": "application/json"
}

{
    "uuid_grupo": "018715xc-054b-409f-b122-f683951e5460",
    "nome": "Grupo Jurídico"
}

Parâmetro	Descrição
UUID-SAFE (obrigatório)	UUID do COFRE que deverá ser listado.

Listar os grupos adicionados como signatários de um documento para descobrir o e-mail que foi criado para designar esse grupo.

Após inserir corretamente um grupo como signatário de um documento, temos que confirmar que o grupo é listado corretamente como signatário através da API. Esta é uma condição essencial para permitir que os pins sejam inseridos no terceiro passo. Utilizando o endpoint abaixo, podemos listar todos os signatários do documento.

`GET` /documents/{UUID-DOCUMENT}/list

Testar endpoint 🧪

Esse objeto retornará todos os signatários de um documento.

{
    "Content-Type": "application/json"
}

{
    "uuidDoc": "9f08bf18-bf4b-410f-9701-c286e5b1cad1",
    "nameDoc": "teste.pdf",
    "type": "application/pdf",
    "size": "118990",
    "pages": "6",
    "uuidSafe": "06b3ddb1-abc9-4ab8-b944-0d7c940486af",
    "safeName": "Atendimento",
    "statusId": "3",
    "statusName": "Aguardando Assinaturas",
    "statusComment": "Comentário sobre cancelamento",
    "whoCanceled": "E-mail de quem cancelou o documento",
    "list": {
    	"key_signer": "NwYj=",
    	"user_name": "Signatario 1",
    	"user_document": "000000000000 (CPF)",
    	"email": "[email protected]",
    	"signed": "1",
    	"sign_info": {
    		"ip": "192.168.0.1",
    		"ip_reverser": "bfb467a6.virtua.com.br porta: 33421",
    		"geolocation": "-23 -23",
    		"user_agent": "Mozilla",
    		"date_signed": "2038-03-29 11:05:34",
    		"date_signed_atom": "2038-03-29T11:05:34-03:00"
    	},
    	"type": "1",
    	"foreign": "0",
    	"certificadoicpbr": "0",
    	"assinatura_presencial": "0",
    	"assinatura_presencial_link": "LINK PARA ASSINATURA PRESENCIAL" - O link só será exibido depois que o documento for enviado para assinatura,
    	"embed_methodauth": "email",
    	"embed_smsnumber": "",
    	"email_sent": "1",
    	"email_sent_status": "Delivery",
    	"email_sent_message": "Mensagem entregue com sucesso.",
    	"upload_allowed": "0",
    	"upload_obs": "Descricao dos documentos",
    	"documents_attached": "[]",
    	"date": "2016-04-17 13:56:21",
    	"docauth": "1",
    	"docauth_text": "DADOS CAPTURADOS DO DOCUMENTO REGISTRADO (SOLICITE ESSE RECURSO EM NOSSO [email protected])",
    	"password_code": "Código de acesso do signatário"
    	
	}
}

Parâmetro	Descrição
UUID-DOCUMENT (obrigatório)	UUID do documento que deverá ser listado.

Inserir pins de rubrica da assinatura diretamente vinculados aos grupos inseridos no documento;

Considerando que, no fluxo normal, precisamos apenas enviar os dados de posicionamento do pin no documento e o e-mail do signatário que será vinculado a este pin, podemos apenas trocar o e-mail pelo email usado como referência ao grupo que obtivemos no passo anterior.

A requisição do endpoint abaixo vai utilizar este email para buscar na lista de signatários se esse pin pode ser inserido e vinculado. Neste caso, conforme observamos nos passos anteriores, o e-mail do pin e o da lista de signatários são iguais.

`POST`/documents/{uuid-document}/addpins

Testar endpoint 🧪

Esse objeto irá adicionar a rubrica do signatário selecionado ao documento anexo.

{
"pins": [
{ 
"document": "uuid_document",
"email" : "[email protected]",
"page_height": 300,
"page_width": 500,
"page":1,
"position_x":30,
"position_y":30
}
]
}

{
    "message": "success"
}

Parâmetro	Descrição
document (obrigatório)	uuid do doc principal ou slave/anexo
email (obrigatório)	E-mail do signatário que terá o pin adicionado. Ele deve estar já deve ter sido adicionado como signatário no documento.
page_height (obrigatório)	Altura da página do documento em mm
page_width (obrigatório)	Largura da página do documento em mm
page (obrigatório)	Página que ficará o pin no documento selecionado no parâmetro 1
position_x (obrigatório)	Posição X da assinatura em mm
position_y (obrigatório)	Posição Y da assinatura em mm

Ao trazer a mensagem de sucesso, o pin de rubrica da assinatura deve estar disponível no documento da plataforma e em sua posição determinada na API.

Replicar posição de assinatura em todas as páginas de um documento e anexo

`POST`/documents/{uuid-document}/addpinswithreplics

Testar endpoint 🧪

Esse objeto irá replicar posições de assinatura em todas as páginas do documento principal e anexos.

{
    "pins": {
        "email": "[email protected]",
        "page_height": "1097px",
        "page_width": "790px",
        "position_x": 360,
        "position_y": 150,
        "type": 1,
        "document_slaves": [
            {
                "uuid": "{uuid-slave}"
            },
            {
                "uuid": "{uuid-slave}"
            }
        ]
    }
}

{
    "message": "success"
}

Parâmetro	Descrição
uuid-document (obrigatório)	uuid do documento principal
email (obrigatório)	E-mail do signatário que terá o pin adicionado. Ele deve estar já deve ter sido adicionado como signatário no documento.
page_height (obrigatório)	Altura da página do documento em px
page_width (obrigatório)	Largura da página do documento em px
position_x (obrigatório)	Posição X da assinatura em mm
position_y (obrigatório)	Posição Y da assinatura em mm
type (opcional)	Escolha qual será o tipo da posição de assinatura - 0:assinatura; 1:rubrica e 2:selo
uuid (opcional)	Caso queira replicar a posição de assinatura também nos arquivos em anexo, adicione o uuid do slave que deseja adicionar.

Ao trazer a mensagem de sucesso, o pin com a posição de assinatura deve estar disponível em todas as páginas do documento da plataforma e em sua posição determinada na API.

Remover posições de assinatura replicadas no documento e anexo

`POST`/documents/{uuid-document}/removepinswithreplics

Testar endpoint 🧪

Esse objeto irá remover as posições de assinatura replicadas no documento principal e anexos.

{
    "pins": {
        "email": "[email protected]",
        "position_x": 360,
        "position_y": 150
    }
}

{
    "message": "success"
}

Parâmetro	Descrição
uuid-document (obrigatório)	uuid do documento principal
email (obrigatório)	E-mail do signatário que terá o pin removido. Ele deve estar já deve ter sido adicionado como signatário no documento.
position_x (obrigatório)	Posição X da assinatura em mm
position_y (obrigatório)	Posição Y da assinatura em mm

Endpoints Signatários

Importante

Listar signatários de um documento

GET /documents/{UUID-DOCUMENT}/list

Listar Grupos de Assinaturas

GET /groups/{UUID-SAFE}

Cadastrar signatários

POST/documents/{UUID-DOCUMENT}/createlist

Alterar signatário

POST/documents/{UUID-DOCUMENT}/changeemail

Alterar número do SMS

POST/documents/{UUID-DOCUMENT}/changesmsnumber

Alterar código de acesso do signatário

POST/documents/{UUID-DOCUMENT}/changepasswordcode

Remover signatário

POST/documents/{UUID-DOCUMENT}/removeemaillist

Adicionar assinatura posicionada no documento principal ou anexo com pins de rubrica

POST/documents/{UUID-MAIN-DOCUMENT}/addpins

GET/documents/{uuid-main-document}/listslaves

Remover assinatura posicionada ao documento

POST/documents/{UUID-DOCUMENT}/removepins

Listar assinaturas posicionadas ao documento

GET/documents/{UUID-DOCUMENT}/listpins

Cadastrar informações do signatário

POST/documents/{UUID-DOCUMENT}/addinfo

Importante

Criação de Nomenclatura em Assinar Como

POST documents/{UUID-USUARIO}/addsignaturetype

Parâmetros de requisição

Listar detalhes de Grupo de assinatura

GET/groups/{UUID-COFRE}/groupdetails/{UUID-GROUP}

Copiar Link de Assinatura

GET/documents/{UUID-DOCUMENTO}/signaturelink/{ID_LINKASSINATURA}

Inserir pin de rubrica do grupo de assinatura no documento.

POST/documents/{UUID-DOCUMENT}/createlist

GET /groups/{UUID-SAFE}

GET /documents/{UUID-DOCUMENT}/list

POST/documents/{uuid-document}/addpins

Replicar posição de assinatura em todas as páginas de um documento e anexo

POST/documents/{uuid-document}/addpinswithreplics

Remover posições de assinatura replicadas no documento e anexo

POST/documents/{uuid-document}/removepinswithreplics

`GET` /documents/{UUID-DOCUMENT}/list

`GET` /groups/{UUID-SAFE}

`POST`/documents/{UUID-DOCUMENT}/createlist

`POST`/documents/{UUID-DOCUMENT}/changeemail

`POST`/documents/{UUID-DOCUMENT}/changesmsnumber

`POST`/documents/{UUID-DOCUMENT}/changepasswordcode

`POST`/documents/{UUID-DOCUMENT}/removeemaillist

`POST`/documents/{UUID-MAIN-DOCUMENT}/addpins

`GET`/documents/{uuid-main-document}/listslaves

`POST`/documents/{UUID-DOCUMENT}/removepins

`GET`/documents/{UUID-DOCUMENT}/listpins

`POST`/documents/{UUID-DOCUMENT}/addinfo

`POST` documents/{UUID-USUARIO}/addsignaturetype

`GET`/groups/{UUID-COFRE}/groupdetails/{UUID-GROUP}

`GET`/documents/{UUID-DOCUMENTO}/signaturelink/{ID_LINKASSINATURA}

`POST`/documents/{UUID-DOCUMENT}/createlist

`GET` /groups/{UUID-SAFE}

`GET` /documents/{UUID-DOCUMENT}/list

`POST`/documents/{uuid-document}/addpins

`POST`/documents/{uuid-document}/addpinswithreplics

`POST`/documents/{uuid-document}/removepinswithreplics