Domínios — Assinatura Eletrônica

Usados em Assinatura Eletrônica.

Ao enviar, informe sempre a key. Ao ler, a API devolve CodeKeyName { code, key, name } — ou StatusField nos campos de status.

---

Envelope

SignatureProvider

Campo provider. Diz qual plataforma externa executa a assinatura. Determina qual implementação de ISignatureProvider o resolver escolhe. Padrão internal. Inválido → 1006004.

Code	Key	Nome	Observação
1	internal	Interno	Sem provedor externo: a assinatura é registrada pela própria plataforma. Padrão.
100	qi_sign	QI Sign	QI Tech. Fluxo multi-etapa; biometria facial e prova de vida próprias.
200	clicksign	Clicksign	Requisitos por documento, rubrica posicionada, modelos .docx, observadores.
300	confia	Confia	Chamada única; auditoria detalhada por parte.
400	unico_sign	Unico Sign	Chamada única; assinatura embarcada e código de autenticação pré-definido.
500	docu_sign	DocuSign	Tabs posicionadas por coordenada ou âncora.
999	other	Outro

SignatureFlow

Campo flow. Diz se os signatários assinam em ordem ou ao mesmo tempo. Padrão parallel. Inválido → 1006005.

Code	Key	Nome	Significado
1	sequential	Sequencial	Cada grupo de assinatura só é notificado quando o anterior termina.
2	parallel	Paralelo	Todos são notificados de uma vez. Padrão.

SignatureStatus

Campo status, devolvido como StatusField. Inválido → 1006003.

Code	Key	Nome	Cor	Significado
1	draft	Rascunho	Cinza	Criado e sendo montado. Ainda não existe no provedor. Único estado em que documentos, signatários e requisitos podem ser alterados.
2	running	Em Assinatura	Azul	Enviado ao provedor; signatários notificados.
3	partially_signed	Parcialmente Assinado	Amarelo	Parte dos signatários já assinou.
4	completed	Concluído	Verde	Todos os requisitos cumpridos; dossiês disponíveis.
5	refused	Rejeitado	Vermelho	Algum signatário recusou.
6	canceled	Cancelado	Cinza	Cancelado pela operação. Links invalidados.
7	expired	Expirado	Laranja	Prazo de assinatura vencido.
8	failed	Falha	Vermelho	Erro irrecuperável na comunicação com o provedor.

---

Documento

SignatureDocumentType

Campo documents[].type. Diz que documento jurídico aquele arquivo é. Fica no documento, e não no envelope, porque um envelope pode carregar tipos diferentes — a CCB e o termo de garantia dela. Padrão contract. Inválido → 1006002.

Code	Key	Nome	Quando usar
1	contract	Contrato	Contrato genérico. Padrão.
2	ccb	Cédula de Crédito Bancário	Emissão de CCB.
3	amendment	Aditivo	Alteração de um contrato já assinado.
4	term	Termo	Termo de adesão, de ciência, de quitação.
5	power_of_attorney	Procuração	Outorga de poderes.
6	assignment	Cessão	Cessão de direitos creditórios.
7	receipt	Recibo	Comprovação de recebimento.
8	report	Laudo	Vistoria, avaliação, parecer.
99	other	Outro	Fora da lista.

SignatureDocumentRole

Campo documents[].role. Diz o que aquele arquivo é dentro do envelope. Padrão original. Inválido → 1006014.

Code	Key	Nome	Significado
1	original	Documento Original	O arquivo a ser assinado. É sobre ele que os requisitos incidem. Padrão.
2	signed	Documento Assinado	Versão final, com as assinaturas aplicadas.
3	attachment	Anexo	Acompanha o envelope sem receber assinatura.
4	evidence_report	Dossiê de Evidências	Relatório de autenticidade gerado pelo provedor. Um por documento assinado, ligado por sourceDocumentNid.
10	face_image	Imagem Facial	Selfie capturada do signatário. Sempre com signerNid preenchido.
11	document_front	Documento de Identificação - Frente	RG/CNH, lado da foto. Sempre com signerNid.
12	document_back	Documento de Identificação - Verso	RG/CNH, lado dos dados. Sempre com signerNid.

