Bienvenue dans la documentation de l'API de Dataleon !
Dans le tableau de bord, dans l'espace développeur, vous pourrez générer une clé d'API. Assurez-vous de l'avoir créée, car elle sera utilisée dans l'ensemble de la documentation.
À la fin de cette section, vous serez en mesure de créer une identification, vérifier votre identité et consulter les résultats en utilisant le service de vérification d'identité de Dataleon.
1. Création d'une URL d'identification
Pour vérifier l'identité d'un utilisateur, vous devrez créer un objet d'identification. L'objet d'identification est le composant principal du produit de Dataleon et représente une vérification d'identité. Chaque identification est associée à un seul utilisateur et ne peut pas être liée à plusieurs utilisateurs.
Exemple de demande de lien
curl --request POST \
--url https://inference.eu-west-1.dataleon.ai/identity-request \
--header 'Content-Type: multipart/form-data' \
--header 'api_key: apkey_01Mn...' \
--form workspace_id=wk_Tzkr7XXXX \
--form path=/kyc-verification \
--form first_name=Gerard \
--form last_name=TOKO \
--form callback_url=http://localhost \
--form 'tags=[{ "key": "phone_number", "value": "+33766XXXXXX" }]'
Nous vous recommandons vivement d'envoyer le numéro de téléphone si vous utilisez un flux sur ordinateur de bureau : nous l'utilisons pour pré-remplir la page de redirection SMS (l'une des deux options de redirection avec le code QR).
Réponse JSON
{
"task_id": "b2b772f1-85fd-42ad-8116-06651128567c",
"status": "WAITING"
"link": "https://id.dataleon.eu/b2b772f1-85fd-42ad-8116-06651128567c"
}
2. Vérifiez votre identité
Accédez au Lien d'identification fourni par l'objet d'identification que vous venez de créer et suivez le processus de vérification d'identité proposé par Dataleon. Une fois terminé, vous serez redirigé vers l'URL de redirection associée à l'identification.
Veuillez noter que si vous utilisez un ordinateur de bureau, vous serez redirigé vers votre téléphone pour effectuer la vérification. En production, vous avez la possibilité de pré-remplir le numéro de téléphone lors de la génération d'une identification.
3. Obtenir les résultats
Récupérer les données via votre callback_url
Une fois que vous avez terminé le processus de vérification, vous pouvez recevoir les résultats via un webhook que vous avez renseigné dans le callback_url.
Récupérer les données manuellement
Vous avez aussi la possibilité de venir récupérer les données via la taskId comme ceci
curl --request GET \
--url https://inference.eu-west-1.dataleon.ai/task/:id \
--header 'api_key: apkey_01Mn...'
Résultat en sortie
{
"entities": [
{
"id": "043d528b-a313-401a-8f12-7bcf1f03d001",
"confidence": 0.9999908208847046,
"name": "Firstname",
"text": "Gérard",
"value": "Gérard",
"bounding_box": [],
"page": 1,
"document_number": 1,
"document_id": "Py5CCdjNYgUH3hBTExciC5Gb-por-recto",
"step": "step-1",
"action": "document",
"document_name": "Py5CCdjNYgUH3hBTExciC5Gb-por-recto.jpg",
},
{
"id": "043d528b-a313-401a-8f12-7bcf1f03d001",
"confidence": 0.9999908208847046,
"name": "Face",
"bounding_box": [],
"page": 1,
"document_number": 1,
"document_id": "Py5CCdjNYgUH3hBTExciC5Gb-por-recto",
"step": "step-1",
"action": "face",
"document_name": "Py5CCdjNYgUH3hBTExciC5Gb-por-recto.jpg",
}
],
"validations": [
{
"message": "Luminosité détectée",
"code": "Luminosity",
"id": "5fe11296-cfd5-4b02-8e88-ae86b5e878e9",
"type": "node",
"document_name": "Py5CCdjNYgUH3hBTExciC5Gb-por-recto.jpg",
"document_id": "Py5CCdjNYgUH3hBTExciC5Gb-por-recto",
"step": "step-1",
"action": "luminosity",
"page": 1,
"nodes": [],
"tags": [],
"name": "Luminosity",
"weight": 1,
"validate": true,
"type_validation": "Luminosity",
"document_number": 1
},
],
"class": [
{
"id": "d6ed11c9-4f68-4a9d-9246-d3cc64282ced",
"name": "POR",
"confidence": 0.9755672216415405,
"color": "#808080",
"page": 1,
"document_number": 1,
"document_id": "Py5CCdjNYgUH3hBTExciC5Gb-por-recto",
"step": "step-1",
"action": "document_type",
"document_name": "Py5CCdjNYgUH3hBTExciC5Gb-por-recto.jpg"
},
{
"id": "cbfd7e8a-0340-41a8-a20c-0a0ac72db5c3",
"name": "RECTO",
"confidence": 1,
"color": "#808080",
"page": 1,
"document_number": 1,
"document_id": "Py5CCdjNYgUH3hBTExciC5Gb-por-recto",
"step": "step-1",
"action": "document_face",
"document_name": "Py5CCdjNYgUH3hBTExciC5Gb-por-recto.jpg"
}
],
"form": {
"document_type": "por",
"document_country": "FR"
}
}
Félicitations ! Vous avez réussi votre première identification. Pour aller plus loin, vous pouvez explorer les différentes étapes d'intégration ou examiner les résultats obtenus à partir d'une identification.