v1

latestOpenAPI 3.0.0MIT2026-08-0414772502.0 KB

Assinador CMS

Assinar CMS/CAdES utilizando Certificado em nuvem

post/fw/v1/cms/kms/assinaturas

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.

kms_type'BRYKMS' | 'GOVBR' | 'DINAMO' | 'HSMPKCS1' | 'PSC' required

Tipo da credencial enviada em 'kms_data'.

Request body

algoritmoHashstring required

String que representa o algoritmo de hash que será utilizado para gerar a assinatura. [Valores disponíveis: SHA1, SHA256 e SHA512].

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]

padraostring required

Indica o padrão da assinatura que será gerada. [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

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.

oidPoliticastring

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

Example request

{
  "kms_data": {
    "pin": "c2VuaGFFbUJhc2U2NA==",
    "token": "546f6b656e2064652061636573736f20616f204252794b4d5320656d20486578",
    "uuid_cert": "UUID do certificado (Opcional)",
    "user": "Cpf para Identificação (Opcional)"
  },
  "algoritmoHash": "SHA256",
  "formatoAssinatura": "ATTACHED",
  "formatoDadosEntrada": "Base64",
  "padrao": "CADES",
  "perfil": "TIMESTAMP",
  "hashes": [
    "SGFzaCBlbSBiYXNlIDY0"
  ],
  "comentarios": [
    "Um Comentario."
  ],
  "nomeDocumentos": [
    "Nome documento"
  ],
  "oidPolitica": "2.16.76.1.7.1.1.2.3"
}

Response

Signature response

assinaturasstring[]

Example response

{
  "assinaturas": [
    "Base 64 da assinatura"
  ]
}