Documentation de démonstration

Brancher VERIFIMMO sur la régie

L'intégration tient en trois éléments : deux adresses dédiées à la régie, une clé d'API au périmètre fermé, et trois lectures. Aucun webhook n'est nécessaire pour démarrer.

1 · Adresses

L'API est hébergée par VERIFIMMO sur un sous-domaine propre à la régie : rien à configurer côté informatique de la régie. Le portail utilisé par les collaborateurs peut, lui, rester en marque blanche via un simple CNAME.

# API (hébergée par VERIFIMMO)
https://votreregie.api.verifimmo.ch/api/public/v1

# Portail collaborateurs de la régie (marque blanche)
portalverifimmo.votreregie.ch.  CNAME  edge.verifimmo.ch.

2 · Clé d'API

Format vki_<préfixe>_<secret>. Le secret n'est affiché qu'une fois ; seul son hachage est conservé. La clé ne voit que les partages adressés aux adresses de son périmètre.

Authorization: Bearer vki_9f2c41ab_demo000000000000000000000000000000
# ou
x-api-key: vki_9f2c41ab_demo000000000000000000000000000000

3 · Endpoints

GET/v1/dossiers

Partages actifs adressés aux collaborateurs de la régie, paginés.

GET/v1/dossiers/{id}

Vue complète d'un dossier : candidat, finances, attestation, pièces.

GET/v1/dossiers/{id}/pieces/{docKey}

URL signée et temporaire d'une pièce. Chaque appel est journalisé.

Appel

curl -s "https://votreregie.api.verifimmo.ch/api/public/v1/dossiers?page=1&perPage=25" \
  -H "Authorization: Bearer vki_9f2c41ab_demo000000000000000000000000000000"

Erreurs

401 missing_api_keyaucun en-tête d'authentification
401 invalid_api_keyclé inconnue ou hachage non concordant
401 revoked_api_keyclé révoquée par la régie
403 missing_scopeportée insuffisante pour cette lecture
404 not_founddossier hors du périmètre de la clé

Réponse (extrait)

200/v1/dossiers

{
  "data": [
    {
      "id": "8b1f4d2e-6c3a-4a71-9d20-3f6c1a55e001",
      "agentEmail": "sophie.mercier@votreregie.ch",
      "agentName": "Sophie Mercier",
      "propertyRef": "LAU-2041 · Av. de Cour 42, Lausanne · 3.5 p.",
      "createdAt": "2026-08-04T09:12:00.000Z",
      "expiresAt": "2026-09-03T09:12:00.000Z",
      "candidate": {
        "fullName": "Camille Rochat",
        "email": "camille.rochat@example.ch",
        "phone": "+41 79 214 55 08",
        "city": "Renens VD",
        "household": "Couple, sans enfant"
      },
      "dossier": {
        "monthlyIncome": 9850,
        "rentBudget": 2450,
        "effortRate": 24.9,
        "contractType": "CDI · Ingénieure, EPFL",
        "currency": "CHF"
      },
      "certificate": {
        "reference": "VFI-2026-LAU-004821",
        "valid": true,
        "issuedAt": "2026-08-04T10:02:00.000Z",
        "expiresAt": "2026-11-02T10:02:00.000Z",
        "identityVerified": true,
        "url": "https://verifimmo.ch/verification/004821"
      },
      "pieceCount": 6,
      "links": {
        "self": "/api/public/v1/dossiers/8b1f4d2e-6c3a-4a71-9d20-3f6c1a55e001",
        "pieces": "/api/public/v1/dossiers/8b1f4d2e-6c3a-4a71-9d20-3f6c1a55e001/pieces/{docKey}"
      }
    }
  ],
  "page": 1,
  "perPage": 25,
  "total": 4
}

Rappel : cette page décrit l'intégration à titre d'illustration. Les réponses affichées sont statiques et aucun appel réseau n'est effectué.