Campos de assinatura

Os campos marcam onde cada destinatário assina, rubrica ou preenche um texto sobre o PDF do documento. São posicionados na seção Campos de assinatura da tela Detalhe do documento. Só PDF recebe campos.

Os campos são substituídos como um conjunto: cada PUT grava a lista completa de campos do documento e apaga os anteriores.

Endpoints

Método	Caminho	Descrição
GET	/digital-signature/documents/{document_uuid}/fields	Consulta os campos do documento
PUT	/digital-signature/documents/{document_uuid}/fields	Substitui os campos do documento

GET /digital-signature/documents/{document_uuid}/fields

Resposta (200):

{
  "render_width": 800,
  "fields": [
    {
      "id": 15,
      "recipient_id": 3,
      "type": "signature",
      "page": 2,
      "x_pos": 120,
      "y_pos": 540,
      "width": 200,
      "height": 60,
      "text": null,
      "default": null,
      "validate_data": false,
      "fontsize": null
    }
  ]
}

PUT /digital-signature/documents/{document_uuid}/fields

Substitui todos os campos do documento pelos enviados. Enviar uma lista vazia remove os campos. Os campos só podem ser alterados enquanto o documento está em Aguardando envio.

Corpo (JSON)

Campo	Obrigatório	Tipo	Descrição
render_width	Sim	Inteiro (1 a 5000)	Largura de referência, em pixels, em que as coordenadas dos campos foram medidas
fields	Sim	Lista	Campos do documento. Pode ser vazia
fields[].recipient_id	Sim	Inteiro	Id do destinatário do campo. Precisa ser destinatário deste documento
fields[].type	Sim	Texto	signature (assinatura), rubric (rubrica) ou text (texto)
fields[].page	Sim	Inteiro (1 ou mais)	Página do PDF
fields[].x_pos	Sim	Inteiro (-999 ou mais)	Posição horizontal do canto superior esquerdo
fields[].y_pos	Sim	Inteiro (-999 ou mais)	Posição vertical do canto superior esquerdo
fields[].width	Sim	Inteiro (1 a 5000)	Largura do campo
fields[].height	Sim	Inteiro (1 a 5000)	Altura do campo
fields[].text	Não	Texto	Rótulo que o destinatário preenche ao assinar. Obrigatório em campo text sem default
fields[].default	Não	Texto	Valor fixo, gravado no PDF. Não precisa ser preenchido pelo destinatário
fields[].validate_data	Não	Booleano	Valida o dado informado pelo destinatário
fields[].fontsize	Não	Inteiro (1 a 255)	Tamanho da fonte

Resposta (200): o mesmo formato do GET, com os campos gravados.

Erros

Status	Mensagem	Quando acontece
400	Os campos só podem ser editados enquanto o documento está aguardando envio.	O documento já foi enviado para assinatura
422	Destinatário inválido para um dos campos posicionados.	Um recipient_id não pertence ao documento
422	O campo de texto sem valor fixo precisa de um rótulo (text).	Campo text sem default e sem text

curl -X PUT https://api.pedagogo.app/digital-signature/documents/<uuid-do-documento>/fields \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <token-de-sessao>" \
  -d '{
    "render_width": 800,
    "fields": [
      {"recipient_id": 3, "type": "signature", "page": 1, "x_pos": 100, "y_pos": 600, "width": 200, "height": 60}
    ]
  }'