API reference · Your application

Read your profile

GET/v1/profile

Your 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.

Permissionprofile:read

AuthenticationSigned read

Anis’s answerNot signed

Staff-set limits it counts towardAll requests

.NET SDKanis.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
400	Refused: the signed request is badly built.	Problem
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

The answers of this call are not signed — no Signature or Signature-Input header, success or refusal. There is nothing to verify; TLS protects them. Content-Digest and X-Request-Id are still present.

Refusals

A refusal of this call is a problem without a signature. Branch on its code; each links to what it means and what to do.

Error	Code	Status
Invalid credentials	`invalid_credentials`	401
Malformed signed request	`malformed_signed_request`	400
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
`partner`always present	object	The partner your application belongs to.
`partner.id`always present	UUID	The partner’s id.
`application`always present	object	Your application.
`application.id`always present	UUID	Your application’s id. It stays the same when your keys are replaced.
`application.scopes`always 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.