v1

latestOpenAPI 3.0.0MIT2026-08-0414772502.0 KB

Assinador CMS

Inicializa a assinatura CMS/CADES

post/fw/v1/cms/pkcs1/assinaturas/acoes/inicializar

Headers

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.

Request body

algoritmoHashstring required

Algoritmo de HASH [SHA1, SHA256, SHA512], Default value : SHA256

certificadostring required

Certificado [conteúdo codificado em Base64]

coAssinaturaboolean

Boolean representando se será realizado uma coassinatura. Valor padrão é false.

formatoAssinaturastring required

Formato do processamento dos documentos recebidos na lista de hashes. [Valores disponíveis: HASH, ATTACHED e DETACHED].

formatoDadosEntradastring required

String indicando qual será o formato de codificação dos dados a serem assinados. [Valores disponíveis: Base64]

formatoDadosSaidastring required

String indicando qual será o formato de codificação dos dados da resposta. [Valores disponíveis: Base64]

padraostring required

String representando o padrão de assinatura. [Valores disponíveis: CMS, CADES]

perfilstring required

String representando o tipo de perfil desejado para a assinatura a ser gerada. [Valores disponíveis: BASIC, TIMESTAMP, COMPLETE, ADRB, ADRT, ADRV, ADRC, ADRA, ETSI_B, ETSI_T, ETSI_LT e ETSI_LTA]. Aceita também os valores legados em português para os perfis de assinatura CMS básica.

hashesstring[] required

Array de strings com os conteúdos a serem assinados. Atualmente se o formatoAssinatura for HASH deve ser enviado os resumos criptográficos (hashes) calculados a partir do documento original. Caso formatoAssinatura seja algum dos demais valores (ATTACHED ou DETACHED), deve ser enviado o conteúdo original do documento que se deseja assinar.

noncesstring[] required

Array de strings com um conjunto de nonces gerados pela aplicação cliente para realizar o controle das assinaturas. Para cada arquivo encaminhado, deverá ser atribuído um nonce.

comentariosstring[]

Array de strings com um conjunto de comentários que serão inseridos na assinatura. Parâmetro Opcional, mas se utilizado deve ser enviado um comentario para cada assinatura a ser realizada.

nomeDocumentosstring[]

Array de strings com um conjunto de nomes que serão inseridos na assinatura como nome do documento. Parâmetro Opcional, mas se utilizado deve ser enviado um nome para cada assinatura a ser realizada.

Example request

{
  "algoritmoHash": "SHA256",
  "certificado": "Certificado codificado em Base64",
  "formatoAssinatura": "ATTACHED",
  "formatoDadosEntrada": "Base64",
  "formatoDadosSaida": "Base64",
  "padrao": "CADES",
  "perfil": "TIMESTAMP",
  "hashes": [
    "SGFzaCBlbSBiYXNlIDY0"
  ],
  "nonces": [
    "1"
  ],
  "comentarios": [
    "Um Comentario."
  ],
  "nomeDocumentos": [
    "Nome documento"
  ]
}

Response

The initialization response

noncestring

formatoDadosEntradastring

formatoDadosSaidastring

algoritmoHashstring

Example response

{
  "nonce": "123456789",
  "formatoDadosEntrada": "Base64",
  "formatoDadosSaida": "Base64",
  "algoritmoHash": "SHA256",
  "assinaturasInicializadas": [
    {
      "messageDigest": "Hash correspondente ao conteúdo que deve ser assinado. O conteúdo deste campo deve ser cifrado com a chave privada do certificado (por exemplo via Bry Extension) e então enviado à finalização."
    }
  ]
}