Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Table of Contents
minLevel1
maxLevel7

ℹ️ About webhooks

Webhooks allow Ondato to send you real-time notifications regarding changes in the status of your resources. These notifications are sent as POST requests to your server immediately after the event occurs. The request body includes information about the resource.

🔐 Security

Ondato uses HTTPS to send these notifications as a JSON payload.

🛒 Ordering

Ondato delivers events asynchronously. Therefore, you might receive them out of order and need to handle them accordingly.

📫 Webhook IP addresses

All webhook requests will originate from the following IP addresses:

Code Block
20.31.10.47
20.31.227.231
20.76.229.117
20.76.229.248
213.226.187.101

Please make sure to whitelist the following IPs in order to receive webhook notifications.

🔃 Retry logic

Upon sending a webhook notification, we are waiting for a success response for 30 seconds. Otherwise, if your endpoint does not respond, the webhook is queued for retry. We use an exponential backoff retry policy for event delivery. The attempt to resend the notifications is according to the following schedule on a best effort basis:

Panel
panelIconId23f1
panelIcon:stopwatch:
panelIconText⏱️
bgColor#F4F5F7
  • 10 seconds

  • 30 seconds

  • 1 minute

  • 5 minutes

  • 10 minutes

  • 30 minutes

  • 1 hour

  • 3 hours

  • 6 hours

  • Every 12 hours up to 24 hours

If the endpoint responds within 3 minutes, we will attempt to remove the event from the retry queue on a best effort basis but duplicates may still be received.

A small randomisation is added to all retry steps and may opportunistically skip certain retries if an endpoint is down for a long period o appears to be overloaded.

Maximum number of retry attempts is 30.

When Event Grid can't deliver an event within a certain time period or after trying to deliver the event a certain number of times the event is dropped.

❔ How to start receiving webhooks?

To start receiving event notifications into your application you need to go through the following steps:

  1. Identify the events you want to monitor. Please see a full list of events in this section here:

    1. https://ondato.atlassian.net/wiki/spaces/PUB/pages/2296184995/Webhooks#%F0%9F%AA%84-Types.

  2. Create a webhook endpoint as an HTTP endpoint on your local server.

  3. Handle requests from Ondato.

  4. Deploy your webhook endpoint so it would be publicly accessible HTTPS URL.

  5. Contact Ondato support team to register the publicly accessible HTTPS URL and a list of events you want to monitor.

Please note that we also support multiple URLs for sending webhooks.

😶‍🌫️ Requirements for webhook endpoint

Ondato needs to know where to send information about events. In order to receive webhooks you need to create a webhook endpoint and provide us with the publicly accessible HTTPS URL that would meet the following criteria:

  1. URL format: https://<your-website-name>/<your-webhook-endpoint>.

  2. URL must support POST HTTP Method.

  3. URL must support one of the available authentication flows:

    1. basic - username, password.

    2. oAuth2 - clientID, clientSecret, tokenUrl.

Events sent by Ondato will have a body in the following structure:

Property

Description

Id

Webhook ID

ApplicationId

Internal ID that identifies you in Ondato system.

CreatedUtc

Date and time when webhook was generated.

DeliveredUtc

Date and time when webhook was delivered.

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#F4F5F7

This property is only visible via Consents API and is not sent with the body of the Webhook itself.

IsDelivered

Status of the webhook if it was delivered or not. Possible values are true/ false.

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#F4F5F7

This property is only visible via Consents API and is not sent with the body of the Webhook itself.

Payload

Depending on the webhook type property, the payload always returns the same information you could obtain from the

Status
colourGreen
titleGET
endpoint of the resource.

E.g. of the webhook type is KycIdentification.<<event>> then payload will contain information you could retrieve from KYC ID endpoint

Status
colourGreen
titleGET
/identifications/{id}.

Type

Type of the webhook. It contains of two parts (the first part identifies the service and the second one the event):

Table of Contents

Table of Contents
minLevel1
maxLevel7

ℹ️ About webhooks

Webhooks enable Ondato to send real-time notifications about changes in your resources. These notifications are sent as POST requests to your server immediately after the event occurs, and the request body includes information about the resource.


🔐 Security

Ondato uses HTTPS to transmit these notifications in the form of a JSON payload.


🛒 Ordering

Ondato delivers events asynchronously. Therefore, you might receive them out of order and need to handle them accordingly.


📫 Webhook IP addresses

All webhook requests will originate from the following IP addresses:

Code Block
20.31.10.47
20.31.227.231
20.76.229.117
20.76.229.248
213.226.187.101

Please ensure that you whitelist the above IPs to receive webhook notifications.


🔃 Retry logic

Upon sending a webhook notification, we are waiting for a success response for 30 seconds. Otherwise, if your endpoint does not respond, the webhook is queued for retry.

We use an exponential backoff retry policy for event delivery. The attempt to resend the notifications is according to the following schedule on a best effort basis:

Panel
panelIconId23f1
panelIcon:stopwatch:
panelIconText⏱️
bgColor#F4F5F7
  • 10 seconds

  • 30 seconds

  • 1 minute

  • 5 minutes

  • 10 minutes

  • 30 minutes

  • 1 hour

  • 3 hours

  • 6 hours

  • Every 12 hours up to 24 hours

If the endpoint responds within 3 minutes, we will attempt to remove the event from the retry queue on a best-effort basis. However, duplicates may still be received.

A small degree of randomization is incorporated into all retry steps and may selectively skip certain retries if an endpoint is offline for an extended period or seems overloaded.

The maximum number of retry attempts is 30.

When Event Grid is unable to deliver an event within a specific time frame or after attempting to deliver the event a certain number of times, the event is dropped.


❔ How to start receiving webhooks?

To begin receiving event notifications in your application, you need to follow these steps:

1️⃣ Identify the events you want to monitor.

Panel
bgColor#F4F5F7

📄 Please see a full list of events in this section here: https://ondato.atlassian.net/wiki/spaces/PUB/pages/2296184995/

Webhooks#%F0%9F%86%94

Webhooks#%F0%9F%AA%84-

