Criar conta

Sua organização pode ter múltiplas contas, o que permite separar scripts e convites por produto, equipe ou necessidade específica.

post/video-agreement/api/v1/account

Request

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

Request body

namestring required

Nome da conta

logostring required

Logo da conta (URL ou Base64)

slugstring required

Identificador amigável para o cliente a ser usado no acesso do convite. (ex: nuv, xpto)

colorstring required

Cor de estilo a ser aplicado para a empresa.

biometricProvider'idwall' | 'serpro'

Provedor de biometria principal a ser usado pela empresa, em caso de erro o secundário do sistema será usado.

videoProvider'zoom'

Provedor de video a ser usado pela empresa nas chamadas. Atualmente apenas o zoom está disponível.

transcriptionProvider'conversify' | 'bot_runner'

Provedor de transcrição principal a ser usado pela empresa, em caso de erro o secundário do sistema será usado.

Response

201

createdAtstring
idstring
namestring
logostring
colorstring
styleIdstring
biometricProviderstring
whatsappConfigunknown
cloudConfigunknown
organizationIdstring
videoProviderstring
slugstring
contractedIntelligencesstring[]

Example response

{
  "createdAt": "2025-07-11T14:41:12.916889658-03:00",
  "id": "9d6a1eca-029b-4b06-a0e2-b4ddb4ed379d",
  "name": "John Titor",
  "logo": "url_logo",
  "color": "purple",
  "styleId": "da887ea7-73b7-47e8-831a-b6747daa9d64",
  "biometricProvider": "idwall",
  "organizationId": "id",
  "videoProvider": "zoom",
  "slug": "nuvidio",
  "contractedIntelligences": [
    "danger_zone"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.