Skip to main content

Receiving Real-Time KYC Status Updates via Securitize Webhooks

  • Updated

Integrating real-time KYC updates into your workflow is simple and efficient with Securitize’s Webhook Notification Service. This guide will help you understand how to receive and process investor KYC status updates instantly.

🚀 How It Works

When you activate the webhook service, Securitize will send you notifications automatically whenever an investor’s KYC status is updated.

📨 Webhook Notification Example: 

{
  "domainId": "{domainId}",
  "externalId": "5298922124",
  "eventType": "domain-investor-kyc-update",
  "subscriptionId": "{subscriptionId}",
  "nonce": 1
}

🔍 What the Fields Mean:

  • domainId: Your issuer ID.
  • externalId: The investor’s unique ID whose KYC status was updated.
  • eventType: The event that triggered the webhook. In this case, domain-investor-kyc-update.
  • subscriptionId: Your webhook subscription ID.
  • nonce: The number of times this event has triggered.

👉 Important:
The webhook payload does not include sensitive personal details for privacy and security reasons.

🔎 How to Retrieve the Latest KYC Status

Once you receive the webhook notification, you can retrieve the investor’s latest KYC status by calling this API endpoint:

GET /investors/kyc/status

Example Request: 

curl --location 'https://public-api.{environment}.securitize.io/v1/domains/{domainId}/investors/{externalId}/kyc/status' \
--header 'Authorization: apiKey xxx:yyy'

Example Response: 

{
  "kycStatus": "verified",
  "kycStatusChangingDate": "2023-03-22T20:40:13.000Z",
  "hasReport": true
}

✅ Understanding the Response:

  • kycStatus: The investor’s current KYC status (example: verified).
  • kycStatusChangingDate: The date and time when the KYC status was last updated.
  • hasReport: Indicates if a KYC report is available (internal use).

👉 For more details about possible KYC status values, please refer to this guide:
KYC Status Enum Reference

Related articles