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_callbacks [2025/08/05 09:20] – [PAYLOAD STRUCTURE] adminen:guide_callbacks [2025/09/23 15:51] (Version actuelle) – [CALLBACK ENDPOINTS] admin
Ligne 1: Ligne 1:
-~~NOTOC~~ +[[:guide_callbacks|Français]] | [[:en:guide_callbacks|English]]
-[[:fr:guide_callbacks|Français]] | [[:en:guide_callbacks|English]]+
 ---- ----
 ====== INTRODUCTION TO CALLBACKS ====== ====== INTRODUCTION TO CALLBACKS ======
Ligne 30: Ligne 29:
 Below is an example of a payload (in JSON format) sent by ID360 to your callback URL: Below is an example of a payload (in JSON format) sent by ID360 to your callback URL:
  
-{{:payload.png| ? 289 × 286}}+{{:payload.png?350%|}}
  
 ==== PREREQUISITES ==== ==== PREREQUISITES ====
Ligne 46: Ligne 45:
 ==== STRUCTURE AND CHARACTERISTICS ==== ==== STRUCTURE AND CHARACTERISTICS ====
  
-{{callbackintermediaire.png?   251 × 255}}+{{:callbackintermediaire.png?300%|}}
  
 The **status** of an intermediate callback will always be set to “STARTED”. The **status** of an intermediate callback will always be set to “STARTED”.
Ligne 62: Ligne 61:
 === Identity Documents === === Identity Documents ===
  
-| ‘enrollment_step’ > ‘name’ | Document(s)        | Control / Note                                           | +^ ‘enrollment_step’ > ‘name’ ^ Document(s)        ^ Control / Note                                           ^
-|----------------------------|--------------------|-----------------------------------------------------------|+
 | id_document                | Identity document  | The ID document has been successfully received and read  | | id_document                | Identity document  | The ID document has been successfully received and read  |
-| id_document_mandat        | ID (from KBIS)     | The mandate ID was successfully received and read         |+| id_document_mandate       | ID (from KBIS)     | The mandate ID was successfully received and read         |
 | fake_photo_id             | ID document        | The photo on the ID document is valid                     | | fake_photo_id             | ID document        | The photo on the ID document is valid                     |
 | phone_detection           | ID document        | Presentation attack detection was successfully completed  | | phone_detection           | ID document        | Presentation attack detection was successfully completed  |
Ligne 72: Ligne 70:
 === Electronic Identification Methods === === Electronic Identification Methods ===
  
-| ‘enrollment_step’ > ‘name’ | Document(s)       | Control / Note                                           | +^ ‘enrollment_step’ > ‘name’ ^ Document(s)       ^ Control / Note                                           ^
-|----------------------------|-------------------|-----------------------------------------------------------|+
 | ar24                       | PVID              | AR24 has provided ID360 with the enrollment results       | | ar24                       | PVID              | AR24 has provided ID360 with the enrollment results       |
 | france_connect            | France Connect    | France Connect has shared the enrollment results          | | france_connect            | France Connect    | France Connect has shared the enrollment results          |
Ligne 81: Ligne 78:
 === Selfie === === Selfie ===
  
-| ‘enrollment_step’ > ‘name’ | Document(s)           | Control / Note                                           | +^ ‘enrollment_step’ > ‘name’ ^ Document(s)           ^ Control / Note                                           ^
-|----------------------------|------------------------|-----------------------------------------------------------|+
 | facecomparison             | Selfie + ID document   | Selfie image extracted from video was successfully received | | facecomparison             | Selfie + ID document   | Selfie image extracted from video was successfully received |
 | liveness                   | Selfie                 | Challenge videos received for liveness detection          | | liveness                   | Selfie                 | Challenge videos received for liveness detection          |
Ligne 88: Ligne 84:
 === Additional Documents === === Additional Documents ===
  
-| ‘enrollment_step’ > ‘name’ | Document(s)              | Control / Note                                           | +^ ‘enrollment_step’ > ‘name’ ^ Document(s)           ^ Control / Note                                           ^
-|----------------------------|--------------------------|-----------------------------------------------------------|+
 | property_tax_notice        | Property tax notice      | Document successfully received and read                   | | property_tax_notice        | Property tax notice      | Document successfully received and read                   |
 | proof_of_address           | Proof of address         | Document successfully received and read                   | | proof_of_address           | Proof of address         | Document successfully received and read                   |
Ligne 101: Ligne 96:
 === Other Controls === === Other Controls ===
  
-| ‘enrollment_step’ > ‘name’ | Field              | Control / Note                                           | +^ ‘enrollment_step’ > ‘name’ ^ Document(s)           ^ Control / Note                                           ^
-|----------------------------|--------------------|-----------------------------------------------------------|+
 | phone                      | Phone number       | User provided their phone number                         | | phone                      | Phone number       | User provided their phone number                         |
 | otp                        | OTP code           | User successfully entered the OTP code                   | | otp                        | OTP code           | User successfully entered the OTP code                   |
Ligne 110: Ligne 104:
  
 The final callback notifies you of the completion of the identification process and provides final status details.   The final callback notifies you of the completion of the identification process and provides final status details.  
-{{callbackfinale.png?386 × 137 }}+{{:callbackfinale.png?386 × 137|}}
  
 The status of a final callback can be:   The status of a final callback can be:  
Ligne 123: Ligne 117:
 If this response is not received, up to 6 additional retry attempts will be made according to the following schedule: If this response is not received, up to 6 additional retry attempts will be made according to the following schedule:
  
-| Attempt | Seconds | Minutes | Cumulative Minutes | +^ Attempt ^ Seconds ^ Minutes ^ Cumulative Minutes ^
-|---------|---------|---------|--------------------|+
 | 1       | 10      | 0.17    | 0.17               | | 1       | 10      | 0.17    | 0.17               |
 | 2       | 80      | 1.33    | 1.50               | | 2       | 80      | 1.33    | 1.50               |
Ligne 138: Ligne 131:
 ====== CALLBACK ENDPOINTS ====== ====== CALLBACK ENDPOINTS ======
  
-In the body of the user file creation step:+In the body when creating a user file:
  
-```json+<code json>
 "callback_endpoints": [ "callback_endpoints": [
   {   {
Ligne 149: Ligne 142:
     "headers": [     "headers": [
       {       {
-        "name": "Authorization: Bearer abc123"+        "name": "Authorization", value: "Bearer abc123"
       }       }
     ]     ]
   }   }
 ] ]
 +</code>
 +
 +----
 +
 +=== 📝 Field Details ===
 +
 +  * **''url''**: the POST endpoint address to be called when an event is triggered.  
 +  * **''on''**: list of statuses for which this callback will be executed.  
 +  * **''headers''**: list of custom headers to include in the request (e.g., authentication, trace, etc.).
 +
 +----
 +
 +=== 🎯 List of Possible Statuses in ''on'' ===
 +
 +  * **''F''** – Failed  
 +  * **''C''** – Canceled  
 +  * **''E''** – End (OK or KO)  
 +  * **''I''** – Intermediate  
 +  * **''UP''** – Mie User Processing  
 +  * **''SP''** – Mie Sys Processing  
 +
 +----
 +
 +=== 💬 Comment ===
 +
 +  * You can define multiple endpoints by adding them to the **''callback_endpoints''** list.  
 +  * Each callback will only be triggered for the statuses specified in **''on''**.
  

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