Compartilhar via

Dokobit Universal API

A API Universal do Dokobit é uma ferramenta versátil que permite assinar documentos internamente, dentro do sistema e coletar assinaturas de terceiros, fora do sistema, em toda a Europa. A assinatura de documento ocorre em uma assinatura do Dokobit sem conta (em que os participantes convidados podem assinar documentos sem se registrar no portal do Dokobit) com a identidade visual da sua organização.

Esse conector está disponível nos seguintes produtos e regiões:

Service Class Regions
Copilot Studio Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos Standard Todas as regiões dos Aplicativos Lógicos , exceto as seguintes:
     – Regiões do Azure Governamental
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões do Power Apps , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Power Automate Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Dokobit
URL https://support.dokobit.com
Email developers@dokobit.com
Metadados do conector
Publicador Dokobit
Site https://www.dokobit.com/solutions
Política de privacidade https://www.dokobit.com/compliance/privacy-policy
Categorias Produtividade

A API Universal do Dokobit é uma ferramenta versátil que permite assinar documentos internamente, dentro do sistema e coletar assinaturas de terceiros, fora do sistema, em toda a Europa. A assinatura de documento ocorre em uma assinatura do Dokobit sem conta (em que os participantes convidados podem assinar documentos sem se registrar no portal do Dokobit) com a identidade visual da sua organização.

Pré-requisitos

Para usar a API Universal do Dokobit, entre em sales@dokobit.com contato conosco para obter o token de acesso à API.

Como obter credenciais

Entre em contato com nossas Vendas para obter o token de acesso à API

Introdução ao conector

  • A assinatura de documento pode ser iniciada usando ações 'DokobitUniversalAPICreateExternalSigning' ou 'DokobitUniversalAPICreateInternalSigning'. O uso de 'DokobitUniversalAPICreateExternalSigning' enviará um convite de assinatura aos participantes. 'DokobitUniversalAPICreateInternalSigning' gerará uma URL de assinatura na qual os usuários podem ser redirecionados.
  • A assinatura pode ser gerenciada com ações correspondentes, permitindo que você adicione/remova participantes, envie lembretes ou verifique o status de assinatura do documento.
  • Depois que os participantes assinarem o documento, ele poderá ser baixado com ações 'DokobitUniversalAPIDownloadDocumentExternal' ou 'DokobitUniversalAPIDownloadDocumentInternal'.

Problemas e limitações conhecidos

A implementação atual dá suporte à coleta de assinaturas em arquivos PDF e suportada por contêineres ASiCe, ADoc, BDoc ou EDoc.

Erros e soluções comuns

  • O arquivo deve ser fornecido como conteúdo de arquivo codificado em Base64.
  • Se a assinatura de documento 'Type' estiver definida como 'pdf', um único documento PDF será aceito quando a assinatura do documento for iniciada. Para vários arquivos, defina a assinatura 'Type' como 'asice' ou outro formato de contêiner.

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:
Default Parâmetros para criar conexão. Todas as regiões Não compartilhável

Padrão

Aplicável: todas as regiões

Parâmetros para criar conexão.

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome Tipo Description Obrigatório
Chave de API secureString A chave de API para esta api Verdade

Limitações

Nome Chamadas Período de renovação
Chamadas à API por conexão 100 60 segundos

Ações

Adicionar Signatário Externo

Os participantes indicados terão acesso ao documento com a função selecionada.
Adicionar Signatário Interno

Os participantes indicados terão acesso ao documento com a função selecionada.
Assinatura de selo

O documento será lacrado com o selo eletrônico de suas organizações. Entre em contato com nosso suporte developers@dokobit.com para obter um certificado qualificado para selagem.
Atualizar Assinatura Externa

Permite atualizar atributos de uma assinatura de documento existente.
Atualizar Assinatura Interna

Permite atualizar atributos de uma assinatura de documento existente.
Baixar Documento Externo

Baixa o documento assinado.
Baixar Documento Interno

Baixa o documento assinado.
Criar Assinatura Externa

A assinatura externa inicia uma solicitação de assinatura assíncrona do sistema. Nesse caso, o usuário recebe um email para assinatura e você receberá um retorno de chamada assim que assinar o documento.
Criar assinatura interna

