Ledger balances

Update balance identity

Update the identity associated with a balance.

PUT/balances/{balance_id}/identity

Authorization

If set, the API uses an API key for authentication. Include the following header in your requests: X-blnk-key: <api-key>.

Replace <api-key> with your secret API key. Ensure the key is kept secure and not exposed in public repositories or client-side code.

Path

balance_idstringrequiredpath

Unique balance_id of the balance whose identity you want to update.

Body

identity_idstringrequiredbody

The new identity ID to associate with the balance. Must be a valid existing identity ID.

curl -X PUT "http://localhost:5001/balances/{balance_id}/identity" \
  -H "X-blnk-key: <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "identity_id": "idt_3b63c8da-af29-4cc3-ad38-df17d87456e6"
  }'

{
  "message": "Balance identity updated successfully"
}

{
  "error": "Identity with ID 'idt_00000000-0000-0000-0000-000000000000' not found",
  "error_detail": {
    "code": "BAL_NOT_FOUND",
    "message": "Identity with ID 'idt_00000000-0000-0000-0000-000000000000' not found"
  }
}