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

# Create API key

> Create a new scoped API key with the Go SDK.

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>;
};

Use `client.ApiKeys.Create` to create a scoped API key.

<Steps>
  <Step title="Call the method">
    ```go client.ApiKeys.Create wrap theme={"system"}
    apiKey, resp, err := client.ApiKeys.Create(
    	blnkgo.CreateApiKeyRequest{
    		Name: "Service Account",
    		Owner: "merchant_a",
    		Scopes: []string{
    			"ledgers:read",
    			"balances:write",
    		},
    		ExpiresAt: time.Date(
    			2026, 12, 31, 23, 59, 59, 0, time.UTC,
    		),
    	},
    )
    ```

    | Field       | Type        | Description                                                                   |
    | :---------- | :---------- | :---------------------------------------------------------------------------- |
    | `Name`      | `string`    | Descriptive name for the key or service account.                              |
    | `Owner`     | `string`    | Owner identifier you assign, such as a team, service, or user ID.             |
    | `Scopes`    | `[]string`  | List of permissions in `resource:action` format (for example `ledgers:read`). |
    | `ExpiresAt` | `time.Time` | Expiration timestamp. Must be a non-zero time.                                |
  </Step>

  <Step title="Store the plaintext key">
    Save `apiKey.Key` immediately. It is only returned at creation and cannot be retrieved later.
  </Step>

  <Step title="Response">
    ```json 201 Created wrap theme={"system"}
    {
      "api_key_id": "api_key_879f0ecb-e29f-4137-801b-1048366381db",
      "key": "YVLIhuIplUzLRCcT9r7DQ_jsGKCXAn39JQ3n_o-Ll2Q=",
      "name": "Service Account",
      "owner_id": "owner_id",
      "scopes": ["ledgers:read", "balances:write"],
      "expires_at": "2026-03-11T00:00:00Z",
      "created_at": "2025-11-18T13:39:50.390457762Z",
      "last_used_at": "0001-01-01T00:00:00Z",
      "is_revoked": false
    }
    ```

    #### Go response (`*blnkgo.ApiKeyResponse`)

    | Field        | Type       | Description                                                                          |
    | :----------- | :--------- | :----------------------------------------------------------------------------------- |
    | `ApiKeyID`   | `string`   | Unique ID for the key. Use it to [revoke the key](/sdks/go/api-keys/delete-api-key). |
    | `Key`        | `string`   | Plaintext secret. Store it now. It is only returned at creation.                     |
    | `Name`       | `string`   | Name you passed in the request.                                                      |
    | `OwnerID`    | `string`   | Owner assigned to the key.                                                           |
    | `Scopes`     | `[]string` | Permissions granted to the key.                                                      |
    | `ExpiresAt`  | `string`   | Date and time the key expires.                                                       |
    | `CreatedAt`  | `string`   | Date and time the key was created.                                                   |
    | `LastUsedAt` | `string`   | Date and time the key was last used.                                                 |
    | `IsRevoked`  | `bool`     | Whether the key has been revoked.                                                    |
    | `RevokedAt`  | `string`   | Revocation timestamp when present.                                                   |
  </Step>
</Steps>

***

## Related docs

<CardGroup cols={2}>
  <Card title="How API keys work" icon="key" href="/advanced/secure-blnk">
    Scopes, the master key, and the auth model.
  </Card>

  <Card title="Create API key" icon="book-open" href="/reference/create-api-key">
    HTTP request and response schema.
  </Card>
</CardGroup>

***

## 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="Connect your ledger to Blnk Cloud" href="https://cloud.blnkfinance.com/auth/sign-up?utm_source=blnk_docs&utm_medium=documentation&utm_campaign=need-help" buttonLabel="Open Blnk Cloud" trackingEvent="clicked_cloud_signup">
  Sign up and manage your ledger with our back-office dashboard. You can invite teammates to collaborate and manage your ledger operations directly from the dashboard.
</CtaCallout>