Pular para o conteúdo principal

Assinar em Lote

Assina multiplos envelopes de uma vez como o usuario autenticado (proprietario). Util para cenarios em que o proprietario da conta precisa assinar varios documentos pendentes de uma so vez.

Endpoint

POST /v1/envelopes/batch-sign

Headers

HeaderValor
AuthorizationBearer {token}
Content-Typeapplication/json

Body

CampoTipoObrigatorioDescricao
envelopeIdsstring[]SimLista de IDs (UUID) dos envelopes a serem assinados
Como funciona

A assinatura em lote utiliza as credenciais do usuario autenticado. Ou seja, o token usado na requisicao identifica quem esta assinando. Apenas envelopes onde o usuario autenticado e um dos signatarios pendentes serao processados.

Exemplo de Requisicao

curl -X POST https://api.tapsign.com.br/v1/envelopes/batch-sign \
-H "Authorization: Bearer {token}" \
-H "Content-Type: application/json" \
-d '{
"envelopeIds": [
"a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"b2c3d4e5-f6a7-8901-bcde-f12345678901",
"c3d4e5f6-a7b8-9012-cdef-123456789012"
]
}'

Resposta de Sucesso

Status: 200 OK

{
"results": [
{
"envelopeId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"status": "SIGNED",
"signedAt": "2026-03-29T14:30:00Z"
},
{
"envelopeId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"status": "SIGNED",
"signedAt": "2026-03-29T14:30:01Z"
},
{
"envelopeId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"status": "ERROR",
"error": "Signatario nao encontrado neste envelope"
}
],
"summary": {
"total": 3,
"signed": 2,
"errors": 1
}
}

Campos da Resposta

Array results

CampoTipoDescricao
envelopeIdstring (UUID)ID do envelope processado
statusstringResultado: SIGNED ou ERROR
signedAtstring ou nullData da assinatura (quando sucesso)
errorstring ou nullMensagem de erro (quando falha)

Objeto summary

CampoTipoDescricao
totalnumberTotal de envelopes enviados
signednumberQuantidade assinada com sucesso
errorsnumberQuantidade com erro

Erros

CodigoDescricao
400Lista de IDs vazia ou formato invalido
401Token de autenticacao invalido
429Limite de requisicoes excedido
Atencao

Envelopes onde o usuario autenticado nao e signatario serao retornados com status ERROR no array de resultados -- a requisicao nao sera rejeitada por completo.

Dica

O limite maximo por requisicao e de 50 envelopes. Para volumes maiores, divida em multiplas chamadas.