API
New Horizon
Log In
API

Inicializar Assinatura PDF/PAdES

post
https://example.com/fw/v1/pdf/pkcs1/assinaturas/acoes/inicializar
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
file
required

Documento no formato PDF que será assinado. Para lotes, basta incrementar o valor do índice, por ex: documento[0], documento[1]

dados_inicializar
object
required

Identificação do signatário (chave pública do certificado digital) e configurações básicas da assinatura (algoritmo de hash e perfil). Deve ser informado no formato JSON.

configuracao_imagem
array of objects

Configuração dos parâmetros de posição, dimensão e visualização da imagem. Deve ser informado no formato JSON. Obs: Para configurações específicas para cada documento, é necessário adicionar entradas 'configuracao_imagem' tantas vezes quanto forem necessárias.

configuracao_imagem
configuracao_texto
array of objects

Configuração do texto que será inserido na assinatura. Deve ser informado no formato JSON. A posição do texto é definida pelo parâmetro 'configuracao_imagem'. Obs: Para configurações específicas para cada documento, é necessário adicionar entradas 'configuracao_texto' tantas vezes quanto forem necessárias.

configuracao_texto
metadados
array of objects

Lista dos pares de nome e valor dos metadados a serem adicionados no arquivo a ser assinado. É possível adicionar tantos quanto se deseje. Para enviar uma configuracao específica por documento do lote, basta repetir este parâmetro. Deve ser informado no formato JSON.

metadados
configuracao_anotacao[0]
array of objects

Lista das configurações que definem os parâmetros de posição, dimensão e visualização de uma anotação. Deve ser informado no formato JSON. Para cada documento que se deseja adicionar anotações, é necessário enviar configurações específicas de acordo com o índice do documento, por ex: configuracao_anotacao[0], configuracao_anotacao[1]. Para adicionar múltiplas anotações a um mesmo documento é necessário adicionar entradas 'configuracao_anotacao[i]' tantas vezes quanto forem necessárias.

configuracao_anotacao[0]
file

Imagem que será inserida no campo de assinatura. Atualmente os formatos suportados são JPEG, PNG e BMP. Obs: Para imagens específicas para cada documento, é necessário adicionar entradas 'imagem[i]' para cada documento do lote.

file

Imagem que será inserida ao fundo do campo de assinatura. Atualmente os formatos suportados são JPEG, PNG e BMP. Obs: Para imagens de Fundo específicas para cada documento, é necessário adicionar entradas 'imagemFundo[i]' para cada documento do lote.

file

Imagem que será inserida na anotacao. O nome do parâmetro deve corresponder ao campo "valor/nome" de uma anotação com "tipo" igual a IMAGEM. É possível utilizar a mesma imagem para diferentes anotações. Atualmente os formatos suportados são JPEG, PNG e BMP.

string

Quando enviado, este parâmetro define o OID da política de assinatura a ser usada com perfil de assinatura selecionado.

es_data
array of objects

Lista das configurações de evidências que serão adicionadas a uma coleção de assinaturas eletrônicas para emissão de relatório. Deve ser informado no formato JSON. É necessário definir um valor de 'es_data' pra cada documento do lote, adicionando entradas 'es_data' de acordo com o número de documentos.

es_data
configuracao_qrcode
array of objects

Configuração da imagem QRCode que será inserida. Deve ser informado no formato JSON. A posição do QRCode é definida pelo parâmetro 'configuracao_imagem'. Não pode ser utilizado em conjunto com o parâmetro 'imagem'. Obs: Para configurações específicas para cada documento, é necessário adicionar entradas 'configuracao_qrcode' tantas vezes quanto forem necessárias.

configuracao_qrcode
string

Array de strings com as senhas para decifragem dos documentos enviados no lote. Deve haver uma senha para cada documento do lote remetido, que será usada na decifragem do documento no respectivo índice do lote de documentos. Exemplo: ['1234','4321']

string

Array de strings com as senhas para cifragem dos documentos enviados no lote. Deve haver uma senha para cada documento do lote remetido, que será usada na cifragem do documento no respectivo índice do lote de documentos. Exemplo: ['1234','4321']

Headers
string

Token de acesso aos serviços BRy emitido no BRy Cloud. É obrigatório em todas as requisições ao HUB. Para utilizar esta documentação é necessário inserir o token em Authorize.

Responses

default

Para mais detalhes sobre as Respostas: link para as respostas de erro ou no formato properties

Updated about 1 year ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago