Pular para o conteúdo principal
SDK Node/TypeScript para a API da DeepXL: detecção de fraude, parsing de documentos e verificação de identidade.

​
Instalação

npm install deepxl-node-sdk

​
Exemplo

Crie uma chave de API no Dashboard da DeepXL (Configurações → Chaves de API).
Trate sua chave de API como qualquer segredo de ambiente. Não faça commit em um repositório público nem armazene em texto simples.
import { DeepXLClient } from "deepxl-node-sdk";

const client = new DeepXLClient({ apiKey: process.env.DEEPXL_API_KEY });

const detection = await client.detectFile("document", "./file.pdf");
const parsed = await client.parseFile("light", "./id.pdf");
const verification = await client.verifyFiles("./id.jpg", "./selfie.jpg");
console.log(detection.likelihood, parsed.documentType, verification.verified);

​
Métodos do cliente

​
Conta

  • checkUsage() – GET /v1/account. Retorna UsageResponse (uso e limites por tipo de mídia). Campos opcionais: parsingUsageLimit, parsingUsage.

​
Modelos

  • getDetectionModels() – GET /v1/detection-models. Retorna ModelMetadata[].
  • getParsingModels() – GET /v1/parsing-models. Retorna ModelMetadata[].

​
Detecção de fraude

  • detect(modelName, fileName, fileData [, tags]) / detectFile(modelName, filePath [, tags]) – POST /v1/detection. Modelos: document, object. Retorna um objeto de resultado (por exemplo, detectionId, likelihood, reasoning, modelResults, files).
  • getDetection(detectionId) – GET /v1/detection/. Retorna um único resultado de detecção.
  • listDetections([params]) – GET /v1/detection. Parâmetros: limit, offset, sortBy, direction, tagFilter. Retorna { totalCount, count, data }.

​
Parsing de documentos

  • parse(modelName, fileName, fileData [, tags]) / parseFile(modelName, filePath [, tags]) – POST /v1/parse. Modelos: light, performance. Retorna um objeto de resultado (por exemplo, parseId, documentType, parsedData, files).
  • getParse(parseId) – GET /v1/parse/. Retorna um único resultado de parsing.
  • listParses([params]) – GET /v1/parse. Parâmetros: os mesmos de list. Retorna { totalCount, count, data }.

​
Verificação de identidade

  • verify(idFileName, idFileData, selfieFileName, selfieFileData [, tags]) / verifyFiles(idFilePath, selfieFilePath [, tags]) – POST /v1/verification. Retorna um objeto de resultado (por exemplo, verificationId, verified, modelResults, files).
  • getVerification(verificationId) – GET /v1/verification/. Retorna um único resultado de verificação.
  • listVerifications([params]) – GET /v1/verification. Retorna { totalCount, count, data }.

​
Recuperação de arquivos

  • getFile(fileName) – GET /v1/files/. Retorna Buffer. Use o nome do arquivo do array files em qualquer resposta de análise.

​
Tipos

  • UsageResponse – imageUsageLimit, imageUsage, videoUsageLimit, videoUsage, audioUsageLimit, audioUsage, documentUsageLimit, documentUsage e, opcionalmente, parsingUsageLimit, parsingUsage.
  • ModelMetadata – name, description, tags, category, validInputTypes, validFileTypes, ownedBy, version.
  • ListParams – limit, offset, sortBy, direction, tagFilter.

​
Erros

O cliente lança AuthError, FileTypeError, InvalidParameterError, UsageLimitError ou ServerError de deepxl-node-sdk para erros de API.