A assinatura interna inicia a solicitação de assinatura do sistema. Nesse caso, a URL de assinatura é gerada em que o participante deve ser redirecionado.
e-Delivery

A entrega de documentos é usada para compartilhar documentos com segurança com a API Universal do Dokobit.
Enviar Lembrete

Permite enviar um email de lembrete para o participante, somente se a pessoa ainda não tiver assinado o documento. Só funciona com o fluxo de assinatura externo.
Excluir Assinatura Externa

O documento será removido da conta do proprietário. Ele permanecerá acessível a outros participantes.
Excluir Assinatura Interna

O documento será removido da conta do proprietário. Ele permanecerá acessível a outros participantes.
Excluir Signatário Externo

O acesso ao documento será revogado para o participante indicado.
Excluir Signatário Interno

O acesso ao documento será revogado para o participante indicado.
Validation

O Dokobit é um provedor de serviços certificado pelo eIDAS para validações qualificadas de assinatura e selo eletrônico. Use essa ação para carregar um arquivo assinado para validação. Tipos de arquivo com suporte: asice, , asics, sce, bdoc, edoc, , pdf, p7s, xml.
Validação – Dados de Diagnóstico XML

Baixe dados de diagnóstico em XML.
Validação – Relatório PDF

Baixe o relatório de validação em PDF.
Validação – Relatório PDF detalhado

Baixe o relatório de validação detalhado em PDF.
Validação – Relatório XML

Baixe o relatório de validação no XML.
Verificar o status da assinatura externa

Retorna as informações do documento com o status de assinatura.
Verificar o status da assinatura interna

Retorna as informações do documento com o status de assinatura.

Adicionar Signatário Externo

ID da operação:
DokobitUniversalAPIAddExternalSigner

Os participantes indicados terão acesso ao documento com a função selecionada.

Parâmetros

Nome Chave Obrigatório Tipo Description
Token de assinatura
 token True string

Token de assinatura.
ID externa
 external_id True string

Identificador aleatório exclusivo do participante do seu sistema. Você pode gerar identificadores aleatórios exclusivos se não tiver um.
Nome
 name string

Nome do participante.
Surname
 surname string

Sobrenome do participante.
Email
 email string

Email do participante.
Code
 code string

Código do participante.
Código do país
 country_code string

Código do país do participante. Obrigatório se o código pessoal for fornecido. Valores disponíveis: LT, , LV, EE, IS, NO, , FI, BE, . SE
Função
 role string

Função do participante. Valores disponíveis: signer, viewer. Padrão: signer.
Empresa
 company string

Empresa do participante.
Cargo
 position string

Posição do participante.
Telefone
 phone string

Telefone do participante.
Motivo Personalizado
 custom_reason string

Motivo da assinatura personalizada.
Idioma de notificações
 notifications_language string

Define o idioma das notificações. Valores disponíveis: en, , lt, lv, et, is, no, , fr, se, , de, , fi, dk, nl.
Página
 page string

Índice de página para anotação de assinatura pdf visível. Aplicável somente à assinatura de tipo PDF. Padrão: 1.
Posição da parte superior
 top string

Posição (em pontos) da parte superior para anotação de assinatura PDF visível. Aplicável somente à assinatura de tipo PDF. Padrão: 1.
Posição da esquerda
 left string

Posição (em pontos) da esquerda para anotação de assinatura PDF visível. Aplicável somente à assinatura de tipo PDF. Padrão: 1.
Linguagem
 language string

Linguagem de anotação de assinatura PDF visível. Aplicável somente à assinatura de tipo PDF. Valores disponíveis: en, , lt, lv, et, is
Comment
 comment string

Mensagem para os participantes.

Retornos

Nome Caminho Tipo Description
Situação
 status string

Status.
Signatários
 signers array of object

Informações do participante.
ID externa
 signers.external_id string

Identificador aleatório exclusivo do participante do seu sistema.
Símbolo
 signers.token string

Token do participante.
Nome
 signers.name string

Nome do participante.
Surname
 signers.surname string

Sobrenome do participante.
Email
 signers.email string

Email do participante.
Code
 signers.code string

