post
https://apigw.nuvidio.com/video-agreement/api/v1/account/invite
Cria um invite de vídeo-acordo para um cliente e script da conta.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Formato das datas
Data e hora sem timezone embutido. O fuso vem no campo separado timezone do payload.
📌 Formato: YYYY-MM-DDTHH:mm:ss
Exemplos válidos:
2025-03-29T17:21:00 + "timezone": "America/Sao_Paulo"
2025-03-29T17:21:00 + "timezone": "UTC"
Explicação:
2025-03-29→ Data (AAAA-MM-DD)T→ separador entre data e hora17:21:00→ hora, minutos e segundos (HH:mm:ss)- Sem sufixo
Ze sem offset±HH:MM— inclualhar. - O fuso é definido pelo campo
timezone; ausente → U
Campos do script
Caso algum campo (variável) exista no script criado e não tenha sido enviado no payload dessa requisição, ocorrerá um erro na criação do invite. Ex: "meu nome é {{name}} e tenho {{age}}". Se as label's e value's de "name" ou "age" não forem enviadas, ocorrerá um erro.
- Em script.fields, é preenchido os dados que serão incluidos nas mensagens do script.
- Sobre os formatos:
- ⚠️⚠️⚠️ CPF: Recomendamos o formato 111.222.333-44 para auxiliar a leitura do documento por parte da I.A
- ⚠️⚠️⚠️ RG: Recomendamos o formato 12.345.678-9 (ou 1.234.567-X quando o dígito verificador for X) — o primeiro grupo aceita 1 ou 2 dígitos
- ⚠️⚠️⚠️ CNPJ: Recomendamos o formato 12.345.678/0001-95
- ⚠️⚠️⚠️ Número de benefício INSS: Recomendamos o formato 123.456.789-0 (mesmo padrão do CPF, porém com apenas 1 dígito verificador)
- ⚠️⚠️⚠️ CEP: Recomendamos o formato 12345-678
- ⚠️⚠️⚠️ E-mail: Recomendamos o formato padrão [email protected], sem espaços
- ⚠️⚠️⚠️ Telefone: Recomendamos o formato (61) 99998-0090, com DDD entre parênteses; com código do país use 55 (61) 99998-0090 ou +55 (61) 99998-0090; para 0800 use o formato 0800 123 4567 (separado por espaços, sem hífen)
- ⚠️⚠️⚠️ Agência/Conta bancária: Recomendamos o formato 12345-6 (4 a 6 dígitos, hífen, 1 a 2 dígitos verificadores)
- ⚠️⚠️⚠️ Valores monetários: Recomendamos o formato R$1.234,56, sempre com 2 casas decimais após a vírgula — valores com 1 casa decimal (ex.: R$1.234,5) não são reconhecidos pela máscara
- ⚠️⚠️⚠️ Percentual: Recomendamos o formato 12,34%, sempre com vírgula decimal
- ⚠️⚠️⚠️ Pix: Pode ser escrito em qualquer variação de maiúsculas/minúsculas (ex.: PIX, pix, Pix) — a máscara normaliza automaticamente para leitura como palavra
- Sobre os formatos:
Biometria habilitada na jornada
Quando a biometria estiver habilitada na jornada, e no payload de envio estiver o campo
identificationImage, um erro de validação será retornado ao tentar criar o invite.

