API reference · Your application
Read your profile
GET
/v1/profileYour application’s identity, the Anis business account it acts for, and the permissions its current policy grants. Permissions are re-evaluated on every call, so read them rather than caching them.
Permission
profile:readAuthenticationSigned read
Staff-set limits it counts towardAll requests
.NET SDK
anis.Profile.GetAsync()Request
Signed with your key. No body, no nonce.
Headers: Signature-Input, Signature, X-Anis-Date, Accept-Language (optional). The SDKs set all of them for you.
Body: none.
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | Success. | Profile |
| 401 | Refused: not authenticated. | Problem |
| 403 | Refused: not allowed. | Problem |
| 429 | Refused: a limit was reached. | Problem |
| 503 | No decision: a dependency was unavailable. | Problem |
Every answer is signed by Anis; the SDKs check it before you see it.
Refusals
Every refusal is a signed problem. Branch on its code; each links to what it means and what to do.
| Error | Code | Status |
|---|---|---|
| Invalid credentials | invalid_credentials | 401 |
| Insufficient scope | insufficient_scope | 403 |
| Source address not allowed | source_ip_not_allowed | 403 |
| Rate limited | rate_limited | 429 |
| Account not authorised | binding_not_authorized | 403 |
| Service unavailable | dependency_unavailable | 503 |
| Request timeout | request_timeout | 504 |
| Internal error | internal_error | 500 |
Types
Profile
| Field | Type | Notes |
|---|---|---|
partneralways present | object | The partner your application belongs to. |
partner.idalways present | UUID | The partner’s id. |
applicationalways present | object | Your application. |
application.idalways present | UUID | Your application’s id. It stays the same when your keys are replaced. |
application.scopesalways present | list of string | The permissions your application has right now. Re-read rather than cache: a change applies to your next call. |
ownerAccount | object | The Anis business account your application acts for, when shown. |
ownerAccount.id | UUID | The business account’s id. |
ownerAccount.displayName | string | The business account’s name. |
documentationVersion | string | The version of this documentation the Anis deployment you called matches. |