Developers › API reference

Meta API

Who you are, the scopes, the OpenAPI document and long-running jobs.

Objects

  • Me: who the token acts as: a person or a service account, their firm, role, effective privileges, the token's scopes, how it was obtained (grant) and when it expires. Call it first to check a token.
  • Scopes: the list of every scope with its meaning.
  • Job: a long-running operation (test benches, reports, rebalances of more than three accounts). Endpoints marked Asynchronous answer 202 with a job; poll it.
  • The OpenAPI document: the machine-readable description of this API (OpenAPI 3.1), generated from the same registry as this reference. Use it to generate a client.

Job life cycle

queued → running → succeeded | failed. When succeeded, result holds the outcome; when failed, error says why.

JOB=$(curl -s -X POST https://vestoris.com/api/v1/compliance/rules/41/test-bench \
  -H "Authorization: Bearer $VESTORIS_TOKEN" -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" -d '{"days":10}' | jq -r .id)
until [ "$(curl -s https://vestoris.com/api/v1/jobs/$JOB -H "Authorization: Bearer $VESTORIS_TOKEN" | jq -r .status)" != "running" ]; do sleep 2; done

Poll every 1 to 5 seconds.

Endpoints

CallWhat it doesScope
GET/openapi.jsonThis API's OpenAPI 3.1 documentnone
GET/meWho the token acts as: user or service account, firm, role, privileges, scopesany token
GET/scopesEvery scope with its meaningany token
GET/jobs/{id}A long-running operation (202 responses point here)any token