SignatureDocumentOrigin

Campo documents[].origin. Diz quem produziu o arquivo. Padrão internal. Inválido → 1006015.

Code	Key	Nome	Significado
1	internal	Enviado pelo Sistema	Nós subimos o arquivo ao provedor. Padrão.
2	provider	Coletado pelo Provedor	O provedor capturou na hora da assinatura (selfie, foto do RG) ou gerou (dossiê) e nós baixamos depois.

SignatureDocumentStatus

Campo documents[].status. Existe separado do status do envelope porque a Clicksign permite cancelar ou finalizar um documento sem encerrar os demais.

Code	Key	Nome	Cor	Significado
1	draft	Rascunho	Cinza	Anexado ao envelope, ainda não enviado.
2	running	Em Assinatura	Azul	Aguardando assinaturas.
3	closed	Finalizado	Verde	Todas as assinaturas exigidas foram aplicadas.
4	canceled	Cancelado	Cinza	Retirado do fluxo.

---

Signatário

SignatureSignerAction

Campo signers[].action. Diz o que a pessoa precisa fazer no envelope. Vale para todos os documentos: quem entrou como testemunha é testemunha em tudo. Padrão sign. Inválido → 1006012.

Code	Key	Nome	Significado
1	sign	Assinar	Aplica assinatura. Padrão.
2	approve	Aprovar	Aprova sem assinar.
3	acknowledge	Acusar Recebimento	Confirma ciência.
4	witness	Testemunhar	Corrobora a assinatura de outro signatário.
5	receive_copy	Receber Cópia	Observador: recebe cópia e notificações, não assina. Equivale ao carbonCopies da DocuSign e aos observadores da Clicksign.
6	certified_delivery	Entrega Certificada	Precisa receber e visualizar para o envelope concluir, mas não assina.

SignatureDeliveryChannel

Campos signers[].deliveryChannel (por onde chega o documento), signers[].authDeliveryChannel (por onde chega o token) e requirements[].authenticity.channel (canal em que a assinatura ocorreu). Padrão email. Inválido → 1006013.

Code	Key	Nome
1	email	E-mail
2	sms	SMS
3	whatsapp	WhatsApp
4	link	Link
5	presential	Presencial

SignatureAuthenticationType

Campo signers[].authenticationType. É como a identidade do signatário é comprovada. Vale para todos os documentos do envelope: o mesmo signatário não se autentica de um jeito num documento e de outro jeito em outro. Inválido → 1006018.

Nem todo provedor suporta todos os métodos — a tabela indica a origem de cada um.

Code	Key	Nome	Provedores
1	token_email	Token por E-mail	Todos
2	token_sms	Token por SMS	Todos
3	token_whatsapp	Token por WhatsApp	Clicksign, QI Sign
4	access_code	Código de Acesso	DocuSign, Unico Sign (AuthCode)
5	phone_auth	Autenticação por Telefone	DocuSign
6	kba	Perguntas de Conhecimento	DocuSign
7	idv	Verificação de Identidade	DocuSign
10	handwritten	Assinatura Manuscrita	Clicksign
11	selfie	Selfie	Clicksign, QI Sign
12	liveness	Prova de Vida	Clicksign, QI Sign
13	facial_biometrics	Biometria Facial	Clicksign, QI Sign, Unico
14	identity_biometrics	Biometria de Base Ampliada	Clicksign
15	serpro_biometric	Biometria SERPRO	Clicksign
16	official_document	Documento Oficial com Foto	Clicksign, QI Sign
17	address_proof	Comprovante de Endereço	Clicksign
18	documentscopy	Documentoscopia	Clicksign, Unico
20	icp_brasil	Certificado Digital ICP-Brasil	Clicksign
21	pix	Autenticação via Pix	Clicksign
22	presential	Assinatura Presencial	Clicksign
23	embedded	Assinatura Embarcada	Clicksign, Unico Sign, DocuSign
24	auto_signature	Assinatura Automática	Clicksign

