API reference
API reference
Every Trustaige endpoint: what it is for, what it takes and returns, its errors, and the request in curl, JavaScript, Go and Python.
Trustaige's APIs are plain HTTPS and JSON. Each page here covers one endpoint: when to use it, every field it takes and returns, the errors it can answer with and what to do about each, and the request in four languages.
Base URL
Every path is relative to your issuer:
https://id.trustaige.com Authentication
Most endpoints take an access token in the Authorization header. Your app gets one from POST /oauth2/token with the
client-credentials grant, asking for the scopes the endpoint lists. Tokens expire; request a new one when yours does. HumanProof's verify endpoint takes no token.
Errors
A failed request answers with an HTTP status and a JSON body with a message for people and, usually, a code for your code.
Branch on code, never on the message. Each endpoint's page lists its codes and what to do about each.
Pagination
Lists return items, hasMore and, when there is more, a nextPageToken. Pass it back as
next_page_token for the next page, with an optional limit. There are no page numbers or offsets.
Endpoints
HumanProof
Check that a person was present before you accept a form or an action.
Customer credentials
Offer credentials to your customers, read what you issued, and erase a customer who leaves. Your app calls these with a client token for your organization's issuer.
- post Offer a credential /o/{shortId}/api/credentials/offers
- get List subjects /o/{shortId}/api/credentials/subjects
- get Get a subject /o/{shortId}/api/credentials/subjects/{subject}
- delete Erase a subject /o/{shortId}/api/credentials/subjects/{subject}
This reference covers the endpoints the guides use today. It grows to the whole API, generated from the description the hub publishes.