Partilhar via

Dokobit Universal API

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

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

Serviço Class Regiões
Estúdio Copiloto Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas Standard Todas as regiões do Logic Apps , exceto as seguintes:
     - Regiões do Azure Government
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Aplicações Power Premium Todas as regiões do Power Apps , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Automatize o poder Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - 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
Editora Dokobit
Sítio Web https://www.dokobit.com/solutions
Política de privacidade https://www.dokobit.com/compliance/privacy-policy
Categorias Produtividade

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

Pré-requisitos

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

Como obter credenciais

Entre em contato com nosso departamento de vendas para obter o token de acesso à API

Introdução ao conector

  • A assinatura de documentos pode ser iniciada usando as ações 'DokobitUniversalAPICreateExternalSigning' ou 'DokobitUniversalAPICreateInternalSigning'. Usando 'DokobitUniversalAPICreateExternalSigning' enviará um convite de assinatura aos participantes. 'DokobitUniversalAPICreateInternalSigning' irá gerar um URL de assinatura onde os utilizadores 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 assinam o documento, ele pode ser baixado com as ações 'DokobitUniversalAPIDownloadDocumentExternal' ou 'DokobitUniversalAPIDownloadDocumentInternal'.

Problemas conhecidos e limitações

A implementação atual suporta a recolha de assinaturas em ficheiros PDF e é suportada por contentores 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 do documento 'Tipo' estiver definida como 'pdf', um único documento PDF será aceito quando a assinatura do documento for iniciada. Para vários ficheiros, defina a assinatura 'Tipo' como 'asice' ou outro formato de contentor.

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:
Predefinição 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.

Esta conexão não é compartilhável. Se o aplicativo avançado 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

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de 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 do selo

O documento será lacrado com o selo eletrônico da sua organização. Entre em contato com nosso suporte para developers@dokobit.com obter um certificado qualificado para selagem eletrônica.
Atualizar assinatura externa

Permite atualizar atributos de uma assinatura de documento existente.
Atualizar assinatura interna

Permite atualizar atributos de uma assinatura de documento existente.
Criar assinatura externa

A assinatura externa inicia a solicitação de assinatura assíncrona do seu sistema. Neste caso, o usuário recebe um e-mail para assinar e você receberá um retorno de chamada assim que ele assinar o documento.
Criar assinatura interna

A assinatura interna inicia a solicitação de assinatura do seu sistema. Neste caso, a URL de assinatura é gerada para onde o participante deve ser redirecionado.
Download do documento externo

Transfere o documento assinado.
Download Interno do Documento

Transfere o documento assinado.
e-Entrega

O Document e-Delivery é usado para compartilhar documentos com segurança com a API Universal Dokobit.
Enviar lembrete

Permite enviar um e-mail de lembrete para o participante, apenas se a pessoa ainda não tiver assinado o documento. Só funciona com fluxo de assinatura externo.
Excluir assinatura externa

O documento será removido da conta do proprietário. Continuará acessível a outros participantes.
Excluir assinatura interna

O documento será removido da conta do proprietário. Continuará 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

A Dokobit é uma prestadora de serviços certificada pela eIDAS para validações qualificadas de assinatura e selo eletrônicos. Use esta ação para carregar um arquivo assinado para validação. Tipos de ficheiros suportados: asice, asics, sce, bdoc, edoc, pdf, p7s, xml.
Validação - Dados de diagnóstico XML

Baixar dados de diagnóstico em XML.
Validação - Relatório PDF

Faça o download do relatório de validação em PDF.
Validação - Relatório PDF detalhado

Faça o download do relatório de validação detalhado em PDF.
Validação - Relatório XML

Faça o download do relatório de validação em 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

Name Chave Necessário Tipo Description
Token de assinatura
 token True string

Token de assinatura.
ID externo
 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

Apelido do participante.
E-mail
 email string

E-mail do participante.
Código
 code string

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

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

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

Empresa do participante.
Position
 position string

Posição do participante.
Telemóvel
 phone string

Telefone do participante.
Razão personalizada
 custom_reason string

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

Define o idioma das notificações. Valores disponíveis: en, lt, lv, et, is, no, fr, sedefi, dknl, .
Página
 page string

Índice de página para anotação de assinatura PDF visível. Aplicável apenas para assinatura do tipo PDF. Padrão: 1.
Posição a partir do topo
 top string

Posicione (em pontos) a partir do topo para uma anotação de assinatura PDF visível. Aplicável apenas para assinatura do tipo PDF. Padrão: 1.
Posição a partir da esquerda
 left string

