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

​
Instalación

pip install deepxl-python-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 plano.
import os
from deepxl_python_sdk import DeepXLClient

client = DeepXLClient(os.environ["DEEPXL_API_KEY"])

detection = client.detect_file("document", "./file.pdf")
parsed = client.parse_document_file("light", "./id.pdf")
verification = client.verify_files("./id.jpg", "./selfie.jpg")
print(detection["likelihood"], parsed["documentType"], verification["verified"])

​
Métodos del cliente

​
Cuenta

  • check_usage() – GET /v1/account. Devuelve UsageResponse (uso y límites). Atributos opcionales: parsing_usage_limit, parsing_usage.

​
Modelos

  • get_detection_models() – GET /v1/detection-models. Devuelve una lista de diccionarios de modelos.
  • get_parsing_models() – GET /v1/parsing-models. Devuelve una lista de diccionarios de modelos.

​
Detección de fraude

  • detect(model_name, file_name, file_data [, tags]) / detect_file(model_name, file [, tags]) – POST /v1/detection. Modelos: document, object. Devuelve un diccionario de resultados.
  • get_detection(detection_id) – GET /v1/detection/. Devuelve un único resultado de detección.
  • list_detections([limit, offset, sort_by, direction, tag_filter]) – GET /v1/detection. Devuelve un diccionario con totalCount, count, data.

​
Análisis de documentos

  • parse_document(model_name, file_name, file_data [, tags]) / parse_document_file(model_name, file [, tags]) – POST /v1/parse. Modelos: light, performance. Devuelve un diccionario de resultados.
  • get_parse(parse_id) – GET /v1/parse/. Devuelve un único resultado de análisis.
  • list_parses([limit, offset, sort_by, direction, tag_filter]) – GET /v1/parse. Devuelve un diccionario con totalCount, count, data.

​
Verificación de identidad

  • verify(id_file_name, id_file_data, selfie_file_name, selfie_file_data [, tags]) / verify_files(id_file, selfie_file [, tags]) – POST /v1/verification. Devuelve un diccionario de resultados.
  • get_verification(verification_id) – GET /v1/verification/. Devuelve un único resultado de verificación.
  • list_verifications([limit, offset, sort_by, direction, tag_filter]) – GET /v1/verification. Devuelve un diccionario con totalCount, count, data.

​
Recuperación de archivos

  • get_file(file_name) – GET /v1/files/. Devuelve bytes. Usa el nombre del archivo del arreglo files en cualquier respuesta de análisis.

​
Errores

Genera DeepXLError para errores de la API (clave no válida, solicitud incorrecta, límite de uso, etc.).