These API's are used for the interaction with the Eagle Eye AIR platform when using Wallets. A Wallet is a data container that links multiple other data objects. Wallets are typically accessed through the walletId which is obtained by calling application by looking up from an identity. Each wallet can have one or many identities.

For the avoidance of doubt this specification documents error codes thrown by the application it, does not cover error codes such as 429 to many requests, 503 service unavailable or 504 Gateway timeout.

The API supports standard Keep Alive as passed in through the Connection header (as supported by Google Cloud) and compression through the Accept-Encoding header is supported (gzip and deflate). Other standard HTTP headers maybe supported but not explicitly documented here.

This API is secured by Eagle Eye's standard security mechanic which is a client-id and hash where the hash is generated during the request. All API requests require the X-EES-AUTH-CLIENT-ID and X-EES-AUTH-HASH headers to be correct and valid (for more details see the authorise section) and as such are not directly specified per API definition below.

There are some additional headers supported by the system which are available on all API requests so documented in the table below to keep the specification cleaner

Header	Description
X-EES-TRANSACTION-ID	Unique Reference for the API transaction within the calling company
X-CUSTOM-SUBSYSTEM-ID	Optional header provided by the calling application for EES AIR to identify what was the external Subsystem that made the request, this is passed through in the atomic events and used for clients for their own purposes
X-CUSTOM-KEY	Optional header(s) provided by the calling application to EES AIR. Please note this header name has to follow pattern X-CUSTOM-* and is passed through to the atomic events for clients own purposes

201Created

400Bad Request

401Unauthorized

403Forbidden

404Not Found

409Conflict

415Unsupported Media Type

423Locked

429Too Many Requests

500Server Error