Código pessoal do participante (número da ID nacional).
Código do país
 signers.country_code string

País do participante.
Função
 signers.role string

Função do participante.
Empresa
 signers.company string

Empresa do participante.
Cargo
 signers.position string

Posição do participante.
Idioma de notificações
 signers.notifications_language string

Define o idioma das notificações. Valores disponíveis: en, , lt, lv, et, is, no'fr', 'se', 'de'.
Telefone
 signers.phone string

Telefone do participante.

Adicionar Signatário Interno

ID da operação:
DokobitUniversalAPIAddInternalSigner

Os participantes indicados terão acesso ao documento com a função selecionada.

Parâmetros

Nome Chave Obrigatório Tipo Description
Token de assinatura
 token True string

Token de assinatura.
ID externa
 external_id True string

Identificador aleatório exclusivo do participante do seu sistema. Você pode gerar identificadores aleatórios exclusivos se não tiver um.
Função
 role string

Função do participante. Valores disponíveis: signer, viewer. Padrão: signer.
Code
 code string

Código do participante.
Código do país
 country_code string

Código do país do participante. Obrigatório se o código pessoal for fornecido. Valores disponíveis: LT, , LV, EE, IS, NO, , PL, FI, , BE, SE.
Telefone
 phone string

Telefone do participante.
Idioma de notificações
 language string

Define o idioma da interface do usuário. Valores disponíveis: en, , lt, lv, et, is, no, , fr, se, , de, , fi, dk, nl.
Página
 page string

Índice de página para anotação de assinatura pdf visível. Aplicável somente à assinatura de tipo PDF. Padrão: 1.
Posição da parte superior
 top string

Posição (em pontos) da parte superior para anotação de assinatura PDF visível. Aplicável somente à assinatura de tipo PDF. Padrão: 1.
Posição da esquerda
 left string

Posição (em pontos) da esquerda para anotação de assinatura PDF visível. Aplicável somente à assinatura de tipo PDF. Padrão: 1.
Linguagem
 language string

Linguagem de anotação de assinatura PDF visível. Aplicável somente à assinatura de tipo PDF. Valores disponíveis: en, , lt, lv, et, is
Motivo Personalizado
 custom_reason string

Motivo da assinatura personalizada.

Retornos

Nome Caminho Tipo Description
Situação
 status string

Status.
Signatários
 signers array of object

Informações do participante.
ID externa
 signers.external_id string

Identificador aleatório exclusivo do participante do seu sistema.
Símbolo
 signers.token string

Token do participante.
Nome
 signers.name string

Nome do participante.
Surname
 signers.surname string

Sobrenome do participante.
Email
 signers.email string

Email do participante.
Code
 signers.code string

Código pessoal do participante (número da ID nacional).
Código do país
 signers.country_code string

País do participante.
Função
 signers.role string

Função do participante.
Empresa
 signers.company string

Empresa do participante.
Cargo
 signers.position string

Posição do participante.
Telefone
 signers.phone string

Telefone do participante.

Assinatura de selo

ID da operação:
DokobitUniversalAPISealSigning

O documento será lacrado com o selo eletrônico de suas organizações. Entre em contato com nosso suporte developers@dokobit.com para obter um certificado qualificado para selagem.

Parâmetros

Nome Chave Obrigatório Tipo Description
Token de assinatura
 token True string

Token de assinatura.
Motivo Personalizado
 custom_reason string

Motivo da assinatura personalizada.
Página
 page string

Índice de página para anotação de assinatura pdf visível. Aplicável somente à assinatura de tipo PDF. Padrão: 1.
Posição da parte superior
 top string

Posição (em pontos) da parte superior para anotação de assinatura PDF visível. Aplicável somente à assinatura de tipo PDF. Padrão: 1.
Posição da esquerda
 left string

Posição (em pontos) da esquerda para anotação de assinatura PDF visível. Aplicável somente à assinatura de tipo PDF. Padrão: 1.

Retornos

Nome Caminho Tipo Description
Situação
 status string

Status.

Atualizar Assinatura Externa

ID da operação:
DokobitUniversalAPIUpdateExternalSigning

Permite atualizar atributos de uma assinatura de documento existente.

Parâmetros