Posicione (em pontos) a partir da esquerda para uma anotação de assinatura PDF visível. Aplicável apenas para assinatura do tipo PDF. Padrão: 1.
Linguagem
 language string

Idioma da anotação de assinatura PDF visível. Aplicável apenas para assinatura do tipo PDF. Valores disponíveis: en, lt, lv, et, is
Comment
 comment string

Mensagem aos participantes.

Devoluções

Name Caminho Tipo Description
Situação
 status string

Estado.
Signatários
 signers array of object

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

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

Ficha do participante.
Nome
 signers.name string

Nome do participante.
Surname
 signers.surname string

Apelido do participante.
E-mail
 signers.email string

E-mail do participante.
Código
 signers.code string

Código pessoal do participante (número de identificação nacional).
Código do país
 signers.country_code string

País do participante.
Funções
 signers.role string

Papel do participante.
Empresa
 signers.company string

Empresa do participante.
Position
 signers.position string

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

Define o idioma das notificações. Valores disponíveis: en, lt, lv, et, is, no, , «fr», «se», «de».
Telemóvel
 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

Name Chave Necessário Tipo Description
Token de assinatura
 token True string

Token de assinatura.
ID externo
 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ções
 role string

Papel do participante. Valores disponíveis: signer, viewer. Padrão: signer.
Código
 code string

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

Código do país do participante. Obrigatório se for fornecido um código pessoal. Valores disponíveis: LT, LV, EE, IS, NO, PL, FIBE, SE, .
Telemóvel
 phone string

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

Define o idioma da interface do usuário. Valores disponíveis: en, lt, lv, et, is, no, fr, sedefi, dknl, .
Página
 page string

Índice de página para anotação de assinatura PDF visível. Aplicável apenas para assinatura do tipo PDF. Padrão: 1.
Posição a partir do topo
 top string

Posicione (em pontos) a partir do topo para uma anotação de assinatura PDF visível. Aplicável apenas para assinatura do tipo PDF. Padrão: 1.
Posição a partir da esquerda
 left string

Posicione (em pontos) a partir da esquerda para uma anotação de assinatura PDF visível. Aplicável apenas para assinatura do tipo PDF. Padrão: 1.
Linguagem
 language string

Idioma da anotação de assinatura PDF visível. Aplicável apenas para assinatura do tipo PDF. Valores disponíveis: en, lt, lv, et, is
Razão personalizada
 custom_reason string

Motivo da assinatura personalizada.

Devoluções

Name Caminho Tipo Description
Situação
 status string

Estado.
Signatários
 signers array of object

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

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

Ficha do participante.
Nome
 signers.name string

Nome do participante.
Surname
 signers.surname string

Apelido do participante.
E-mail
 signers.email string

E-mail do participante.
Código
 signers.code string

Código pessoal do participante (número de identificação nacional).
Código do país
 signers.country_code string

País do participante.
Funções
 signers.role string

Papel do participante.
Empresa
 signers.company string

Empresa do participante.
Position
 signers.position string

Posição do participante.
Telemóvel
 signers.phone string

Telefone do participante.

Assinatura do selo

ID da Operação:
DokobitUniversalAPISealSigning

O documento será lacrado com o selo eletrônico da sua organização. Entre em contato com nosso suporte para developers@dokobit.com obter um certificado qualificado para selagem eletrônica.

Parâmetros

Name Chave Necessário Tipo Description
Token de assinatura
 token True string

Token de assinatura.
Razão personalizada
 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 apenas para assinatura do tipo PDF. Padrão: 1.
Posição a partir do topo
 top string

Posicione (em pontos) a partir do topo para uma anotação de assinatura PDF visível. Aplicável apenas para assinatura do tipo PDF. Padrão: 1.
Posição a partir da esquerda
 left string

Posicione (em pontos) a partir da esquerda para uma anotação de assinatura PDF visível. Aplicável apenas para assinatura do tipo PDF. Padrão: 1.

Devoluções

Name Caminho Tipo Description
Situação
 status string

Estado.

Atualizar assinatura externa

ID da Operação:
DokobitUniversalAPIUpdateExternalSigning

Permite atualizar atributos de uma assinatura de documento existente.

Parâmetros

Name Chave Necessário Tipo Description
Token de assinatura
 token True string

Token de assinatura.
Deadline
 deadline date-time

Data limite de assinatura com fragmento de fuso horário especificado. Exemplo: 2018-11-05T13:15:30Z.
Prazo difícil
 hard_deadline boolean

Se definido como true os participantes não poderão assinar ou aprovar este documento após a definição deadline. Padrão: false.
Exigir assinaturas qualificadas
 require_qualified_signatures boolean

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

