• ✅ Gérer l’identification et l’authentification des utilisateurs de votre service métier.
• 🗂️ (Optionnel) Collecter, stocker et vérifier l’authenticité de documents complémentaires.
• 🎨 Personnaliser une interface utilisateur selon vos besoins.

• Swagger Préproduction
• Swagger Production

1. Connexion à l’API : Cet appel vous fournira un token valide pendant 15 minutes, vous permettant d’accéder aux différentes méthodes de l’API.
2. Création d’un dossier utilisateur : Lors de la création d’un dossier utilisateur, vous recevrez un identifiant de dossier ainsi qu'une clé API (api_key), qui sera essentielle pour la suite du processus.
3. Comparaison de données (en option) : Il est également possible de comparer des données attendues avec celles extraites de l'identité.
4. Redirection de l’utilisateur vers l’interface utilisateur (UI) : La clé API obtenue à l’étape précédente vous permettra de rediriger l’utilisateur vers son parcours d’enrôlement.
5. Récupération du rapport : Vous pourrez récupérer le rapport du dossier utilisateur en utilisant l'identifiant du dossier obtenu lors de la deuxième étape. Ce rapport contiendra le statut du dossier ainsi que des informations techniques et sur les différentes étapes de vérification.
6. Récupération des documents : Vous aurez également la possibilité de récupérer les documents d'identité et complémentaires soumis par l'utilisateur lors de son parcours.
7. Récupération de l'idClaim (en option) : Uniquement dans le cas de la signature électronique avancée, retourne un ASIC-E.

• Faire fonctionner ID360 dans une webview (en option) : hors parcours proposant l'Identité Numérique La Poste
• Interrompre un dossier : Pour invalider une URL d'identification et forcer la clôture d'un dossier dans le cas d'un parcours non démarré ou incomplet.

📘 Pour poursuivre la lecture de ce guide, il est nécessaire d’avoir créé au moins un parcours et une application.

Si ce n’est pas encore fait, nous vous recommandons de consulter la première section de ce guide: Mes premiers pas avec ID360

Voir la méthode dans le Swagger

curl -X POST "https://id360docaposte.com/api/1.0.0/user/login/" \
  -H "accept: application/json" \
  -d '{ "username": "string", "password": "string", "token": "string" }'

curl -X POST "https://preprod.id360docaposte.com/api/1.0.0/user/login/" \
  -H "accept: application/json" \
  -d '{ "username": "string", "password": "string", "token": "string" }'

HTTP Status : 200 OK

Réponse (Body) :

{
  "token": "0123456789abcdef01234567"
}

• Cet appel doit être effectué par votre serveur, jamais depuis le navigateur de l’utilisateur.
• Le token retourné est valide 15 minutes. Ce délai est réinitialisé à chaque appel API utilisant ce token.
• Si vous tentez un appel avec un token expiré ou sans token, vous recevrez une erreur 401 Unauthorized.
• Tant que le token est valide, il ne faut pas refaire un appel à /login/.
• Le token s’utilise dans les appels suivants sous forme de header : Authorization: Token 0123456789abcdef01234567
• Le token est composé de 25 caractères (longueur fixe).

Le header essentiel à ajouter à vos requêtes API est :

Authorization → doit contenir :

• le préfixe Token
• un espace
• la valeur du token récupérée lors de la connexion à l’API

Exemple :

Authorization: Token 0123456789abcdef01234567

Pour tester les appels dans Swagger :

1. Cliquez sur le bouton Try it out (en haut à droite)
2. Entrez le token sous la forme : Token 0123456789abcdef01234567
3. Cliquez ensuite sur Authorize.

Vous serez alors authentifié pour effectuer les appels API directement depuis Swagger.

