Criar Modelo DOCX

Faz upload de um arquivo DOCX contendo variaveis em duplas chaves ({{variavel}}). O TapSign detecta automaticamente todas as variaveis presentes no documento e cria um modelo reutilizavel.

Endpoint

POST /v1/models/docx

Headers

Header	Valor
Authorization	Bearer {token}
Content-Type	multipart/form-data

Body (multipart/form-data)

Campo	Tipo	Obrigatorio	Descricao
file	file	Sim	Arquivo DOCX contendo variaveis em {{duplas_chaves}}
name	string	Nao	Nome do modelo. Se nao informado, usa o nome do arquivo

Variaveis automaticas

O TapSign escaneia o documento DOCX em busca de textos no formato {{nome_variavel}} e cria campos automaticamente. Use nomes descritivos e sem espacos (use underline).

Exemplos validos:

• {{nome_completo}}
• {{cpf}}
• {{data_inicio}}
• {{valor_contrato}}
• {{endereco_completo}}

Exemplo de Requisicao

curl -X POST https://api.tapsign.com.br/v1/models/docx \
  -H "Authorization: Bearer {token}" \
  -F "file=@contrato-template.docx" \
  -F "name=Contrato de Prestacao de Servicos"

Resposta de Sucesso

Status: 201 Created

{
  "id": "m1o2d3e4-l5o6-7890-abcd-ef1234567890",
  "name": "Contrato de Prestacao de Servicos",
  "status": "ACTIVE",
  "fields": [
    {
      "key": "nome_completo",
      "label": "nome_completo",
      "type": "TEXT",
      "required": true
    },
    {
      "key": "cpf",
      "label": "cpf",
      "type": "TEXT",
      "required": true
    },
    {
      "key": "data_inicio",
      "label": "data_inicio",
      "type": "TEXT",
      "required": true
    },
    {
      "key": "valor_contrato",
      "label": "valor_contrato",
      "type": "TEXT",
      "required": true
    }
  ],
  "documentCount": 0,
  "createdAt": "2026-03-29T14:30:00Z"
}

Campos da Resposta

Campo	Tipo	Descricao
id	string (UUID)	ID unico do modelo
name	string	Nome do modelo
status	string	Status: ACTIVE ou INACTIVE
fields	array	Lista de variaveis detectadas no DOCX
fields[].key	string	Identificador da variavel (sem chaves)
fields[].label	string	Label de exibicao
fields[].type	string	Tipo do campo (atualmente sempre TEXT)
fields[].required	boolean	Se o campo e obrigatorio ao usar o modelo
documentCount	number	Quantidade de documentos ja criados a partir deste modelo
createdAt	string (ISO 8601)	Data de criacao

Erros

Codigo	Descricao
400	Arquivo nao e um DOCX valido ou esta corrompido
413	Arquivo excede o limite de tamanho (10 MB)
422	Nenhuma variavel {{...}} encontrada no documento

Atencao

O arquivo deve ser um DOCX valido (Microsoft Word). Arquivos PDF, DOC (formato antigo) ou outros formatos nao sao aceitos neste endpoint.

Dica

Antes de fazer o upload, abra o DOCX e verifique se as variaveis estao em texto corrido (sem formatacao parcial). Se voce digitar {{nome}} e depois aplicar negrito apenas no nome, o Word pode quebrar a variavel internamente e o TapSign nao conseguira detecta-la.