Quick reference tables with all the values the API returns or accepts.
Envelope statuses#
| Status |
Meaning |
Final |
rascunho |
Created, not sent yet (or waiting for the template PDF) |
No |
enviado |
Sent; nobody has signed yet |
No |
em_andamento |
At least one signature recorded |
No |
concluido |
Everyone has signed; final copy available |
Yes |
recusado |
A signer declined |
Yes |
expirado |
The deadline passed without all signatures |
Yes |
cancelado |
Canceled by the sender |
Yes |
Signer statuses#
| Status |
Meaning |
pendente |
Waiting for their turn or for the envelope to be sent |
notificado |
Invitation delivered |
visualizado |
Opened the document |
assinado |
Signed |
recusado |
Declined |
Values accepted at creation#
| Field |
Values |
Default |
ordem |
paralela, sequencial |
paralela |
nivel |
avancada, simples |
avancada |
idioma |
pt, en, es |
Account language |
papel |
signatario, testemunha, aprovador, observador |
signatario |
canal_otp |
email, conversa |
conversa in accounts that come from ChatISP; in the others, the channel configured in the account (initially email) |
origem (response) |
painel, api, chatisp |
Defined by Ravisign |
Coming soon qualificada level (with the signer's ICP-Brasil certificate) and confirmation code by SMS and by WhatsApp through the official API.
Limits#
| Item |
Limit |
| PDF size |
20 MB (about 27 MB in base64) |
| Signers per envelope |
1 to 50, with at least one who is not an observer |
| Title |
190 characters |
| Invitation message |
2000 characters |
| Cancellation reason |
500 characters |
| Template variable value |
5000 characters |
referencia_externa |
190 characters |
Deadline (expira_em) |
From 1 hour to 365 days from now |
Deadline (prazo_dias) |
1 to 365 days |
| Automatic reminder |
0 to 720 hours (0 turns it off) |
| Confirmation code |
6 digits; 10 minutes by email, 30 minutes in the conversation; 5 attempts; up to 4 per hour |
| Pagination |
limite from 1 to 100, default 50 |
| Key rate limit |
Default 60 requests per minute, up to 600 |
| Webhooks per account |
10 |
| Webhook delivery attempts |
8 |
Webhook events#
| Event |
When |
dados |
envelope.enviado |
The envelope was sent to the signers |
{} |
signatario.visualizou |
The signer opened the document |
signatario |
signatario.assinou |
The signer signed |
signatario |
signatario.recusou |
The signer declined (the envelope becomes recusado) |
signatario |
envelope.concluido |
Everyone signed and the final copy is ready |
hash_final |
envelope.expirado |
The deadline passed without all signatures |
{} |
envelope.cancelado |
The envelope was canceled |
{} |
signatario.otp_solicitado |
On the conversation channel, the signer requested a new code on the page |
signatario, codigo, validade_minutos, expira_em |
webhook.teste |
Test triggered by webhooks/testar |
mensagem |
Audit trail events#
Returned by envelopes/eventos. The meaning of each one is in Audit trail.
envelope_criado, envelope_enviado, notificacao_enviada, link_aberto, documento_visualizado, otp_enviado, otp_validado, otp_falhou, assinado, recusado, lembrete_enviado, expirado, cancelado, documento_final_gerado, concluido, webhook_entregue, ancoragem, conclusao_retomada.
| Header |
Where |
Content |
Authorization |
Request |
Bearer rsg_... |
X-Ravisign-Api-Versao |
Every response |
1 |
X-RateLimit-Limite |
Response |
Requests allowed per minute |
X-RateLimit-Restante |
Response |
How many still fit in the minute |
X-RateLimit-Reinicio |
Response |
Seconds until the count resets |
Retry-After |
429 response |
Seconds to wait before retrying |
X-Ravisign-Evento |
Webhook delivery |
The event |
X-Ravisign-Entrega |
Webhook delivery |
Delivery identifier, the same in all attempts |
X-Ravisign-Tentativa |
Webhook delivery |
Attempt number (1 to 8) |
X-Ravisign-Assinatura |
Webhook delivery |
sha256= and the HMAC-SHA256 of the body |
API actions#
| Action |
Method |
Scope |
conta/situacao |
GET |
conta.ler |
modelos/listar |
GET |
modelos.ler |
modelos/detalhe |
GET |
modelos.ler |
envelopes/criar |
POST |
envelopes.escrever |
envelopes/enviar |
POST |
envelopes.escrever |
envelopes/detalhe |
GET |
envelopes.ler |
envelopes/listar |
GET |
envelopes.ler |
envelopes/eventos |
GET |
envelopes.ler |
envelopes/lembrar |
POST |
envelopes.escrever |
envelopes/cancelar |
POST |
envelopes.escrever |
documentos/baixar |
GET |
documentos.ler |
signatarios/link |
GET |
envelopes.escrever |
signatarios/otp_gerar |
POST |
envelopes.escrever |
signatarios/otp_pendente |
GET |
envelopes.escrever |
webhooks/criar |
POST |
envelopes.escrever |
webhooks/listar |
GET |
envelopes.ler |
webhooks/testar |
POST |
envelopes.escrever |
webhooks/remover |
POST |
envelopes.escrever |