---
title: "Criar invite"
method: POST
path: "/video-agreement/api/v1/account/invite"
---

# Criar invite

`POST /video-agreement/api/v1/account/invite`

## Request

- Base URL: `https://apigw.nuvidio.com`
- URL: `https://apigw.nuvidio.com/video-agreement/api/v1/account/invite`
- Auth: OAuth 2

## Request body

- object
  - `availableAt` string: Data de quando o invite estará disponível para utilização. Se não informado, a data de criação do invite será usado. Exemplo: 2025-03-29T17:21:00.000
  - `expiresAt` string, required: Data de expiração do invite.
  - `timezone` string: Se não informado, o default será America/Sao_Paulo.
  - `customer` object, required: Campos relacionados ao cliente que realizará o vídeo agreement.
    - `cpf` string, required: CPF do cliente que realizará a vídeo declaração.
    - `fields` object[]: Lista de campos que serão (ou não) exibidos no front-end.
      - `label` string, required: Nome do campo que será exibido (ou não) no front-end.
      - `value` string, required: Valor do campo que será exibido (ou não) no front-end.
      - `private` boolean: Caso seja privado, não será exibido no front-end, mas será enviado para a empresa ao final do fluxo de video-agreement.
    - `name` string, required: Nome do cliente que realizará a vídeo declaração.
    - `identificationImage` string: Imagem (base64 ou URL) para auxiliar na identificação do cliente que realizará a vídeo declaração. Ex: Selfie, RG, CNH
  - `script` object, required: Campos relacionados ao script.
    - `id` string, required: Id de identificação do script.
    - `fields` object[]: Lista de variáveis com chave e valor que estão no script para realizar a geração do roteiro a ser lido pelo cliente no vídeo agreement.
      - `label` string, required: Label da variável que consta no script.
      - `value` string, required: Valor da variável que consta no script. Na criação do roteiro ocorrerá a troca do que consta {{label}} pelo value informado.
      - `displayName` string: Nome amigável que poderá ser exibido no frontend sempre que necessário.

## Response `201`

201

- object
  - `availableAt` string
  - `expiresAt` string
  - `inviteId` string
  - `inviteUrl` string
  - `expiredInviteUrl` string
  - `invalidDataUrl` string
  - `termsUrl` string
  - `helpUrl` string
  - `successUrl` string
  - `timezone` string
  - `customerJourneyType` string
  - `voiceGender` string

## Other responses

- `400`: 400
- `422`: 422
- `500`: 500

---

[API](https://skmtc.dev/nuvidio/apis/gateway-nuvidio-v2.md) - [All operations](https://skmtc.dev/nuvidio/apis/gateway-nuvidio-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/nuvidio/apis/gateway-nuvidio-v2/revisions/c488e657f07b?raw)