TypeScript / JavaScript

:::caution Pré-release (alpha) Este SDK está em alpha (0.1.0-alpha.1). A superfície de API pública ainda está sendo estabilizada — não use em produção. :::

Instalação

npm install @velix/sdk
# ou
yarn add @velix/sdk

Quickstart

import { VelixClient, CheckinModule, PersonsModule } from '@velix/sdk';

const client = new VelixClient({
  apiUrl: process.env.VELIX_API_URL!,
  apiKey: process.env.VELIX_API_KEY!,
});

const persons = new PersonsModule(client);
const checkin = new CheckinModule(client);

const person = await persons.create({ name: 'João Silva', document: '000.000.000-00' });
await persons.enroll(person.id, fotoBase64);

const result = await checkin.facial('tenant-slug', frameBase64);
console.log(result.passed); // true | false

Requisitos

• Node.js 20+
• TypeScript 5+ (strict mode)

Variáveis de ambiente

Variável	Obrigatória	Descrição
VELIX_API_URL	Sim	URL base da API
VELIX_API_KEY	Sim	API key do tenant (vx_live_... ou vx_sandbox_...)
VELIX_TIMEOUT	Não	Timeout em ms (padrão: 10000)