Skip to main content
WEBHOOK

Authorizations

Authorization
string
header
required

OAuth 2.0 client credentials. Exchange the client id and secret Securitize issued you for a bearer token at the token URL (the host root, not under the base URL), with grant_type=client_credentials; the token lasts 2 hours and goes in the Authorization: Bearer header of every request. No scope is needed. The token identifies your partner account, so you never send a partner id, and every record you create is scoped to you.

Body

application/json

The body of a suitability webhook.

schemaVersion
string
required

The body's own version.

Example:

"1.0"

sourceEventId
string
required

One per verdict change, the same on every retry of it. The deduplication key; not the svix-id header, which is the message id.

Example:

"suit_8c2f4a1e9b7d40c3a6e5f1b2d9c07e4a"

eventType
enum<string>
required
Available options:
investor.suitability.updated
occurredAt
string<date-time>
required

When the verdict changed. Keep the latest per investor.

data
object
required

Response

200

Any 2xx within 10 seconds acknowledges the delivery. Anything else, or no answer, is retried with backoff for up to 72 hours.