Nome Chave Obrigatório Tipo Description
Token de assinatura
 token True string

Token de assinatura.
Data limite
 deadline date-time

Data limite de assinatura com o fragmento de fuso horário especificado. Exemplo: 2018-11-05T13:15:30Z.
Dura data limite
 hard_deadline boolean

Se definido como true participantes, não será possível assinar ou aprovar este documento após o conjunto deadline. Padrão: false.
Exigir assinaturas qualificadas
 require_qualified_signatures boolean

Permitir assinar somente com assinaturas qualificadas. Padrão: false.
Permitir identificação de vídeo
 allow_video_identification boolean

Permitir a assinatura usando a identificação baseada em vídeo. Padrão: false.
Permitir salvamento de documentos
 allow_document_saving boolean

Permitir que o usuário salve o documento no Portal do Dokobit e faça outras ações. Padrão: true.
Métodos de assinatura permitidos
 allowed_signing_methods array of string

Permitir somente métodos de assinatura específicos. Valores disponíveis: mobile, , smartid, smartcard, eparaksts_mobile, bankid_no, bankid_se, , audkenni_app, ftn, mitid, , electronic_id, , itsmeidin, , , swisscom, . sms_otp

Retornos

Nome Caminho Tipo Description
Situação
 status string

Status.

Atualizar Assinatura Interna

ID da operação:
DokobitUniversalAPIUpdateInternalSigning

Permite atualizar atributos de uma assinatura de documento existente.

Parâmetros

Nome Chave Obrigatório Tipo Description
Token de assinatura
 token True string

Token de assinatura.
Exigir assinaturas qualificadas
 require_qualified_signatures boolean

Permitir assinar somente com assinaturas qualificadas. Padrão: false.
Permitir identificação de vídeo
 allow_video_identification boolean

Permitir a assinatura usando a identificação baseada em vídeo. Padrão: false.
Métodos de assinatura permitidos
 allowed_signing_methods array of string

Permitir somente métodos de assinatura específicos. Valores disponíveis: mobile, , smartid, smartcard, eparaksts_mobile, bankid_no, bankid_se, , audkenni_app, ftn, mitid, , electronic_id, , itsmeidin, , , swisscom, . sms_otp

Retornos

Nome Caminho Tipo Description
Situação
 status string

Status.

Baixar Documento Externo

ID da operação:
DokobitUniversalAPIDownloadDocumentExternal

Baixa o documento assinado.

Parâmetros

Nome Chave Obrigatório Tipo Description
Token de assinatura
 token True string

Token de assinatura.

Retornos

response
object

Baixar Documento Interno

ID da operação:
DokobitUniversalAPIDownloadDocumentInternal

Baixa o documento assinado.

Parâmetros

Nome Chave Obrigatório Tipo Description
Token de assinatura
 token True string

Token de assinatura.

Retornos

response
object

Criar Assinatura Externa

ID da operação:
DokobitUniversalAPICreateExternalSigning

A assinatura externa inicia uma solicitação de assinatura assíncrona do sistema. Nesse caso, o usuário recebe um email para assinatura e você receberá um retorno de chamada assim que assinar o documento.

Parâmetros

Nome Chave Obrigatório Tipo Description
Tipo
 type True string

Formato do documento. Valores disponíveis: pdf, , asice, bdoc, edoc, adoc, . adoc.cedoc
Nome
 name True string

Nome de assinatura exibido para o usuário.
Postback URL
 postback_url string

URL do seu sistema para lidar com webhooks.
Data limite
 deadline date-time

Data limite de assinatura com o fragmento de fuso horário especificado. Exemplo: 2018-11-05T13:15:30Z.
Dura data limite
 hard_deadline boolean

Se definido como true participantes, não será possível assinar este documento após o conjunto deadline. Padrão: false.
Exigir assinaturas qualificadas
 require_qualified_signatures boolean

Permitir assinar somente com assinaturas qualificadas. Padrão: false.
Posição de anotação
 annotation_position string

Você pode escolher a posição das anotações de assinatura em um documento PDF. Valores disponíveis: first_top, , first_bottom, last_top, last_bottom, none. Padrão: first_top.
Código pessoal de anotação
 annotation_personal_code boolean

