Saltar al contenido principal
SDK de Node/TypeScript para la API de DeepXL: detección de fraude, análisis de documentos y verificación de identidad.

​
Instalación

npm install deepxl-node-sdk

​
Ejemplo

Crea una clave de API en el panel de DeepXL (Configuración → Claves de API).
Trata tu clave de API como cualquier secreto de entorno. No la subas a un repositorio público ni la almacenes en texto sin cifrar.
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 del cliente

​
Cuenta

  • checkUsage() – GET /v1/account. Devuelve UsageResponse (uso y límites por tipo de medio). Campos opcionales: parsingUsageLimit, parsingUsage.

​
Modelos

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

​
Detección de fraude

  • detect(modelName, fileName, fileData [, tags]) / detectFile(modelName, filePath [, tags]) – POST /v1/detection. Modelos: document, object. Devuelve un objeto de resultado (p. ej., detectionId, likelihood, reasoning, modelResults, files).
  • getDetection(detectionId) – GET /v1/detection/. Devuelve un único resultado de detección.
  • listDetections([params]) – GET /v1/detection. Parámetros: limit, offset, sortBy, direction, tagFilter. Devuelve { totalCount, count, data }.

​
Análisis de documentos

  • parse(modelName, fileName, fileData [, tags]) / parseFile(modelName, filePath [, tags]) – POST /v1/parse. Modelos: light, performance. Devuelve un objeto de resultado (p. ej., parseId, documentType, parsedData, files).
  • getParse(parseId) – GET /v1/parse/. Devuelve un único resultado de análisis.
  • listParses([params]) – GET /v1/parse. Parámetros: los mismos que en la lista. Devuelve { totalCount, count, data }.

​
Verificación de identidad

  • verify(idFileName, idFileData, selfieFileName, selfieFileData [, tags]) / verifyFiles(idFilePath, selfieFilePath [, tags]) – POST /v1/verification. Devuelve un objeto de resultado (p. ej., verificationId, verified, modelResults, files).
  • getVerification(verificationId) – GET /v1/verification/. Devuelve un único resultado de verificación.
  • listVerifications([params]) – GET /v1/verification. Devuelve { totalCount, count, data }.

​
Recuperación de archivos

  • getFile(fileName) – GET /v1/files/. Devuelve Buffer. Usa el nombre del archivo de la matriz files en cualquier respuesta de análisis.

​
Tipos

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

​
Errores

El cliente lanza AuthError, FileTypeError, InvalidParameterError, UsageLimitError o ServerError desde deepxl-node-sdk para errores de la API.