API docs

Quickstart

From a paid account to a verification you can watch land, in four steps.

Before you start

You need a paid StackGo plan. The API is not available on trial accounts. Sign in at identity.stackgo.io.

1. Create a user with developer permission

API keys belong to a user, and only a user with the developer permission can mint them.

  1. From the left navigation, select Account.
  2. Select Users.
  3. Click Add user and give them the developer permission.

Give this to a person, not a shared mailbox. Keys are traceable to the user who created them, which is the point.

2. Activate the account

The user receives an email and activates their account. They then sign in and open the API keys section.

3. Send your first request

The key goes in the Authorization header as Basic.

POST https://identity.stackgo.io/api/direct-verification

Authorization: Basic <API_KEY>
Content-Type: application/json

{
  "firstName": "FName",
  "lastName": "LName",
  "email": "user@example.com",
  "emailUser": "Yes",
  "type": "kyc",
  "triggeredBy": "direct",
  "active": true
}

With emailUser set to Yes, the person is emailed an invitation and completes the verification themselves.

4. Watch it land

Progress is visible in the dashboard as the person works through it. For a programmatic result, set up a webhook — verification is asynchronous, so there is nothing useful to return synchronously.

Keeping the key safe

  • Server-side only. A key in browser JavaScript is a key you have published.
  • One key per integration, so you can revoke one without breaking the others.
  • Scopes are frozen when the key is minted. Widening them means a new key.