Se definido como true código pessoal, ficará visível na anotação. Aplicável somente à assinatura de tipo PDF. Padrão: false.
Comment
 comment string

Mensagem para os participantes.
Permitir identificação de vídeo
 allow_video_identification boolean

Permitir a assinatura usando a identificação baseada em vídeo. Padrão: false.
Permitir salvamento de documentos
 allow_document_saving boolean

Permitir que o usuário salve o documento no Portal do Dokobit e faça outras ações. Padrão: true.
Nivelar PDF
 flatten_pdf boolean

Se definido como true, o documento será mesclado para que os campos de formulário se tornem parte do conteúdo do documento e não possam ser editados após a assinatura. Aplicável somente à assinatura de tipo PDF. Padrão: false.
Métodos de assinatura permitidos
 allowed_signing_methods array of string

Permitir somente métodos de assinatura específicos. Valores disponíveis: mobile, , smartid, smartcard, eparaksts_mobile, bankid_no, bankid_se, , audkenni_app, ftn, mitid, , electronic_id, , itsmeidin, , , swisscom, . sms_otp
Nome
 name True string

Nome do arquivo.
Content
 content True string

Conteúdo do arquivo codificado em Base64.
ID externa
 external_id True string

Identificador aleatório exclusivo do participante do seu sistema. Você pode gerar identificadores aleatórios exclusivos se não tiver um.
Nome
 name string

Nome do participante.
Surname
 surname string

Sobrenome do participante.
Email
 email string

Email do participante.
Code
 code string

Código pessoal do participante (número da ID nacional).
Código do país
 country_code string

Código do país do participante. Obrigatório se o código pessoal for fornecido. Valores disponíveis: LT, , LV, EE, IS, NO, , FI, BE, . SE
Função
 role string

Função do participante. Valores disponíveis: signer, viewer. Padrão: signer.
Empresa
 company string

Nome da empresa do participante.
Cargo
 position string

Posição do participante.
Telefone
 phone string

Número de telefone do participante.
Sequence
 sequence integer

Permite configurar a ordem de sequência de ações de aprovação e assinatura de documentos.
Idioma de notificações
 notifications_language string

Define o idioma das notificações. Valores disponíveis: en, , lt, lv, et, is, no, , fr, se, , de, , fi, dk, nl.
Motivo Personalizado
 custom_reason string

Motivo da assinatura personalizada.
Página
 page string

Índice de página para anotação de assinatura pdf visível. Aplicável somente à assinatura de tipo PDF. Padrão: 1.
Posição da parte superior
 top string

Posição (em pontos) da parte superior para anotação de assinatura PDF visível. Aplicável somente à assinatura de tipo PDF. Padrão: 1.
Posição da esquerda
 left string

Posição (em pontos) da esquerda para anotação de assinatura PDF visível. Aplicável somente à assinatura de tipo PDF. Padrão: 1.
Linguagem
 language string

Linguagem de anotação de assinatura PDF visível. Aplicável somente à assinatura de tipo PDF. Valores disponíveis: en, , lt, lv, et, is

Retornos

Nome Caminho Tipo Description
Situação
 status string

Status.
Token de assinatura
 token string

Token de assinatura.
Signatários
 signers array of object

Informações do participante.
ID externa
 signers.external_id string

Identificador aleatório exclusivo do participante do seu sistema.
Símbolo
 signers.token string

Token do participante.
Nome
 signers.first_name string

Nome do participante.
Surname
 signers.last_name string

Sobrenome do participante.
Code
 signers.code string

Código pessoal do participante (número da ID nacional).
País
 signers.country string

País do participante.
Email
 signers.email string

Email do participante.

Criar assinatura interna

ID da operação:
DokobitUniversalAPICreateInternalSigning

A assinatura interna inicia a solicitação de assinatura do sistema. Nesse caso, a URL de assinatura é gerada em que o participante deve ser redirecionado.

Parâmetros

Nome Chave Obrigatório Tipo Description
Tipo
 type True string

Formato do documento. Valores disponíveis: pdf, , asice, bdoc, edoc, adoc, . adoc.cedoc
Nome
 name True string

Nome de assinatura exibido para o usuário.
URI de redirecionamento
 redirect_uri True string

