Get list of wallets

get

https://api.sandbox.audd.digital/wallets

Returns a paginated list of the wallets registered to your company, newest first. Both wallets you registered yourself and any AUDD holds for you appear here.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

index

string

Zero-based index of the page to return.

query

string

Free-text search, case-insensitive and matching anywhere in the value. Covers the wallet nickname and public key.

limit

string

Number of items returned per page. A value below 1 is rejected with a 500.

type

string

Return only wallets of this type.

companyId

string

Return only wallets belonging to this company. An ordinary integration is already scoped to its own company, so supplying another company's id has no effect.

direction

string

Sort direction. Any other value is rejected.

status

string

Return only wallets in this state.

sortBy

string

Attribute to sort by, given as the underlying record's field name, for example dateCreated or nickname. An unrecognised field is rejected with a 500.

Headers

Authorization

string

required

Bearer JWT obtained from POST /mfa/login. Send as "Bearer ". Expires after 5 minutes.

Responses

400

Invalid input. Returned when a query parameter cannot be parsed, for example a status or type outside the allowed values, a direction other than ASC or DESC, or a non-numeric limit or index. Also returned by the gateway when the Authorization header is absent.

401

Unauthorized. The bearer token is missing, expired or invalid. The response body is empty.

404

Not found

500

Internal server error. Also returned for a limit below 1 or an unrecognised sortBy field.

200Success