Documentação Collections API

{
  "access_token": "eyJhbGciOiJIUzI1NiIs...",
  "token_type": "bearer",
  "expires_in": 3600,
  "expires_at": 1781234567
}

{
  "payload": {
    "email": "cliente@empresa.com",
    "cpf": "12345678901"
  }
}

{
  "request_id": "col_8f2a71c9d4",
  "recovery_assessment": {
    "classification": "HIGH_RECOVERY_PRIORITY",
    "score": 876,
    "recommended_action": "PRIORITIZE_COLLECTION"
  },
  "recovery_index": {
    "name": "Autentify Recovery Index",
    "score": 876,
    "class": "HIGH_RECOVERY_PRIORITY",
    "label": "Alta prioridade de recuperação"
  },
  "contact_eligibility": {
    "status": "ELIGIBLE",
    "restrictions": []
  },
  "recommended_contacts": {
    "primary_channel": "PHONE",
    "phones": [
      {
        "rank": 1,
        "number": "+55 11 9XXXX-4321",
        "contact_potential": "HIGH",
        "whatsapp_available": true,
        "best_contact_window": "18:00-21:00"
      },
      {
        "rank": 2,
        "number": "+55 11 9XXXX-8765",
        "contact_potential": "MEDIUM",
        "whatsapp_available": false,
        "best_contact_window": "09:00-12:00"
      }
    ],
    "email": {
      "address": "t********@gmail.com",
      "cpf_link": "CONFIRMED",
      "link_strength": "VERY_HIGH",
      "deliverability_status": "VALID",
      "channel_quality": "HIGH"
    },
    "recommended_contact": {
      "value": "+55 11 9XXXX-4321",
      "best_contact_window": "18:00-21:00"
    }
  },
  "payment_propensity": {
    "classification": "VERY_HIGH",
    "score": 798
  },
  "collection_profile": {
    "digital_affinity": {
      "level": "HIGH",
      "label": "Alta afinidade digital"
    },
    "negotiation_capacity": {
      "level": "MODERATE",
      "label": "Capacidade indicativa de negociação moderada"
    },
    "collection_insight": "Perfil com boa aderência a abordagens digitais na régua de cobrança.",
    "negotiation_insight": "Perfil com sinal intermediário de capacidade econômica, sugerindo abordagem de cobrança com opções flexíveis de negociação."
  },
  "recovery_cluster": {
    "code": "HIGH_RECOVERY_POTENTIAL",
    "label": "Alto potencial de recuperação",
    "description": "Registro com alta prioridade para acionamento no primeiro ciclo de cobrança."
  },
  "collection_strategy": {
    "suggested_approach": "WHATSAPP_THEN_PHONE",
    "recommended_priority": "HIGH_PRIORITY_QUEUE",
    "action_recommendation": "Priorizar contato via WhatsApp seguido de telefone na janela de maior potencial."
  },
  "reasons": [
    "Registro elegível para acionamento de cobrança",
    "Registro analisado com sinais suficientes para priorização operacional",
    "Perfil avaliado conforme política de cobrança vigente"
  ],
  "executive_summary": {
    "headline": "Contato com alta prioridade de recuperação",
    "summary": "O e-mail analisado apresenta vínculo confirmado com o CPF em uma das fontes de validação utilizadas pela Autentify e está válido para acionamento digital. Isso torna o registro prioritário para cobrança. A propensão estimada de pagamento ajusta sua posição dentro da fila de recuperação. Recomenda-se incluí-lo na régua prioritária e utilizar os canais complementares disponíveis."
  }
}

{
  "detail": "invalid or expired demo key"
}

const BASE_URL = "https://collections.autentify.com.br";
const API_KEY = "ak_live_xxx";

const tokenRes = await fetch(`${BASE_URL}/v1/auth/token`, {
  method: "POST",
  headers: { "X-Api-Key": API_KEY },
});
const { access_token } = await tokenRes.json();

const analyzeRes = await fetch(`${BASE_URL}/v1/analyze`, {
  method: "POST",
  headers: {
    Authorization: `Bearer ${access_token}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ payload: { email: "cliente@empresa.com", cpf: "12345678901" } }),
});
const data = await analyzeRes.json();
console.log(data.recovery_index.score, data.collection_strategy.suggested_approach);