Authentication

Reporting API Keys

If you’ve generated reporting API keys you can authenticate your requests to reporting and notifications endpoints on the base URL ​​https://api.vault.ledger.com using the below headers:

• Header parameter name: X-Ledger-Workspace

  • Set the header value to the name of your workspace

• Header parameter name: X-Ledger-Reporting-API-Key

  • Set the header value to the reporting API Key you wish to use

API Operators

If you’ve registered API operators, you can authenticate the requests to all endpoints exposed by the container running your LAM, using the below headers:

Ledger_API_User (required)

• Username of a registered API User

• Header parameter name: X-Ledger-API-User

Ledger_API_Key

• If you've set up your API Key when initializing your LAM, you'll need to include it as a header along with the api user header. For more details, see step 5 of the get started documentation.

• Header parameter name: X-Ledger-API-Key

Ledger_Store_Auth_Token

• If you've set up HashiCorp Vault as an authentication service, you'll need to pass the X-Ledger-Store-Auth-Token header along with the API user header. For more details see how to set up HashiCorp Vault with the LAM.

• Header parameter name: X-Ledger-Store-Auth-Token

Reporting & Notifications

Use our reporting endpoints to query and export transactions (transfers, DeFi & NFT, staking), accounts (balances, addresses, governance, etc.), users, and all workspace objects (whitelists, groups, entities).

Set notifications to catch workspace events (incoming or outgoing transactions, accounts, progress in governance schemes, changes to workspace objects) and automate your workflows.

You can generate reporting API keys to access our reporting and notifications endpoints.

Transactions

Use our transaction endpoints to perform programmatic crypto transfers, automate your staking operations or interact with DeFi & NFT contracts at scale.

You can create and register API operators for that purpose, and assign them transaction creation or approval roles in accounts’ governance rules (transfer, staking, or smart contract interactions).