| Les deux révisions précédentesRévision précédenteProchaine révision | Révision précédente |
| en:guide_du_developpeur_service [2025/08/08 12:09] – [7. Selfie Upload (optional)] admin | en:guide_du_developpeur_service [2026/01/26 14:45] (Version actuelle) – admin |
|---|
| - **Creating a user enrollment**: When creating a user enrollment, you will receive an enrollment ID and an API key (api_key), which will be essential for the rest of the process. | - **Creating a user enrollment**: When creating a user enrollment, you will receive an enrollment ID and an API key (api_key), which will be essential for the rest of the process. |
| - **Route selection**: The api_key obtained in the previous step allows you to retrieve the identifier of the “route” to be executed. In your use case, there will be only one route available – the customizable online process by Docaposte. | - **Route selection**: The api_key obtained in the previous step allows you to retrieve the identifier of the “route” to be executed. In your use case, there will be only one route available – the customizable online process by Docaposte. |
| - **Acceptance of Terms & Conditions**: This method allows you to update the fields `accept_cgu` and `accept_biometry` within the enrollment. | - **Acceptance of Terms & Conditions**: This method allows you to update the fields `accepted_system_cgu` and `accept_biometry` within the enrollment. |
| - **Data comparison (optional)**: It is also possible to compare expected data with information extracted from the identity document. | - **Data comparison (optional)**: It is also possible to compare expected data with information extracted from the identity document. |
| - **Identity document upload**: Upload of the ID document is performed at this step. | - **Identity document upload**: Upload of the ID document is performed at this step. |
| - **Finalizing the enrollment**: Finalizes the user enrollment. | - **Finalizing the enrollment**: Finalizes the user enrollment. |
| - **Retrieving the report**: You can retrieve the user enrollment report using the enrollment ID obtained in step two. The report includes the status of the enrollment, technical information, and details of the verification steps. | - **Retrieving the report**: You can retrieve the user enrollment report using the enrollment ID obtained in step two. The report includes the status of the enrollment, technical information, and details of the verification steps. |
| | - **Retrieving the idClaim (optional)**: Only in the case of advanced electronic signature, returns an ASIC-E. |
| |
| ---- | ---- |
| |
| ^ Parameter ^ Required ^ Details ^ | ^ Parameter ^ Required ^ Details ^ |
| | ''username'' | Yes | Login identifier | | | ''username'' | Yes | Login identifier (by default, the application login)| |
| | ''password'' | Yes | Password | | | ''password'' | Yes | Password | |
| | ''token'' | No (except for admin) | Unnecessary for `application` accounts. Required only for `admin` accounts with two-factor authentication | | | ''token'' | No (except for admin) | Unnecessary for `application` accounts. Required only for `admin` accounts with two-factor authentication | |
| * **''group''**: optional – Enables consumption exports grouped by logical units. | * **''group''**: optional – Enables consumption exports grouped by logical units. |
| |
| > For more details on callback_endpoints, refer to [[https://wiki.id360docaposte.com/doku.php?id=guide_callbacks|this dedicated guide]]. | > For more details on callback_endpoints, refer to [[https://id360.doca-id.com/doku.php?id=guide_callbacks|this dedicated guide]]. |
| |
| ---- | ---- |
| <code bash> | <code bash> |
| curl -X POST \ | curl -X POST \ |
| "https://id360docaposte.com/api/1.0.0/enrollment/flow/consent/?accepted_cgu=true&accepted_biometry=true" \ | "https://id360docaposte.com/api/1.0.0/enrollment/flow/consent/?accepted_system_cgu=true&accepted_biometry=true" \ |
| -H "accept: */*" \ | -H "accept: */*" \ |
| -H "x-api-key: <your_api_key>" \ | -H "x-api-key: <your_api_key>" \ |
| <code bash> | <code bash> |
| curl -X POST \ | curl -X POST \ |
| "https://preprod.id360docaposte.com/api/1.0.0/enrollment/flow/consent/?accepted_cgu=true&accepted_biometry=true" \ | "https://preprod.id360docaposte.com/api/1.0.0/enrollment/flow/consent/?accepted_system_cgu=true&accepted_biometry=true" \ |
| -H "accept: */*" \ | -H "accept: */*" \ |
| -H "x-api-key: <your_api_key>" \ | -H "x-api-key: <your_api_key>" \ |
| === 💬 Notes === | === 💬 Notes === |
| |
| * ✅ If you are only uploading an **identity or supporting document**, use `accepted_cgu=true` only. | * ✅ If you are only uploading an **identity or supporting document**, use `accepted_system_cgu=true` only. |
| * ✅ If you are also uploading a **selfie**, make sure to add `accepted_biometry=true` in the URL. | * ✅ If you are also uploading a **selfie**, make sure to add `accepted_biometry=true` in the URL. |
| |
| |
| In the process configuration, it is mandatory to select **at least one data field to compare**. | In the process configuration, it is mandatory to select **at least one data field to compare**. |
| To do so, go to the **''Information Entry''** block and choose the elements to compare. | To do so, go to the **''Information input''** block and choose the elements to compare. |
| | |
| | Then, under the “Validations selection”, click on “Identity” and check the controls you want to enable. |
| | For example, “Verify coherence with the identity name.” |
| |
| [[https://preprod.id360docaposte.com/static/swagger.html#/Enrollment%20Control/control_data|See the method in Swagger]] | [[https://preprod.id360docaposte.com/static/swagger.html#/Enrollment%20Control/control_data|See the method in Swagger]] |
| * **`total_pages`**: indicates the **total number of pages** to be uploaded for the document (e.g., `2` for a front/back ID). | * **`total_pages`**: indicates the **total number of pages** to be uploaded for the document (e.g., `2` for a front/back ID). |
| * **`uploaded_page`**: index (starting at `0`) of the page currently being uploaded. | * **`uploaded_page`**: index (starting at `0`) of the page currently being uploaded. |
| * Allowed formats: jpg, jpeg, png, pdf, heic | * **Allowed formats**: jpg, jpeg, png, pdf, heic |
| * Maximum size per document: 9.5 MB | * **Maximum size** per document: 9.5 MB |
| |
| ---- | ---- |
| * **`total_pages`**: must be `1` for a selfie. | * **`total_pages`**: must be `1` for a selfie. |
| * **`uploaded_page=0`**: remains at `0` since there is only one page. | * **`uploaded_page=0`**: remains at `0` since there is only one page. |
| * Allowed formats: jpg, jpeg, png, pdf, heic | * **Allowed formats**: jpg, jpeg, png, pdf, heic |
| * Maximum size per document: 9.5 MB | * **Maximum size** per document: 9.5 MB |
| |
| ---- | ---- |
| |
| **HTTP Status**: ''200 OK'' | **HTTP Status**: ''200 OK'' |
| | |
| **Response format**: JSON | **Response format**: JSON |
| |
| [[https://preprod.id360docaposte.com/static/swagger.html#/enrollment/enrollment_proof_slip|Download the PDF report]] | [[https://preprod.id360docaposte.com/static/swagger.html#/enrollment/enrollment_proof_slip|Download the PDF report]] |
| |
| | ====== 10. Retrieving the idClaim ====== |
| |
| | [[https://preprod.id360docaposte.com/static/swagger.html#/enrollment/enrollment_idclaim|See the method in Swagger]] |
| | |
| | ---- |
| | |
| | === 🔧 CURL Request – Production === |
| | <code javascript> |
| | curl -X GET \ |
| | "https://id360docaposte.com/api/1.0.0/enrollment/{id}/idclaim" \ |
| | -H "accept: application/json" \ |
| | -H "Authorization: Token 0123456789abcdef01234567" |
| | </code> |
| | |
| | ---- |
| | |
| | === 🔧 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> |
