Outils pour utilisateurs

Différences

Ci-dessous, les différences entre deux révisions de la page.

Lien vers cette vue comparative

Les deux révisions précédentesRévision précédente
Prochaine révision		Révision précédente
en:guide_du_developpeur_capture [2025/08/04 18:21] – adminen:guide_du_developpeur_capture [2025/11/04 11:18] (Version actuelle) – [5.1 Retrieving the Report via API] admin
Ligne 1: Ligne 1:
-~~NOTOC~~ +[[:guide_du_developpeur_capture|Français]] | [[:en:guide_du_developpeur_capture|English]]
-[[:fr:guide_du_developpeur_capture|Français]] | [[:en:guide_du_developpeur_capture|English]]+
 ---- ----
 +
 ====== Developer Guide – ID360 Capture ====== ====== Developer Guide – ID360 Capture ======
  
Ligne 25: Ligne 25:
   - **Retrieve report**: Retrieve the user's folder report using the folder ID, with status and technical/verification info.   - **Retrieve report**: Retrieve the user's folder report using the folder ID, with status and technical/verification info.
   - **Retrieve documents**: Optionally, retrieve identity and supporting documents submitted by the user.   - **Retrieve documents**: Optionally, retrieve identity and supporting documents submitted by the user.
 +  - **Retrieving the idClaim (optional)**: Only in the case of advanced electronic signature, returns an ASIC-E.
 +
 +=== 🔧 Additional options and tools ===
 +  * **Run ID360 in a WebView (optional)**: outside processes offering La Poste Digital Identity
 +  * **Interrupt a user folder** : To invalidate an identification URL and force the closure of a file in the case of an identification process that has not been started or is incomplete.
  
 ---- ----
Ligne 84: Ligne 89:
   * As long as the token is valid, **do not call `/login/` again**.   * As long as the token is valid, **do not call `/login/` again**.
   * Use the token in the header of future calls:''Authorization: Token 0123456789abcdef01234567''   * Use the token in the header of future calls:''Authorization: Token 0123456789abcdef01234567''
 +  * The token is made up of 25 characters (fixed length).
  
 ---- ----
Ligne 144: Ligne 150:
   * Otherwise, generate a **new token** via the `logIn` method.   * Otherwise, generate a **new token** via the `logIn` method.
  
