---
title: "Request a grant"
method: POST
path: "/v1/automations/{automationId}/grants"
tags: ["Automations"]
---

# Request a grant

`POST /v1/automations/{automationId}/grants`

## Request

- Base URL: `https://api.banksync.io`
- URL: `https://api.banksync.io/v1/automations/{automationId}/grants`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

Compute the active revision’s grant request again and store it for a member to approve in the app. An approved grant for the revision is kept as it is. Approving is a person’s decision and has no API route.

## Path parameters

- `automationId` string, required: Automation ID

## Headers

- `Idempotency-Key` string: Makes a retry safe: the same key with the same request replays the first answer for 24 hours instead of running twice, and the same key with a different request is a 409 `IDEMPOTENCY_KEY_REUSED`. Refusals a retry can outlive — 408, 409, 423, 425, 429 and every 5xx — are never replayed, so retrying with the same key after the cause clears runs the request.

## Response `200`

The request the revision already had, refreshed

- object
  - `success` true, required
  - `data` object, required
    - `grant` object, required
      - `id` string, required
      - `automationId` string, required
      - `revision` string, required
      - `status` 'requested' | 'active' | 'needs_reapproval' | 'revoked' | 'expired', required
      - `catalogueDigest` string, required
      - `bindingFingerprint` string, required
      - `permissions` string[], required
      - `resources` object[], required
        - `binding` string, required
        - `type` string, required
        - `id` string, required
        - `access` 'read' | 'write' | 'delete', required
      - `egressHosts` string[], required
      - `caps` object[], required
        - `key` string, required
        - `node` string, required
        - `limit` integer, required
        - `window` 'run' | 'day' | 'month', required
      - `callable` string[], required
      - `grantedBy` string, nullable, required
      - `grantedAt` string, nullable, required
      - `expiresAt` string, nullable, required
      - `reapprovalSince` string, nullable, required
      - `revokedAt` string, nullable, required
    - `replayed` boolean

## Other responses

- `201`: The new grant request
- `400`: Invalid input, or the draft has blocking findings — `code` names the refusal (`AUTOMATION_BLOCKED_BY_FINDINGS`, `AUTOMATION_SECRET_REFUSED`, …) and `details[]` each finding with its node
- `401`: Unauthorized
- `403`: Forbidden — missing scope, insufficient role, a credential narrowed to some accounts, or a grant the caller does not hold
- `404`: Not found — or automations are not enabled for this workspace
- `409`: Conflict — the draft moved since you read it (`AUTOMATION_VERSION_CONFLICT`), the automation is not published or not active, or a grant does not hold (`AUTOMATION_GRANT_STATE`)
- `429`: The automation’s admission refused the run and does not queue (`AUTOMATION_ADMISSION_REFUSED`, `AUTOMATION_RATE_LIMITED`): `code` names which, and the `Retry-After` header says how many seconds to wait before trying again. A start that queues is a 202, not this.
- `503`: Automations are paused while an incident is worked (`AUTOMATIONS_STOPPED`) or not configured here (`AUTOMATIONS_UNAVAILABLE`): `code` names which, and the `Retry-After` header says how many seconds to wait before retrying

---

[API](https://skmtc.dev/banksync/apis/banksync-api.md) · [All operations](https://skmtc.dev/banksync/apis/banksync-api/llms.txt) · [OpenAPI document](https://skmtc.dev/banksync/apis/banksync-api/revisions/94465f5ee922?raw)