Exclusões do provedor

A Clicksign trata alguns métodos como mutuamente exclusivos — facial_biometrics, serpro_biometric e identity_biometrics não convivem com official_document, liveness ou selfie. A API não valida essas combinações: quem recusa é o provedor, e o erro chega como evento de falha.

SignatureSignerStatus

Campo signers[].status.

Code	Key	Nome	Cor	Significado
1	pending	Pendente	Cinza	Ainda não notificado (envelope em rascunho ou grupo anterior em andamento).
2	sent	Notificado	Azul	Convite enviado.
3	viewed	Visualizado	Azul claro	Abriu o link de assinatura.
4	started	Assinatura Iniciada	Amarelo	Começou o fluxo (autenticação, biometria) sem concluir.
5	signed	Assinado	Verde	Cumpriu todos os requisitos.
6	refused	Recusado	Vermelho	Recusou explicitamente. Ver refusalReason.
7	expired	Expirado	Laranja	Prazo individual (expiresAt do signatário) vencido.
8	removed	Removido	Cinza	Retirado do envelope antes de assinar.

SignatureLivenessResult

Campo signers[].biometry.livenessResult. Resultado da prova de vida.

Code	Key	Nome	Significado
1	live	Prova de Vida Aprovada	Pessoa real diante da câmera.
2	spoof	Prova de Vida Reprovada	Indício de foto, vídeo ou máscara.
3	inconclusive	Inconclusivo	Captura insuficiente para veredito.

SignatureBiometryProvider

Campo signers[].biometry.faceProvider. Quem executou a validação facial — nem sempre é o mesmo provedor de assinatura.

Code	Key	Nome
1	qitech	QI Tech
2	unico	Unico
3	serpro	SERPRO
4	clicksign	Clicksign
99	other	Outro

---

Requisito

SignatureSignerRole

Campo requirements[].role. É a qualificação jurídica do signatário naquele documento: com que título ele assina. Fica no requisito, e não no signatário, porque a mesma pessoa pode ser devedora na CCB e caucionante no termo de garantia do mesmo envelope. Padrão party. Inválido → 1006017.

O vocabulário segue a lista de qualificações da Clicksign, a mais completa entre os provedores integrados, e já cobre CCB, aval, cessão e consignado.

Code	Key	Nome
1	party	Parte
2	issuer	Emitente
3	debtor	Devedor
4	joint_debtor	Devedor Solidário
5	creditor	Credor
6	guarantor	Avalista
7	surety	Fiador
8	guarantor_spouse	Cônjuge do Fiador
9	secured	Afiançado
10	co_responsible	Responsável Solidário
11	collateral_provider	Caucionante
12	witness	Testemunha
13	intervening	Interveniente
14	consenting_intervenor	Interveniente Anuente
15	intervening_guarantor	Interveniente Garantidor
16	consenting	Anuente
17	consented	Anuído
18	transferor	Cedente
19	transferee	Cessionário
20	endorser	Endossante
21	endorsee	Endossatário
22	lender	Mutuante
23	borrower	Comodatário
24	comforter	Comodante
25	consignee	Consignatário
26	pledged	Consignado
27	contractor	Contratante
28	contractee	Contratada
29	buyer	Parte Compradora
30	seller	Parte Vendedora
31	lessor	Locador
32	lessee	Locatário
33	grantor	Outorgante
34	grantee	Outorgado
35	attorney	Procurador
36	legal_representative	Representante Legal
37	legal_guardian	Responsável Legal
38	account_holder	Correntista
39	employer	Empregador
40	employee	Empregado
41	insured	Segurado
42	insurance_broker	Corretor de Seguros
43	broker	Corretor
44	intermediary	Intermediário
45	partner	Sócio
46	administrator	Administrador
47	director	Diretor
48	president	Presidente
49	manager	Gestor
50	lawyer	Advogado
51	accountant	Contador
52	validator	Validador
53	approver	Aprovador
54	observer	Observador
99	other	Outro

