Referência dos campos do documento

Esta página lista os campos que você pode enviar em POST /api/documents: os dados do participante, as opções de cada participante e as opções do documento. Para criar um documento passo a passo, veja Criar documentos.

O participante (user)

Campo	Descrição
name	Nome do participante, até 200 caracteres.
email	E-mail do participante.
identifier	Identificador principal do participante, por exemplo o CPF.
identifierType	Tipo do identificador principal (veja a tabela abaixo).
identifiers	Lista de identificadores, cada um com type e value. Só vale quando a instância permite vários identificadores por usuário.
phone	Celular no formato internacional, por exemplo +55 11 91234-5678. O Signer só usa o telefone se o usuário ainda não existe: ele não altera o telefone de um usuário que já existe.

Os tipos de identificador (identifierType e identifiers[].type) são:

Tipo	Documento
Cpf	CPF (Brasil)
EcuadorBceId	Identificador do Equador
ParaguayCedulaIdentidad	Cédula de Identidad (Paraguai)
ParaguayRuc	RUC (Paraguai)
ParaguayPassport	Passaporte paraguaio
Passport	Passaporte de qualquer país
Ssn, Itin, Ein	SSN, ITIN e EIN (Estados Unidos). Disponíveis a partir da versão 3.0.0.

A instância define quais tipos aceita. Para saber como o Signer usa o identificador e o e-mail para encontrar o usuário, e como funcionam os vários identificadores e os signatários estrangeiros, veja Identificação de participantes. Para cadastrar identificadores de um usuário que já existe, veja Contatos e identificadores.

Opções do participante

Além de type, step e user, cada item de flowActions aceita estas opções:

Campo	Descrição
title	Título do participante no documento, por exemplo "Parte" ou "Testemunha".
disableRefusal	Se true, o participante não pode recusar o documento. A tela não mostra a opção de recusa, e a API de recusa rejeita o pedido. O padrão é false.
notificationLanguage	Idioma das notificações deste participante: Pt, En ou Es. Veja Notificações.
signatureInitialsMode	Rubrica do participante: None (sem rubrica), Optional ou Required.
requiredCertificateTypeToSign	Tipo de certificado que o participante deve usar: A1, A2, A3, A4, S1, S2, S3, S4, T3 ou T4.
requiredCertificateHolderTypeToSign	Titular do certificado: Individual (pessoa física, por exemplo e-CPF) ou Company (pessoa jurídica, por exemplo e-CNPJ).
requiredCompanyIdentifier	CNPJ que o certificado de pessoa jurídica deve ter.
requireCompanyCertificate	Obsoleto. Use requiredCertificateHolderTypeToSign com Company.
allowIdrcSignature	Se true, o participante pode escolher entre a assinatura com o IdRC e a assinatura com certificado. Só vale se a instância tem o IdRC habilitado.

As opções abaixo só valem quando allowElectronicSignature é true. Cada uma exige uma verificação a mais antes da assinatura eletrônica:

Campo	O participante deve
requireSmsAuthenticationToSignElectronically	Informar um código enviado por SMS.
requireWhatsappAuthenticationToSignElectronically	Informar um código enviado por WhatsApp.
requireAuthenticatorAppToSignElectronically	Informar uma senha de uso único (OTP) de um aplicativo autenticador.
requireSelfieAuthenticationToSignElectronically	Tirar uma selfie.
requireDatavalidAuthenticationToSignElectronically	Tirar uma selfie, que o Datavalid do SERPRO valida.
requirePixAuthenticationToSignElectronically	Pagar um Pix.
requireLivenessAuthenticationToSignElectronically	Fazer uma prova de vida.
requireIdScanAuthenticationToSignElectronically	Fotografar um documento com foto.
disableEmailAuthenticationToSignElectronically	Não precisa informar o código enviado por e-mail. Só é aceito se o SMS ou o WhatsApp também é exigido.

Opções do documento

Estes campos opcionais de POST /api/documents valem para todos os documentos da requisição:

Campo	Descrição
notifiedEmailsData	Lista de e-mails que recebem o aviso de documento concluído. Cada item tem email e notificationLanguage (Pt, En ou Es). Sem idioma, o Signer usa o idioma padrão da instância. Use este campo no lugar de notifiedEmails, que é obsoleto.
timestampEnabled	Substitui a configuração de carimbo do tempo da organização para este documento. true aplica o carimbo do tempo em todas as assinaturas, e false em nenhuma. Sem o campo, vale a configuração da organização. Se a instância não tem carimbador, a criação é rejeitada.
signerPositioningEnabled, automaticSignaturePositioning	Veja Posicionamento da assinatura pelo signatário.
overrides	Ignora, só nesta requisição, uma exigência da organização: disableTagRequirement (tag obrigatória), disableRegisteredTagLabelsRequirement (só tags cadastradas) e disableRequireFolderOnDocumentCreation (pasta obrigatória). Só uma chave de API pode ativar estas opções. Outro tipo de usuário recebe o erro AgentIsNotApplication. Veja as exigências em Configurações da organização pela API.
accessValidationType	Quem pode consultar o documento pelo código de validação. Só tem efeito se a instância habilita a validação de acesso (veja Configurações do Signer). Os valores estão na tabela abaixo. Sem o campo, vale o padrão da instância.

Os valores de accessValidationType são:

Valor	Quem pode consultar o documento
UserIdentifier	Quem informa o identificador (por exemplo o CPF) de um participante do documento.
Login	Qualquer usuário que entrou no Signer (fez login).
ParticipateInOrganization	Um usuário que tem um papel na organização do documento.
HasAccessToDocument	Um usuário que tem acesso ao documento no Signer, ou o criador do documento se ele ainda é membro da organização.
None	Qualquer pessoa, mesmo se a instância exige a validação em todos os documentos.