Uri de redirecionamento que será usado para redirecionar o signatário após a conclusão da assinatura.
Postback URL
 postback_url string

URL do seu sistema para lidar com webhooks.
Exigir assinaturas qualificadas
 require_qualified_signatures boolean

Permitir assinar somente com assinaturas qualificadas. Padrão: false.
Posição de anotação
 annotation_position string

Você pode escolher a posição das anotações de assinatura em um documento PDF. Valores disponíveis: first_top, , first_bottom, last_top, last_bottom, none. Padrão: first_top.
Código pessoal de anotação
 annotation_personal_code boolean

Se definido como true código pessoal, ficará visível na anotação. Aplicável somente à assinatura de tipo PDF. Padrão: false.
Permitir identificação de vídeo
 allow_video_identification boolean

Permitir a assinatura usando a identificação baseada em vídeo. Padrão: false.
Nivelar PDF
 flatten_pdf boolean

Se definido como true, o documento será mesclado para que os campos de formulário se tornem parte do conteúdo do documento e não possam ser editados após a assinatura. Aplicável somente à assinatura de tipo PDF. Padrão: false.
Métodos de assinatura permitidos
 allowed_signing_methods array of string

Permitir somente métodos de assinatura específicos. Valores disponíveis: mobile, , smartid, smartcard, eparaksts_mobile, bankid_no, bankid_se, , audkenni_app, ftn, mitid, , electronic_id, , itsmeidin, , , swisscom, . sms_otp
Nome
 name True string

Nome do arquivo.
Content
 content True string

Conteúdo do arquivo codificado em Base64.
ID externa
 external_id True string

Identificador aleatório exclusivo do participante do seu sistema. Você pode gerar identificadores aleatórios exclusivos se não tiver um.
Função
 role string

Função do participante. Valores disponíveis: signer, viewer. Padrão: signer.
Code
 code string

Código do participante.
Código do país
 country_code string

Código do país do participante. Obrigatório se o código pessoal for fornecido. Valores disponíveis: LT, , LV, EE, IS, NO, , PL, FI, , BE, SE.
Telefone
 phone string

Telefone do participante.
Idioma de notificações
 language string

Define o idioma da interface do usuário. Valores disponíveis: en, , lt, lv, et, is, no, , fr, se, , de, , fi, dk, nl.
Página
 page string

Índice de página para anotação de assinatura pdf visível. Aplicável somente à assinatura de tipo PDF. Padrão: 1.
Posição da parte superior
 top string

Posição (em pontos) da parte superior para anotação de assinatura PDF visível. Aplicável somente à assinatura de tipo PDF. Padrão: 1.
Posição da esquerda
 left string

Posição (em pontos) da esquerda para anotação de assinatura PDF visível. Aplicável somente à assinatura de tipo PDF. Padrão: 1.
Linguagem
 language string

Linguagem de anotação de assinatura PDF visível. Aplicável somente à assinatura de tipo PDF. Valores disponíveis: en, , lt, lv, et, is
Motivo Personalizado
 custom_reason string

Motivo da assinatura personalizada.

Retornos

Nome Caminho Tipo Description
Situação
 status string

Status.
Token de assinatura
 token string

Token de assinatura.
Signatários
 signers array of object

Informações do participante.
ID externa
 signers.external_id string

Identificador aleatório exclusivo do participante do seu sistema.
Símbolo
 signers.token string

Token do participante.
URI de redirecionamento
 signers.redirect_uri string

URL para assinatura.

e-Delivery

ID da operação:
DokobitUniversalAPIeDelivery

A entrega de documentos é usada para compartilhar documentos com segurança com a API Universal do Dokobit.

Parâmetros

Nome Chave Obrigatório Tipo Description
Tipo
 type True string

Formato do documento. Valores disponíveis: pdf.
Nome
 name True string

Nome do documento exibido para o usuário.
Postback URL
 postback_url string

URL do seu sistema para lidar com webhooks.
Comment
 comment string

Mensagem para destinatários.
Nome
 name True string

Nome do arquivo.
Content
 content True string

Conteúdo do arquivo codificado em Base64.
ID externa
 external_id True string