Permitir assinar usando identificação baseada em vídeo. Padrão: false.
Permitir gravação de documentos
 allow_document_saving boolean

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

Permitir apenas métodos de assinatura específicos. Valores disponíveis: mobile, smartid, smartcard, eparaksts_mobile, bankid_no, bankid_se, audkenni_appmitidswisscomitsmesms_otpftnelectronic_ididin.

Devoluções

Name Caminho Tipo Description
Situação
 status string

Estado.

Atualizar assinatura interna

ID da Operação:
DokobitUniversalAPIUpdateInternalSigning

Permite atualizar atributos de uma assinatura de documento existente.

Parâmetros

Name Chave Necessário Tipo Description
Token de assinatura
 token True string

Token de assinatura.
Exigir assinaturas qualificadas
 require_qualified_signatures boolean

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

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

Permitir apenas métodos de assinatura específicos. Valores disponíveis: mobile, smartid, smartcard, eparaksts_mobile, bankid_no, bankid_se, audkenni_appmitidswisscomitsmesms_otpftnelectronic_ididin.

Devoluções

Name Caminho Tipo Description
Situação
 status string

Estado.

Criar assinatura externa

ID da Operação:
DokobitUniversalAPICreateExternalSigning

A assinatura externa inicia a solicitação de assinatura assíncrona do seu sistema. Neste caso, o usuário recebe um e-mail para assinar e você receberá um retorno de chamada assim que ele assinar o documento.

Parâmetros

Name Chave Necessá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.
Deadline
 deadline date-time

Data limite de assinatura com fragmento de fuso horário especificado. Exemplo: 2018-11-05T13:15:30Z.
Prazo difícil
 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 apenas com assinaturas qualificadas. Padrão: false.
Posição da 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 será visível na anotação. Aplicável apenas para assinatura do tipo PDF. Padrão: false.
Comment
 comment string

Mensagem aos participantes.
Permitir identificação por vídeo
 allow_video_identification boolean

Permitir assinar usando identificação baseada em vídeo. Padrão: false.
Permitir gravação de documentos
 allow_document_saving boolean

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

Se definido como true, o documento será nivelado 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 apenas para assinatura do tipo PDF. Padrão: false.
Métodos de assinatura permitidos
 allowed_signing_methods array of string

Permitir apenas métodos de assinatura específicos. Valores disponíveis: mobile, smartid, smartcard, eparaksts_mobile, bankid_no, bankid_se, audkenni_appmitidswisscomitsmesms_otpftnelectronic_ididin.
Nome
 name True string

Nome do arquivo.
Content
 content True string

Conteúdo do arquivo codificado Base64.
ID externo
 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

Apelido do participante.
E-mail
 email string

E-mail do participante.
Código
 code string

Código pessoal do participante (número de identificação nacional).
Código do país
 country_code string

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

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

Nome da empresa do participante.
Position
 position string

Posição do participante.
Telemóvel
 phone string

Número de telefone do participante.
Sequence
 sequence integer

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

Define o idioma das notificações. Valores disponíveis: en, lt, lv, et, is, no, fr, sedefi, dknl, .
Razão personalizada
 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 apenas para assinatura do tipo PDF. Padrão: 1.
Posição a partir do topo
 top string

Posicione (em pontos) a partir do topo para uma anotação de assinatura PDF visível. Aplicável apenas para assinatura do tipo PDF. Padrão: 1.
Posição a partir da esquerda
 left string

Posicione (em pontos) a partir da esquerda para uma anotação de assinatura PDF visível. Aplicável apenas para assinatura do tipo PDF. Padrão: 1.
Linguagem
 language string

Idioma da anotação de assinatura PDF visível. Aplicável apenas para assinatura do tipo PDF. Valores disponíveis: en, lt, lv, et, is

Devoluções

Name Caminho Tipo Description
Situação
 status string

Estado.
Token de assinatura
 token string

Token de assinatura.
Signatários
 signers array of object

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

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

Ficha do participante.
Nome
 signers.first_name string

Nome do participante.
Surname
 signers.last_name string

Apelido do participante.
Código
 signers.code string

Código pessoal do participante (número de identificação nacional).
Country
 signers.country string

País do participante.
E-mail
 signers.email string

E-mail do participante.

Criar assinatura interna

ID da Operação:
DokobitUniversalAPICreateInternalSigning

A assinatura interna inicia a solicitação de assinatura do seu sistema. Neste caso, a URL de assinatura é gerada para onde o participante deve ser redirecionado.

Parâmetros

Name Chave Necessá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.
Redirecionar URL
 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 apenas com assinaturas qualificadas. Padrão: false.
