API
Cadastrar origem no VIDaaS
Registra uma origem (domínio) do seu front-end como endereço de retorno válido no VIDaaS.
POST
Cadastrar origem no VIDaaS
Cadastra uma origem do seu front-end como endereço de retorno autorizado no VIDaaS. O VIDaaS só redireciona o navegador de volta para endereços previamente cadastrados; este endpoint gerencia esse cadastro.
A operação é idempotente: registrar uma origem já cadastrada não dispara uma chamada ao provedor. Use o parâmetro
force para reenviar ao provedor mesmo que localmente conste como registrada (útil se o cadastro foi perdido do lado do VIDaaS).
Autenticação: use uma chave de API (x-api-key).
Parâmetros
string
required
Origem do front a cadastrar (esquema + host + porta, sem caminho). Exemplos:
https://assinador.cliente.com.br, https://localhost:3000, https://app.valid.com:8443.O caminho (tudo após a porta) é ignorado — o VIDaaS sempre usa um caminho fixo de retorno (/sign/vidaas/callback).boolean
Se
true, reenvia o cadastro ao provedor VIDaaS mesmo que a origem conste como já registrada localmente. Use quando o cadastro tiver sido perdido ou sobrescrito do lado do provedor. Padrão: false.Respostas
string
required
Identificador do cadastro.
string
required
Origem normalizada (como foi registrada).
string
required
URI completa de retorno (origem + caminho fixo). Exemplo:
https://assinador.cliente.com.br/sign/vidaas/callback.string
Tenant da Platform (extraído da chave de API).
string
required
Status do cadastro no provedor:
PENDING: enviado ao provedor mas ainda aguardando confirmação.REGISTERED: aceito e registrado no provedor.FAILED: o provedor recusou o cadastro (vejalastError).
string
Timestamp (ISO-8601) de quando o cadastro foi aceito pelo provedor. Presente apenas quando
status = REGISTERED.string
Descrição da última falha no cadastro. Presente apenas quando
status = FAILED.Erros
Veja Autenticação e erros.- 400:
origininválido ou validação falhou (ex: URL malformada, esquema não éhttpouhttps). - 401: Chave de API inválida ou expirada.
- 502: O VIDaaS não respondeu ou recusou o cadastro.
- 503: Integração VIDaaS não configurada no ambiente.
Exemplo
Importante
- Autenticação por API Key: este é um endpoint administrativo — use sua chave de API.
- Caminho fixo de retorno: independente de qual
originvocê registra, o caminho de retorno é sempre/sign/vidaas/callback. Se seu front precisa de um caminho diferente, configure um alias/redirecionador. - Múltiplas origens: você pode registrar quantas origens precisar (desenvolvimento, homologação, produção, etc.).
- Normalização: a origem é normalizada (trailing slashes e portas implícitas são removidos/padronizados).
Próximas etapas
- Após registrar uma origem com sucesso, o VIDaaS começará a aceitar redirecionamentos para
https://origin/sign/vidaas/callback. - Quando o signatário autorizar via QR Code, o VIDaaS o redireciona para este endereço.
- Seu front extrai o
codeda URL e chamaPOST /signer/v1/sign/:sessionToken/vidaas/authorization/callback.