> ## 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.

# Proxy API

> Send write and search requests to a Blnk Core instance through Blnk Cloud.

export const CtaCallout = props => {
  const {title, buttonLabel, href, trackingEvent, buttonTarget, rel = "noopener noreferrer", children} = props;
  const handleCtaClick = () => {
    if (typeof window === "undefined" || !trackingEvent) {
      return;
    }
    try {
      window.dispatchEvent(new CustomEvent("blnk:docs-cta", {
        detail: {
          name: trackingEvent,
          href
        }
      }));
    } catch {}
    try {
      window.posthog?.capture?.(trackingEvent, {
        href
      });
    } catch {}
    const gaPayload = {
      cta_href: href
    };
    try {
      window.gtag?.("event", trackingEvent, gaPayload);
    } catch {}
    try {
      window.dataLayer = window.dataLayer || [];
      window.dataLayer.push({
        event: trackingEvent,
        ...gaPayload
      });
    } catch {}
  };
  const isExternal = typeof href === "string" && (/^https?:\/\//i).test(href);
  const target = buttonTarget ?? (isExternal ? "_blank" : undefined);
  const linkRel = isExternal ? rel : undefined;
  return <section className="cta-callout not-prose relative my-8 w-full min-w-0 overflow-hidden rounded-xl border border-zinc-200 p-5 dark:border-white/10">
      <div className="cta-callout-noise" aria-hidden="true" />
      <div className="cta-callout-layout">
        {title ? <div className="cta-callout-title-row">
            <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 28 28" width="14" height="14" className="cta-callout-icon shrink-0 text-zinc-800 dark:text-zinc-200" aria-hidden="true">
              <g fill="none" fillRule="nonzero">
                <path d="M28 0v28H0V0h28ZM14.691833333333335 27.134333333333334l-0.012833333333333334 0.0023333333333333335 -0.08283333333333333 0.04083333333333334 -0.023333333333333334 0.004666666666666667 -0.016333333333333335 -0.004666666666666667 -0.08283333333333333 -0.04083333333333334c-0.011666666666666667 -0.004666666666666667 -0.022166666666666668 -0.0011666666666666668 -0.028000000000000004 0.005833333333333334l-0.004666666666666667 0.011666666666666667 -0.019833333333333335 0.49933333333333335 0.005833333333333334 0.023333333333333334 0.011666666666666667 0.015166666666666667 0.12133333333333333 0.08633333333333333 0.0175 0.004666666666666667 0.014000000000000002 -0.004666666666666667 0.12133333333333333 -0.08633333333333333 0.014000000000000002 -0.018666666666666668 0.004666666666666667 -0.019833333333333335 -0.019833333333333335 -0.4981666666666667c-0.0023333333333333335 -0.011666666666666667 -0.0105 -0.019833333333333335 -0.019833333333333335 -0.021Zm0.3091666666666667 -0.13183333333333336 -0.015166666666666667 0.0023333333333333335 -0.21583333333333335 0.1085 -0.011666666666666667 0.011666666666666667 -0.0035000000000000005 0.012833333333333334 0.021 0.5016666666666667 0.005833333333333334 0.014000000000000002 0.009333333333333334 0.008166666666666668 0.23450000000000004 0.1085c0.014000000000000002 0.004666666666666667 0.026833333333333334 0 0.03383333333333334 -0.009333333333333334l0.004666666666666667 -0.016333333333333335 -0.03966666666666667 -0.7163333333333334c-0.0035000000000000005 -0.014000000000000002 -0.011666666666666667 -0.023333333333333334 -0.023333333333333334 -0.025666666666666667Zm-0.8341666666666667 0.0023333333333333335a0.026833333333333334 0.026833333333334334 0 0 0 -0.0315 0.007000000000000001l-0.007000000000000001 0.016333333333333335 -0.03966666666666667 0.7163333333333334c0 0.014000000000000002 0.008166666666666668 0.023333333333333334 0.019833333333333335 0.028000000000000004l0.0175 -0.0023333333333333335 0.23450000000000004 -0.1085 0.011666666666666667 -0.009333333333333334 0.004666666666666667 -0.012833333333333334 0.019833333333333335 -0.5016666666666667 -0.0035000000000000005 -0.014000000000000002 -0.011666666666666667 -0.011666666666666667 -0.21466666666666667 -0.10733333333333334Z" strokeWidth="1.1667" />
                <path fill="currentColor" d="M14 2.916666666666667A1.75 1.75 0 0 1 15.750000000000002 4.666666666666667v6.302333333333334L21.207666666666668 7.816666666666667a1.75 1.75 0 0 1 1.75 3.031L17.5 14l5.457666666666667 3.151166666666667a1.75 1.75 0 0 1 -1.75 3.031l-5.457666666666667 -3.1500000000000004V23.333333333333336a1.75 1.75 0 0 1 -3.5 0v-6.302333333333334L6.792333333333334 20.183333333333337a1.75 1.75 0 1 1 -1.75 -3.031L10.5 14 5.042333333333334 10.848833333333333a1.75 1.75 0 0 1 1.75 -3.031l5.457666666666667 3.1500000000000004V4.666666666666667A1.75 1.75 0 0 1 14 2.916666666666667Z" strokeWidth="1.1667" />
              </g>
            </svg>
            <p className="cta-callout-title min-w-0 font-semibold text-zinc-800 dark:text-zinc-200">
              {title}
            </p>
          </div> : null}
        <div className={`cta-callout-body text-sm leading-normal text-zinc-800 dark:text-zinc-200${title ? " cta-callout-body--indented" : ""}`}>
          {children}
        </div>
        <a href={href} target={target} rel={linkRel} onClick={handleCtaClick} data-docs-cta={trackingEvent || undefined} className="cta-callout-button inline-flex items-center justify-center gap-1 rounded-full bg-white px-3 py-1.5 text-sm font-semibold transition hover:bg-zinc-100 focus-visible:outline focus-visible:outline-2 focus-visible:outline-offset-2 focus-visible:outline-white/50 dark:bg-white dark:hover:bg-zinc-200">
          {buttonLabel}
          <span className="cta-callout-button-arrow" aria-hidden="true">
            →
          </span>
        </a>
      </div>
    </section>;
};

The Proxy API forwards HTTP requests to your Blnk Core instance through Blnk Cloud. Use it to create ledgers, balances, transactions, identities, and other Core resources without connecting to Core directly.

<Note>
  Blnk Cloud authenticates your request, routes it to the target instance using `instance_id`, and returns the Core response unchanged. For a step-by-step walkthrough, see [Making requests via the Cloud Proxy](/cloud/proxy/proxy-api).
</Note>

***

### Request structure

<RequestExample>
  ```bash cURL wrap theme={"system"}
  curl -X POST 'https://api.cloud.blnkfinance.com/proxy/ledgers?instance_id=YOUR_INSTANCE_ID' \
    -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
    -H 'Content-Type: application/json' \
    -d '{
      "name": "My Integration Ledger",
      "meta_data": {
        "description": "Ledger for integration test"
      }
    }'
  ```
</RequestExample>

<ParamField header="Authorization" type="string" required>
  Bearer token for an API key or OAuth access token. Format: `Bearer YOUR_API_KEY` or `Bearer YOUR_ACCESS_TOKEN`. Credentials must include the appropriate proxy scope:

  | Scope         | Access                                          |
  | ------------- | ----------------------------------------------- |
  | `proxy:write` | Create and update resources (POST, PUT, DELETE) |
  | `proxy:read`  | Read resources (GET routes)                     |

  Create credentials with proxy scopes in [API keys](/cloud/auth/api-keys) or [OAuth clients](/cloud/auth/oauth).
</ParamField>

<ParamField query="instance_id" type="string" required>
  Unique identifier of the Blnk Core instance to target. Required on every Proxy API request.
</ParamField>

<ParamField header="Content-Type" type="string">
  Required for requests with a body. Set to `application/json`. Use `multipart/form-data` for reconciliation file uploads.
</ParamField>

***

### Available endpoints

All paths are relative to `https://api.cloud.blnkfinance.com/proxy`. Append `?instance_id=YOUR_INSTANCE_ID` to every request.

<Tabs>
  <Tab title="Writes">
    | Method | Path                         | Description                                                    |
    | ------ | ---------------------------- | -------------------------------------------------------------- |
    | POST   | `/ledgers`                   | Create a ledger                                                |
    | POST   | `/balances`                  | Create a balance                                               |
    | POST   | `/transactions`              | Create a transaction                                           |
    | POST   | `/transactions/bulk`         | Create multiple transactions                                   |
    | PUT    | `/transactions/inflight/:id` | Update an inflight transaction                                 |
    | POST   | `/refund-transaction/:id`    | Refund a transaction                                           |
    | POST   | `/identities`                | Create an identity                                             |
    | PUT    | `/identities/:identity_id`   | Update an identity                                             |
    | PUT    | `/balances/:id/identity`     | Link an identity to a balance                                  |
    | POST   | `/:id/metadata`              | Update metadata on a ledger, balance, transaction, or identity |
  </Tab>

  <Tab title="Reads">
    | Method | Path                                         | Description                                             |
    | ------ | -------------------------------------------- | ------------------------------------------------------- |
    | GET    | `/balances/:id/at`                           | Get balance at a timestamp (`timestamp` query required) |
    | GET    | `/balances/:id/lineage`                      | Get balance lineage                                     |
    | GET    | `/transactions/:id/lineage`                  | Get transaction lineage                                 |
    | GET    | `/identities/:identity_id/tokenized-fields`  | List tokenized fields                                   |
    | GET    | `/identities/:identity_id/detokenize/:field` | Detokenize a single field                               |
  </Tab>

  <Tab title="Tokenization">
    | Method | Path                                       | Description                |
    | ------ | ------------------------------------------ | -------------------------- |
    | POST   | `/identities/:identity_id/tokenize/:field` | Tokenize a single field    |
    | POST   | `/identities/:identity_id/tokenize`        | Tokenize multiple fields   |
    | POST   | `/identities/:identity_id/detokenize`      | Detokenize multiple fields |
  </Tab>

  <Tab title="Reconciliation">
    | Method | Path                                 | Description                  |
    | ------ | ------------------------------------ | ---------------------------- |
    | POST   | `/reconciliation/start`              | Start a reconciliation       |
    | POST   | `/reconciliation/upload`             | Upload reconciliation data   |
    | POST   | `/reconciliation/matching-rules`     | Create matching rules        |
    | PUT    | `/reconciliation/matching-rules/:id` | Update a matching rule       |
    | DELETE | `/reconciliation/matching-rules/:id` | Delete a matching rule       |
    | GET    | `/reconciliation/:reconciliation_id` | Get reconciliation details   |
    | POST   | `/reconciliation/start-instant`      | Start instant reconciliation |
  </Tab>
</Tabs>

<Info>
  When creating a transaction, Blnk Cloud automatically adds `precision: 100` and a `reference` value if they are omitted from the request body.
</Info>

***

### Response structure

Proxy responses pass through the Core instance response unchanged. Status codes and body shapes match the corresponding Core endpoint.

***

## 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](mailto:support@blnkfinance.com) or [join our Discord community](https://discord.gg/7WNv94zPpx).

<CtaCallout title="Need help with your product?" href="https://blnkfinance.com/contact/us?utm_source=blnk_docs&utm_medium=documentation&utm_campaign=home%2Finstall" buttonLabel="Speak with us" trackingEvent="clicked_pro_support">
  Get dedicated support for architecture reviews, integration planning, ledger workflows, and production deployment.
</CtaCallout>