Pular para o conteúdo principal
SDK Python para a API DeepXL: detecção de fraude, análise de documentos e verificação de identidade.

​
Instalação

pip install deepxl-python-sdk

​
Exemplo

Crie uma chave de API no Painel 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 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 do cliente

​
Conta

  • check_usage() – GET /v1/account. Retorna UsageResponse (uso e limites). Atributos opcionais: parsing_usage_limit, parsing_usage.

​
Modelos

  • get_detection_models() – GET /v1/detection-models. Retorna uma lista de dicionários de modelos.
  • get_parsing_models() – GET /v1/parsing-models. Retorna uma lista de dicionários de modelos.

​
Detecção de fraude

  • detect(model_name, file_name, file_data [, tags]) / detect_file(model_name, file [, tags]) – POST /v1/detection. Modelos: document, object. Retorna um dicionário de resultado.
  • get_detection(detection_id) – GET /v1/detection/. Retorna um único resultado de detecção.
  • list_detections([limit, offset, sort_by, direction, tag_filter]) – GET /v1/detection. Retorna um dicionário com totalCount, count, data.

​
Análise de documentos

  • parse_document(model_name, file_name, file_data [, tags]) / parse_document_file(model_name, file [, tags]) – POST /v1/parse. Modelos: light, performance. Retorna um dicionário de resultado.
  • get_parse(parse_id) – GET /v1/parse/. Retorna um único resultado de análise.
  • list_parses([limit, offset, sort_by, direction, tag_filter]) – GET /v1/parse. Retorna um dicionário com totalCount, count, data.

​
Verificação de identidade

  • verify(id_file_name, id_file_data, selfie_file_name, selfie_file_data [, tags]) / verify_files(id_file, selfie_file [, tags]) – POST /v1/verification. Retorna um dicionário de resultado.
  • get_verification(verification_id) – GET /v1/verification/. Retorna um único resultado de verificação.
  • list_verifications([limit, offset, sort_by, direction, tag_filter]) – GET /v1/verification. Retorna um dicionário com totalCount, count, data.

​
Recuperação de arquivos

  • get_file(file_name) – GET /v1/files/. Retorna bytes. Use o nome do arquivo do array files em qualquer resposta de análise.

​
Erros

Lança DeepXLError para erros de API (chave inválida, requisição inválida, limite de uso etc.).