Posição da 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 será visível na anotação. Aplicável apenas para assinatura do tipo PDF. Padrão: false.
Permitir identificação por vídeo
 allow_video_identification boolean

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

Se definido como true, o documento será nivelado 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 apenas para assinatura do tipo PDF. Padrão: false.
Métodos de assinatura permitidos
 allowed_signing_methods array of string

Permitir apenas métodos de assinatura específicos. Valores disponíveis: mobile, smartid, smartcard, eparaksts_mobile, bankid_no, bankid_se, audkenni_appmitidswisscomitsmesms_otpftnelectronic_ididin.
Nome
 name True string

Nome do arquivo.
Content
 content True string

Conteúdo do arquivo codificado Base64.
ID externo
 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ções
 role string

Papel do participante. Valores disponíveis: signer, viewer. Padrão: signer.
Código
 code string

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

Código do país do participante. Obrigatório se for fornecido um código pessoal. Valores disponíveis: LT, LV, EE, IS, NO, PL, FIBE, SE, .
Telemóvel
 phone string

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

Define o idioma da interface do usuário. Valores disponíveis: en, lt, lv, et, is, no, fr, sedefi, dknl, .
Página
 page string

Índice de página para anotação de assinatura PDF visível. Aplicável apenas para assinatura do tipo PDF. Padrão: 1.
Posição a partir do topo
 top string

Posicione (em pontos) a partir do topo para uma anotação de assinatura PDF visível. Aplicável apenas para assinatura do tipo PDF. Padrão: 1.
Posição a partir da esquerda
 left string

Posicione (em pontos) a partir da esquerda para uma anotação de assinatura PDF visível. Aplicável apenas para assinatura do tipo PDF. Padrão: 1.
Linguagem
 language string

Idioma da anotação de assinatura PDF visível. Aplicável apenas para assinatura do tipo PDF. Valores disponíveis: en, lt, lv, et, is
Razão personalizada
 custom_reason string

Motivo da assinatura personalizada.

Devoluções

Name Caminho Tipo Description
Situação
 status string

Estado.
Token de assinatura
 token string

Token de assinatura.
Signatários
 signers array of object

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

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

Ficha do participante.
Redirecionar URL
 signers.redirect_uri string

URL para assinatura.

Download do documento externo

ID da Operação:
DokobitUniversalAPIDownloadDocumentExternal

Transfere o documento assinado.

Parâmetros

Name Chave Necessário Tipo Description
Token de assinatura
 token True string

Token de assinatura.

Devoluções

response
object

Download Interno do Documento

ID da Operação:
DokobitUniversalAPIDownloadDocumentInternal

Transfere o documento assinado.

Parâmetros

Name Chave Necessário Tipo Description
Token de assinatura
 token True string

Token de assinatura.

Devoluções

response
object

e-Entrega

ID da Operação:
DokobitUniversalAPIeDelivery

O Document e-Delivery é usado para compartilhar documentos com segurança com a API Universal Dokobit.

Parâmetros

Name Chave Necessá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 Base64.
ID externo
 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.
Código
 code True string

Código pessoal do destinatário (número de identificação nacional).
Código do país
 country_code True string

Código do país do destinatário. Obrigatório se for fornecido um código pessoal. Valores disponíveis: lt, lv, ee, is.
E-mail
 email string

E-mail do destinatário para envio de documento. Necessário se o telefone não estiver definido.
Telemóvel
 phone string

Número de telefone do destinatário para enviar SMS de documentos. Obrigatório se o e-mail não estiver definido. SMS será enviado apenas quando o e-mail não é fornecido.
Idioma das notificações
 notifications_language string

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

Devoluções

Name Caminho Tipo Description
Situação
 status string

Estado.
Token do documento
 token string

Token do documento.
Destinatários
 recipients array of object

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

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

Token do destinatário.
Código
 recipients.code string

Código pessoal do destinatário (número de identificação nacional).
Country
 recipients.country string

País do destinatário.
E-mail
 recipients.email string

E-mail do destinatário.

Enviar lembrete

ID da Operação:
DokobitUniversalAPIReminder

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

Parâmetros

Name Chave Necessário Tipo Description
Token de assinatura
 token True string

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

Ficha do participante.
Message
 message string

Mensagem de lembrete para o signatário.

Devoluções

Name Caminho Tipo Description
Situação
 status string

Estado.

Excluir assinatura externa

ID da Operação:
DokobitUniversalAPIDeleteExternalSigning

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

Parâmetros

Name Chave Necessário Tipo Description
Token de assinatura
 token True string

Token de assinatura.

Devoluções

Name Caminho Tipo Description
Situação
 status string

Estado.

Excluir assinatura interna

