Adresse de l'API https://france-verification.com/api/v1

Compte et référentiels

Deux routes de lecture, pour que votre code ne contienne aucune valeur écrite en dur.

Le compte

GET /api/v1/account

{
  "email": "contact@votre-societe.fr",
  "name": "Votre société",
  "mode": "live",
  "credits": 482,
  "credits_per_document": 1,
  "limits": {
    "max_file_size_mb": 100,
    "max_files_per_submission": 100,
    "allowed_extensions": ["zip", "rar", "pdf", "jpeg", "jpg", "png", "heic"],
    "requests_per_minute": 60
  }
}
Champ Description
mode live ou test, selon la clé utilisée.
credits Solde disponible. null avec une clé test.
credits_per_document Crédits débités par document (par page de PDF).
limits Limites d'envoi en vigueur. Lisez-les plutôt que de les recopier : elles peuvent être relevées.

Les crédits s'achètent sur le site : france-verification.com/plans.

Types de documents, instructions de dossier, verdicts

GET /api/v1/document-types

{
  "document_types": [
    { "key": "fiche_de_paie", "label": "Fiche de paie" },
    { "key": "rib", "label": "RIB / IBAN" },
    { "key": "carte_identite", "label": "Carte nationale d'identité" },
    { "key": "autre_document", "label": "Autre document" }
  ],
  "final_checks": [
    { "type": "dossier_location", "label": "Vérifier un dossier de location", "description": "...", "credits": 1 }
  ],
  "verdicts": ["CONFORME", "SUSPECT", "NON-CONFORME", "FAKE"]
}
  • document_types : toutes les valeurs possibles du champ document_type d'une vérification. Un document d'un type non listé reste analysé, avec document_type = "autre_document".
  • final_checks : les valeurs acceptées par le paramètre final_check d'un envoi.
  • verdicts : les quatre valeurs possibles de verdict.

De nouveaux types de documents et de nouvelles instructions peuvent apparaître : prévoyez qu'une valeur inconnue soit traitée comme autre_document.

Prêt à intégrer ? Créez votre clé test gratuitement : aucune analyse n'est facturée pendant le développement.

Créer ma clé API