API Reference

Integra Garanto
nel tuo gestionale.

API REST JSON per agenzie e property manager. Scoring, certificati, referral e webhook — tutto documentato e accessibile dalla dashboard agenzia.

Base URLhttps://garanto.it/api/v1
Autenticazione

Bearer Token

Ogni richiesta richiede un API key nell'header Authorization. Genera la tua chiave dalla dashboard agenzia. Le chiavi sono legate all'account e ai permessi del ruolo.

Header richiestoAuthorization: Bearer grt_live_xxxx
Content-Type: application/json
Endpoints
POST/api/v1/score

Calcola lo score di un inquilino dato il suo profilo finanziario. Richiede i dati Open Banking o i campi manuali del form.

Request body
{
  "monthly_income": 2800,
  "monthly_rent": 900,
  "employment_type": "permanent",
  "years_experience": 3.5,
  "ob_path": "connected"
}
Response
{
  "score": 78,
  "risk_category": "Verde",
  "approved": true,
  "fee_anno1": 535
}
GET/api/v1/certificate/{id}

Recupera un certificato Garanto tramite ID. Restituisce metadati, stato e hash di verifica.

Response
{
  "id": "GR-7841-A",
  "tenant_name": "Marco Conti",
  "score": 78,
  "status": "active",
  "valid_until": "2027-05-21",
  "verify_hash": "sha256:a3f..."
}
POST/api/v1/agency/invite

Invia un invito a un cliente tramite il codice agenzia. Il cliente riceve un link personalizzato con il referral dell'agenzia pre-compilato.

Request body
{
  "client_email": "mario.rossi@email.com",
  "client_name": "Mario Rossi",
  "property_address": "Via Manzoni 12, Milano"
}
Response
{
  "invite_id": "inv_abc123",
  "invite_url": "https://garanto.it/register?ref=AG-001",
  "status": "sent"
}
GET/api/v1/agency/referrals

Lista dei referral dell'agenzia con stato scoring, pagamento e commissioni maturate.

Response
{
  "referrals": [...],
  "total_commissions": 1240.00,
  "pending_commissions": 340.00
}
Webhook Events

Ricevi notifiche in tempo reale.

score.completedScore calcolato — approvato, manuale o rifiutato.
certificate.issuedCertificato emesso e disponibile per il download.
payment.completedPagamento completato via Stripe.
certificate.expiredCertificato scaduto — notifica a inquilino e proprietario.
Rate limits

100 richieste/minuto per API key. Header X-RateLimit-Remaining in ogni risposta.

Pronto a integrare?

Registra la tua agenzia, genera l'API key e inizia a usare le API.

Registra l'agenzia →