Agora Accounts API is one of 5 APIs that Agora publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Account. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.
This API exposes
3 operations
across 2 paths,
and defines 70 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against a single base URL, https://api.agora.finance.
The identity and technical contract details declared by the specification.
V0AccountsAccountIdPutResponsesContentApplicationJsonSchemaOneOf0NetworksItemsChain
string
Network the wallet is registered on (kebab-case public network id).
V0AccountsAccountIdPutResponsesContentApplicationJsonSchemaOneOf0Kind
string
Discriminator: this is a customer-owned blockchain address.
V0AccountsAccountIdPutResponsesContentApplicationJsonSchemaOneOf0NetworksItems
object
Per-network entitlement state for the wallet.
2 properties
2 required
V0AccountsGetResponsesContentApplicationJsonSchemaDataItemsOneOf0NetworksItems
object
Per-network entitlement state for the wallet.
2 properties
2 required
V0AccountsGetResponsesContentApplicationJsonSchemaDataItemsOneOf0Kind
string
Discriminator: this is a customer-owned blockchain address.
V0AccountsGetResponsesContentApplicationJsonSchemaDataItemsOneOf0NetworksItemsEntitlementsItems
object
2 properties
2 required
V0AccountsPostResponsesContentApplicationJsonSchemaOneOf1Kind
string
Discriminator: this is a customer-owned bank account.
V0AccountsPostResponsesContentApplicationJsonSchemaOneOf0NetworksItemsEntitlementsItems
object
2 properties
2 required
ErrorResponse_400_parameter_invalid
object
4 properties
3 required
ErrorResponse401UnauthorizedContextReason
string
accounts_get_Response_200
object
2 properties
2 required
ErrorResponse_404_account_not_found_not_found
object
3 properties
3 required
V0AccountsPostRequestBodyContentApplicationJsonSchemaOneOf0Kind
string
Discriminator: register a customer-owned blockchain address.
V0AccountsAccountIdPutRequestBodyContentApplicationJsonSchemaEntitlement
string
Entitlement to request. Moves to pendingapproval; granting stays Agora-side.
V0AccountsPostResponsesContentApplicationJsonSchemaOneOf0NetworksItemsEntitlementsItemsType
string
Entitlement type. mint is the mint capability gated by the per-chain compliance scan; instantsettlement is the instant-settlement whitelist; rewards is rewards…
V0AccountsPostRequestBodyContentApplicationJsonSchemaOneOf1Kind
string
Discriminator: register a customer-owned bank account.
V0AccountsAccountIdPutResponsesContentApplicationJsonSchemaOneOf0NetworksItemsEntitlementsItems
object
2 properties
2 required
accounts_create_Response_201
V0AccountsPostResponsesContentApplicationJsonSchemaOneOf0NetworksItemsEntitlementsItemsStatus
string
Entitlement status. pendingapproval is requested and under Agora review; approved is active. conditionallyapproved applies to mint only: the address is usable…
V0AccountsPostResponsesContentApplicationJsonSchemaOneOf0NetworksItemsChain
string
Network the wallet is registered on (kebab-case public network id).
V0AccountsGetResponsesContentApplicationJsonSchemaDataItemsOneOf0NetworksItemsEntitlementsItemsType
string
Entitlement type. mint is the mint capability gated by the per-chain compliance scan; instantsettlement is the instant-settlement whitelist; rewards is rewards…
V0AccountsAccountIdPutRequestBodyContentApplicationJsonSchemaNetwork
string
V0AccountsPostResponsesContentApplicationJsonSchemaOneOf0Kind
string
Discriminator: this is a customer-owned blockchain address.
ErrorResponse500InternalErrorCode
string
AccountsCreateRequest0
object
4 properties
3 required
V0AccountsAccountIdPutRequestBodyContentApplicationJsonSchemaOperation
string
V0AccountsPostResponsesContentApplicationJsonSchemaOneOf0AddressFormat
string
Address syntax family. ethereum covers every EVM chain (Ethereum, Base, Polygon, Arbitrum, etc.); per-chain authorization is enforced separately via the accoun…
V0AccountsGetResponsesContentApplicationJsonSchemaDataItemsOneOf0NetworksItemsEntitlementsItemsStatus
string
Entitlement status. pendingapproval is requested and under Agora review; approved is active. conditionallyapproved applies to mint only: the address is usable…
AccountsUpdateResponse2001
object
Customer-owned bank account (WireDetail, status=verified).
9 properties
9 required
ErrorResponse_500_internal_error
object
3 properties
3 required
ErrorResponse400EntitlementNotRequestableParameterInvalidContext
object
1 property
1 required
ErrorResponse401UnauthorizedContext
object
1 property
1 required
ErrorResponse429RateLimitExceededCode
string
V0AccountsPostRequestBodyContentApplicationJsonSchemaOneOf0NetworksItems
string
Blockchain network identifier. Use this to filter or group supply data by chain. Values are stable; new networks may be added but existing ones will not be ren…
ErrorResponse403AccountNotEligibleForbiddenCode
string
ErrorResponse_401_unauthorized
object
4 properties
3 required
V0AccountsAccountIdPutResponsesContentApplicationJsonSchemaOneOf0NetworksItemsEntitlementsItemsStatus
string
Entitlement status. pendingapproval is requested and under Agora review; approved is active. conditionallyapproved applies to mint only: the address is usable…
V0AccountsPostResponsesContentApplicationJsonSchemaOneOf0NetworksItems
object
Per-network entitlement state for the wallet.
2 properties
2 required
V0AccountsGetResponsesContentApplicationJsonSchemaDataItems1
object
Customer-owned bank account (WireDetail, status=verified).
9 properties
9 required
ErrorResponse400EntitlementNotRequestableParameterInvalidContextIssuesItems
object
2 properties
2 required
AccountsCreateResponse2011
object
Customer-owned bank account (WireDetail, status=verified).
9 properties
9 required
AccountsUpdateResponse2000
object
Customer-owned blockchain address (CustomerAddress).
7 properties
7 required
V0AccountsAccountIdPutResponsesContentApplicationJsonSchemaOneOf0AddressFormat
string
Address syntax family. ethereum covers every EVM chain (Ethereum, Base, Polygon, Arbitrum, etc.); per-chain authorization is enforced separately via the accoun…
V0AccountsGetResponsesContentApplicationJsonSchemaDataItems0
object
Customer-owned blockchain address (CustomerAddress).
7 properties
7 required
ErrorResponse409AccountAlreadyExistsCode
string
V0AccountsGetResponsesContentApplicationJsonSchemaDataItems
accounts_update_Response_200
AccountsCreateRequest1
object
6 properties
5 required
ErrorResponse_403_account_not_eligible_forbidden
object
3 properties
3 required
V0AccountsGetResponsesContentApplicationJsonSchemaDataItemsOneOf0NetworksItemsChain
string
Network the wallet is registered on (kebab-case public network id).
ErrorResponse400ParameterInvalidContextIssuesItems
object
2 properties
2 required
ErrorResponse_429_rate_limit_exceeded
object
3 properties
3 required
V0AccountsGetResponsesContentApplicationJsonSchemaDataItemsOneOf1Kind
string
Discriminator: this is a customer-owned bank account.
AccountsCreateResponse2010
object
Customer-owned blockchain address (CustomerAddress).
7 properties
7 required
V0AccountsGetResponsesContentApplicationJsonSchemaDataItemsOneOf1Currency
string
Settlement currency. Today only usd; will extend as new currencies launch.
ErrorResponse400ParameterInvalidCode
string
ErrorResponse_409_account_already_exists
object
3 properties
3 required
ErrorResponse400ParameterInvalidContext
object
1 property
1 required
V0AccountsAccountIdPutResponsesContentApplicationJsonSchemaOneOf1Kind
string
Discriminator: this is a customer-owned bank account.
ErrorResponse400EntitlementNotRequestableParameterInvalidCode
string
V0AccountsPostResponsesContentApplicationJsonSchemaOneOf1Currency
string
Settlement currency. Today only usd; will extend as new currencies launch.
ErrorResponse404NotFoundCode
string
ErrorResponse401UnauthorizedCode
string
ErrorResponse404AccountNotFoundNotFoundCode
string
V0AccountsGetResponsesContentApplicationJsonSchemaDataItemsOneOf0AddressFormat
string
Address syntax family. ethereum covers every EVM chain (Ethereum, Base, Polygon, Arbitrum, etc.); per-chain authorization is enforced separately via the accoun…
ErrorResponse_404_not_found
object
3 properties
3 required
V0AccountsAccountIdPutResponsesContentApplicationJsonSchemaOneOf0NetworksItemsEntitlementsItemsType
string
Entitlement type. mint is the mint capability gated by the per-chain compliance scan; instantsettlement is the instant-settlement whitelist; rewards is rewards…
V0AccountsAccountIdPutResponsesContentApplicationJsonSchemaOneOf1Currency
string
Settlement currency. Today only usd; will extend as new currencies launch.
ErrorResponse_400_entitlement_not_requestable_parameter_invalid
object
4 properties
3 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Agora publishes across the network.