Read a wallet

Retrieves a wallet identified by the provided handle. If the wallet with the provided handle doesn't exist, API will return 404 error.

GET
/wallets/{id}

Authorization

AuthorizationBearer <token>

JWT signed by private key. The presence of this token is not mandatory. It becomes required through the configuration of authorization access rules that requires a token to grant access. Once sent, the token is validated for its format, signature and expiration, regardless of the presence of access rules.

In: header

Path Parameters

idaddress | luid

The unique identifier of the wallet record - it is luid or handle (address).

Header Parameters

x-ledger?handle | luid

The unique identifier of ledger in context for multi tenant requests.

Response Body

fetch("http://localhost:3000/v2/wallets/string", {
  headers: {
    "x-ledger": "string"
  }
})

{
  "hash": "ea5d148b0db152db450cd8eb39bd6a08b1fffd9c5939ac9701b17aceb47e0e77",
  "data": {
    "parent": "4298573b4fec0885d45b20d7063056e9db4de15c639bc7ecf20d45954745b2d0",
    "handle": "bank-wallet",
    "schema": "bank-wallet",
    "custom": {
      "name": "Updated Bank Wallet",
      "status": "active",
      "description": "Updated primary wallet for banking operations"
    },
    "access": [
      {
        "action": "any",
        "signer": {
          "$record": "owner"
        }
      },
      {
        "action": "read",
        "bearer": {
          "$signer": {
            "$record": "owner"
          }
        }
      }
    ]
  },
  "luid": "$wlt.-08478ypxQPyJOg5b",
  "meta": {
    "proofs": [
      {
        "custom": {
          "moment": "2025-04-02T05:10:32.267Z"
        },
        "digest": "acc4a22e416dc43e82431922bd09cdedc1a26c62c2a7760af3a3954d698e88bc",
        "method": "ed25519-v2",
        "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
        "result": "5eLklbr1Al/ZmYTWa38lk5gUngbc9J8bnpBthUJNXPr/0qeb8O1hXbITAO9qjX0SECyxSHiWfCQrf5TqAoAtCw=="
      },
      {
        "custom": {
          "luid": "$wlt.-08478ypxQPyJOg5b",
          "moment": "2025-04-02T05:10:32.283Z"
        },
        "digest": "f5641460ca9dec5b6123993a65da3ea3fa513f2578a04c7a308a00572d9ae475",
        "method": "ed25519-v2",
        "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
        "result": "x6gDmR5EN6KTt0nPezhgpM1IIy71KAD2WDlxznsCtPCYLGZVxAHJqV/F59d3exoTFzGdc4B52vE6AMf2t/EKCg=="
      },
      {
        "custom": {
          "moment": "2025-04-02T05:10:30.823Z",
          "status": "onboarded",
          "operation": "onboarding"
        },
        "digest": "80f31d6fc8c9dedea9be9f56d75374f681d507a469a058344f96d76d8c1eb22a",
        "method": "ed25519-v2",
        "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
        "result": "BlBU3f1lwMlqor46VnlcG3RaaXTNWP4qaF0ekFt6x6PbDe8lZin7n+5AoHmbch01AzgI7v4Sx8VdgMGiw0oGDA=="
      }
    ],
    "status": "onboarded",
    "moment": "2025-04-02T05:10:32.281Z",
    "owners": [
      "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
    ]
  }
}

{
  "hash": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
  "data": {
    "reason": "auth.unauthorized",
    "detail": "Invalid token."
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "JdK8m5SqXGCiZ1TdXQbCe9ECqwL3Kg1UZxj4r9gT+cA=",
        "digest": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
        "result": "X2m5A9Yxh4FRPgj6wgJKN0dYrfgXSq3hx8UX1jnmJ7fVHtQCnAp8MepXDZQhNkMsJd7a9HPk96hmvYXTFcHzAw=="
      }
    ]
  }
}

{
  "hash": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
  "data": {
    "reason": "auth.forbidden",
    "detail": "Request is not authorized"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "WAweF9PHlboQoW0z8NqhZXFmzUTaV74NRFAd/aILprE=",
        "digest": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
        "result": "0G2gvSfBx6MwPT8ShBaiYx7zwa5Kqc4Cq3S3NXV1m5/ZPozoH/SUouuhi9sQU+f0yo0eX4ygH7PzE3PAdlxsCQ=="
      }
    ]
  }
}

{
  "hash": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
  "data": {
    "reason": "record.not-found",
    "detail": "Signer not found"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "7ZMqyx5Lk3PQwNrJvGIs9eT6ahcUKXZ8SbRj4WyF2dQ=",
        "digest": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
        "result": "VFp8RxnT2h+JK9W5/nJfLZdV1uLKXHBL5RwpnbZ4qDz3J1Ks4eOj7y9QVMhmwlIa5AQlNbdT3GJcvH8xo3WhBA=="
      }
    ]
  }
}

{
  "hash": "3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4c7b0a3f6e",
  "data": {
    "reason": "record.schema-invalid",
    "detail": "Schema validator error: data.handle must match pattern \"^[a-zA-Z0-9_\\\\-+.]+$\"",
    "custom": {
      "errors": [
        {
          "instancePath": "/handle",
          "schemaPath": "#/properties/handle/pattern",
          "keyword": "pattern",
          "params": {
            "pattern": "^[a-zA-Z0-9_\\\\-+.]+$"
          },
          "message": "must match pattern \"^[a-zA-Z0-9_\\\\-+.]+$\""
        }
      ]
    }
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "vL8jKxm5PqTnJfEaRs2uOdY7gzX4CS9WbHlN3cAiBV0=",
        "digest": "3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4c7b0a3f6e",
        "result": "uYxJLd2QGkEfT8rP7mCn1lHVzBvIaSK4jFqpO5ZwW9oADnMbg6yeiUsvN3tcXj0RwYxkrq5aLm9f4y2Ko8WwDw=="
      }
    ]
  }
}

{
  "hash": "e1d4c7b0a3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4",
  "data": {
    "reason": "api.unexpected-error",
    "detail": "An unexpected error occurred"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "KxiLpB3v8VEdmYsT2RwNq5o1Cz9gHJfU4aAySt7D0X8=",
        "digest": "e1d4c7b0a3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4",
        "result": "LzRmNh7x5TQYoqjw30BKDaZnbGcFUsX8v4tpEsr9P6iW1dyJkVC2uALfY8HdpM3eX9w0On12cqYxEtveKoFZDQ=="
      }
    ]
  }
}