---
title: "Finalizar Assinatura XML/XADES"
method: POST
path: "/api/xml-signature-service/v2/signatures/finalize"
tags: ["Assinador XML"]
---

# Finalizar Assinatura XML/XADES

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

## Request

- Base URL: `https://cloud-hom.bry.com.br`
- URL: `https://cloud-hom.bry.com.br/api/xml-signature-service/v2/signatures/finalize`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/bry/apis/bry-easy-sign-api-rest/docs/api/xml-signature-service/v2/signatures/finalize/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.
  - `finalizations[0][nonce]` string: Nonce da assinatura.
  - `finalizations[0][content]` string, binary, required: Arquivo que será assinado. Deve ser adicionado na mesma ordem da inicialização.
  - `finalizations[0][signatureValue]` string, required: Valor em Base64 do parâmetro signedAttributes retornado do inicializar, assinado com a chave privada do usuário (via Bry Extension por exemplo). Deve ser inserido na mesma ordem do retorno.
  - `finalizations[0][initializedDocument]` string, required: Conteúdo Base64 do documento inicializado [Assinatura ou co-assinatura]
  - `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.

## Response `200`

- union
  - DocumentoLinkSemNome
    - `identificador` string: Identificador da requisição
    - `quantidadeAssinaturas` integer: Numero de documentos da requisição
    - `documentos` object[]
      - `nonce` integer: Nonce do documento, se enviado na requisição
      - `hash` string: Hash do documento
      - `links` object[]
        - `rel` string
        - `href` string: Link para recuperar documento assinado
      - `DocumentoLinkSemNonce` object
        - `identificador` string: Identificador da requisição
        - `quantidadeAssinaturas` integer: Numero de documentos da requisição
        - `documentos` object[]
          - `hash` string: Hash do documento
          - `nomeArquivo` string: Nome do documento
          - `links` object[]
            - `rel` string
            - `href` string: Link para recuperar documento assinado
  - string[]

## 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)
