Signatários

As ações desta página servem para quem entrega o convite e o código de confirmação pelo próprio canal, como o ChatISP faz na conversa de WhatsApp. Se os seus signatários recebem tudo por e-mail, o Ravisign cuida disso sozinho e você não precisa delas.

Todas exigem o escopo envelopes.escrever, porque dão acesso à assinatura de outra pessoa.

Nos exemplos, a chave está na variável de ambiente RAVISIGN_CHAVE e as respostas foram encurtadas onde indicado:

export RAVISIGN_CHAVE="rsg_..."
API="https://ravisign.com.br/api/v1"

signatarios/link#

GET, escopo envelopes.escrever. Parâmetro signatario_uuid. Link de assinatura do signatário, para quem entrega o convite por canal próprio (o ChatISP manda na conversa). O link é pessoal: não compartilhe com outra pessoa.

curl -sS -G "$API/signatarios/link" -H "Authorization: Bearer $RAVISIGN_CHAVE" \
  -d signatario_uuid=7eb90fca-1488-4a17-84c4-0b01f4acb9f1

{
    "ok": true,
    "signatario_uuid": "7eb90fca-1488-4a17-84c4-0b01f4acb9f1",
    "envelope_uuid": "157b650a-75e0-4eaa-a32c-b92b5a432ee4",
    "link": "https://ravisign.com.br/assinar.php?t=yEJ0y3ENQjLq3jTSy9Lx-obvgnQFa05o0mHtOP7C7m4",
    "situacao": "notificado",
    "envelope_situacao": "enviado"
}

Erro 409 signatario_fora_da_vez quando ainda não há link (rascunho, ordem sequencial antes da vez ou observador).

signatarios/otp_gerar#

POST, escopo envelopes.escrever. Só para signatários do canal conversa. Gera o código de confirmação de 6 dígitos (válido por 30 minutos) e o devolve para o integrador entregar na conversa. Parâmetros signatario_uuid e, opcional, origem_conversa (objeto que identifica a conversa onde o código será entregue; vai para a trilha).

curl -sS "$API/signatarios/otp_gerar" -H "Authorization: Bearer $RAVISIGN_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"signatario_uuid":"7eb90fca-1488-4a17-84c4-0b01f4acb9f1","origem_conversa":{"conversa_id":"8812"}}'

{
    "ok": true,
    "signatario_uuid": "7eb90fca-1488-4a17-84c4-0b01f4acb9f1",
    "codigo": "473334",
    "canal": "conversa",
    "validade_minutos": 30,
    "expira_em": "2026-10-09T20:58:25-03:00"
}

• Um código novo invalida o anterior. No máximo 4 códigos por hora para o mesmo signatário (429 otp_reenvio_limite); cada código aceita 5 tentativas.
• Erros: 409 canal_indisponivel (signatário de outro canal), 409 envelope_encerrado, envelope_vencido, situacao_invalida (já assinou ou recusou) e signatario_fora_da_vez.

signatarios/otp_pendente#

GET, escopo envelopes.escrever. Parâmetro signatario_uuid. O código do canal conversa ainda válido (gerado pela API ou pedido pelo próprio signatário na página), para quem não usa webhook.

curl -sS -G "$API/signatarios/otp_pendente" -H "Authorization: Bearer $RAVISIGN_CHAVE" \
  -d signatario_uuid=7eb90fca-1488-4a17-84c4-0b01f4acb9f1

{
    "ok": true,
    "signatario_uuid": "7eb90fca-1488-4a17-84c4-0b01f4acb9f1",
    "pendente": true,
    "codigo": "473334",
    "expira_em": "2026-10-09T20:58:25-03:00",
    "segundos_restantes": 1800
}

Sem código válido: { "ok": true, "signatario_uuid": "...", "pendente": false }.

Atenção o link e o código dão acesso à assinatura do signatário. Entregue-os só à própria pessoa, não os grave em log e não guarde o código depois de entregue.