Get a Wallet Address

GET

/

• Server for Alice's wallet address
• Server for Bob's wallet address

Retrieve the public information of the Wallet Address.

This end-point should be open to anonymous requests as it allows clients to verify a Wallet Address URL and get the basic information required to construct new transactions and discover the grant request URL.

The content should be slow changing and cacheable for long periods. Servers SHOULD use cache control headers.

Responses

200

Wallet Address Found

A wallet address resource is the root of the API and contains the public details of the financial account represented by the Wallet Address that is also the service endpoint URL.

object

id

required

The URL identifying the wallet address.

string format: uri

publicName

A public name for the account. This should be set by the account holder with their provider to provide a hint to counterparties as to the identity of the account holder.

string

assetCode

required

The assetCode is a code that indicates the underlying asset. This SHOULD be an ISO4217 currency code.

string

assetScale

required

The scale of amounts denoted in the corresponding asset code.

integer

<= 255

authServer

required

The URL of the authorization server endpoint for getting grants and access tokens for this wallet address.

string format: uri

resourceServer

required

The URL of the resource server endpoint for performing Open Payments with this wallet address.

string format: uri

key

additional properties

any

Examples

{
  "id": "https://ilp.interledger-test.dev/alice",
  "publicName": "Alice",
  "assetCode": "USD",
  "assetScale": 2,
  "authServer": "https://ilp.interledger-test.dev/auth",
  "resourceServer": "https://ilp.interledger-test.dev/op"
}

404

Wallet Address Not Found