Integrating real-time accreditation updates into your workflow is easy with Securitize’s Webhook Notification Service. This guide will walk you through how to receive and handle Accreditation status updates for investors.
🚀 How It Works
When you activate the webhook service, Securitize will send you real-time notifications whenever an investor’s accreditation status is updated.
📨 Webhook Notification Example:
{
"domainId": "{domainId}",
"externalId": "5298922124",
"eventType": "domain-investor-accreditation-update",
"subscriptionId": "{subscriptionId}",
"nonce": 1
}🔍 What the Fields Mean:
- domainId: Your issuer ID.
- externalId: The investor’s unique ID (the one whose accreditation status has changed).
-
eventType: The event that triggered the notification. In this case, it's
domain-investor-accreditation-update. - subscriptionId: Your webhook subscription ID.
- nonce: The number of times this webhook event has been triggered.
👉 Important:
For privacy and security, the webhook notification does not include sensitive investor details.
🔎 How to Retrieve the Latest Accreditation Status
After you receive the webhook, you can get the investor’s most up-to-date accreditation status by calling this API endpoint:
GET /investors/accreditation/status
Example Request:
curl --location 'https://public-api.{environment}.securitize.io/v1/domains/{domainId}/investors/{externalId}/accreditation/status' \
--header 'Authorization: apiKey xxx:yyy'
Example Response:
{
"accreditationStatus": "not-applicable"
}
✅ Accreditation Status Values
The accreditationStatus field will tell you the investor’s current accreditation status.
👉 For a complete list of all possible accreditation statuses, please refer to this article:
Accreditation Status Enum Guide