SignatureInitialsType

Campo requirements[].initialsType. Diz se aquele signatário precisa rubricar o documento, além de assinar. Padrão none. Inválido → 1006019.

Code	Key	Nome	Significado
1	none	Sem Rubrica	Só a assinatura. Padrão.
2	typed_initials	Iniciais	Rubrica eletrônica com as iniciais do nome.
3	handwritten	Manuscrita	Rubrica desenhada com mouse, touchpad ou tela.

SignatureRequirementStatus

Campo requirements[].status.

Code	Key	Nome	Cor	Significado
1	pending	Pendente	Cinza	Ainda não cumprido.
2	fulfilled	Cumprido	Verde	Atendido. fulfilledAt preenchido.
3	refused	Recusado	Vermelho	O signatário recusou ou falhou na autenticação.
4	waived	Dispensado	Azul	Dispensado pela operação sem cumprimento.

---

Evento

SignatureEventType

Campo events[].eventType. Classifica o que aconteceu na trilha de auditoria. Inválido → 1006028.

Os códigos 30 a 36 existem porque, sem eles, um envelope travado fica indefinidamente em running sem que ninguém saiba o motivo.

Code	Key	Nome	Quando ocorre
1	created	Criado	Envelope criado.
2	document_added	Documento Adicionado	Arquivo anexado.
3	signer_added	Signatário Adicionado	Pessoa incluída.
4	signer_removed	Signatário Removido	Pessoa retirada antes de assinar.
5	sent	Enviado para Assinatura	Envelope ativado no provedor.
6	notified	Signatário Notificado	Convite ou reenvio disparado.
7	link_accessed	Link de Assinatura Acessado	Signatário abriu o link.
8	viewed	Documento Visualizado	Signatário abriu o documento.
9	signature_started	Assinatura Iniciada	Fluxo de assinatura começou.
10	signed	Assinado	Assinatura aplicada.
11	refused	Recusado	Signatário recusou.
12	document_closed	Documento Finalizado	Documento pronto para download.
13	completed	Concluído	Envelope inteiro concluído.
14	canceled	Cancelado	Cancelado pela operação.
15	expired	Expirado	Prazo vencido.
16	deadline_reached	Prazo Atingido	Data limite atingida.
17	failed	Falha no Processamento	Erro no provedor.
30	liveness_refused	Prova de Vida Recusada	A prova de vida reprovou.
31	facematch_refused	Biometria Facial Recusada	O rosto não bateu com o documento.
32	biometric_refused	Biometria SERPRO Recusada	A consulta à base SERPRO reprovou.
33	identity_biometrics_refused	Biometria de Base Ampliada Recusada	Recusada, inconclusiva ou não validada.
34	documentscopy_refused	Documentoscopia Recusada	Documento apresentado reprovado.
35	ocr_refused	OCR Recusado	Leitura do documento falhou.
36	attempts_exceeded	Tentativas Excedidas	Limite de tentativas de token ou biometria atingido.
99	other	Outro	Evento do provedor sem correspondência canônica. O original fica em externalEventType.

SignatureEventSource

Campo events[].source. Diz como soubemos do evento. Inválido → 1006029.

Code	Key	Nome	Significado
1	internal	Interno	Gerado pela própria plataforma (criação, envio, cancelamento).
2	webhook	Webhook	Recebido do provedor por notificação.
3	polling	Consulta	Descoberto ao consultar o provedor ativamente.

---

Outros domínios usados

Campo	Domínio	Página
signers[].documentType	PersonDocumentType	Pessoas
documents[].feature	Feature	Módulo do registro que o documento atesta. Não é lista fixa deste módulo.