Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.blnkfinance.com/llms.txt

Use this file to discover all available pages before exploring further.

Available in version 0.8.2 and later.

​
Overview

With the Update Metadata endpoint, you can modify existing metadata or add new metadata to ledgers, transactions, identities, and balances after they have been created.
Important to note:When you update the metadata of a parent resource, the changes propagate to its children. For example, if you update the metadata of an inflight transaction, it is also updated on its applied or void child transactions.

​
How it works

1

Initial metadata

Consider the following metadata attached to an item:
{
  ...
  "meta_data": {
    "first_name": "Jason"
  }
}
2

Adding more metadata

To add a last name and verification status, send a POST request to:
cURL
curl -X POST "http://localhost:5001/{id}/metadata" \
  -H "X-blnk-key: <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "meta_data": {
      "last_name": "Brooks",
      "verification_status": "Pending"
    }
  }'
3

Updating metadata

To update the verification status, send the following request:
cURL
curl -X POST "http://localhost:5001/{id}/metadata" \
  -H "X-blnk-key: <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "meta_data": {
      "verification_status": "Approved"
    }
  }'
Breaking change (0.13.6+): The Update Metadata response now returns meta_data instead of metadata.If you parse the response by key, use meta_data or support both for compatibility. See the 0.13.6 migration guide for details.
4

Final metadata

After these updates, the metadata for the item will look like this:
{
  ...
  "meta_data": {
    "first_name": "Jason",
    "last_name": "Brooks",
    "verification_status": "Approved"
  }
}

​
Need help?

We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool. To ask questions or discuss issues, please contact us or join our Discord community.
Tip: Connect to Blnk Cloud to see your Core data.You can view your transactions, manage identities, create custom reports, invite other team members to collaborate, and perform operations on your Core — all in one dashboard.Check out Blnk Cloud →