-**ℹ️ Tip: Automate this call to avoid repeated login requests, which may be seen by ID360 as abnormal or aggressive behavior.** +**ℹ️ Reminder: integrate this call automatically into your process to avoid repeatedly calling the logIn method, as this may be interpreted by ID360 as abnormal or aggressive behavior.**
- +
-# 2. Creating a User Folder +
- +
-[See method in Swagger](https://preprod.id360docaposte.com/static/swagger.html#/process/process_enrollment_create) +
- +
---- +
- +
-## 🔧 CURL Request – Production +
-```bash +
-curl -X POST \ +
-  "https://id360docaposte.com/api/1.0.0/process/{id}/enrollment" \ +
-  -H "Authorization: Token 0123456789abcdef01234567" +
 ====== 2. Create a user folder ====== ====== 2. Create a user folder ======
  
Ligne 204: Ligne 197:
     "headers": [{"name": "string", "value": "string"}]     "headers": [{"name": "string", "value": "string"}]
   }],   }],
-  "callback_headers": { 
-    "header_name_1": "header_value_1", 
-    "header_name_2": "header_value_2" 
-  }, 
   "last_name": "Users last name",   "last_name": "Users last name",
   "first_name": "Users first name",   "first_name": "Users first name",
Ligne 318: Ligne 307:
 ^ Parameter ^ Value ^ Description ^ ^ Parameter ^ Value ^ Description ^
 | ''locked'' | true | Locks the data once submitted (prevents further modification) | | ''locked'' | true | Locks the data once submitted (prevents further modification) |
 +| ''auto'' | false | The behavior depends on the type of data requested. For the ''phone_number'' data, the OTP SMS is triggered **upon page load**. Otherwise, the OTP code is sent **immediately upon the API request**. |
  
 ---- ----
Ligne 414: Ligne 404:
  
 **HTTP Status**: ''200 OK''   **HTTP Status**: ''200 OK''  
 +
 **Response format**: JSON **Response format**: JSON
  
Ligne 573: Ligne 564:
 | **Liveness** | ''"documents": { "liveness": [{"name": "liveness_video$0", "files": [{"url": "xxxxxxxxxxxxxxx"}]},{"name": "liveness_video$1","files": [{"url": "xxxxxxxxxxxxxxx"}]}]'' | | **Liveness** | ''"documents": { "liveness": [{"name": "liveness_video$0", "files": [{"url": "xxxxxxxxxxxxxxx"}]},{"name": "liveness_video$1","files": [{"url": "xxxxxxxxxxxxxxx"}]}]'' |
  
-====== Health Monitoring ======+====== 7. Retrieving the idClaim ======
  
-You can use the health API to retrieve a JSON containing the status of services used by ID360.+[[https://preprod.id360docaposte.com/static/swagger.html#/enrollment/enrollment_idclaim|See the method in Swagger]]
  
-curl "https://id360docaposte.com/health/" -H "accept:application/json"+----
  
-**Example result:** +=== 🔧 CURL Request – Production === 
-  +<code javascript> 
-<code json> +curl -X GET \ 
-    "AR24": { +  "https://id360docaposte.com/api/1.0.0/enrollment/{id}/idclaim" \ 
-        "local_status": { +  -H "accept: application/json" \ 
-            "status": "OK", +  -H "Authorization: Token 0123456789abcdef01234567"
-            "time": 1718095009.5825012 +
-        }, +
-        "global_status": { +
-            "status": "OK", +
-            "time": 1718095010.3707883 +
-        }, +
-        "all_status": { +
-            "0": "OK", +
-            "1": "OK" +
-        } +
-    }, +
-    "Antivirus": { +
-        "local_status": { +
-            "status": "OK", +
-            "time": 1718095015.1533806 +
-        }, +
-        "global_status": { +
-            "status": "OK", +
-            "time": 1718095017.9609795 +
-        }, +
-        "all_status": { +
-            "0": "OK", +
-            "1": "OK" +
-        }, …. +
-    }, ….+
 </code> </code>
  
-**Time**: corresponds to the timestamp of the last update+----
  
-**Two instances "0" and "1"**: make sure both instances of ID360 return an "OK" status+=== 🔧 CURL Request – Preproduction === 
 +<code javascript> 
 +curl -X GET \ 
 +  "https://preprod.id360docaposte.com/api/1.0.0/enrollment/{id}/idclaim" \ 
 +  -H "accept: application/json" \ 
 +  -H "Authorization: Token 0123456789abcdef01234567" 
 +</code> 
 + 
 +---- 
 + 
 +=== 🛠 Technical information === 
 + 
 +  * **''{id}''** : user file identifier, retrieved when it is created. 
 +  * **Parameters** : none expected in this request. 
 + 
 +---- 
 + 
 +=== ✅ Expected result === 
 + 
 +**HTTP Status** : ''200 OK'' 
 + 
 +**Response format** : ASIC-E 
 + 
 +---- 
 + 
 +=== 💬 Notes === 
 + 
 +  * The connection token is **valid for 15 minutes**, renewed with each call made using this token. 
 +  * If the token is expired or missing, you will receive a **401 Unauthorized** error. 
 +  * As long as your token remains valid, **you must not reuse the ''login'' method**. 
 +  * The token must be used in the header of subsequent calls as follows: 
 + 
 +<code> 
 +Authorization: Token token_returned_by_login 
 +</code> 
 + 
 +====== Conditions for running ID360 in a WebView ====== 
 +The following permissions must be enabled on the application side (Android or iOS): 
 +  * Camera access 
 +  * Gyroscope access 
 +  * File access (for document import) 
 +And also: 
 +  * Enable JavaScript 
 +  * On Android, initialize the WebView with the **activity context** (and not the application's global context) to ensure proper functioning of elements such as drop-down menus. 
 + 
 +====== Discontinue an Enrollment ====== 
 + 
 +[[https://preprod.id360docaposte.com/static/swagger.html#/Enrollment%20Control/control_discontinue|View the method in Swagger]] 
 + 
 +---- 
 + 
 +=== 🔧 CURL Request – Production === 
 +<code javascript> 
 +curl -X GET \ 
 +  "https://id360docaposte.com/api/1.0.0/enrollment/{id}/control/discontinue" \ 
 +  -H "Authorization: Token 0123456789abcdef01234567" 
 +</code> 
 + 
 +---- 
 + 
 +=== 🔧 CURL Request – Preproduction === 
 +<code javascript> 
 +curl -X GET \ 
 +  "https://preprod.id360docaposte.com/api/1.0.0/enrollment/{id}/control/discontinue" \ 
 +  -H "Authorization: Token 0123456789abcdef01234567" 
 +</code> 
 + 
 +---- 
 + 
 +=== 🛠 Technical Information === 
 + 
 +  * **''{id}''**: user enrollment identifier, retrieved during its creation. 
 +  * **Parameters**: no parameters are expected in this request. 
 + 
 +---- 
 + 
 +=== ✅ Expected Result === 
 + 
 +**HTTP Status**: ''204 No Content'' 
 + 
 +---- 
 + 
 +=== 💬 Notes ===
  
 +The enrollment status will be changed to **DISCONTINUED**.
  
  

This website uses cookies. By using the website, you agree with storing cookies on your computer. Also, you acknowledge that you have read and understand our Privacy Policy. If you do not agree, please leave the website.

Plus d’informations