📄 Toodego Ocr API

🇬🇧 English Documentation Here

Une api pour matcher l'identité d'une personne à partir d'un justificatif d'identité fourni sur la plateforme Toodego. projet experimental réalisé par les étudiants du Centrale Digital Lab

Table des matières

• 📄 Toodego Ocr API
  • Table des matières
  • 🗒 Prérequis
  • 🚀 Démarrage rapide
  • 🚴 Utilisation
  • 🚇 API
    • GET ?password=PASSWORD&formId=FORM_ID
  • ❤️ Contributeurices

🗒 Prérequis

• Docker
• Python
• pip

🚀 Démarrage rapide

Copiez le fichier .env.example en .env et remplissez les variables d'environnement.

cp .env.example .env

Lancez docker-compose pour démarrer l'application.

docker-compose up

🚴 Utilisation

1. Soumettre le formulaire sur le site de recette de toodego et récupérer l'identifiant du formulaire

1. accéder à l'url apit-toodego.example/form
2. remplir le formulaire avec l'identifiant récupéré le mot de passe (configuré dans env sous API_BASE_URL et cliquer sur exécuter, le résultat s'affiche dans en dessous du formulaire

🚇 API

Il est possible de récupérer directement le résultat du score de confiance en utilisant l'api suivante

GET ?password=PASSWORD&formId=FORM_ID

• password : mot de passe pour accéder à l'api
• formId : identifiant du formulaire

Retourne un json avec le score de confiance

{
    "data": {
        "score_adress2": number,
        "score_adress3": number,
        "score_adress1": number,
        "score_nom": number,
        "score_prenom": number,
    }
}

❤️ Contributeurices

• Freeinkstein