---
title: "Adicionar campos de assinatura no documento PDF"
method: POST
path: "/preparador/v1/campos"
tags: ["Utilitários"]
deprecated: true
---

# Adicionar campos de assinatura no documento PDF

`POST /preparador/v1/campos`

## Request

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

> **Deprecated.**

## Request body `multipart/form-data`

- object
  - `documento[0]` string, binary, required: Documento PDF que deseja incluir campos de assinatura. Para lotes, basta incrementar o valor do índice, por ex: documento[0], documento[1].
  - `tipoRetorno` string, required: Define o tipo de retorno da requisição. LINK retorna uma resposta JSON, a qual possui links para downloads dos arquivos PDFs. BASE64 retorna uma lista com os arquivos PDFs, codificados em Base64. Caso LINK, o arquivo será excluído da cache após o download.
  - `configuracao_campo[0]` ConfiguracaoCampo, required: Configuração dos parâmetros de posição, dimensão e visualização do campo no documento do lote, indicado no índice [i]. Deve ser informado no formato JSON. Para configurar múltiplos campos, deve ser enviado um array de JSON.
    - `altura` string, required: Altura (em mm) da imagem que será inserida.
    - `largura` string, required: Largura (em mm) da imagem que será inserida.
    - `campoAssinatura` string, required: Define o nome do campo. O nome do campo é utilizado posteriormente para indicar qual campo deseja assinar.
    - `coordenadaX` string: Define o deslocamento horizontal (em mm) da imagem em relação a posição definida no parâmetro "posicao", sendo o valor default o canto inferior esquerdo da página. Valores positivos deslocam a imagem para a direita e para cima, enquanto negativos para a esquerda e para baixo.
    - `coordenadaY` string: Define o deslocamento vertical (em mm) da imagem em relação a posição definida no parâmetro "posicao", sendo o valor default o canto inferior esquerdo da página. Valores positivos deslocam a imagem para a direita e para cima, enquanto negativos para a esquerda e para baixo.
    - `posicao` string: Define a origem 0,0 do campo em relação aos quatro cantos da página. [Valores disponíveis: INFERIOR_DIREITO, INFERIOR_ESQUERDO, SUPERIOR_DIREITO e SUPERIOR_ESQUERDO].
    - `pagina` string: Define a(s) página(s) na qual a imagem será adicionada. [Valores disponíveis: PRIMEIRA, ULTIMA e TODAS]. A opção TODAS não pode ser utilizada em documentos já assinados.
    - `numeroPagina` string: Define o índice da página na qual a imagem será adicionada. A contagem do índice de páginas inicia em 1.
    - `posicaoBorda` string: Define que a imagem será posicionada centralizada em uma das bordas da página. [Valores disponíveis: BORDA_DIREITA, BORDA_ESQUERDA, BORDA_INFERIOR e BORDA_SUPERIOR].
    - `rotacaoImagemBorda` string: Define a rotação da imagem para os casos de página em modo paisagem ou imagem de assinatura posicionada na borda.[Valores disponíveis: ANTI_HORARIO_90_GRAUS e HORARIO_90_GRAUS].

## Response `200`

Tipo de retorno de documentos

- union
  - object
    - `identificador` string: Identificador da requisição
    - `quantidadeAssinaturas` integer: Número de documentos da requisição
    - `documentos` object[]
      - `nonce` integer: Nonce do documento, se enviado na requisição
      - `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

---

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