Skip to main content
The API follows semantic versioning. While in Beta (0.x), any version can change the contract; each entry says what changed and what to do about it.
0.3.0 (Beta)
A resulting token now carries its chain and contract address.
  • New fields. Wherever a corporate action has a resultingTokenId (a stock dividend’s or spin-off’s terms, a merger’s consideration[], an option’s outcome), it is followed by resultingChainId (CAIP-2, for example eip155:196) and resultingContractAddress. They are null together with resultingTokenId when there is no CET yet.
  • Why. GET /tokens/{tokenId} only returns tokens linked to your account, so a resultingTokenId you do not hold answers 404 TOKEN_NOT_FOUND. With the chain and address you read the token’s basic information directly from the chain.
  • What to do. Nothing breaks: ignore the fields or use them. See The resulting token.
0.2.1 (Beta)
Documentation only; the contract does not change.
  • The token request is in the API reference. Get an access token documents POST /oauth2/token and returns a sandbox token to try the other operations with.
0.2.0 (Beta)
The event routes move to their own base URL and cover every webhook family.
  • Breaking in Beta. GET /events, GET /events/{eventId} and POST /events/recover are now served at https://partners-api.sandbox.securitize.io/webhooks/v1 instead of …/corporate-actions/v1. The old path stops answering at the same time; nothing else in the API changes, and the same bearer token works on both base URLs.
  • Why. A partner may point one webhook endpoint at every family Securitize sends (this API’s ca.* events, the SecId API’s investor.kyc.updated, …). Replay and recovery belong to the endpoint, not to one API: the list now returns every family sent to you, GET /events/{eventId} returns any of them, and eventTypes accepts the types of any family. Pass the ca.* types to read only corporate actions.
  • Pages updated: Sandbox and authentication, Replay and recover, Errors and the Events section of the API reference.
0.1.0 (Beta)
First published version, in Beta: the API and its webhooks are in development and subject to change.
  • State queries: GET /assets, GET /assets/{assetId}, GET /assets/{assetId}/status, GET /tokens, GET /tokens/{tokenId}, GET /tokens/{tokenId}/status, GET /tokens/{tokenId}/corporate-actions, GET /corporate-actions/{sourceCaId} and /versions/{version}.
  • Webhooks: the eleven ca.* event types, one envelope, signed under the svix-* headers with the Standard Webhooks scheme.
  • Events: GET /events (90 days, newest first, iterator paging, eventTypes and since filters), GET /events/{eventId}, POST /events/recover.
  • Sandbox: POST /sandbox/events with nine scenarios.
  • Authentication: OAuth 2.0 client credentials at POST /oauth2/token, 2-hour tokens; 20 requests a second and 1,000 a minute per account.
Planned before 1.0.0, each to be announced here first: the webhook signature headers under the webhook-* names of the Standard Webhooks specification, alongside the svix-* names for a transition period; the production base URL.