---
title: Adicionar Rubrica no Documento (API)
description: Adicionar Rubrica no Documento (API)
---

[Pular para o conteúdo](https://ajuda.d4sign.com.br/adicionar-rubrica-no-documento-api#main-content)

[![LOGO D4SIGN-2](https://ajuda.d4sign.com.br/hs-fs/hubfs/LOGO%20D4SIGN-2.png?width=150&height=33&name=LOGO%20D4SIGN-2.png)](https://www.d4sign.com.br)

- [Central de Conhecimento](https://ajuda.d4sign.com.br/)

Abrir navegação principal

Fechar navegação principal

- [Central de Conhecimento](https://ajuda.d4sign.com.br/)
- [Canais de Atendimento](https://ajuda.d4sign.com.br/contatos-d4sign-nossos-canais-de-atendimento)

[Canais de Atendimento](https://ajuda.d4sign.com.br/contatos-d4sign-nossos-canais-de-atendimento?hsLang=pt-br)

 Como podemos ajudar?

- Não há sugestões porque o campo de pesquisa está em branco.

1. [Central de Conhecimento](https://ajuda.d4sign.com.br/?hsLang=pt-br)
2. [Integrações Via API e SSO](https://ajuda.d4sign.com.br/integra%C3%A7%C3%B5es-via-api-e-sso?hsLang=pt-br)
3. [Endpoints Adicionar Rubrica](https://ajuda.d4sign.com.br/integra%C3%A7%C3%B5es-via-api-e-sso?hsLang=pt-br#endpoints-adicionar-rubrica)

# Adicionar Rubrica no Documento (API)

## Esta seção da API D4Sign permite que você adicione elementos visuais como assinaturas, rubricas ou selos em posições específicas dentro de um documento. Isso é fundamental para personalizar a aparência final do seu documento assinado.

**🚧 Importante:** Não esqueça de enviar o `tokenAPI` e `cryptKey` em sua requisição.

**Exemplo:** `https://secure.d4sign.com.br/api/v1/documents/{UUID-MAIN-DOCUMENT}/addpins?tokenAPI={SEU-TOKEN}&cryptKey={SEU-CRYPT-KEY}`

### Adicionar rubrica no documento (API)

Este endpoint irá adicionar um "pin" (assinatura, rubrica ou selo) na posição definida de um documento.

**`POST /documents/{UUID-MAIN-DOCUMENT}/addpins`**

**Parâmetros de Requisição (URL)**

| Parâmetro | Descrição |
| --- | --- |
| `UUID-MAIN-DOCUMENT` | **(obrigatório)** O UUID do documento principal ao qual a rubrica será adicionada. |

Exportar para as Planilhas

**Parâmetros de Requisição (Body `pins` array)**

| Parâmetro | Descrição |
| --- | --- |
| `document` | **(obrigatório)** UUID do documento principal ou do documento anexo (slave) onde o pin será adicionado. |
| `email` | **(obrigatório)** E-mail do signatário que terá o pin adicionado. Este e-mail já deve pertencer a um signatário previamente adicionado ao documento. |
| `page_width` | **(obrigatório)** Largura da página do documento em pixels. |
| `page_height` | **(obrigatório)** Altura da página do documento em pixels. |
| `page` | **(obrigatório)** O número da página onde o pin será posicionado no documento selecionado no parâmetro `document`. |
| `position_x` | **(obrigatório)** Posição X (horizontal) da assinatura em pixels, a partir da esquerda da página. |
| `position_y` | **(obrigatório)** Posição Y (vertical) da assinatura em pixels, a partir do topo da página. |
| `type` | Tipo de pin a ser adicionado: `0` para assinatura \<br\> `1` para rubrica \<br\> `2` para selo |

**Requisição - Envio Header**

 

JSON

 

```
{    "Content-Type": "application/json"}
```

```
{    "Accept": "application/json"}
```

**Requisição - Envio Body**

JSON 

```
{  "pins": [    {      "document": "uuid-do-documento",      "email" : "emaila@dominio.com.br",      "page_width": 794,      "page_height": 1123,      "page": 1,      "position_x": 397,      "position_y": 560,      "type": 1     }  ]}
```

**Lembrando que o modelo acima segue o padrão de uma folha A4 retrato.**

**Para saber o UUID de um documento anexo (slave), é preciso fazer a seguinte requisição já apresentada anteriormente na documentação:** `GET /documents/{uuid-main-document}/listslaves`

---

#### **Como Identificar o Posicionamento no Documento**

Para definir com precisão os valores de `position_x` e `position_y`, você precisará identificar as coordenadas exatas no seu documento. Uma forma comum de fazer isso durante o desenvolvimento é usando um script JavaScript para capturar a posição do cursor.

Ao visualizar o documento (por exemplo, dentro de um `<iframe>` ou elemento `canvas`), você pode usar o seguinte código no console do navegador para te ajudar a encontrar as coordenadas desejadas:

JavaScript 

```
var canvasElements = document.querySelectorAll("canvas");canvasElements.forEach(function(canvasElement) {    canvasElement.addEventListener("mousemove", function(event) {        var rect = canvasElement.getBoundingClientRect();        var posX = event.clientX - rect.left;        var posY = event.clientY - rect.top;        console.log("Posição do cursor: X=" + posX + " Y=" + posY);    });});
```

Este script irá logar no console do seu navegador as coordenadas X e Y do cursor cada vez que você mover o mouse sobre um elemento `canvas`. Assim, um desenvolvedor pode navegar visualmente até o ponto desejado no documento e anotar as coordenadas para usar na requisição da API.

---

**Resposta** Em caso de sucesso, a resposta retornará uma mensagem confirmando a operação.

JSON 

```
{  "message": "success"}
```

Após receber a mensagem de sucesso, atualize a tela de visualização do documento (`viewblob`) e o pin (rubrica, assinatura ou selo) deve estar na página e posição definida na requisição.

- [Treinamento](https://ajuda.d4sign.com.br/treinamento?hsLang=pt-br#main-content)

    - [Treinamento - Conhecendo o nosso Dashboard](https://ajuda.d4sign.com.br/treinamento?hsLang=pt-br#treinamento-conhecendo-o-nosso-dashboard)
    - [Treinamento - Enviando um documento para assinatura](https://ajuda.d4sign.com.br/treinamento?hsLang=pt-br#treinamento-enviando-um-documento-para-assinatura)
    - [Treinamento - Opções do cofre](https://ajuda.d4sign.com.br/treinamento?hsLang=pt-br#treinamento-op%C3%A7%C3%B5es-do-cofre)
    - [Treinamento - Pontos de autenticação](https://ajuda.d4sign.com.br/treinamento?hsLang=pt-br#treinamento-pontos-de-autentica%C3%A7%C3%A3o)
    - [Treinamento - D4Sign.AI](https://ajuda.d4sign.com.br/treinamento?hsLang=pt-br#treinamento-d4sign-ai)
    - [Treinamento - Menu Relatórios](https://ajuda.d4sign.com.br/treinamento?hsLang=pt-br#treinamento-menu-relat%C3%B3rios)
    - [Treinamento - Template Word e Banco de Minutas](https://ajuda.d4sign.com.br/treinamento?hsLang=pt-br#treinamento-template-word-e-banco-de-minutas)
    - [Treinamento - Power Form e Novo Power Form](https://ajuda.d4sign.com.br/treinamento?hsLang=pt-br#treinamento-power-form-e-novo-power-form)
    - [Treinamento - Envio em lote e Grupos de assinaturas](https://ajuda.d4sign.com.br/treinamento?hsLang=pt-br#treinamento-envio-em-lote-e-grupos-de-assinaturas)
- [Primeiros Passos](https://ajuda.d4sign.com.br/primeiros-passos?hsLang=pt-br)
- [Dashboard](https://ajuda.d4sign.com.br/dashboard?hsLang=pt-br#main-content)

    - [Caixa de Entrada](https://ajuda.d4sign.com.br/dashboard?hsLang=pt-br#caixa-de-entrada)
    - [D4Sign CLM](https://ajuda.d4sign.com.br/dashboard?hsLang=pt-br#d4sign-clm)
    - [Grupo de Assinatura](https://ajuda.d4sign.com.br/dashboard?hsLang=pt-br#grupo-de-assinatura)
    - [Envio em Lote](https://ajuda.d4sign.com.br/dashboard?hsLang=pt-br#envio-em-lote)
    - [Relatórios](https://ajuda.d4sign.com.br/dashboard?hsLang=pt-br#relat%C3%B3rios)
    - [Últimos eventos do cofre](https://ajuda.d4sign.com.br/dashboard?hsLang=pt-br#%C3%BAltimos-eventos-do-cofre)
- [Menu Superior (Seu e-mail)](https://ajuda.d4sign.com.br/menu-superior-seu-e-mail?hsLang=pt-br#main-content)

    - [Editar assinatura](https://ajuda.d4sign.com.br/menu-superior-seu-e-mail?hsLang=pt-br#editar-assinatura)
    - [Faturamentos](https://ajuda.d4sign.com.br/menu-superior-seu-e-mail?hsLang=pt-br#faturamentos)
    - [Certificados A1](https://ajuda.d4sign.com.br/menu-superior-seu-e-mail?hsLang=pt-br#certificados-a1)
    - [Minha Conta](https://ajuda.d4sign.com.br/menu-superior-seu-e-mail?hsLang=pt-br#minha-conta)
    - [Usuários do Domínio](https://ajuda.d4sign.com.br/menu-superior-seu-e-mail?hsLang=pt-br#usu%C3%A1rios-do-dom%C3%ADnio)
    - [Notificações](https://ajuda.d4sign.com.br/menu-superior-seu-e-mail?hsLang=pt-br#notifica%C3%A7%C3%B5es)
    - [Cadastro de SSO](https://ajuda.d4sign.com.br/menu-superior-seu-e-mail?hsLang=pt-br#cadastro-de-sso)
    - [\</\> Dev (API)](https://ajuda.d4sign.com.br/menu-superior-seu-e-mail?hsLang=pt-br#dev-api)
    - [Upgrade de conta](https://ajuda.d4sign.com.br/menu-superior-seu-e-mail?hsLang=pt-br#upgrade-de-conta)
    - [GoPaperless - Selo de empresa sustentável](https://ajuda.d4sign.com.br/menu-superior-seu-e-mail?hsLang=pt-br#gopaperless-selo-de-empresa-sustent%C3%A1vel)
- [Cofres](https://ajuda.d4sign.com.br/cofres?hsLang=pt-br#main-content)

    - [Novo Documento](https://ajuda.d4sign.com.br/cofres?hsLang=pt-br#novo-documento)
    - [Opções do Cofre](https://ajuda.d4sign.com.br/cofres?hsLang=pt-br#op%C3%A7%C3%B5es-do-cofre)
    - [Opções do cofre - Pré-cadastrar e-mails](https://ajuda.d4sign.com.br/cofres?hsLang=pt-br#op%C3%A7%C3%B5es-do-cofre-pr%C3%A9-cadastrar-e-mails)
    - [Opções do cofre - Configurações](https://ajuda.d4sign.com.br/cofres?hsLang=pt-br#op%C3%A7%C3%B5es-do-cofre-configura%C3%A7%C3%B5es)
    - [Opções do Cofre - Configurações - Permissões do Cofre](https://ajuda.d4sign.com.br/cofres?hsLang=pt-br#op%C3%A7%C3%B5es-do-cofre-configura%C3%A7%C3%B5es-permiss%C3%B5es-do-cofre)
    - [Mover para outro cofre](https://ajuda.d4sign.com.br/cofres?hsLang=pt-br#mover-para-outro-cofre)
- [Como Assinar](https://ajuda.d4sign.com.br/como-assinar?hsLang=pt-br)
- [Integrações Via API e SSO](https://ajuda.d4sign.com.br/integra%C3%A7%C3%B5es-via-api-e-sso?hsLang=pt-br#main-content)

    - [Introdução a API](https://ajuda.d4sign.com.br/integra%C3%A7%C3%B5es-via-api-e-sso?hsLang=pt-br#introdu%C3%A7%C3%A3o-a-api)
    - [Endpoints Cofres](https://ajuda.d4sign.com.br/integra%C3%A7%C3%B5es-via-api-e-sso?hsLang=pt-br#endpoints-cofres)
    - [Endpoints Documentos](https://ajuda.d4sign.com.br/integra%C3%A7%C3%B5es-via-api-e-sso?hsLang=pt-br#endpoints-documentos)
    - [Endpoints Signatários](https://ajuda.d4sign.com.br/integra%C3%A7%C3%B5es-via-api-e-sso?hsLang=pt-br#endpoints-signat%C3%A1rios)
    - [Endpoints Adicionar Rubrica](https://ajuda.d4sign.com.br/integra%C3%A7%C3%B5es-via-api-e-sso?hsLang=pt-br#endpoints-adicionar-rubrica)
    - [Endpoints Observadores](https://ajuda.d4sign.com.br/integra%C3%A7%C3%B5es-via-api-e-sso?hsLang=pt-br#endpoints-observadores)
    - [Endpoints Certificados ICP-Brasil](https://ajuda.d4sign.com.br/integra%C3%A7%C3%B5es-via-api-e-sso?hsLang=pt-br#endpoints-certificados-icp-brasil)
    - [Endpoints Webhook](https://ajuda.d4sign.com.br/integra%C3%A7%C3%B5es-via-api-e-sso?hsLang=pt-br#endpoints-webhook)
    - [Endpoints Tags](https://ajuda.d4sign.com.br/integra%C3%A7%C3%B5es-via-api-e-sso?hsLang=pt-br#endpoints-tags)
    - [Endpoints Usuários](https://ajuda.d4sign.com.br/integra%C3%A7%C3%B5es-via-api-e-sso?hsLang=pt-br#endpoints-usu%C3%A1rios)
    - [Embed](https://ajuda.d4sign.com.br/integra%C3%A7%C3%B5es-via-api-e-sso?hsLang=pt-br#embed)
    - [SSO](https://ajuda.d4sign.com.br/integra%C3%A7%C3%B5es-via-api-e-sso?hsLang=pt-br#sso)
- [Perguntas Frequentes](https://ajuda.d4sign.com.br/perguntas-frequentes?hsLang=pt-br#main-content)

    - [Contatos D4Sign](https://ajuda.d4sign.com.br/perguntas-frequentes?hsLang=pt-br#contatos-d4sign)
    - [Procedimentos em Destaque](https://ajuda.d4sign.com.br/perguntas-frequentes?hsLang=pt-br#procedimentos-em-destaque)
    - [Perguntas Frequentes](https://ajuda.d4sign.com.br/perguntas-frequentes?hsLang=pt-br#perguntas-frequentes)
    - [Resolução de Problemas](https://ajuda.d4sign.com.br/perguntas-frequentes?hsLang=pt-br#resolu%C3%A7%C3%A3o-de-problemas)
    - [Plano e Limites](https://ajuda.d4sign.com.br/perguntas-frequentes?hsLang=pt-br#plano-e-limites)
- [Segurança e Validade Jurídica](https://ajuda.d4sign.com.br/seguran%C3%A7a-e-validade-jur%C3%ADdica?hsLang=pt-br)

[![LOGO D4SIGN-1](https://ajuda.d4sign.com.br/hs-fs/hubfs/LOGO%20D4SIGN-1.png?width=150&height=33&name=LOGO%20D4SIGN-1.png "LOGO D4SIGN-1")](https://d4sign.com.br/)

<https://www.facebook.com/d4sign/> <https://www.instagram.com/d4sign_/> <https://www.youtube.com/c/d4sign> <https://br.linkedin.com/company/d4sign>