Identificador aleatório exclusivo do participante do seu sistema. Você pode gerar identificadores aleatórios exclusivos se não tiver um.
Code
 code True string

Código pessoal do destinatário (número da ID nacional).
Código do país
 country_code True string

Código do país do destinatário. Obrigatório se o código pessoal for fornecido. Valores disponíveis: lt, , lv, eeis.
Email
 email string

Email do destinatário para enviar documento. Obrigatório se o telefone não estiver definido.
Telefone
 phone string

Número de telefone do destinatário para enviar SMS do documento. Necessário se o email não estiver definido. O SMS será enviado somente quando o email não for fornecido.
Idioma de notificações
 notifications_language string

Define o idioma das notificações. Valores disponíveis: en, , lt, lv, et, is, no'fr', 'se', 'de'.

Retornos

Nome Caminho Tipo Description
Situação
 status string

Status.
Token de documento
 token string

Token de documento.
Destinatários
 recipients array of object

Informações do destinatário.
ID externa
 recipients.external_id string

Identificador aleatório exclusivo do participante do seu sistema.
Símbolo
 recipients.token string

Token do destinatário.
Code
 recipients.code string

Código pessoal do destinatário (número da ID nacional).
País
 recipients.country string

País do destinatário.
Email
 recipients.email string

Email do destinatário.

Enviar Lembrete

ID da operação:
DokobitUniversalAPIReminder

Permite enviar um email de lembrete para o participante, somente se a pessoa ainda não tiver assinado o documento. Só funciona com o fluxo de assinatura externo.

Parâmetros

Nome Chave Obrigatório Tipo Description
Token de assinatura
 token True string

Token de assinatura.
Token do signatário
 signer True string

Token do participante.
Message
 message string

Mensagem de lembrete para o signatário.

Retornos

Nome Caminho Tipo Description
Situação
 status string

Status.

Excluir Assinatura Externa

ID da operação:
DokobitUniversalAPIDeleteExternalSigning

O documento será removido da conta do proprietário. Ele permanecerá acessível a outros participantes.

Parâmetros

Nome Chave Obrigatório Tipo Description
Token de assinatura
 token True string

Token de assinatura.

Retornos

Nome Caminho Tipo Description
Situação
 status string

Status.

Excluir Assinatura Interna

ID da operação:
DokobitUniversalAPIDeleteInternalSigning

O documento será removido da conta do proprietário. Ele permanecerá acessível a outros participantes.

Parâmetros

Nome Chave Obrigatório Tipo Description
Token de assinatura
 token True string

Token de assinatura.

Retornos

Nome Caminho Tipo Description
Situação
 status string

Status.

Excluir Signatário Externo

ID da operação:
DokobitUniversalAPIDeleteExternalSigner

O acesso ao documento será revogado para o participante indicado.

Parâmetros

Nome Chave Obrigatório Tipo Description
Token de assinatura
 token True string

Token de assinatura.
Símbolo
 token True string

Token do participante.

Retornos

Nome Caminho Tipo Description
Situação
 status string

Status.

Excluir Signatário Interno

ID da operação:
DokobitUniversalAPIDeleteInternalSigner

O acesso ao documento será revogado para o participante indicado.

Parâmetros

Nome Chave Obrigatório Tipo Description
Token de assinatura
 token True string

Token de assinatura.
Símbolo
 token True string

Token do participante.

Retornos

Nome Caminho Tipo Description
Situação
 status string

Status.

Validation

ID da operação:
DokobitUniversalAPIValidation

O Dokobit é um provedor de serviços certificado pelo eIDAS para validações qualificadas de assinatura e selo eletrônico. Use essa ação para carregar um arquivo assinado para validação. Tipos de arquivo com suporte: asice, , asics, sce, bdoc, edoc, , pdf, p7s, xml.

Parâmetros

Nome Chave Obrigatório Tipo Description
Nome
 name True string

Nome do arquivo.
Content
 content True string

Conteúdo do arquivo codificado em Base64.

Retornos

Nome Caminho Tipo Description
Upload Status
 status string

Carregar status.
Token de validação
 token string

Token de validação.

Validação – Dados de Diagnóstico XML

ID da operação:
DokobitUniversalAPIValidationXMLDiagnosticData

