Learn more about how to get started with the Vecurity Public API.

📘

Important Information

In order to use the Vecurity API - you will need to be authenticated to utilise any of the endpoints that we provide.

We authenticate you based on your API token - which we will now refer to as an Auth Token.

Prerequisites

Please note, in order to utilise this API - you will need an Auth Token.

  1. You will need an account with Vecurity.
  2. You must have a verified email address.
  3. Your account must not be disabled, terminated or deleted in any way.
  4. You accept the Vecurity terms of service which may be subject to change.

Things to note

  1. We do not accept reverse engineering, decryption or attempts to flood or degrade performance of the Vecurity Infrastructure.
  2. You must abide by the rate limits that we have in place to ensure fair use and support the stability of our architecture. If you would like custom rate limits, you may be able to reach out to the team.
  3. Additions or reductions to our endpoints will be rolled out alongside notifications to all consumers of the application.
  4. We're open to new requests - you can always reach out, and let us know if you'd like to see anything new introduced to our Public API.

Getting your first Auth Token

Upon signing up to Vecurity - we automatically generate you an auth_token that can be utilised from the moment you verify your email address.

This will be visible in the Vecurity Dashboard.