Jump to Content
API
v1.0
Log In
API
Log In
Moon (Dark Mode)
Sun (Light Mode)
New Horizon
API
Edição de Envelope
Search
JUMP TO
🏁 Início rápido
🚀Produtos Bry
Sobre Assinatura Digital
BRy Easy Sign - API REST
🧭Quickstart
Obter credenciais de acesso por e-mail
post
Funcionalidades
Imagens de Assinatura
Tipo de Notificação
Níveis de Segurança
Relatório de Assinaturas
iFrame
Assinatura Médica
Informações Adicionais
Edição de Envelope
Assinatura em Lote
Quickstart
Iniciar uma requisição de assinatura
post
Copiar documento da Requisição de Assinatura
get
Webhook
Cadastrar vínculo Webhook
post
Listar Webhooks Cadastrados
get
Remoção de vínculo Webhook
delete
Testar mensagem webhook para assinatura
post
Testar mensagem webhook para envio
post
Relatório
Relatório em PDF com as informações sobre as evidências de assinatura coletadas até o presente momento
get
Relatório PDF com as informações sobre as evidências de assinatura coletadas até o presente momento
post
Relatório unificado do processo de assinatura
get
Relatório unificado do processo de assinatura
post
Validação
Link para página de validação da(s) assinatura(s) sobre documento específico
get
Gestão
Cancelamento da assinatura do(s) documento(s)
delete
Envio de link de assinatura para todos os assinantes.
post
Envio de link de assinatura para assinante
post
Inclusão de novos documentos para assinatura
post
Modificação de documento e representação visual da assinatura
put
Remoção de um documento
delete
Inclusão de novas imagens na representação visual da assinatura
post
Modificação de imagem
put
Inclusão de novos assinantes para assinatura
post
Modificação de assinante
put
Remoção de assinante
delete
Gera um novo link de acesso único a página de configuração do envelope
post
Autenticação
Obter Token de Acesso
post
Informação
Informações completas das assinaturas
get
Status das assinaturas
get
Informações sobre todos os documentos
get
Informações sobre documento específico
get
Informações sobre posicionamento da representação visual da assinatura de um documento específico
get
Documento original
get
Informações sobre todos os assinantes
get
Informações sobre um assinante específico
get
Configuração
Modifica a configuração da aplicação
put
Health
Verifica se o serviço está disponível
get
BRy HUB - Signer
Assinador CMS
Visão Geral
Serviço de assinatura CMS
Envio de documentos para assinatura CMS/CAdES
Extrair documento de assinatura CMS/CAdES
Anexar documento e assinaturas CMS/CAdES
Completar assinatura CMS/CAdES
Serviço de verificação CMS
Respostas de sucesso e erro: CMS
Assinar CMS/CAdES utilizando Certificado em nuvem
post
Inicializa a assinatura CMS/CADES
post
Finalizar Assinatura CMS/CAdES
post
Inicializa a assinatura CMS/CADES - V2 Assíncrono Compliance FW2
post
Finalizar Assinatura CMS/CAdES - V2 Assíncrono Compliance FW2
post
Assinar CMS/CAdES utilizando certificado em arquivo (Passo único) ⚠️
post
Assinador PDF
Visão Geral
Serviço de assinatura PDF
Completar assinatura PDF/PAdES
Obter posições de marcadores no PDF
Adicionar carimbo do tempo sobre documento PDF
Adicionar metadados em documentos PDF
Adicionar imagens e textos em documento PDF
Adicionar QR Code em documento PDF
Adicionar anotações em documento PDF
Obter informações de documento PDF
Cifragem e decifragem de documento PDF
Verificação QR Code Validar ITI
Adicionar campos no PDF
Adicionar imagens e textos no PDF (deprecated)
Serviço de verificação de assinatura PDF
Respostas de sucesso e erro: PDF
Adiciona um carimbo de documento no PDF
post
Assinar PDF/PAdES utilizando Certificado em nuvem
post
Inicializar Assinatura PDF/PAdES
post
Finalizar Assinatura PDF/PAdES
post
Assinar PDF/PAdES utilizando certificado em arquivo (Passo único) ⚠️
post
Recupera um documento via link enquanto disponível em cache. Após o download, o documento é excluído da cache.
get
Assinador XML
Visão Geral
Serviço de assinatura XML
Completar assinatura XML/XAdES
Adição de Carimbo de Arquivamento Extra
Serviço de verificação de assinatura XML
Respostas de sucesso e erro: XML
Assinar XML/XAdES utilizando Certificado em nuvem
post
Inicializa a assinatura XML/XAdES
post
Finalizar Assinatura XML/XADES
post
Assinar XML/XAdES utilizando certificado em arquivo (Passo único) ⚠️
post
Recupera um documento via link enquanto disponível em cache. Após o download, o documento é excluído da cache.
get
Utilitários
Extrair documento de assinatura CMS/CAdES
post
Juntar assinaturas CMS/CAdES e uní-las a um documento, se um documento tiver sido enviado
post
Obtem as posições x e y, na unidade de medida definida na requisição (pontos ou milímetros), e em conformidade com o ponto de origem informado.
post
Obtem as posições x e y de um texto, retornando todas ocorrências do texto no documento, na unidade de medida definida na requisição (pontos ou milímetros).
post
Inserção de metadados para prescrições digitais
post
Obtem informações sobre um documento PDF
post
Processo de cifragem e decifragem de documentos PDF. Caso o documento seja assinado, a integridade das assinaturas pode ser perdida.
post
Adicionar campos de assinatura no documento PDF
post
Preparar documento PDF realizando manipulações com imagem e texto
post
Customizar documento PDF adicionando imagens, textos ou campos de assinatura. Algumas opções não podem ser utilizadas em documentos assinados.
post
Informações referente a aplicação HUB
get
Verificadores
Verifica uma assinatura CMS/CAdES.(Attached, Detached, Detached com hash, Lote Mesclado)
post
Verifica uma assinatura PDF/PAdES.
post
Verifica uma assinatura, co-assinatura ou contra-assinatura assinatura XML
post
Validação de Certificados
Valida uma lista de certificados.
post
Verifica a assinatura de um desafio e o certificado do assinante
post
Completadores
Upgrade de assinatura CMS/CAdES
post
Upgrade de assinatura PDF/PAdES. Pode ser utilizado somente em documentos com apenas UMA assinatura.
post
Upgrade de assinatura XML/XAdES
post
Adicionar Carimbo do tempo de Arquivamento extra XAdES
post
Recupera um documento via link enquanto disponível em cache. Após o download, o documento é excluído da cache.
get
Certificado em Arquivo
Lista os signatarios dos certificados PKCS12 presentes no HUB ⚠️
get
Verifica se certificado PKCS12 está disponível no HUB ⚠️
get
Adiciona um certificado PKCS12 ao HUB ⚠️
post
Remove um certificado PKCS12 do HUB ⚠️
delete
Cache
Lista os certificados presentes em cache ⚠️
get
Adiciona em cache a cadeia do certificado informado ⚠️
post
Remove o certificado informado ⚠️
delete
Health
Verifica a disponibilidade do Hub
get
API de Assinatura Médica
Visão geral
Assinatura da Prescrição
Assinatura Digital com Metadados
Inclusão de Metadados
Respostas de sucesso e erro Assinatura Médica
Verificação da Prescrição
Prescrição eletrônica com assinatura digital
API de Diploma Digital
Visão geral
Assinatura do Diploma Digital
XML Documentação Acadêmica
Assinatura do Representante da Emissora
Assinatura da IES Emissora
Assinatura Final da IES Emissora (Envelope)
XML Diplomado
Assinatura do Representante da Registradora
Assinatura Final da Registradora
XML Histórico Escolar Digital
Assinatura Representante da Secretaria (Caso Histórico Integral)
Assinatura Final IES Emissora
XML Currículo Escolar Digital
Assinatura do Coordenador do Curso
Assinatura Final IES Emissora
XML Lista Diplomas Anulados e Arquivo de Fiscalização
Assinatura de Diploma com Certificado em Nuvem
Assinatura em lote de diplomas
Verificação do Diploma Digital
Adição de Carimbo de Arquivamento Extra
Respostas de sucesso e erro Diploma Digital
Criptografia a favor da educação
Assinatura em Nuvem
Visão geral
Assinatura com certificado na nuvem
Assinatura PDF com única etapa
Assinatura CMS com única etapa
Assinatura XML com única etapa
Geração de uma assinatura digital
Assinatura Híbrida - Digital e Eletrônica
Assinatura no App Mobile
Processamento em lotes
BRY CERT - API Cert
Introdução
1 - Autenticação
Autenticação
post
2 - Solicitação do Certificado
Solicitação do Certificado
post
Anexar Documento na Solicitação
post
3 - Direcionamento para o Atendimento (Vídeconferência)
4 - Direcionamento para a Emissão do Certificado
5 - Recebimento do Certificado
Envio do certificado criptografado
post
Funcionalidades Adicionais
Webhooks
Webhook - Protocolo Revogado
post
Consulta para Autorização de Emissão
get
Voucher
Criar Voucher
post
Listar Vouchers
get
Atualizar Voucher
put
Obter Dados do Voucher
get
Excluir Voucher
delete
Obter Dados do Voucher por Valor
get
Listar Solicitações de Certificado
get
Listar Documentos da Solicitação
get
Verificar cadastro no PSBIO (Cliente sem CNH)
get
Excluir Solicitação de Certificado
delete
Excluir Documento da Solicitação
delete
Exibir Documento da Solicitação
get
Exibir Solicitação de Certificado
get
Exibir Status da Solicitação de Certificado
get
Baixar Documento da Solicitação
get
Baixar Termo de Titularidade
get
Emissão de Protocolo via Certificado ("Renovação")
post
FAQ
BryID V2
🚀Bry ID
Auth
Application Login
post
Subject
Create Subject
post
Delete Subject
delete
Get Subject
get
Subject Exists
get
Verify Subject Biometry
post
Activate Subject Identify
post
Deactivate Subject Identify
post
Identify Subject
post
Document
Document
post
FaceMatch
Face Match
post
Liveness
Liveness Validation
post
❓Conceitos
🔑O que é uma assinatura digital?
O que é um certificado digital?
Powered by
Edição de Envelope
Em breve nova documentação
