Obtenir une clé API

📚 Documentation API Dokimo

Intégrez l'analyse automatique de candidatures dans vos applications

v1.0

🚀 Introduction

L'API Dokimo vous permet d'intégrer notre moteur d'analyse de candidatures dans vos applications. Analysez automatiquement les dossiers locataires, générez des documents conformes, et gérez vos biens immobiliers via une API REST simple et puissante.

⚡

API REST

Format JSON, HTTP/HTTPS, facile à intégrer

🔒

Sécurisé

OAuth 2.0, clés API, webhooks signés

📊

Temps réel

Webhooks pour notifications instantanées

Base URL

URL 
https://api.dokimo.fr/v1
💡 Sandbox disponible : Utilisez https://sandbox-api.dokimo.fr/v1 pour vos tests sans consommer vos crĂ©dits.

🔐 Authentification

L'API Dokimo utilise des clĂ©s API pour authentifier les requĂȘtes. Vous pouvez obtenir votre clĂ© API depuis votre dashboard Dokimo dans la section "ParamĂštres > API".

Utilisation de la clé API

Incluez votre clĂ© API dans l'header Authorization de chaque requĂȘte :

bash 
curl https://api.dokimo.fr/v1/candidates \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
php 
$ch = curl_init('https://api.dokimo.fr/v1/candidates');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer YOUR_API_KEY',
    'Content-Type: application/json'
]);
$response = curl_exec($ch);
javascript 
fetch('https://api.dokimo.fr/v1/candidates', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
});
⚠ SĂ©curitĂ© : Ne partagez jamais votre clĂ© API publiquement. Utilisez des variables d'environnement en production.

⏱ Rate Limits

Pour garantir la stabilité de l'API, des limites de taux sont appliquées :

Plan RequĂȘtes/minute RequĂȘtes/jour
Starter 60 10,000
Professional 120 50,000
Business 300 150,000
Enterprise Illimité Illimité

Headers de réponse

http 
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 58
X-RateLimit-Reset: 1640995200

đŸ‘€ Candidatures

GĂ©rez les candidatures et lancez des analyses automatiques.

POST /candidates

Crée une nouvelle candidature et lance l'analyse automatique

ParamĂštres

ParamĂštre Type Requis Description
email string Oui Email du candidat
first_name string Oui Prénom du candidat
last_name string Oui Nom du candidat
phone string Non Téléphone du candidat
documents[] array Non Liste des URLs de documents Ă  analyser
property_id string Non ID du bien concerné

Exemple de requĂȘte

json 
{
  "email": "jean.dupont@example.com",
  "first_name": "Jean",
  "last_name": "Dupont",
  "phone": "+33612345678",
  "documents": [
    "https://example.com/bulletin_salaire.pdf",
    "https://example.com/contrat_travail.pdf"
  ],
  "property_id": "prop_abc123"
}

Exemple de réponse

json 
{
  "id": "cand_xyz789",
  "email": "jean.dupont@example.com",
  "first_name": "Jean",
  "last_name": "Dupont",
  "status": "analyzing",
  "score": null,
  "analysis": {
    "status": "pending",
    "estimated_completion": "2026-02-01T14:32:00Z"
  },
  "created_at": "2026-02-01T14:30:00Z"
}
GET /candidates/{id}

RécupÚre les détails d'une candidature et son analyse

Exemple de réponse (analyse terminée)

json 
{
  "id": "cand_xyz789",
  "email": "jean.dupont@example.com",
  "first_name": "Jean",
  "last_name": "Dupont",
  "status": "analyzed",
  "score": 87,
  "analysis": {
    "status": "completed",
    "monthly_income": 2847,
    "contract_type": "CDI",
    "contract_duration_months": 36,
    "employer": "Société ABC",
    "documents_verified": 4,
    "effort_rate": 33,
    "recommendation": "approved",
    "risk_flags": [],
    "summary": "Excellent profil de locataire. Revenu stable..."
  },
  "created_at": "2026-02-01T14:30:00Z",
  "analyzed_at": "2026-02-01T14:32:15Z"
}

🔔 Webhooks

Recevez des notifications en temps réel lorsque des événements se produisent dans votre compte Dokimo.

Configuration

Configurez vos webhooks depuis votre dashboard Dokimo dans "ParamÚtres > Webhooks". Vous pouvez spécifier une URL qui recevra les événements via POST.

ÉvĂ©nements disponibles

ÉvĂ©nement Description
candidate.created Une nouvelle candidature a été créée
candidate.analyzed L'analyse d'une candidature est terminée
candidate.approved Une candidature a été approuvée
candidate.rejected Une candidature a été rejetée
document.generated Un document a été généré

Exemple de payload

json 
{
  "event": "candidate.analyzed",
  "timestamp": "2026-02-01T14:32:15Z",
  "data": {
    "candidate_id": "cand_xyz789",
    "score": 87,
    "recommendation": "approved"
  }
}
🔒 Signature : Tous les webhooks sont signĂ©s avec HMAC-SHA256. VĂ©rifiez le header X-Dokimo-Signature pour garantir l'authenticitĂ©.

⚠ Gestion d'erreurs

L'API Dokimo utilise les codes HTTP standards pour indiquer le succĂšs ou l'Ă©chec d'une requĂȘte.

Codes d'erreur HTTP

Code Signification
200 OK - RequĂȘte rĂ©ussie
201 Created - Ressource créée
400 Bad Request - ParamĂštres invalides
401 Unauthorized - Clé API invalide
403 Forbidden - AccÚs refusé
404 Not Found - Ressource introuvable
429 Too Many Requests - Rate limit atteint
500 Internal Server Error - Erreur serveur

Format des erreurs

json 
{
  "error": {
    "code": "invalid_parameter",
    "message": "Le paramĂštre 'email' est requis",
    "param": "email"
  }
}