Le token de connexion est valable pendant 15 minutes. Cette durée est réinitialisée à chaque appel de méthode utilisant le token (*à l'exception de la méthode logIn*).

Si vous n’êtes pas connecté ou si votre token a expiré, vous recevrez une erreur 401 Unauthorized pour toute opération nécessitant une authentification.

Pour prolonger la durée de vie de votre token, vous pouvez appeler la méthode suivante toutes les 13 minutes :

/api/1.0.0/user/whoami

Cette méthode :

• Ne nécessite aucun paramètre
• Requiert un en-tête Authorization au format suivant :

Authorization: Token 0123456789abcdef01234567

• Si cette méthode retourne un code 200, cela signifie que votre token est toujours valide.
• Dans le cas contraire, vous devrez générer un nouveau token via la méthode logIn.

ℹ️ À retenir : intégrer cet appel de manière automatique dans vos processus pour éviter d’avoir à solliciter la méthode logIn à répétition, cela pourrait être interprété par ID360 comme un comportement anormal ou agressif.

Voir la méthode dans le Swagger

curl -X POST \
  "https://id360docaposte.com/api/1.0.0/process/{id}/enrollment" \
  -H "Authorization: Token 0123456789abcdef01234567"

curl -X POST \
  "https://preprod.id360docaposte.com/api/1.0.0/process/{id}/enrollment" \
  -H "Authorization: Token 0123456789abcdef01234567"

Remplacez la partie {id} par l’UUID d’un process. Les objets process sont configurables via l’IHM d’administration (leur UUID y est affiché).

{
  "browser_callback_url": "https://www.example.com/browser_callback_url",
  "client_reference": "any_string", 
  "callback_endpoints": [{
    "url": "https://www.example.com/callback_url1",
    "on": ["E","F","C"],
    "headers": [{"name": "string", "value": "string"}]
    },{
    "url": "https://www.example.com/callback_url2",
    "on": [],
    "headers": [{"name": "string", "value": "string"}]
  }],
  "last_name": "Users last name",
  "first_name": "Users first name",
  "email": "Users email",
  "address_line_1": "Users address line 1",
  "address_line_2": "Users address line 2",
  "address_line_3": "Users address line 3",
  "zip_code": "Users zip code",
  "city": "Users city",
  "country": "Users country",
  "phone_number": "Users phone number",
  "group": "string"
}

• browser_callback_url : obligatoire – URL appelée par le navigateur de l’utilisateur à la fin du parcours (utilisée uniquement pour la redirection).
• client_reference : facultatif – Permet d’associer un identifiant interne à votre système. Utile pour les croisements en cas d’annulation ou d’échec.
• callback_endpoints : obligatoire – un callback endpoint permet à ID360 de notifier automatiquement votre système lorsqu’un dossier atteint un certain statut (ex. échec, annulation, fin de traitement), via une requête HTTP POST envoyée à l’URL que vous avez fournie. Les headers sont optionnels, vous pouvez les utiliser comme des headers d'identification lors de la réception des callbacks.
• last_name, first_name, address_line_1/2/3, zip_code, city, country, phone_number, email : facultatifs – Informations utilisateur à titre informatif uniquement (aucun contrôle réalisé dessus).
• group : facultatif – permettra de faire un export des consommations en fonction de groupes.

Pour plus de détails sur les callback_endpoints, consultez ce guide dédié.

HTTP Status : 200 OK

{
  "url": "https://www.id360docaposte.com/api/1.0.0/enrollment/{id}",
  "id": "{id}",
  "process": 1,
  "api_key": "0123456789abcdef0123456789abcde",
  "browser_callback_url": "yyy",
  "client_reference": "any_string",
  "status": "NEW",
  "reason": null,
  "creation_time": "2021-12-17T15:01:49.013906",
  "starting_time": null,
  "finished_time": null;
  "callback_endpoints": [{
            "url": "https://dev.webhook.id360docaposte.com/66b905f6-ac91-4a2c-8b1b-752d2393ac3b",
            "on": ["E","F","C"],
            "headers": [{"name": "string"}]
        },{
            "url": "https://dev.webhook.id360docaposte.com/66b905f6-ac91-4a2c-8b1b-752d2393ac3b",
            "on": [],
            "headers": [{"name": "string"}]
  }]
}

• Cet appel doit être effectué côté serveur, jamais depuis le navigateur de l'utilisateur.
• ⚠️ Il est essentiel de conserver l’id du dossier ainsi que la api_key pour la suite du processus.

Dans la configuration du parcours, il est indispensable de sélectionner au moins une donnée à comparer. Pour ce faire, accédez au bloc Saisie d'informations et choisissez les éléments à comparer.

Voir la méthode dans le Swagger

curl -X POST \
  "https://id360docaposte.com/api/1.0.0/enrollment/{id}/control/data/{data_name}/?locked=true" \
  -H "accept: application/json" \
  -H "Authorization: Token 0123456789abcdef01234567"

curl -X POST \
  "https://preprod.id360docaposte.com/api/1.0.0/enrollment/{id}/control/data/{data_name}/?locked=true" \
  -H "accept: application/json" \
  -H "Authorization: Token 0123456789abcdef01234567"

• {id} : identifiant de l’enrôlement, récupéré lors de la création du dossier utilisateur.
• {data_name} : nom de la donnée à comparer.
  1. Exemples :
     1. name → nom de famille
     2. first_name → prénom
     3. birth_date → date de naissance
• Pour connaître les données attendues, vous pouvez interroger :

https://preprod.id360docaposte.com/api/1.0.0/enrollment/flow/enrollment_info

Le body doit simplement contenir la donnée à vérifier, au format brut (texte ou valeur simple).

Attention, les données doivent être poussées en UTF-8.

HTTP Status : 204 No Content Cela indique que la comparaison a bien été prise en compte et ne retourne pas de corps de réponse.

Cette étape doit être réalisée directement dans le navigateur de l’utilisateur. À l’aide de l’api_key obtenue lors de la création du dossier utilisateur, vous pouvez rediriger l’utilisateur vers l’interface de saisie via l’URL suivante :

https://www.id360docaposte.com/static/process_ui/index.html#/enrollment/api_key_de_l_etape_precedente

https://preprod.id360docaposte.com/static/process_ui/index.html#/enrollment/api_key_de_l_etape_precedente

• Cette URL doit être ouverte dans le navigateur de l’utilisateur final.
• Remplacez api_key_de_l_etape_precedente par la valeur réelle reçue lors de la création du dossier utilisateur (champ api_key dans la réponse).

Un token est ajouté en paramètre de l’URL de redirection (browser callback) lors de la redirection de l’utilisateur. Par exemple :

https://browsercallback.fr?token=2c4a10812ed36dd6d6de2e3c4751ff20e277b4fe41b557dcebb31f5f5a66550815163de0f4e51ac4619a14be98da2de156914a87bdecccba41e9be357aaa2582

Ce token permet d’appeler la méthode suivante :

https://preprod.id360docaposte.com/static/swagger.html#/enrollment/enrollment_status_retrieve

Cette méthode récupère l'enrôlement associé au jeton présent dans l'URL de callback. Elle ne peut être invoquée qu'une seule fois pour un même enrôlement, après quoi le jeton sera automatiquement invalidé.

Notez qu'il s'agit d'une empreinte de l'enrôlement et non d'un rapport d’identification comme celui obtenu via le paramètre « report » (un exemple est disponible dans le swagger).

Même si vous n’utilisez pas ce token, le statut du dossier sera communiqué via l’URL de callback (voir le guide de callback).

Voir la méthode dans le Swagger

curl -X GET \
  "https://id360docaposte.com/api/1.0.0/enrollment/{id}/report" \
  -H "accept: application/json" \
  -H "Authorization: Token 0123456789abcdef01234567"

curl -X GET \
  "https://preprod.id360docaposte.com/api/1.0.0/enrollment/{id}/report" \
  -H "accept: application/json" \
  -H "Authorization: Token 0123456789abcdef01234567"

• {id} : identifiant du dossier utilisateur, récupéré lors de sa création.
• Paramètres : aucun paramètre attendu dans cette requête.

HTTP Status : 200 OK

Format de la réponse : JSON

• Cet appel doit être effectué par votre serveur, jamais depuis le navigateur de l’utilisateur.
• Le token de connexion est valable 15 minutes, renouvelées à chaque appel utilisant ce token.
• En cas de token expiré ou absent, vous recevrez une erreur 401 Unauthorized.
• Tant que votre token est valide, il ne faut pas réutiliser la méthode login.
• Le token s’utilise dans l’en-tête des appels suivants sous la forme :

Authorization: Token le_token_retourné_par_login

Le rapport est également accessible dans la console, sous l'onglet « Dossiers Utilisateurs » pour une durée de deux mois. L'identifiant correspond à l'ID du dossier généré à l’issue de l’étape 2. En sélectionnant « Voir le détail », vous pouvez consulter le rapport d’identification et télécharger le dossier de preuves au format JSON en bas de page.

Un rapport temporaire est disponible avant que le rapport final ne soit émis. Ce rapport peut être récupéré grâce au paramètre allow_draft = true, mais ne doit pas être utilisé en production.

⚠️ La récupération du rapport ne peut se faire qu'après réception de la callback_url vous informant de la fin du traitement du dossier.

Attention : L'appel à un rapport temporaire peut induire des ralentissements ou des blocages pour vos utilisateurs.

Les applications et utilisateurs peuvent récupérer tous les dossiers de preuve via la méthode report.

- Un dossier ayant le statut :

1. NEW
2. STARTED
3. CANCELED

aura un dossier de preuve temporaire accessible en ajoutant draft = true à l’appel.

→ Voir dans Swagger

Les utilisateurs peuvent récupérer tous les dossiers de preuve finalisés (avec un verdict OK ou KO) via la méthode report.

Seuls les utilisateurs peuvent accéder aux rapports archivés via la méthode report/archive.

• Un dossier avec un statut CANCELED ou FAILED n’est pas archivé.
• Un dossier DELETED (de plus de 2 mois) est archivé uniquement s’il avait un statut final OK ou KO.

▶️ Récupération via une application : Connexion via vos identifiants *applicatifs* (identifiant de l'application + mot de passe défini à la création).

▶️ Récupération via un utilisateur : Connexion avec vos identifiants *utilisateur* :

1. Adresse e-mail
2. Mot de passe personnel
3. Jeton de double authentification (2FA)

Voir méthode dédiée : Téléchargement du PDF du rapport

Il vous est possible, via l’API, de récupérer les pièces d’identité analysées et, si configuré, les documents collectés. Cela est possible jusqu’à 7 jours après l’enrôlement.

Voir la méthode dans le Swagger

curl -X 'GET' \
  'https://id360docaposte.com/api/1.0.0/document/{id_document}/file_contents/?page_number={page_number}' \
  -H 'accept: application/octet_stream' \
  -H 'Authorization: Token 4550d727f89d76dc0b07917461a16710141d101e0796ec644c'

curl -X 'GET' \
  'https://preprod.id360docaposte.com/api/1.0.0/document/{id_document}/file_contents/?page_number={page_number}' \
  -H 'accept: application/octet_stream' \
  -H 'Authorization: Token 4550d727f89d76dc0b07917461a16710141d101e0796ec644c'

• Le document est renvoyé directement en réponse.
• Pour obtenir le recto et le verso d’une pièce d’identité, appelez deux fois la méthode avec un page_number différent :
  1. page_number=0 → recto
  2. page_number=1 → verso

"documents": {
  "identity": [{
    "name": "id_document_image",
    "files": [
      { "url": "https://preprod.id360docaposte.com/api/1.0.0/document/354746/file_contents/?page_number=0" },
      { "url": "https://preprod.id360docaposte.com/api/1.0.0/document/354746/file_contents/?page_number=1" }
    ]
  }]
}

• L’identifiant du document est 354746.
• page 0 = recto / page 1 = verso

Voir la méthode dans le Swagger

curl -X GET \
  "https://id360docaposte.com/api/1.0.0/enrollment/{id}/idclaim" \
  -H "accept: application/json" \
  -H "Authorization: Token 0123456789abcdef01234567"

curl -X GET \
  "https://preprod.id360docaposte.com/api/1.0.0/enrollment/{id}/idclaim" \
  -H "accept: application/json" \
  -H "Authorization: Token 0123456789abcdef01234567"

• {id} : identifiant du dossier utilisateur, récupéré lors de sa création.
• Paramètres : aucun paramètre attendu dans cette requête.

HTTP Status : 200 OK

Format de la réponse : ASIC-E

• Le token de connexion est valable 15 minutes, renouvelées à chaque appel utilisant ce token.
• En cas de token expiré ou absent, vous recevrez une erreur 401 Unauthorized.
• Tant que votre token est valide, il ne faut pas réutiliser la méthode login.
• Le token s’utilise dans l’en-tête des appels suivants sous la forme :

Authorization: Token le_token_retourné_par_login

Les permissions suivantes doivent être activées côté application (Android ou iOS) :

• Accès à la caméra
• Accès au gyromètre
• Accès aux fichiers (pour l’import de documents)

Et également :

• Activer le JavaScript
• Sur Android, initialiser la WebView avec l’activity context (et non le context global de l’application), pour assurer le bon fonctionnement des éléments comme les menus déroulants.

Voir la méthode dans le Swagger

curl -X GET \
  "https://id360docaposte.com/api/1.0.0/enrollment/{id}/control/discontinue" \
  -H "Authorization: Token 0123456789abcdef01234567"

curl -X GET \
  "https://preprod.id360docaposte.com/api/1.0.0/enrollment/{id}/control/discontinue" \
  -H "Authorization: Token 0123456789abcdef01234567"

• {id} : identifiant du dossier utilisateur, récupéré lors de sa création.
• Paramètres : aucun paramètre attendu dans cette requête.

HTTP Status : 204 No Content

Le statut du dossier sera changé en DISCONTINUED