Baixe dados de diagnóstico em XML.

Parâmetros

Nome Chave Obrigatório Tipo Description
Token de validação
 token True string

Token de validação recebido da ação DokobitUniversalAPIValidation.

Retornos

response
object

Validação – Relatório PDF

ID da operação:
DokobitUniversalAPIValidationPDFReport

Baixe o relatório de validação em PDF.

Parâmetros

Nome Chave Obrigatório Tipo Description
Token de validação
 token True string

Token de validação recebido da ação DokobitUniversalAPIValidation.

Retornos

response
object

Validação – Relatório PDF detalhado

ID da operação:
DokobitUniversalAPIValidationDetailedPDFReport

Baixe o relatório de validação detalhado em PDF.

Parâmetros

Nome Chave Obrigatório Tipo Description
Token de validação
 token True string

Token de validação recebido da ação DokobitUniversalAPIValidation.

Retornos

response
object

Validação – Relatório XML

ID da operação:
DokobitUniversalAPIValidationXMLReport

Baixe o relatório de validação no XML.

Parâmetros

Nome Chave Obrigatório Tipo Description
Token de validação
 token True string

Token de validação recebido da ação DokobitUniversalAPIValidation.

Retornos

response
object

Verificar o status da assinatura externa

ID da operação:
DokobitUniversalAPICheckExternalSigningStatus

Retorna as informações do documento com o status de assinatura.

Parâmetros

Nome Chave Obrigatório Tipo Description
Token de assinatura
 token True string

Token de assinatura.

Retornos

Nome Caminho Tipo Description
Status de Assinatura
 status string

Status da assinatura do documento.
Nome
 name string

Nome de assinatura exibido para o usuário.
Tipo
 type string

Tipo de documento.
Data criada
 date_created string

Data em que a assinatura do documento foi iniciada.
Data limite
 deadline date-time

Data limite de assinatura com o fragmento de fuso horário especificado. Exemplo: 2018-11-05T13:15:30Z.
Nome do Arquivo
 filename string

Nome do arquivo.
Arquivos
 files array of object
Nome
 files.name string

Nome do arquivo.
Transferir URL
 files.url string

URL de Download de Arquivo.
Tipo MIME
 files.mime_type string

Tipo MIME de arquivo.
Signatários
 signers array of object

Informações do participante.
Símbolo
 signers.token string

Token do participante.
Nome
 signers.first_name string

Nome do participante.
Surname
 signers.last_name string

Sobrenome do participante.
Code
 signers.code string

Código do participante.
País
 signers.country string

País do participante.
Email
 signers.email string

Email do participante.
Tipo
 signers.type string

Tipo.
Situação
 signers.status string

Status do participante.

Verificar o status da assinatura interna

ID da operação:
DokobitUniversalAPICheckInternalSigningStatus

Retorna as informações do documento com o status de assinatura.

Parâmetros

Nome Chave Obrigatório Tipo Description
Token de assinatura
 token True string

Token de assinatura.

Retornos

Nome Caminho Tipo Description
Status de Assinatura
 status string

Status da assinatura do documento.
Nome
 name string

Nome de assinatura exibido para o usuário.
Tipo
 type string

Tipo de documento.
Data criada
 date_created string

Data em que a assinatura do documento foi iniciada.
Data limite
 deadline date-time

Data limite de assinatura com o fragmento de fuso horário especificado. Exemplo: 2018-11-05T13:15:30Z.
Nome do Arquivo
 filename string

Nome do arquivo.
Arquivos
 files array of object
Nome
 files.name string

Nome do arquivo.
Transferir URL
 files.url string

URL de Download de Arquivo.
Tipo MIME
 files.mime_type string

Tipo MIME de arquivo.
Signatários
 signers array of object

Informações do participante.
Símbolo
 signers.token string

Token do participante.
Nome
 signers.first_name string

Nome do participante.
Surname
 signers.last_name string

Sobrenome do participante.
Code
 signers.code string

Código do participante.
País
 signers.country string

País do participante.
Email
 signers.email string

Email do participante.
Tipo
 signers.type string

Tipo.
Situação
 signers.status string

Status do participante.

Definições

objeto

Esse é o tipo 'object'.