---
title: "Inicializa a assinatura XML/XAdES"
method: POST
path: "/api/xml-signature-service/v2/signatures/initialize"
tags: ["Assinador XML"]
---

# Inicializa a assinatura XML/XAdES

`POST /api/xml-signature-service/v2/signatures/initialize`

## Request

- Base URL: `https://cloud-hom.bry.com.br`
- URL: `https://cloud-hom.bry.com.br/api/xml-signature-service/v2/signatures/initialize`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/bry/apis/bry-easy-sign-api-rest/docs/api/xml-signature-service/v2/signatures/initialize/post.ts> (a function with typed inputs; its response is checked against the schema)

## Request body `multipart/form-data`

- object
  - `nonce` string, required: Nonce da requisição.
  - `certificate` string, required: Certificado [conteúdo codificado em Base64]
  - `returnType` string, required: Define o tipo de retorno da requisição. LINK retorna uma resposta JSON, a qual possui links para downloads dos arquivos assinados. BASE64 retorna uma lista com arquivos assinados, codificados em Base64. Caso LINK, o arquivo será excluído da cache após o download.
  - `hashAlgorithm` string, required: Algoritmo de HASH. [Valores disponíveis: SHA1, SHA256, SHA512]
  - `profile` string, required: Tipo de perfil desejado para a assinatura a ser gerada. [Valores disponíveis: BASIC, COMPLETE, ADRB, ADRT, ADRV, ADRC, ADRA, ETSI_B, ETSI_T, ETSI_LT, ETSI_LTA]
  - `signatureFormat` string, required: Formato da assinatura. [Valores disponíveis: ENVELOPED, ENVELOPING, DETACHED]
  - `operationType` string: Tipo de Operação. [Valores disponíveis: SIGNATURE, CO_SIGNATURE]
  - `binaryContent` string: true = Documento original em qualquer formato<br>false = Documento original no formato xml
  - `includeXPathEnveloped` string: Define se a regra de XPath para que assinaturas anteriores sejam ignoradas em assinaturas enveloped será incluída ou não na assinatura.
  - `generateSimplifiedXMLDSig` string: Define se a assinatura XML básica será gerada sem o prefixo do namespace XMLDSig nas tags da assinatura e se o identificador do certificado do signatário (emissor e serial) será incluído ou não no KeyInfo da assinatura.
  - `includeSigningTime` string: Define se a hora local da assinatura será incluída nos atributos assinados.
  - `canonicalizerType` union: Define o algoritmo de canonicalização a ser aplicado no conteúdo assinado.[Valores disponíveis: INCLUSIVE e EXCLUSIVE]
    - string: Conteúdo processado exclui todos as declarações de namespaces dos antepassados do nodo-alvo, mantendo apenas as declarações de namespace do nodo-alvo, excluindo os comentários. A URL deste canonicalizador é http://www.w3.org/2001/10/xml-exc-c14n#.
    - string: Conteúdo processado inclui todos as declarações de namespaces dos antepassados do nodo-alvo, excluindo os comentários. A URL deste canonicalizador é http://www.w3.org/TR/2001/REC-xml-c14n-20010315.
  - `originalDocuments[0][nonce]` string: Nonce do documento original.
  - `originalDocuments[0][content]` string, binary, required: Arquivo que será assinado. Para lotes, basta incrementar o valor do índice, por ex: originalDocuments[0], originalDocuments[1]
  - `originalDocuments[0][information]` string: Demais informações sobre o arquivo.
  - `originalDocuments[0][filename]` string: Nome do arquivo.
  - `originalDocuments[0][specificNode][id]` string: ID do nodo a ser assinado.
  - `originalDocuments[0][specificNode][name]` string: Nome do nodo a ser assinado.
  - `originalDocuments[0][specificNode][namespace]` string: Namespace do nodo a ser assinado.
  - `policyOid` string: Quando enviado, este parâmetro define o OID da política de assinatura a ser usada com perfil de assinatura selecionado.
  - `lineBreak` boolean: Define se deve ser utilizado quebra de linha na codificação de dados base64 na estrutura da assinatura como certificado, LCR, cadeia e carimbo do tempo. Padrão é True. Utilize o valor False somente se necessário para compatibilidade com outras plataformas.
  - `generationID` string: Define o tipo de geração de IDs nas assinaturas. Valores disponíveis: [SEQUENCIAL, PADRONIZADO]

## Response `200`

The inicialization response

- object
  - `nonce` integer
  - `signedAttributes` object[]
    - `nonce` integer: Nonce equivalente ao documento.
    - `content` string: Hash Base64 sobre o qual se deve realizar a assinatura.
  - `initializedDocuments` object[]
    - `nonce` integer: Nonce equivalente ao documento.
    - `content` string: Hash Base64 do doucumento inicializado.

## Other responses

- `400`: Resposta de erro da aplicação
- `default`: Para mais detalhes sobre as Respostas: [link para as respostas de erro](/openapi/assinadoresXml.html) ou [no formato properties](/openapi/assinadoresXmlErrors.properties)

---

[API](https://skmtc.dev/bry/apis/bry-easy-sign-api-rest.md) - [All operations](https://skmtc.dev/bry/apis/bry-easy-sign-api-rest/llms.txt) - [OpenAPI document](https://skmtc.dev/bry/apis/bry-easy-sign-api-rest/revisions/c87e026e87ac?raw)