ID da Operação:
DokobitUniversalAPIDeleteInternalSigning

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

Parâmetros

Name Chave Necessário Tipo Description
Token de assinatura
 token True string

Token de assinatura.

Devoluções

Name Caminho Tipo Description
Situação
 status string

Estado.

Excluir signatário externo

ID da Operação:
DokobitUniversalAPIDeleteExternalSigner

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

Parâmetros

Name Chave Necessário Tipo Description
Token de assinatura
 token True string

Token de assinatura.
Símbolo
 token True string

Ficha do participante.

Devoluções

Name Caminho Tipo Description
Situação
 status string

Estado.

Excluir signatário interno

ID da Operação:
DokobitUniversalAPIDeleteInternalSigner

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

Parâmetros

Name Chave Necessário Tipo Description
Token de assinatura
 token True string

Token de assinatura.
Símbolo
 token True string

Ficha do participante.

Devoluções

Name Caminho Tipo Description
Situação
 status string

Estado.

Validation

ID da Operação:
DokobitUniversalAPIValidation

A Dokobit é uma prestadora de serviços certificada pela eIDAS para validações qualificadas de assinatura e selo eletrônicos. Use esta ação para carregar um arquivo assinado para validação. Tipos de ficheiros suportados: asice, asics, sce, bdoc, edoc, pdf, p7s, xml.

Parâmetros

Name Chave Necessário Tipo Description
Nome
 name True string

Nome do arquivo.
Content
 content True string

Conteúdo do arquivo codificado Base64.

Devoluções

Name Caminho Tipo Description
Status do carregamento
 status string

Estado do carregamento.
Token de validação
 token string

Token de validação.

Validação - Dados de diagnóstico XML

ID da Operação:
DokobitUniversalAPIValidationXMLDiagnosticData

Baixar dados de diagnóstico em XML.

Parâmetros

Name Chave Necessário Tipo Description
Token de validação
 token True string

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

Devoluções

response
object

Validação - Relatório PDF

ID da Operação:
DokobitUniversalAPIValidationPDFReport

Faça o download do relatório de validação em PDF.

Parâmetros

Name Chave Necessário Tipo Description
Token de validação
 token True string

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

Devoluções

response
object

Validação - Relatório PDF detalhado

ID da Operação:
DokobitUniversalAPIValidationDetailedPDFReport

Faça o download do relatório de validação detalhado em PDF.

Parâmetros

Name Chave Necessário Tipo Description
Token de validação
 token True string

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

Devoluções

response
object

Validação - Relatório XML

ID da Operação:
DokobitUniversalAPIValidationXMLReport

Faça o download do relatório de validação em XML.

Parâmetros

Name Chave Necessário Tipo Description
Token de validação
 token True string

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

Devoluções

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

Name Chave Necessário Tipo Description
Token de assinatura
 token True string

Token de assinatura.

Devoluções

Name Caminho Tipo Description
Status de assinatura
 status string

Estado de assinatura do documento.
Nome
 name string

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

Tipo de documento.
Data de Criação
 date_created string

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

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

Nome do ficheiro.
Ficheiros
 files array of object
Nome
 files.name string

Nome do arquivo.
Download URL
 files.url string

URL de download do arquivo.
Tipo de MIME
 files.mime_type string

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

Informação do participante.
Símbolo
 signers.token string

Ficha do participante.
Nome
 signers.first_name string

Nome do participante.
Surname
 signers.last_name string

Apelido do participante.
Código
 signers.code string

Código do participante.
Country
 signers.country string

País do participante.
E-mail
 signers.email string

E-mail do participante.
Tipo
 signers.type string

Digite.
Situação
 signers.status string

Estatuto 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

Name Chave Necessário Tipo Description
Token de assinatura
 token True string

Token de assinatura.

Devoluções

Name Caminho Tipo Description
Status de assinatura
 status string

Estado de assinatura do documento.
Nome
 name string

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

Tipo de documento.
Data de Criação
 date_created string

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

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

Nome do ficheiro.
Ficheiros
 files array of object
Nome
 files.name string

Nome do arquivo.
Download URL
 files.url string

URL de download do arquivo.
Tipo de MIME
 files.mime_type string

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

Informação do participante.
Símbolo
 signers.token string

Ficha do participante.
Nome
 signers.first_name string

Nome do participante.
Surname
 signers.last_name string

Apelido do participante.
Código
 signers.code string

Código do participante.
Country
 signers.country string

País do participante.
E-mail
 signers.email string

E-mail do participante.
Tipo
 signers.type string

Digite.
Situação
 signers.status string

Estatuto do participante.

Definições

objecto

Este é o tipo 'objeto'.