Identity-Verification-(IDV)-webhooks
  • https://ondato.atlassian.net/wiki/spaces/PUB/pages/2296184995/Webhooks#%F0%9F%91%A4-KYC-Identification-webhooks

  • https://ondato.atlassian.net/wiki/spaces/PUB/pages/2296184995/Webhooks#%F0%9F%8F%A2-KYB-identification-webhooks

  • 🪄 Types

    Info

    You have the option to configure various webhook types that can trigger a message to registered webhooks.

    🆔 Identity Verification (IDV) webhooks

    1️⃣ IdentityVerification.StatusChanged

    Panel
    panelIconIdatlassian-light_bulb_on
    panelIcon:light_bulb_on:
    panelIconText:light_bulb_on:
    bgColor#E6FCFF
    • The webhook is triggered when the identity verification (IDV) status changes.

    • For this webhook type, the payload body depends on the IDV API

      Status
      colourGreen
      titleGET
      /v1/identifications/{id} contract.

    • You can call IDV API by using "id" →

      Status
      colourGreen
      titleGET
      /v1/identifications/{id} to retrieve the information about the user session.

    Expand
    titleReference from the Webhook payload
    Code Block
    languagejson
    {
      "payload": {
        "id": "03be8be3-fbd5-4496-b552-bcd3e4918116"
        }
    }
    Expand
    titleWebhook example
    Code Block
    languagejson
    { "id": "7a21b0e2-580e-4d2d-8578-00fc32a753ad", "applicationId": "44575362-e08e-4f75-b399-00d9d8916552", "createdUtc": "2023-01-31T07:25:55.6073016Z", "payload": { "id": "03be8be3-fbd5-4496-b552-bcd3e4918116", "status": "Completed", "applicationId": "44575362-e08e-4f75-b399-00d9d8916552", "createdUtc": "2023-01-31T07:22:11.313Z", "modifiedUtc": "2023-01-31T07:25:55.595Z", "setup": { "id": "5f16990b-d00a-4ff2-8102-e7b8d5820c28", "versionId": "60e8a778-1885-4162-bd58-d8b07bddba2e" }, "step": { "kycIdentification": { "id": "6df0d302-f0bb-441a-804c-5b114b476fc0" }, "documentSignatures": [],

    Webhook-types.

    2️⃣ Create a webhook endpoint as an HTTP endpoint on your local server.

    3️⃣ Handle requests from Ondato.

    4️⃣ Deploy your webhook endpoint to make it publicly accessible via an HTTPS URL.

    5️⃣ Contact the Ondato support team to register the publicly accessible HTTPS URL and provide a list of events you would like to monitor.

    Please note that we also support multiple URLs for sending webhooks.


    😶‍🌫️ Requirements for webhook endpoint

    Ondato needs to know where to send information about events. To receive webhooks, you must create a webhook endpoint and provide us with a publicly accessible HTTPS URL that meets the following criteria:

    1️⃣ URL format: https://<your-website-name>/<your-webhook-endpoint>

    2️⃣ URL must support

    Status
    colourGreen
    titlePOST
    HTTP method.

    3️⃣ URL must be secure (HTTPS protocol).

    4️⃣ URL must support one of the available authentication flows:

    • basic | username, password

    • oAuth2 | clientID, clientSecret, tokenUrl

    • HMAC | client-side verification


    🔑 Handling webhook events with HMAC Authentication

    Info

    To begin receiving webhook events with HMAC Authentication, you need to first obtain your secret from Ondato.

    🐾 HMAC webhook verification steps:

    1️⃣ In a web request, you would receive the Ondato-Signature header.

    • Request header example:

      • Ondato-Signature: t=1712825621, s=7026783cfd8b88a2652f23e789f1ec7de02b7c6ef8362892fe743fead4bab71d

    2️⃣ Parse the value t from the header - timestamp

    • For a given example:

      • 1712825621

    3️⃣ Get the received body/json string - json

    Note

    The request body must be the raw body string, not a parsed or stringified version, as it may contain escaped characters (e.g., \u0027 vs. ').

    • .NET: Use ReadAsStringAsync()

    • Node.js: Use body.text()

    • Other environments: Ensure you retrieve the raw body string before processing.

    4️⃣ Join to a single string $"{timestamp}.{json}" - message

    Info

    Joining to a single string may vary depending on your programming environment.

    5️⃣ Using secret, compute HMACSHA256 hash (lower case) for message - computedHash

    6️⃣ Parse the value s from the header - signature

    • For a given example:

      • 7026783cfd8b88a2652f23e789f1ec7de02b7c6ef8362892fe743fead4bab71d

    7️⃣ Compare the computedHash with the signature - they should match.


    Panel
    panelIconId1f3af
    panelIcon:dart:
    panelIconText🎯
    bgColor#F4F5F7

    Events sent by Ondato will have a body in the following structure:

    Property

    Description

    Id

    Webhook ID

    ApplicationId

    Internal ID to identify you in the Ondato system.

    CreatedUtc

    Date and time when the webhook was generated.

    DeliveredUtc

    Date and time when the webhook was delivered.

    Panel
    panelIconIdatlassian-info
    panelIcon:info:
    bgColor#F4F5F7

    This property is only visible via Webhooks API and is not sent with the body of the Webhook itself.

    IsDelivered

    Status of the webhook if it was delivered or not. Possible values are true/ false.

    Panel
    panelIconIdatlassian-info
    panelIcon:info:
    bgColor#F4F5F7

    This property is only visible via Webhooks API and is not sent with the body of the Webhook itself.

    Payload

    Depending on the webhook type property, the payload always returns the same information you could obtain from the

    Status
    colourBlue
    titleget
    endpoint of the resource.

    For example, the webhook type is KycIdentification.<event>, and then the payload will contain information that you can retrieve from the KYC ID endpoint

    Status
    colourBlue
    titleget
    /identifications/{id}.

    Information about each event payload is here.

    Type

    Type of the webhook. It consists of two parts (the first part identifies the service and the second one, the event):


    🪄 Webhook types

    Info

    You have the option to configure various webhook types that can trigger a message to registered webhooks.

    🆔 Identity Verification (IDV) webhooks

    1️⃣ IdentityVerification.StatusChanged

    Panel
    panelIconIdatlassian-light_bulb_on
    panelIcon:light_bulb_on:
    panelIconText:light_bulb_on:
    bgColor#E6FCFF
    • The webhook is triggered when the identity verification (IDV) status changes.

    • For this webhook type, the payload body depends on the IDV API

      Status
      colourBlue
      titleget
      /v1/identity-verifications/{id} contract.

    • You can call IDV API by using "id" →

      Status
      colourBlue
      titleget
      /v1/identity-verifications/{id} to retrieve the information about the user session.


    Expand
    titleReference from the Webhook payload
    Code Block
    languagejson
    {
        "payload": {
            "id": "03be8be3-fbd5-4496-b552-bcd3e4918116"
            }
       "forms": [],
      }
    }

    Expand
    titleWebhook example
    Code Block
    languagejson
    {
        "id": "7a21b0e2-580e-4d2d-8578-00fc32a753ad",
        "consentapplicationId": {"44575362-e08e-4f75-b399-00d9d8916552",
                    "isConsented"createdUtc": true"2023-01-31T07:25:55.6073016Z",
           "payload": {
            "consentedUtcid": "2023-01-31T07:22:25.08Z"03be8be3-fbd5-4496-b552-bcd3e4918116",
            "status": "Completed",
      }      "applicationId": "44575362-e08e-4f75-b399-00d9d8916552",
     }     },     "typecreatedUtc": "IdentityVerification.StatusChanged"
    }

    2️⃣ IdentityVerification.Consented

    1️⃣ KycIdentification.Created

    Panel
    panelIconIdatlassian-light_bulb_on
    panelIcon:light_bulb_on:
    panelIconText:light_bulb_on:
    bgColor#E6FCFF
    • The webhook is triggered when the consent step has been processed.

    • For this webhook type, the payload body depends on the IDV API

      Status
      colourGreen
      titleGET
      /v1/identifications/{id} contract.

    • In the webhook payload, you receive the "id" as a reference to the Consents API.

    • You can call Consents API by using “id” →

      Status
      colourGreen
      titleGET
      /v1/consents/{id} to retrieve the information about the consent session.

    Expand
    titleReference from the Webhook payload
    Code Block
    languagejson
    {
      "payload": {2023-01-31T07:22:11.313Z",
            "modifiedUtc": "2023-01-31T07:25:55.595Z",
            "setup": {
                "stepid": {"5f16990b-d00a-4ff2-8102-e7b8d5820c28",
          "consent": {         "idversionId": "6c14b20760e8a778-f73f1885-4a854162-9e38bd58-bbfb5ca62858d8b07bddba2e"
            },
        }    }
    }
    Expand
    titleWebhook example
    Code Block
    languagejson
    "step": {
        "id": "e4df532d-a448-43b2-a875-031475695cf2",         "applicationIdkycIdentification": "a2af2fd1-60aa-4549-ab2e-e6294385af62",
        "createdUtc": "2023-02-21T07:47:06.196653Z",{
          "payload": {         "id": "6c14b2076df0d302-f73ff0bb-4a85441a-9e38804c-bbfb5ca628585b114b476fc0",
      
         "status": "InProgress",      },
      "applicationId": "a2af2fd1-60aa-4549-ab2e-e6294385af62",         "createdUtcdocumentSignatures": "2023-02-21T07:46:57.862Z",[],
                "modifiedUtcforms": "2023-02-21T07:47:06.14Z"[],
                "setupconsent": {
                 "id": "27820208-e4d0-4841-bacf-93e6e709637b",
                "versionId"isConsented": "7cd83758-bc5f-4aa0-97cc-d7f3fa177dca"
    true,
           },         "stepconsentedUtc": {
                "documentSignatures": [],
                "forms": [],"2023-01-31T07:22:25.08Z"
                }
    "consent": {        }
            "isConsented": true,
    },
                   "consentedUtc"type": "2023-02-21T07:47:06.14Z"
                }
            }
        },
        "type": "IdentityVerification.Consented"
    }
    Note

    Following fields can be ignored (are depreciated):

    • "consentedUtc"

    • "isConsented"

    👤 KYC Identification webhooks

    IdentityVerification.StatusChanged"
    }

    2️⃣ IdentityVerification.Consented

    Panel
    panelIconIdatlassian-light_bulb_on
    panelIcon:light_bulb_on:
    panelIconText:light_bulb_on:
    bgColor#E6FCFF
    • The webhook is triggered when the KYC identification step is initiated by the customerconsent step has been processed.

    • For this webhook type, the payload body depends on the KYC ID IDV API

      Status
      colourGreenBlue
      titleGETget
      /v1/identificationsidentity-verifications/{id} contract.

    • In the webhook payload, you receive the "id" as a reference to the Consents API.

    • You can call KYC ID Consents API by using “id” →

      Status
      colourGreenBlue
      titleGETget
      /v1/identificationsconsents/{id} to retrieve the information about the user consent session.


    Expand
    titleReference from the Webhook payload
    Code Block
    languagejson
    {
        "payload": {
            "id": "7175fc816c14b207-8ac1f73f-418a4a85-b2e4-89d0e8894442"9e38-bbfb5ca62858"
            "step": {
                "consent": {
                }
            }
        }
    }

    Expand
    titleWebhook example
    Code Block
    languagejson
    {
        "id": "e4e148dee4df532d-8fd1a448-4e6443b2-9173a875-00374ed139d2031475695cf2",
        "applicationId": "8c7218bda2af2fd1-939460aa-46034549-b8baab2e-1ccea0b5e8d7e6294385af62",
        "createdUtc": "2023-0102-10T1221T07:1647:5306.4746293Z196653Z",
        "payload": {
            "id": "7175fc816c14b207-8ac1f73f-418a4a85-b2e49e38-89d0e8894442bbfb5ca62858",
            "applicationIdstatus": "8c7218bd-9394-4603-b8ba-1ccea0b5e8d7InProgress",
            "createdUtcapplicationId": "2023-01-10T12:16:53.319Za2af2fd1-60aa-4549-ab2e-e6294385af62",
            "setupcreatedUtc": {
    "2023-02-21T07:46:57.862Z",
            "modifiedUtc": "2023-02-21T07:47:06.14Z",
            "setup": {
                "id": "12d8478b27820208-0174e4d0-49e94841-b3e6bacf-45f9063ba0d293e6e709637b",
                "versionId": "03a5ec177cd83758-18afbc5f-4e884aa0-8a3597cc-1f8ebdec2d3ad7f3fa177dca"
            },
            "identityVerificationIdstep": "ef9379b3-652d-44ee-b4c9-8da7a682ce40", {
                "statusdocumentSignatures": "Awaiting",[],
                "statusReasonforms": "Unfinished",[],
                "isCrossCheckedconsent": false{
               },     "typeisConsented": "KycIdentification.Created"
    }
    2️⃣ KycIdentification.Processed
    true,
                    "consentedUtc": "2023-02-21T07:47:06.14Z"
                }
            }
        },
        "type": "IdentityVerification.Consented"
    }

    Note

    Following fields can be ignored (are depreciated):

    • "isConsented"

    • "consentedUtc"


    👤 KYC Identification webhooks

    1️⃣ KycIdentification.Created

    Panel
    panelIconIdatlassian-light_bulb_on
    panelIcon:light_bulb_on:
    panelIconText:light_bulb_on:
    bgColor#E6FCFF
    • The webhook is triggered when the KYC identification step is completed initiated by the customer.

    • For this webhook type, the payload body depends on the KYC ID API

      Status
      colourGreenBlue
      titleGETget
      /v1/identifications/{id} contract.

    • You can call KYC ID API by using “id” →

      Status
      colourGreenBlue
      titleGETget
      /v1/identifications/{id} to retrieve the information about the user session.


    Expand
    titleReference from the Webhook payload
    { "id": "25aa5e86-dd51-4a23-870d-0015e7d98227", "applicationId": "8921c61b-a5c0-4f1f-9d44-5a83009a29b1", "createdUtc": "2023-02-20T13:24:32.4234105Z", "payload":
    Code Block
    Code Block
    languagejson
    languagejson
    {
      "payload": {
        "id": "c9fc134b-0386-4e4f-940e-f1349b9d3d64"
        }
    }
    Expand
    titleWebhook example
    json
    {
        "payload": {
            "id": "7175fc81-8ac1-418a-b2e4-89d0e8894442"
        }
    }

    Expand
    titleWebhook example
    Code Block
    languagejson
    {
        "id": "e4e148de-8fd1-4e64-9173-00374ed139d2",
        "applicationId": "8c7218bd-9394-4603-b8ba-1ccea0b5e8d7",
        "createdUtc": "2023-01-10T12:16:53.4746293Z",
        "payload": {
            "id": "7175fc81-8ac1-418a-b2e4-89d0e8894442",
            "applicationId": "8c7218bd-9394-4603-b8ba-1ccea0b5e8d7",
            "createdUtc": "2023-01-10T12:16:53.319Z",
            "setup": {
                "id": "12d8478b-0174-49e9-b3e6-45f9063ba0d2",
                "versionId": "03a5ec17-18af-4e88-8a35-1f8ebdec2d3a"
            },
            "identityVerificationId": "ef9379b3-652d-44ee-b4c9-8da7a682ce40",
            "status": "Awaiting",
            "statusReason": "Unfinished",
            "isCrossChecked": false
        },
        "type": "KycIdentification.Created"
    }

    2️⃣ KycIdentification.Processed

    Panel
    panelIconIdatlassian-light_bulb_on
    panelIcon:light_bulb_on:
    panelIconText:light_bulb_on:
    bgColor#E6FCFF
    • The webhook is triggered when the KYC identification is completed by the customer.

    • For this webhook type, the payload body depends on the KYC ID API

      Status
      colourBlue
      titleget
      /v1/identifications/{id} contract.

    • You can call KYC ID API by using “id” →

      Status
      colourBlue
      titleget
      /v1/identifications/{id} to retrieve the information about the user session.


    Expand
    titleReference from the Webhook payload
    Code Block
    languagejson
    {
        "payload": {
            "id": "c9fc134b-0386-4e4f-940e-f1349b9d3d64"
        }
    }

    Expand
    titleWebhook example
    Code Block
    languagejson
    {
        "id": "25aa5e86-dd51-4a23-870d-0015e7d98227",
        "applicationId": "8921c61b-a5c0-4f1f-9d44-5a83009a29b1",
        "createdUtc": "2023-02-20T13:24:32.4234105Z",
        "payload": {
            "id": "c9fc134b-0386-4e4f-940e-f1349b9d3d64",
            "applicationId": "8921c61b-a5c0-4f1f-9d44-5a83009a29b1",
            "createdUtc": "2023-02-20T13:24:23.938Z",
            "setup": {
                "id": "d4915b8c-f4a7-4e94-a2c3-16c68a1aee78",
                "versionId": "f3135842-d53c-4525-8118-be63a12641ba"
            },
            "identityVerificationId": "7b4032ff-3a4a-4846-abf3-b1ffa9afbe26",
            "status": "Awaiting",
            "statusReason": "Processing",
            "isCrossChecked": false,
            "document": {
                "type": "IdCard",
                "mrzVerified": false,
                "files": [
                    {
                        "createdUtc": "2023-02-20T13:24:26Z",
                        "fileId": "1d712a49-bcb4-47eb-ba33-0652dcebad2f",
                        "fileName": "c9fc134b03864e4f940ef1349b9d3d64_front_132425267.jpeg",
                        "fileExtension": "jpeg",
                        "part": "Front",
                        "fileType": "DocumentPhoto"
                    }
                ],
                "ocrValidations": [
                    {
                        "key": "Address",
                        "isValid": false
                    },
                    {
            "id": "c9fc134b-0386-4e4f-940e-f1349b9d3d64",            "applicationIdkey": "8921c61b-a5c0-4f1f-9d44-5a83009a29b1Category",
            "createdUtc": "2023-02-20T13:24:23.938Z",            "setupisValid": {true
                   "id": "d4915b8c-f4a7-4e94-a2c3-16c68a1aee78" },
                "versionId": "f3135842-d53c-4525-8118-be63a12641ba"    {
               },         "identityVerificationIdkey": "7b4032ff-3a4a-4846-abf3-b1ffa9afbe26DateOfBirth",
            "status": "Awaiting",            "statusReasonisValid": "Processing",false
                   "isCrossChecked": false},
             "document": {      {
          "type": "IdCard",             "mrzVerifiedkey": false,"DateOfExpiration",
                   "files": [    "isValid": false
               {     },
                   "createdUtc": "2023-02-20T13:24:26Z", {
                        "fileIdkey": "1d712a49-bcb4-47eb-ba33-0652dcebad2fDateOfIssue",
                        "fileNameisValid": "c9fc134b03864e4f940ef1349b9d3d64_front_132425267.jpeg",false
                        "fileExtension": "jpeg"},
                        "part": "Front",{
                        "fileTypekey": "DocumentPhotoDocumentNumber",
                    }    "isValid": false
           ],             "ocrValidations": [},
                    {
                        "key": "AddressFirstName",
                        "isValid": false
                    },
                    {
                        "key": "CategoryLastName",
                        "isValid": truefalse
                    },
                    {
                        "key": "DateOfBirthGender",
                        "isValid": false
                    },
                    {
                        "key": "DateOfExpirationNationality",
                        "isValid": false
                    },
                    {
                        "key": "DateOfIssuePersonalCode",
                        "isValid": false
                    }
                ]
            },
            "rules": [
            {    {
                    "keyname": "DocumentNumberDocumentNotExpired",
                    "status": "Fail",
                    "isValidreason": "DocumentExpirationDateNotFound"
      false          },
          },      {
                 {   "name": "DocumentHasFace",
                    "keystatus": "FirstNameFail",
                    "reason": "DocumentHasNoFace"
        "isValid": false       },
             },   {
                 {   "name": "DocumentHasBothSides",
                    "keystatus": "LastNameFail",
                    "reason": "DocumentPartTypeNotRecognized"
          "isValid": false     },
               }, {
                   { "name": "DocumentTypeNotProhibited",
                      "keystatus": "GenderSuccess",
                },
             "isValid": false  {
                  },  "name": "NotUnder18",
                 {   "status": "Fail",
                    "keyreason": "NationalityBirthDateNotFound",
                },
             "isValid": false  {
                  },  "name": "NotProhibitedByCountryOrState",
                 {   "status": "Fail",
                    "keyreason": "PersonalCode",DocumentCountryOrStateUnknown"
                }
            ],
        "isValid": false   "registries": [],
            "fraudChecks": [],
      }      "completedUtc": "2023-02-20T13:24:32Z"
        },
    ]    "type":     },
    "KycIdentification.Processed"
    }

    3️⃣ KycIdentification.Approved

    Panel
    panelIconIdatlassian-light_bulb_on
    panelIcon:light_bulb_on:
    panelIconText:light_bulb_on:
    bgColor#E6FCFF
    • The webhook is triggered when the KYC identification is manually or automatically approved.

    • For this webhook type, the payload body depends on the KYC ID API

      Status
      colourBlue
      titleget
      /v1/identifications/{id} contract.

    • You can call KYC ID API by using “id” →

      Status
      colourBlue
      titleget
      /v1/identifications/{id} to retrieve the information about the user session.


    Expand
    titleReference from the Webhook payload
    Code Block
    languagejson
    {
           "rulespayload": [
                {
                    "name": "DocumentNotExpired",
                    "status": "Fail",
                    "reason": "DocumentExpirationDateNotFound"
                },
          "id": "4c0000ac-f116-4dec-93ba-493f3809ca9b"
        }
    }

    Expand
    titleWebhook example
    Code Block
    languagejson
    {
        "id": "00b6c3c8-8219-4206-a4ab-04554c97fa1a",
        "applicationId": "00cabb1f-4d7c-41d9-9a97-55482d920160",
        "namecreatedUtc": "DocumentHasFace2023-01-16T23:40:52.4886646Z",
           "payload": {
            "statusid": "Fail4c0000ac-f116-4dec-93ba-493f3809ca9b",
            "applicationId": "00cabb1f-4d7c-41d9-9a97-55482d920160",
            "reasoncreatedUtc": "DocumentHasNoFace"2023-01-16T23:40:42.77Z",
            "setup": {
      },             {
     "id": "04b803f3-6c62-4560-bf5f-9ef75397ce1d",
                  "nameversionId": "DocumentHasBothSides",fde54820-00ec-4da0-87fa-c70f81729b0e"
            },
            "statusidentityVerificationId": "Faild1a76177-00d5-494e-bbba-557527501a0e",
            "status": "Approved",
            "reasonstatusReason": "DocumentPartTypeNotRecognizedAutomaticallyIdentified",
            "isCrossChecked": false,
      },
          "document": {
               { "fullName": "NAME MIDDLE SURNAME",
                "namefirstName": "DocumentTypeNotProhibitedNAME MIDDLE",
                    "statuslastName": "SuccessSURNAME",
                }"documentNumber": "1740931767",
                {
     "dateOfIssue": "2018-12-03",
                  "namedateOfExpiration": "NotUnder182023-12-01",
                    "statusdateOfBirth": "Fail",
     1985-02-27",
                  "reasonpersonalCode": "BirthDateNotFound"000.000.000-17",
                }"countryIso3": "BRA",
                {
       "type": "DriverLicense",
                "namemrzVerified": "NotProhibitedByCountryOrState",
       true,
                "statuscategory": "FailB",
                "files": [
      "reason": "DocumentCountryOrStateUnknown"              {
      }         ],         "registriescreatedUtc": []"2023-01-16T23:40:43Z",
            "fraudChecks": [],            "completedUtcfileId": "2023-02-20T13:24:32Z"e2ec5e00-0000-40f3-9e1c-c7a435d1fe2f",
        },      "type": "KycIdentification.Processed"
    }

    3️⃣ KycIdentification.Approved

    Panel
    panelIconIdatlassian-light_bulb_on
    panelIcon:light_bulb_on:
    panelIconText:light_bulb_on:
    bgColor#E6FCFF
    • The webhook is triggered when KYC identification is manually or automatically approved.

    • For this webhook type, the payload body depends on the KYC ID API

      Status
      colourGreen
      titleGET
      /v1/identifications/{id} contract.

    • You can call KYC ID API by using “id” →

      Status
      colourGreen
      titleGET
      /v1/identifications/{id} to retrieve the information about the user session.

    Expand
    titleReference from the Webhook payload
    Code Block
    languagejson
    {
      "payload": {
        "id": "7175fc81-8ac1-418a-b2e4-89d0e8894442"         "fileName": "4c4811acf1164dec93ba493f3809ca9b_front_234040000.jpeg",
                  } }
    Expand
    titleWebhook example
    Code Block
    languagejson
    {     "idfileExtension": "00b6c3c8-8219-4206-a4ab-04554c97fa1a",jpeg",
                        "applicationIdpart": "00cabb1f-4d7c-41d9-9a97-55482d920160Front",
          "createdUtc              "fileType": "2023-01-16T23:40:52.4886646Z",DocumentPhoto"
                    },
           "payload": {        {
    "id": "4c0000ac-f116-4dec-93ba-493f3809ca9b",         "applicationId": "00cabb1f-4d7c-41d9-9a97-55482d920160",         "createdUtc": "2023-01-16T23:40:42.77Z43Z",
            "setup": {             "idfileId": "04b803f3717e98b1-6c6200a-45600000-bf5fab51-9ef75397ce1d655b8cf0bb2d",
                "versionId        "fileName": "fde54820-00ec-4da0-87fa-c70f81729b0e"4c4811acf1164dec93ba493f3809ca9b_back_234043541.jpeg",
            },            "identityVerificationIdfileExtension": "d1a76177-00d5-494e-bbba-557527501a0ejpeg",
                 "status       "part": "ApprovedBack",
            "statusReason": "AutomaticallyIdentified",            "isCrossCheckedfileType": false,"DocumentPhoto"
               "document": {    }
            "fullName": "NAME MIDDLE SURNAME"    ],
                "firstNameocrValidations": "NAME[
    MIDDLE",             "lastName": "SURNAME",      {
          "documentNumber": "1740931767",             "dateOfIssuekey": "2018-12-03Address",
                 "dateOfExpiration       "isValid": "2023-12-01",true
                "dateOfBirth": "1985-02-27",   },
             "personalCode": "000.000.000-17",      {
          "countryIso3": "BRA",             "typekey": "DriverLicenseCategory",
                "mrzVerified": true,       "isValid": true
        "category": "B",             "files": [},
                    {
                        "createdUtckey": "2023-01-16T23:40:43ZDateOfBirth",
                        "fileIdisValid": "e2ec5e00-0000-40f3-9e1c-c7a435d1fe2f",true
                        "fileName": "4c4811acf1164dec93ba493f3809ca9b_front_234040000.jpeg"},
                    {
       "fileExtension": "jpeg",                     "partkey": "FrontDateOfExpiration",
                        "fileTypeisValid": "DocumentPhoto"true
                    },
                    {
                        "createdUtckey": "2023-01-16T23:40:43ZDateOfIssue",
                        "fileIdisValid": "717e98b1-00a-0000-ab51-655b8cf0bb2d",true
                    },
                    {
        "fileName                "key": "4c4811acf1164dec93ba493f3809ca9b_back_234043541.jpeg"DocumentNumber",
                        "fileExtensionisValid": "jpeg", true
                    },
                   "part": "Back", {
                        "fileTypekey": "DocumentPhotoFirstName",
                    }    "isValid": true
           ],         },
       "ocrValidations": [                 {
                        "key": "AddressLastName",
                        "isValid": true
                    },
                    {
                        "key": "CategoryGender",
                        "isValid": true
                    },
                    {
                        "key": "DateOfBirthNationality",
                        "isValid": true
                    },
                    {
                        "key": "DateOfExpirationPersonalCode",
                        "isValid": true
                    },
                ]
         {   },
            "rules": [
           "key": "DateOfIssue",    {
                    "isValidname": true"DocumentHasBothSides",
                    "status": "Success"
        },        },
            {    {
                    "keyname": "DocumentNumberDocumentNotExpired",
                        "isValidstatus": true"Success"
                    },
           
            {    {
                    "keyname": "FirstNameDocumentHasFace",
       
                    "isValidstatus": true
    "Success"
                   },
                    {
     
                      "keyname": "LastNameDocumentTypeNotProhibited",
                    "status": "Success"
        "isValid": true       },
             },   {
                 {   "name": "NotUnder18",
                    "keystatus": "Gender",Success"
                }
            ],
            "isValidregistries": true[],
            "fraudChecks": [
          },      {
              {      "name": "DocumentManipulation",
                    "keystatus": "NationalitySuccess",
                }
           "isValid": true ],
            "completedUtc": "2023-01-16T23:40:51Z"
        },
           },
                    {
                        "key": "PersonalCode","type": "KycIdentification.Approved"
    }

    4️⃣ KycIdentification.Updated

    Panel
    panelIconIdatlassian-light_bulb_on
    panelIcon:light_bulb_on:
    panelIconText:light_bulb_on:
    bgColor#E6FCFF
    • The webhook is triggered when data of KYC Identification is updated.

    • For this webhook type, the payload body depends on the KYC ID API

      Status
      colourBlue
      titleget
      /v1/identifications/{id} contract.

    • You can call KYC ID API by using “id” →

      Status
      colourBlue
      titleget
      /v1/identifications/{id} to retrieve the information about the user session.


    Expand
    titleReference from the Webhook payload
    Code Block
    languagejson
    {
        "payload": {
                        "isValid": true
                    }
                ]
            },
            "rules": [
       "id": "9655ae23-7be6-4df4-98e4-df43a58f9620"
            }
    }

    Expand
    titleWebhook example
    Code Block
    languagejson
    {
        "id": "a59c2055-7655-43bb-923d-0005928301d7",
        "applicationId": "8921c61b-a5c0-4f1f-9d44-5a83009a29b1",
        "namecreatedUtc": "DocumentHasBothSides2023-02-16T14:46:33.1467591Z",
        "payload": {
              "statusid": "Success"9655ae23-7be6-4df4-98e4-df43a58f9620",
            "applicationId": "8921c61b-a5c0-4f1f-9d44-5a83009a29b1",
      },      "createdUtc": "2023-02-16T14:43:40.503Z",
         {   "setup": {
                "nameid": "DocumentNotExpired""d4915b8c-f4a7-4e94-a2c3-16c68a1aee78",
                    "statusversionId": "Successf3135842-d53c-4525-8118-be63a12641ba"
                },
            "identityVerificationId": "67c8dad4-b8ea-40aa-bced-7cdfb1e3199f",
      {      "status": "Rejected",
             "namestatusReason": "DocumentHasFaceUnrelatedPhotoSubmit",
            "isCrossChecked": true,
            "statusdocument": {
    "Success"             }"type": "DriverLicense",
                {
    "mrzVerified": true,
                "files": [
     "name": "DocumentTypeNotProhibited",               {
        "status": "Success"             },  "createdUtc": "2023-02-16T14:43:42Z",
             {           "fileId": "25afc22e-9f87-4466-afb4-e1609141798a",
        "name": "NotUnder18",                 "statusfileName": "Success"9655ae237be64df498e4df43a58f9620_front_144342156.png",
                }         ],"fileExtension": "png",
              "registries": [],         "fraudCheckspart": ["Front",
                {        "fileType": "DocumentPhoto"
           "name": "DocumentManipulation",            }
        "status": "Success"       ],
         }       "ocrValidations": [
    ],         "completedUtc": "2023-01-16T23:40:51Z"     }, {
       "type": "KycIdentification.Approved"
    }

    4️⃣ KycIdentification.Updated

    Panel
    panelIconIdatlassian-light_bulb_on
    panelIcon:light_bulb_on:
    panelIconText:light_bulb_on:
    bgColor#E6FCFF
    • A webhook is triggered when the document data of KYC Identification is updated in the Ondato Portal.

    • For this webhook type, the payload body depends on the KYC ID API

      Status
      colourGreen
      titleGET
      /v1/identifications/{id} contract.

    • You can call KYC ID API by using “id” →

      Status
      colourGreen
      titleGET
      /v1/identifications/{id} to retrieve the information about the user session.

    Expand
    titleReference from the Webhook payload
    Code Block
    languagejson
    {
      "payload": {                "key": "Address",
                        "isValid": false
                    },
                    {
                        "idkey": "9655ae23-7be6-4df4-98e4-df43a58f9620"Category",
        }
    }
    Expand
    titleWebhook example
    Code Block
    languagejson
    {                "idisValid": "a59c2055-7655-43bb-923d-0005928301d7",false
                   "applicationId": "8921c61b-a5c0-4f1f-9d44-5a83009a29b1" },
        "createdUtc": "2023-02-16T14:46:33.1467591Z",           "payload": {
            "id": "9655ae23-7be6-4df4-98e4-df43a58f9620",            "applicationIdkey": "8921c61b-a5c0-4f1f-9d44-5a83009a29b1DateOfBirth",
             "createdUtc": "2023-02-16T14:43:40.503Z",           "setupisValid": false
      {             "id": "d4915b8c-f4a7-4e94-a2c3-16c68a1aee78" },
                "versionId": "f3135842-d53c-4525-8118-be63a12641ba"    {
               },         "identityVerificationIdkey": "67c8dad4-b8ea-40aa-bced-7cdfb1e3199fDateOfExpiration",
            "status": "Rejected",            "statusReasonisValid": "UnrelatedPhotoSubmit", false
                   "isCrossChecked": true},
            "document":  {      {
          "type": "DriverLicense",             "mrzVerifiedkey": true"DateOfIssue",
                  "files":  [    "isValid": false
               {     },
                   "createdUtc": "2023-02-16T14:43:42Z", {
                        "fileIdkey": "25afc22e-9f87-4466-afb4-e1609141798aDocumentNumber",
                        "fileNameisValid": "9655ae237be64df498e4df43a58f9620_front_144342156.png",false
                        "fileExtension": "png",     },
                   "part": "Front", {
                        "fileTypekey": "DocumentPhotoFirstName",
                    }    "isValid": false
           ],             "ocrValidations": [},
                     {
                        "key": "AddressLastName",
                        "isValid": false
                    },
                    {
                        "key": "CategoryGender",
                        "isValid": false
                    },
                    {
                        "key": "DateOfBirthNationality",
                        "isValid": falsetrue
                    },
                    {
                        "key": "DateOfExpirationPersonalCode",
                        "isValid": false
                    }
                ]
            },
            "rules": [
            {    {
                    "keyname": "DateOfIssueDocumentNotExpired",
                    "status": "Fail",
                    "isValidreason": false "DocumentExpirationDateNotFound"
                },
            },    {
                {    "name": "DocumentHasFace",
                    "keystatus": "DocumentNumberFail",
                    "reason": "DocumentHasNoFace"
       "isValid": false        },
            },    {
                {    "name": "DocumentHasBothSides",
                    "keystatus": "FirstNameFail",
       
                    "isValidreason": false
      "DocumentPartTypeNotRecognized"
                 },
                    {
     
                      "keyname": "LastNameDocumentTypeNotProhibited",
                    "status": "Success"
        "isValid": false       },
             },   {
                 {   "name": "NotUnder18",
                    "keystatus": "GenderFail",
                        "isValidreason": false
       "BirthDateNotFound"
                },
     
                  {
                        "keyname": "NationalityNotProhibitedByCountryOrState",
                        "isValidstatus": true"Fail",
                    },
         "reason": "DocumentCountryOrStateUnknown"
              {  }
            ],
             "keyregistries": "PersonalCode"[],
            "fraudChecks": [],
              "isValidcompletedUtc": false"2023-02-16T14:43:47Z"
        },
        "type":       }
                ]
            },
     "KycIdentification.Updated"
    }

    5️⃣ KycIdentification.Rejected

    Panel
    panelIconIdatlassian-light_bulb_on
    panelIcon:light_bulb_on:
    panelIconText:light_bulb_on:
    bgColor#E6FCFF
    • The webhook is triggered when the KYC identification is manually or automatically rejected.

    • For this webhook type, the payload body depends on the KYC ID API

      Status
      colourBlue
      titleget
      /v1/identifications/{id} contract.

    • You can call KYC ID API by using “id” →

      Status
      colourBlue
      titleget
      /v1/identifications/{id} to retrieve the information about the user session.


    Expand
    titleReference from the Webhook payload
    Code Block
    languagejson
    {
          "rulespayload": [
                {
    
                   "name"id": "DocumentNotExpired",832f67ab-0f6f-4a57-bfc2-83abb543bbd0"
               }
    }

    Expand
    titleWebhook example
    Code Block
    languagejson
    {
        "statusid": "Fail15df07d7-4b54-4674-9dd5-00354e6cd1a9",
        "applicationId": "8921c61b-a5c0-4f1f-9d44-5a83009a29b1",
              "reason"createdUtc": "DocumentExpirationDateNotFound"
                }2023-02-15T15:10:07.6788678Z",
        "payload": {
          {  "id": "832f67ab-0f6f-4a57-bfc2-83abb543bbd0",
                 "nameapplicationId": "DocumentHasFace8921c61b-a5c0-4f1f-9d44-5a83009a29b1",
        
               "statuscreatedUtc": "Fail",
          2023-02-15T15:09:57.944Z",
             "reasonsetup": "DocumentHasNoFace"{
                 },"id": "d4915b8c-f4a7-4e94-a2c3-16c68a1aee78",
                 {"versionId": "f3135842-d53c-4525-8118-be63a12641ba"
            },
            "nameidentityVerificationId": "DocumentHasBothSides0458600b-f373-404d-8603-9fcc5c8d5d23",
                    "status": "FailRejected",
       
                "reasonstatusReason": "DocumentPartTypeNotRecognizedUnrelatedPhotoSubmit",
                }"isCrossChecked": true,
                "document": {
                    "nametype": "DocumentTypeNotProhibitedPassport",
                "mrzVerified": true,
       "status": "Success"        "files": [
       },             {
                        "namecreatedUtc": "NotUnder182023-02-15T15:09:59Z",
                        "statusfileId": "Faildf72c1a0-cb92-43d5-9c32-f15ead7a6c83",
                        "reasonfileName": "BirthDateNotFound"832f67ab0f6f4a57bfc283abb543bbd0_front_150958998.png",
                },        "fileExtension": "png",
       {                 "namepart": "NotProhibitedByCountryOrStateFrontCover",
                        "statusfileType": "FailDocumentPhoto",
                    "reason": "DocumentCountryOrStateUnknown"}
                 }
     ],
          ],         "registriesocrValidations": [],
            "fraudChecks": [],       {
     "completedUtc": "2023-02-16T14:43:47Z"     },     "type": "KycIdentification.Updated"
    }

    5️⃣ KycIdentification.Rejected

    Panel
    panelIconIdatlassian-light_bulb_on
    panelIcon:light_bulb_on:
    panelIconText:light_bulb_on:
    bgColor#E6FCFF
    • A webhook is triggered when a KYC identification is manually or automatically rejected.

    • For this webhook type, the payload body depends on the KYC ID API

      Status
      colourGreen
      titleGET
      /v1/identifications/{id} contract.

    • You can call KYC ID API by using “id” →

      Status
      colourGreen
      titleGET
      /v1/identifications/{id} to retrieve the information about the user session.

    Expand
    titleReference from the Webhook payload
    Code Block
    languagejson
    {
      "payload": {
        "id": "832f67ab-0f6f-4a57-bfc2-83abb543bbd0"       "key": "Address",
                        "isValid": true
                    }
    }
    Expand
    titleWebhook example
    Code Block
    languagejson
    {,
             "id": "15df07d7-4b54-4674-9dd5-00354e6cd1a9",     "applicationId": "8921c61b-a5c0-4f1f-9d44-5a83009a29b1", {
        "createdUtc": "2023-02-15T15:10:07.6788678Z",     "payload": {         "idkey": "832f67ab-0f6f-4a57-bfc2-83abb543bbd0Category",
            "applicationId": "8921c61b-a5c0-4f1f-9d44-5a83009a29b1",            "createdUtcisValid": "2023-02-15T15:09:57.944Z",true
            "setup": {        },
        "id": "d4915b8c-f4a7-4e94-a2c3-16c68a1aee78",           {
     "versionId": "f3135842-d53c-4525-8118-be63a12641ba"         },         "identityVerificationIdkey": "0458600b-f373-404d-8603-9fcc5c8d5d23DateOfBirth",
              "status": "Rejected",         "statusReasonisValid": "UnrelatedPhotoSubmit",false
                   "isCrossChecked": true},
            "document":  {      {
          "type": "Passport",             "mrzVerifiedkey": true"DateOfExpiration",
                "files": [        "isValid": false
                {    },
                    "createdUtc": "2023-02-15T15:09:59Z",{
                         "fileIdkey": "df72c1a0-cb92-43d5-9c32-f15ead7a6c83DateOfIssue",
                        "fileNameisValid": "832f67ab0f6f4a57bfc283abb543bbd0_front_150958998.png",false
                        "fileExtension": "png"},
                        "part": "FrontCover",{
                        "fileTypekey": "DocumentPhotoDocumentNumber",
                    }    "isValid": false
           ],         },
       "ocrValidations": [
                    {
                        "key": "AddressFirstName",
                        "isValid": truefalse
                    },
                    {
                        "key": "CategoryLastName",
                        "isValid": truefalse
                    },
                    {
                        "key": "DateOfBirthGender",
                        "isValid": false
                    },
                    {
                        "key": "DateOfExpirationNationality",
                        "isValid": false
                    },
                    {
                        "key": "DateOfIssuePersonalCode",
                        "isValid": false
                    }
       "isValid": false        ]
            },
            "rules": [
            {    {
                    "keyname": "DocumentNumberDocumentNotExpired",
                    "status": "Fail",
        "isValid": false           "reason": "DocumentExpirationDateNotFound"
        },        },
            {    {
                    "keyname": "FirstNameDocumentHasFace",
                    "status": "Fail",
       "isValid":  false           "reason": "DocumentHasNoFace"
        },        },
            {    {
                    "keyname": "LastNameDocumentHasBothSides",
                    "status": "Fail",
      "isValid": false              "reason": "DocumentPartTypeNotRecognized"
        },        },
            {    {
                    "keyname": "GenderDocumentTypeNotProhibited",
                    "status": "Success"
      "isValid": false          },
             },   {
                 {   "name": "NotUnder18",
                    "keystatus": "NationalityFail",
     
                      "isValidreason": false"BirthDateNotFound"
                    },
                    {
                        "keyname": "PersonalCodeNotProhibitedByCountryOrState",
                        "isValid": false"status": "Fail",
                     }"reason": "DocumentCountryOrStateUnknown"
                ]}
            }],
            "rulesregistries": [],
            "fraudChecks": [],
       {     "completedUtc": "2023-02-15T15:10:02Z"
        },
         "name": "DocumentNotExpired",
                    "status": "Fail",
           "type": "KycIdentification.Rejected"
    }

    🏢 KYB identification webhooks

    1️⃣ KybIdentification.Created

    Panel
    panelIconIdatlassian-light_bulb_on
    panelIcon:light_bulb_on:
    panelIconText:light_bulb_on:
    bgColor#E6FCFF
    • The webhook is triggered when the customer has completed filling out the business onboarding form.

    • For this webhook type, the payload body depends on the KYB ID API

      Status
      colourBlue
      titleget
      /v1/identifications/{id} contract.

    • You can call KYB ID API by using “id” →

      Status
      colourBlue
      titleget
      /v1/identifications/{id} to retrieve the information about the user session.


    Expand
    titleReference from the Webhook payload
    Code Block
    languagejson
    {
        "payload": {
            "reasonid": "DocumentExpirationDateNotFoundd91b5007-4af7-4980-8c48-b9658826673e"
        }
    }

    Expand
    titleWebhook example
    Code Block
    languagejson
    {
          }"id": "019346d0-770c-47a5-b693-049a79d19c51",
        "applicationId": "0068a566-b5d2-46f1-b5c3-22fdf895953a",
        "createdUtc":  {"2023-01-02T14:08:01.4572198Z",
        "payload": {
               "nameid": "DocumentHasFaced91b5007-4af7-4980-8c48-b9658826673e",
       
                "statuscreatedUtc": "Fail2023-01-02T14:08:01.02",
            "setup": [],
             "reasonapplicationId": "DocumentHasNoFace"0068a566-b5d2-46f1-b5c3-22fdf895953a",
            "legalEntity": {
      },          "name": "Test company {SmartId 2",
                   "namecode": "DocumentHasBothSides401038386",
            },
            "statusverificationFormId": "Faila632cc2d-2717-4183-bee0-1efe1c868904",
            "identityVerificationId": "00000000-0000-0000-0000-000000000000",
            "reasonrepresentatives": "DocumentPartTypeNotRecognized"[
                },"37cab687-a53c-4228-a1ad-d3cac0bcaac7",
                "28e92146-d3e3-443c-8d4e-50471481cbfe"
            ],
    {        "status": "Pending",
            "namelastStatusChangedUtc": "DocumentTypeNotProhibited",2023-01-02T14:08:01.02"
             },
          "statustype": "Success"
                },
                {
                    "name": "NotUnder18",
                    "status": "Fail",
                    "reason": "BirthDateNotFound"
                },
                {
                    "name": "NotProhibitedByCountryOrStateKybIdentification.Created"
    }

    2️⃣ KybIdentification.Approved

    Panel
    panelIconIdatlassian-light_bulb_on
    panelIcon:light_bulb_on:
    panelIconText:light_bulb_on:
    bgColor#E6FCFF
    • The webhook is triggered when all KYC identifications have been approved and all registry checks have been successfully validated.

    • For this webhook type, the payload body depends on the KYB ID API

      Status
      colourBlue
      titleget
      /v1/identifications/{id} contract.

    • You can call KYB ID API by using “id” →

      Status
      colourBlue
      titleget
      /v1/identifications/{id} to retrieve the information about the user session.


    Expand
    titleReference from the Webhook payload
    Code Block
    languagejson
    {
        "payload": {
            "id": "dc81eb25-8ccb-4ea9-9dde-c8b46e2f12d1"
        }
    }

    Expand
    titleWebhook example
    Code Block
    languagejson
    {
        "id": "54ec3990-4bfb-40d2-84c1-080ba15be61f",
        "applicationId": "5d2567dc-1e4e-44bc-a651-7f330a80bd23",
        "createdUtc": "2022-12-14T16:38:01.6026518Z",
        "payload": {
              "statusid": "Faildc81eb25-8ccb-4ea9-9dde-c8b46e2f12d1",
            "createdUtc": "2022-12-13T15:55:45.983",
            "reasonsetup": "DocumentCountryOrStateUnknown"{
                }
        "id": null,
       ],         "registriesversionId": [],null
            "fraudChecks": []},
            "completedUtcapplicationId": "2023-02-15T15:10:02Z"
        }5d2567dc-1e4e-44bc-a651-7f330a80bd23",
        "type": "KycIdentification.Rejected"
    }

    🏢 KYB identification webhooks

    1️⃣ KybIdentification.Created

    Panel
    panelIconIdatlassian-light_bulb_on
    panelIcon:light_bulb_on:
    panelIconText:light_bulb_on:
    bgColor#E6FCFF
    • The webhook is triggered when the customer has completed filling out the business onboarding form.

    • For this webhook type, the payload body depends on the KYB ID API

      Status
      colourGreen
      titleGET
      /v1/identifications/{id} contract.

    • You can call KYB ID API by using “id” →

      Status
      colourGreen
      titleGET
      /v1/identifications/{id} to retrieve the information about the user session.

    Expand
    titleReference from the Webhook payload
    Code Block
    languagejson
    {
      "payload": {   "legalEntity": {
                "name": "\u041e\u041e\u041e\u041e\u041e\u041e\u041e",
                "code": "\u041e\u041e\u041e\u041e\u041e\u041e\u041e"
            },
            "verificationFormId": null,
            "identityVerificationId": "a586a568-b464-420f-a7b3-368f2f208b33",
            "idrepresentatives": [
                "aea305f5-6123-4f1f-a266-535955e2584d",
     "7175fc81-8ac1-418a-b2e4-89d0e8894442"
               "e118640c-7e5d-471d-83e7-8cfc43504a03"
            ],
            "status": "Approved",
            "statusReason": null,
       } }
    Expand
    titleWebhook example
    Code Block
    languagejson
    {     "idstatusDescription": "019346d0-770c-47a5-b693-049a79d19c51"null,
            "applicationIdlastStatusChangedUtc": "0068a5662022-b5d2-46f1-b5c3-22fdf895953a"12-14T16:38:01.53"
        },
        "createdUtctype": "2023-01-02T14:08:01.4572198Z",
        "payload": {
            "id": "d91b5007-4af7-4980-8c48-b9658826673e",
            "createdUtc": "2023-01-02T14:08:01.02",
            "setup": [],"KybIdentification.Approved"
    }

    3️⃣ KybIdentification.Rejected

    Panel
    panelIconIdatlassian-light_bulb_on
    panelIcon:light_bulb_on:
    panelIconText:light_bulb_on:
    bgColor#E6FCFF
    • The webhook is triggered when not all KYC identifications have been approved and/or when not all registries have been successfully validated.

    • For this webhook type, the payload body depends on the KYB ID API

      Status
      colourBlue
      titleget
      /v1/identifications/{id} contract.

    • You can call KYB ID API by using “id” →

      Status
      colourBlue
      titleget
      /v1/identifications/{id} to retrieve the information about the user session.


    Expand
    titleReference from the Webhook payload
    Code Block
    languagejson
    {
        "payload": {
            "applicationIdid": "0068a566dc81eb25-b5d28ccb-46f14ea9-b5c39dde-22fdf895953ac8b46e2f12d1",
        }
    }

    Expand
    titleWebhook example
    Code Block
    languagejson
    {
        "legalEntityid": {
       "cbc8f716-425e-4519-990a-584023f9c880",
            "nameapplicationId": "Test company SmartId 2",
       5d2567dc-1e4e-44bc-a651-7f330a80bd23",
            "codecreatedUtc": "401038386"2022-12-14T16:23:50.0805263Z",
        "payload": {
      },         "verificationFormIdid": "a632cc2ddc81eb25-27178ccb-41834ea9-bee09dde-1efe1c868904c8b46e2f12d1",
            "identityVerificationIdcreatedUtc": "000000002022-0000-0000-0000-00000000000012-13T15:55:45.983",
            "representativessetup": [{
                "37cab687-a53c-4228-a1ad-d3cac0bcaac7"id": null,
                "28e92146-d3e3-443c-8d4e-50471481cbfe"
    versionId": null
           ] },
            "statusapplicationId": "Pending5d2567dc-1e4e-44bc-a651-7f330a80bd23",
            "lastStatusChangedUtclegalEntity": {
           "2023-01-02T14:08:01.02"     "name": "\u041e\u041e\u041e\u041e\u041e\u041e\u041e",
         },       "code": "\u041e\u041e\u041e\u041e\u041e\u041e\u041e"
        "type": "KybIdentification.Created"
    }

    2️⃣ KybIdentification.Approved

    Panel
    panelIconIdatlassian-light_bulb_on
    panelIcon:light_bulb_on:
    panelIconText:light_bulb_on:
    bgColor#E6FCFF
    • The webhook is triggered when all KYC identifications have been approved and all registry checks have been successfully validated.

    • For this webhook type, the payload body depends on the KYB ID API

      Status
      colourGreen
      titleGET
      /v1/identifications/{id} contract.

    • You can call KYB ID API by using “id” →

      Status
      colourGreen
      titleGET
      /v1/identifications/{id} to retrieve the information about the user session.

    Expand
    titleReference from the Webhook payload
    Code Block
    languagejson
    {
      "payload": {    },
            "verificationFormId": null,
            "ididentityVerificationId": "dc81eb25a586a568-8ccbb464-4ea9420f-9dde-c8b46e2f12d1"a7b3-368f2f208b33",
            "representatives": [
          } }
    Expand
    titleWebhook example
    Code Block
    languagejson
    {     "id": "54ec3990-4bfb-40d2-84c1-080ba15be61f"aea305f5-6123-4f1f-a266-535955e2584d",
                "e118640c-7e5d-471d-83e7-8cfc43504a03"
            ],
            "applicationIdstatus": "5d2567dc-1e4e-44bc-a651-7f330a80bd23Rejected",
            "createdUtcstatusReason": "2022-12-14T16:38:01.6026518ZDataNotMatch",
            "payloadstatusDescription": {null,
            "idlastStatusChangedUtc": "dc81eb252022-8ccb-4ea9-9dde-c8b46e2f12d1",12-14T16:23:50.033"
        },
         "createdUtc": "2022-12-13T15:55:45.983",
            "setup": {
                "id": null,
       "type": "KybIdentification.Rejected"
    }

    4️⃣ KybIdentification.Document.Created

    Panel
    panelIconIdatlassian-light_bulb_on
    panelIcon:light_bulb_on:
    panelIconText:light_bulb_on:
    bgColor#E6FCFF
    • The webhook is triggered when a KYB-related document entity is created in the KYB identification with the status "NeedReview."

    • For this webhook type, the payload body depends on the KYB ID API

      Status
      colourBlue
      titleget
      /v1/documents/{id} contract.

    • You can call KYB ID API by using “id” →

      Status
      colourBlue
      titleget
      /v1/documents/{id} to retrieve the information about the user session.


    Expand
    titleReference from the Webhook payload
    Code Block
    languagejson
    {
        "payload": {
            "versionIdid": null"701ded06-f832-45f3-9a66-4378d0ba55ed"
        }
    }

    Expand
    titleWebhook example
    Code Block
    languagejson
    {
      },  "id": "696ec22d-304a-412a-b719-6eeca663e5fe",
         "applicationId": "5d2567dc-1e4e-44bc-a651-7f330a80bd23",
            "legalEntitycreatedUtc": {
                "name": "\u041e\u041e\u041e\u041e\u041e\u041e\u041e",
    "2022-12-12T10:12:59.4204Z",
               "code": "\u041e\u041e\u041e\u041e\u041e\u041e\u041e"
            },"payload": {
             "verificationFormIdid": null"701ded06-f832-45f3-9a66-4378d0ba55ed",
            "identityVerificationIdapplicationId": "a586a5685d2567dc-b4641e4e-420f44bc-a7b3a651-368f2f208b337f330a80bd23",
            "representativesidentificationId": ["eccae495-46fb-4f2c-9eba-863f5f407fb0",
                "aea305f5-6123-4f1f-a266-535955e2584d"createdUtc": "2022-12-12T10:12:59.4121043Z",
                "e118640c-7e5d-471d-83e7-8cfc43504a03""lastActionUtc": "2022-12-12T10:12:59.4121045Z",
            ]"lastStatusChangedUtc": null,
            "statusfileId": "Approved"null,
            "statusReasonstatus": null"NeedReview",
            "statusDescriptionpurpose": null"ExternalRegistry",
            "lastStatusChangedUtctitle": "2022-12-14T16:38:01.53SkyNet.pdf"
        },
        "type": "KybIdentification.ApprovedDocument.Created"
    }

    3️⃣

    5️⃣ KybIdentification.Document.

    Rejected

    Uploaded

    Panel
    panelIconIdatlassian-light_bulb_on
    panelIcon:light_bulb_on:
    panelIconText:light_bulb_on:
    bgColor#E6FCFF
    • The webhook is triggered when not all KYC identifications have been approved and/or when not all registries have been successfully validateda KYB-related document file is uploaded to the document entity.

    • For this webhook type, the payload body depends on the KYB ID API

      Status
      colourGreenBlue
      titleGETget
      /v1/identificationsdocuments/{id} contract.

    • You can call KYB ID API by using “id” →

      Status
      colourGreen
      titleGET
      /v1/identifications/{id} to retrieve the information about the user session.

    Expand
    titleReference from the Webhook payload
    Code Block
    languagejson
    { "payload": {
    • .

    • You can call KYB ID API by using “id” →

      Status
      colourBlue
      titleget
      /v1/documents/{id} to retrieve the information about the user session.


    Expand
    titleReference from the Webhook payload
    Code Block
    languagejson
    {
        "payload": {
            "id": "dd8e3b9e-bece-4b79-8c0d-e74412c19067"
        }
    }

    Expand
    titleWebhook example
    Code Block
    languagejson
    {
        "id": "5d9a674a-1d28-45f1-a7fd-cfe920bbdf21",
        "applicationId": "5d2567dc-1e4e-44bc-a651-7f330a80bd23",
        "createdUtc": "2022-12-12T12:59:33.146706Z",
        "payload": {
            "id": "dd8e3b9e-bece-4b79-8c0d-e74412c19067",
            "applicationId": "5d2567dc-1e4e-44bc-a651-7f330a80bd23",
            "identificationId": "85edabe9-3902-483a-9533-f5d48a842d42",
            "idcreatedUtc": "dc81eb252022-8ccb-4ea9-9dde-c8b46e2f12d1"12-12T12:59:32.303",
            "lastActionUtc": "2022-12-12T12:59:33.123",
         }
    }
    Expand
    titleWebhook example
    Code Block
    languagejson
    {   "lastStatusChangedUtc": null,
            "idfileId": "cbc8f716-425e-4519-990a-584023f9c880kybid-29b125e08eb8410ea9234de3371f665a",
            "applicationIdstatus": "5d2567dc-1e4e-44bc-a651-7f330a80bd23NeedReview",
            "createdUtcpurpose": "2022-12-14T16:23:50.0805263ZExternalRegistry",
            "payloadtitle": {"SkyNet.pdf"
        },
        "idtype": "dc81eb25-8ccb-4ea9-9dde-c8b46e2f12d1",
            "createdUtc": "2022-12-13T15:55:45.983",
            "setup": {
                "id": null,"KybIdentification.Document.Uploaded"
    }

    6️⃣ KybIdentification.Document.Updated

    Panel
    panelIconIdatlassian-light_bulb_on
    panelIcon:light_bulb_on:
    panelIconText:light_bulb_on:
    bgColor#E6FCFF
    • The webhook is triggered when a KYB-related document is verified, and the status changes from "NeedReview" to "Validated" or "Invalidated".

    • For this webhook type, the payload body depends on the KYB ID API

      Status
      colourBlue
      titleget
      /v1/documents/{id} contract.

    • You can call KYB ID API by using “id” →

      Status
      colourBlue
      titleget
      /v1/documents/{id} to retrieve the information about the user session.


    Expand
    titleReference from the Webhook payload
    Code Block
    languagejson
    {
        "payload": {
                "versionIdid": null"ef0dbfa6-5533-4463-a4a8-493aeff7d942"
        }
    }

    Expand
    titleWebhook example
    Code Block
    languagejson
    {
      },    "id": "21e2e190-bc8b-43ef-914f-3c8ab630d2fa",
        "applicationId": "5d2567dc-1e4e-44bc-a651-7f330a80bd23",
       
        "legalEntitycreatedUtc": {
                "name": "\u041e\u041e\u041e\u041e\u041e\u041e\u041e",
                "code": "\u041e\u041e\u041e\u041e\u041e\u041e\u041e""2022-12-13T09:46:15.6314497Z",
        "payload": {
      },
            "verificationFormIdid": null"ef0dbfa6-5533-4463-a4a8-493aeff7d942",
            "identityVerificationIdapplicationId": "a586a5685d2567dc-b4641e4e-420f44bc-a7b3a651-368f2f208b337f330a80bd23",
            "representativesidentificationId": ["53953073-3acb-4062-bb34-e2830b01d86d",
               "createdUtc": "aea305f52022-6123-4f1f-a266-535955e2584d12-11T09:49:49.35",
                "e118640c-7e5d-471d-83e7-8cfc43504a03""lastActionUtc": "2022-12-13T09:46:15.58",
            ]"lastStatusChangedUtc": "2022-12-13T09:46:15.577",
            "statusfileId": "Rejectedkybid-f1126a9b929d4bd2ba1249058140eb52",
            "statusReasonstatus": "DataNotMatchInvalidated",
            "statusDescriptionpurpose": null"ExternalRegistry",
            "lastStatusChangedUtctitle": "2022-12-14T16:23:50.033backend (19).txt"
        },
        "type": "KybIdentification.RejectedDocument.Updated"
    }

    4️⃣

    7️⃣ KybIdentification.Document.

    Created

    Deleted

    Panel
    panelIconIdatlassian-light_bulb_on
    panelIcon:light_bulb_on:
    panelIconText:light_bulb_on:
    bgColor#E6FCFF
    • A The webhook is triggered when a KYB-related document entity is created in the deleted from KYB identification with the status "NeedReview."

    • For this webhook type, the payload body depends on the KYB ID API

      Status
      colourGreenBlue
      titleGETget
      /v1/documents/{id} contract.

    • You can call KYB ID API by using “id” →

      Status
      colourGreenBlue
      titleGETget
      /v1/documents/{id} to retrieve the information about the user session.


    Expand
    titleReference from the Webhook payload
    Code Block
    languagejson
    {
        "payload": {
            "id": "701ded06-f832-45f3-9a66-4378d0ba55ed"
        }
    }

    Expand
    titleWebhook example
    Code Block
    languagejson
    {
        "id": "696ec22d29cbf14a-304a9baf-412a40a1-b719ba05-6eeca663e5fee9cf0ed8dee7",
        "applicationId": "5d2567dc-1e4e-44bc-a651-7f330a80bd23",
        "createdUtc": "2022-12-12T10:1215:5908.4204Z4286841Z",
        "payload": {
            "id": "701ded06-f832-45f3-9a66-4378d0ba55ed",
            "applicationId": "5d2567dc-1e4e-44bc-a651-7f330a80bd23",
            "identificationId": "eccae495-46fb-4f2c-9eba-863f5f407fb0",
            "createdUtc": "2022-12-12T10:12:59.4121043Z413",
            "lastActionUtc": "2022-12-12T10:1213:5900.4121045Z57",
            "lastStatusChangedUtc": null,
            "fileId": null"kybid-2aa9a9c735894ecdabd1451471a604aa",
            "status": "NeedReview",
            "purpose": "ExternalRegistry",
            "title": "SkyNet.pdf"
        },
        "type": "KybIdentification.Document.CreatedDeleted"
    }
    5️⃣ KybIdentification.Document.Uploaded

    🧾 Form webhooks

    Info

    The Form webhook events outlined below will provide details on the progress of form steps, excluding form values.

    1️⃣ Form.Created

    Panel
    panelIconIdatlassian-light_bulb_on
    panelIcon:light_bulb_on:
    panelIconText:light_bulb_on:
    bgColor#E6FCFF
    • A The webhook is triggered when a KYB-related document file is uploaded to the document entitythe customer has started filling out the form.

    • For this webhook type, the payload body depends on the KYB ID Forms API

      Status
      colourGreenBlue
      titleGETget
      /v1/documentsforms/{id} contract.

    • You can call KYB ID Forms API by using “id” →

      Status
      colourGreenBlue
      titleGETget
      /v1/documentsforms/{id} to retrieve the information about the user session.

    Expand
    titleReference from the Webhook payload
    Code Block
    languagejson
    {
    • .


    Expand
    titleReference from the Webhook payload
    Code Block
    languagejson
    {
        "payload": {
            "id": "2c6a8441-fc31-47ad-95e6-c77c82b6ec95"
        }
    }

    Expand
    titleWebhook example
    Code Block
    languagejson
    {
      "applicationId": "cf7f1581-25bd-47cb-b2d2-19e099477a7f",
      "createdUtc": "2024-07-09T06:36:32.5324435",
      "id": "b23d9af4-9215-4308-97e5-60dba19d355f",
      "payload": {
        "id": "dd8e3b9e-bece-4b79-8c0d-e74412c19067""2c6a8441-fc31-47ad-95e6-c77c82b6ec95",
        "applicationId": "cf7f1581-25bd-47cb-b2d2-19e099477a7f",
        "status": "Unfinished",
        }
    }
    Expand
    titleWebhook example
    Code Block
    languagejson
    {"createdUtc": "2024-07-09T06:36:32.4558188Z",
        "ididentityVerificationId": "5d9a674ac006aa3c-1d28deba-45f14054-a7fdb92f-cfe920bbdf210bee3964c30c",
        "applicationIdsetupId": "5d2567dc8c9040b1-1e4e87b1-44bc4376-a651af07-7f330a80bd2372d24ee0b148",
        "createdUtcsetupVersionId": "2022-12-12T12:59:33.146706Z7ff2cd5a-7135-4c96-90fc-cb1ca0783def",
        "payloadstepProgress": [
          {
            "idisCompleted": "dd8e3b9e-bece-4b79-8c0d-e74412c19067" false,
            "order": 0,
            "applicationIdref": "5d2567dc-1e4e-44bc-a651-7f330a80bd23",generalInformation"
          },
          {
            "identificationIdisCompleted": "85edabe9-3902-483a-9533-f5d48a842d42"false,
            "createdUtcorder": "2022-12-12T12:59:32.303"1,
            "lastActionUtcref": "2022-12-12T12:59:33.123",representativeInformation"
          },
         "lastStatusChangedUtc": null, {
            "fileIdisCompleted": "kybid-29b125e08eb8410ea9234de3371f665a"false,
            "statusorder": "NeedReview"2,
            "purposeref": "ExternalRegistrymajorShareholder",
          }
     "title": "SkyNet.pdf"  ]
      },
     
      "type": "KybIdentificationForm.Document.UploadedCreated"
    }

    6️⃣ KybIdentification

    2️⃣ Form.

    Document.

    Updated

    Panel
    panelIconIdatlassian-light_bulb_on
    panelIcon:light_bulb_on:
    panelIconText:light_bulb_on:
    bgColor#E6FCFF
    • Webhook is triggered when a KYB-related document is verified, and the status changes from "NeedReview" to "Validated" or "Invalidated"The webhook is triggered every time the customer updates the form data.

    • For this webhook type, the payload body depends on the KYB ID Forms API

      Status
      colourGreenBlue
      titleGETget
      /v1/documentsforms/{id} contract.

    • You can call KYB ID Forms API by using “id” →

      Status
      colourGreenBlue
      titleGETget
      /v1/documents/{id} to retrieve the information about the user session.forms/{id} to retrieve the information about the user session.


    Expand
    titleReference from the Webhook payload
    Code Block
    languagejson
    {
        "payload": {
            "id": "2c6a8441-fc31-47ad-95e6-c77c82b6ec95"
        }
    }

    Expand
    titleReference from the Webhook payloadexample
    Code Block
    languagejson
    {{
      "applicationId": "cf7f1581-25bd-47cb-b2d2-19e099477a7f",
      "createdUtc": "2024-07-09T06:37:03.4974234",
      "id": "b2b9f203-d95b-4ccc-ac76-8b186ce4fa25",
      "payload": {
        "id": "2c6a8441-fc31-47ad-95e6-c77c82b6ec95",
        "payloadapplicationId": {"cf7f1581-25bd-47cb-b2d2-19e099477a7f",
        "idstatus": "ef0dbfa6-5533-4463-a4a8-493aeff7d942"Unfinished",
        }
    }
    Expand
    titleWebhook example
    Code Block
    languagejson
    {
    {"createdUtc": "2024-07-09T06:36:32.455Z",
        "ididentityVerificationId": "21e2e190c006aa3c-bc8bdeba-43ef4054-914fb92f-3c8ab630d2fa0bee3964c30c",
        "applicationIdsetupId": "5d2567dc8c9040b1-1e4e87b1-44bc4376-a651af07-7f330a80bd2372d24ee0b148",
        "createdUtcsetupVersionId": "2022-12-13T09:46:15.6314497Z7ff2cd5a-7135-4c96-90fc-cb1ca0783def",
        "payloadstepProgress": [
          {
            "idisCompleted": "ef0dbfa6-5533-4463-a4a8-493aeff7d942"true,
            "order": 0,
            "applicationIdref": "5d2567dc-1e4e-44bc-a651-7f330a80bd23",generalInformation"
          },
          {
      "identificationId      "isCompleted": "53953073-3acb-4062-bb34-e2830b01d86d"false,
            "createdUtcorder": "2022-12-11T09:49:49.35"1,
            "lastActionUtcref": "2022-12-13T09:46:15.58",representativeInformation"
          },
       "lastStatusChangedUtc": "2022-12-13T09:46:15.577",   {
            "fileIdisCompleted": "kybid-f1126a9b929d4bd2ba1249058140eb52"false,
            "statusorder": "Invalidated"2,
            "purposeref": "ExternalRegistrymajorShareholder",
          }
     "title": "backend (19).txt"
      ]
      },
     
      "type": "KybIdentificationForm.Document.Updated"
    }

    7️⃣ KybIdentification.Document.Deleted

    3️⃣ Form.Completed

    Panel
    panelIconIdatlassian-light_bulb_on
    panelIcon:light_bulb_on:
    panelIconText:light_bulb_on:
    bgColor#E6FCFF
    • A The webhook is triggered when a KYB-related document is deleted from KYB identificationthe customer has finished filling out all steps of the form and submits it on the review step.

    Code Block
    languagejson
    { "payload": {
    • For this webhook type, the payload body depends on the KYB ID Forms API

      Status
      colourGreenBlue
      titleGETget
      /v1/documentsforms/{id} contract.

    • You can call KYB ID Forms API by using “id” →

      Status
      colourGreen
      titleGET
      /v1/documents/{id} to retrieve the information about the user session.

    Expand
    titleReference from the Webhook payload
    • colourBlue
      titleget
      /v1/forms/{id} to retrieve the information about the user session.


    Expand
    titleReference from the Webhook payload
    Code Block
    languagejson
    {
        "payload": {
            "id": "2c6a8441-fc31-47ad-95e6-c77c82b6ec95"
        }
    }

    Expand
    titleWebhook example
    Code Block
    languagejson
    {
      "applicationId": "cf7f1581-25bd-47cb-b2d2-19e099477a7f",
      "createdUtc": "2024-07-09T06:37:21.5027871",
      "id": "cb48242f-4eba-4fcc-99c0-cb326a2f1530",
      "payload": {
        "id": "2c6a8441-fc31-47ad-95e6-c77c82b6ec95",
        "applicationId": "cf7f1581-25bd-47cb-b2d2-19e099477a7f",
        "status": "Completed",
        "idcreatedUtc": "701ded062024-f832-45f3-9a66-4378d0ba55ed"07-09T06:36:32.455Z",
        }
    }
    Expand
    titleWebhook example
    Code Block
    languagejson
    {"identityVerificationId": "c006aa3c-deba-4054-b92f-0bee3964c30c",
        "idsetupId": "29cbf14a8c9040b1-9baf87b1-40a14376-ba05af07-e9cf0ed8dee772d24ee0b148",
        "applicationIdsetupVersionId": "5d2567dc7ff2cd5a-1e4e7135-44bc4c96-a65190fc-7f330a80bd23cb1ca0783def",
        "createdUtcstepProgress": [
          {
     "2022-12-12T10:15:08.4286841Z",       "isCompleted": true,
            "payloadorder": {0,
            "idref": "701ded06-f832-45f3-9a66-4378d0ba55ed",generalInformation"
          },
         "applicationId": "5d2567dc-1e4e-44bc-a651-7f330a80bd23", {
            "identificationIdisCompleted": "eccae495-46fb-4f2c-9eba-863f5f407fb0"true,
            "createdUtcorder": "2022-12-12T10:12:59.413"1,
            "lastActionUtcref": "2022-12-12T10:13:00.57",representativeInformation"
          },
     "lastStatusChangedUtc": null,     {
            "fileIdisCompleted": "kybid-2aa9a9c735894ecdabd1451471a604aa"true,
            "statusorder": "NeedReview"2,
            "purposeref": "ExternalRegistrymajorShareholder",
          }
     "title": "SkyNet.pdf"  ]
      },
        "type": "KybIdentificationForm.Document.DeletedCompleted"
    }