Vai al contenuto

Full Installation

Integrazione delle API con endpoint essenziali.

Base URL: https://dashboard.cooabit.com
Autenticazione: Tutte le richieste richiedono l'header Api-Key

CooabitAPI_1.jpg

Flusso Completo

STEP 1: Configura Webhook

POST /api/prod/v1/webhooks/

Descrizione: Imposta o aggiorna l'URL verso cui Cooabit invierà i webhook

Request Body:

{
  "webhook_url": "https://tuodominio.com/cooabit/webhook",
  "webhook_enabled": true
}

Response:

{
  "message_status": "success"
}

STEP 2: Crea Pratica

POST /api/prod/v1/applications/

Descrizione: Crea nuova pratica che raggruppa tutti i documenti del richiedente

Request Body:

{
  "applicant_reference": "CLIENTE-001"
}

Response:

{
  "application_id": "{{application_id}}",
  "message_status": "success"
}

Importante: Salva l'application_id per lo step successivo

STEP 3: Carica Documento

POST /api/prod/v1/applications/{application_id}/documents/

Descrizione: Invia URL esterno per scaricare un file già hostato. L'API di Cooabit effettua il download, riconosce e classifica il documento in modo automatico.

Request Body:

{
  "external_url": "https://files.tuodominio.com/documento.pdf",
}

Response:

{
  "status": "UPLOADED / PENDING_DOWNLOAD",
  "message_status": "success"
}

STEP 4: Elaborazione Automatica

Una volta caricato il documento, Cooabit avvia automaticamente il processing.

Stati del documento:

  • UPLOADED - Documento caricato correttamente
  • PROCESSING - Elaborazione in corso
  • DONE - Elaborazione completata
  • ERROR - Errore nell'elaborazione
  • REJECTED - File rifiutato

STEP 5: Webhook Callback

Al termine dell'elaborazione riceverai automaticamente un webhook:

POST https://tuodominio.com/cooabit/webhook

Payload:

{
  "event": "document.processed",
  "timestamp": "2025-07-03T12:34:56Z",
  "document_id": "d6ccd504-48c2-4283-a954-bb0dcf0bf522",
  "application_id": "35d31ac5-f604-4e14-ac4b-69323113c334",
  "applicant_reference": "USER-001",
  "status": "DONE",
  "document_type" : "busta_paga",
  "extracted_data": {
    "iban": "IT60X0542811101000000123456",
    "account_holder": "Mario Rossi",
    "balance": 2450.75,
    ...
    ...
    ...
  }
}

Timing

Step Tempo Tipico Note
1. Webhook Config < 1 secondo Verifica immediata raggiungibilità
2. Crea Pratica < 1 secondo Response immediata
3. Carica Documento 1-5 secondi Dipende da dimensione file
4. Processing 10-60 secondi Dipende dal n° di pagine
5. Webhook Delivery < 1 secondo Notifica immediata

Tipologie Documento Supportate

  • busta_paga - Cedolini stipendio
  • documento_identita - Carte identità, passaporti, patenti
  • certificato_stipendio - Certificati di lavoro
  • pensioni - Cedolini pensione INPS/INPDAP

Supporto

Se riscontri problemi durante l'integrazione:

  • Verifica che il webhook risponda con HTTP 200
  • Controlla che l'Api-Key sia corretta
  • Assicurati che l'URL del documento sia pubblicamente raggiungibile
  • Usa formati supportati: PDF, JPG, PNG, WEBP

Data Retention

Tutti i dati estratti e il file PDF / Immagine vengono eliminati automaticamente 30 minuti dopo che l'application raggiunge lo stato COMPLETED o ERROR . Un eventuale retry richiede un nuovo upload del documento.

Supporto tecnico: mattia@cooabit.com

Full InstallationFlusso CompletoSTEP 1: Configura WebhookSTEP 2: Crea PraticaSTEP 3: Carica DocumentoSTEP 4: Elaborazione AutomaticaSTEP 5: Webhook CallbackTimingTipologie Documento SupportateSupportoData Retention