Change an API key's scopes

curl --request PATCH \
  --url https://api-sandbox.ledgersyncappv2.com/v3/api-keys/{api_key_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scopes": [
    "read:accounts",
    "read:transactions",
    "read:checks"
  ]
}
'

import requests

url = "https://api-sandbox.ledgersyncappv2.com/v3/api-keys/{api_key_id}"

payload = { "scopes": ["read:accounts", "read:transactions", "read:checks"] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({scopes: ['read:accounts', 'read:transactions', 'read:checks']})
};

fetch('https://api-sandbox.ledgersyncappv2.com/v3/api-keys/{api_key_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.ledgersyncappv2.com/v3/api-keys/{api_key_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'scopes' => [
        'read:accounts',
        'read:transactions',
        'read:checks'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.ledgersyncappv2.com/v3/api-keys/{api_key_id}"

	payload := strings.NewReader("{\n  \"scopes\": [\n    \"read:accounts\",\n    \"read:transactions\",\n    \"read:checks\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api-sandbox.ledgersyncappv2.com/v3/api-keys/{api_key_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"scopes\": [\n    \"read:accounts\",\n    \"read:transactions\",\n    \"read:checks\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.ledgersyncappv2.com/v3/api-keys/{api_key_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"scopes\": [\n    \"read:accounts\",\n    \"read:transactions\",\n    \"read:checks\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "15a81d54-0471-4f3c-9c1f-2f0a0c7b8d31",
  "environment": "sandbox",
  "prefix": "sk_test_a89d15d0",
  "scopes": [
    "read:clients"
  ],
  "status": "active",
  "created_at": "2023-11-07T05:31:56Z",
  "last_used_at": "2023-11-07T05:31:56Z",
  "revoked_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "unknown_api_key",
    "message": "The API key you presented doesn't match any active key.",
    "type": "auth_error",
    "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
    "category": "AUTH_ERROR",
    "is_user_actionable": true,
    "source_diagnostic_code": "FIN-103",
    "param": "client.email",
    "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
    "errors": [
      {
        "param": "client.email",
        "message": "must be a valid email address",
        "code": "invalid_email"
      }
    ]
  }
}

{
  "error": {
    "code": "unknown_api_key",
    "message": "The API key you presented doesn't match any active key.",
    "type": "auth_error",
    "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
    "category": "AUTH_ERROR",
    "is_user_actionable": true,
    "source_diagnostic_code": "FIN-103",
    "param": "client.email",
    "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
    "errors": [
      {
        "param": "client.email",
        "message": "must be a valid email address",
        "code": "invalid_email"
      }
    ]
  }
}

{
  "error": {
    "code": "unknown_api_key",
    "message": "The API key you presented doesn't match any active key.",
    "type": "auth_error",
    "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
    "category": "AUTH_ERROR",
    "is_user_actionable": true,
    "source_diagnostic_code": "FIN-103",
    "param": "client.email",
    "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
    "errors": [
      {
        "param": "client.email",
        "message": "must be a valid email address",
        "code": "invalid_email"
      }
    ]
  }
}

{
  "error": {
    "code": "unknown_api_key",
    "message": "The API key you presented doesn't match any active key.",
    "type": "auth_error",
    "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
    "category": "AUTH_ERROR",
    "is_user_actionable": true,
    "source_diagnostic_code": "FIN-103",
    "param": "client.email",
    "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
    "errors": [
      {
        "param": "client.email",
        "message": "must be a valid email address",
        "code": "invalid_email"
      }
    ]
  }
}

ApiKeys

Change an API key's scopes

Replace the scopes on an existing key, keeping the same secret — so a scope change doesn’t force you to redeploy a credential.

Mostly useful when we add a new scope: keys issued before it existed don’t carry it, and calls that need it fail with insufficient_scope even though nothing about your key is wrong. PATCH it instead of rotating.

scopes is the complete set, not a delta — send every scope the key should end up with. Unknown scopes are rejected, and the change applies to your next request.

Revoked keys can’t be re-scoped; create a new key instead. A key can only be re-scoped by a credential in its own environment — a sandbox key can’t widen a live key.

PATCH

api-keys

{api_key_id}

Change an API key's scopes

curl --request PATCH \
  --url https://api-sandbox.ledgersyncappv2.com/v3/api-keys/{api_key_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scopes": [
    "read:accounts",
    "read:transactions",
    "read:checks"
  ]
}
'

import requests

url = "https://api-sandbox.ledgersyncappv2.com/v3/api-keys/{api_key_id}"

payload = { "scopes": ["read:accounts", "read:transactions", "read:checks"] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({scopes: ['read:accounts', 'read:transactions', 'read:checks']})
};

fetch('https://api-sandbox.ledgersyncappv2.com/v3/api-keys/{api_key_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.ledgersyncappv2.com/v3/api-keys/{api_key_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'scopes' => [
        'read:accounts',
        'read:transactions',
        'read:checks'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.ledgersyncappv2.com/v3/api-keys/{api_key_id}"

	payload := strings.NewReader("{\n  \"scopes\": [\n    \"read:accounts\",\n    \"read:transactions\",\n    \"read:checks\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api-sandbox.ledgersyncappv2.com/v3/api-keys/{api_key_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"scopes\": [\n    \"read:accounts\",\n    \"read:transactions\",\n    \"read:checks\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.ledgersyncappv2.com/v3/api-keys/{api_key_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"scopes\": [\n    \"read:accounts\",\n    \"read:transactions\",\n    \"read:checks\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "15a81d54-0471-4f3c-9c1f-2f0a0c7b8d31",
  "environment": "sandbox",
  "prefix": "sk_test_a89d15d0",
  "scopes": [
    "read:clients"
  ],
  "status": "active",
  "created_at": "2023-11-07T05:31:56Z",
  "last_used_at": "2023-11-07T05:31:56Z",
  "revoked_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "unknown_api_key",
    "message": "The API key you presented doesn't match any active key.",
    "type": "auth_error",
    "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
    "category": "AUTH_ERROR",
    "is_user_actionable": true,
    "source_diagnostic_code": "FIN-103",
    "param": "client.email",
    "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
    "errors": [
      {
        "param": "client.email",
        "message": "must be a valid email address",
        "code": "invalid_email"
      }
    ]
  }
}

{
  "error": {
    "code": "unknown_api_key",
    "message": "The API key you presented doesn't match any active key.",
    "type": "auth_error",
    "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
    "category": "AUTH_ERROR",
    "is_user_actionable": true,
    "source_diagnostic_code": "FIN-103",
    "param": "client.email",
    "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
    "errors": [
      {
        "param": "client.email",
        "message": "must be a valid email address",
        "code": "invalid_email"
      }
    ]
  }
}

{
  "error": {
    "code": "unknown_api_key",
    "message": "The API key you presented doesn't match any active key.",
    "type": "auth_error",
    "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
    "category": "AUTH_ERROR",
    "is_user_actionable": true,
    "source_diagnostic_code": "FIN-103",
    "param": "client.email",
    "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
    "errors": [
      {
        "param": "client.email",
        "message": "must be a valid email address",
        "code": "invalid_email"
      }
    ]
  }
}

{
  "error": {
    "code": "unknown_api_key",
    "message": "The API key you presented doesn't match any active key.",
    "type": "auth_error",
    "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
    "category": "AUTH_ERROR",
    "is_user_actionable": true,
    "source_diagnostic_code": "FIN-103",
    "param": "client.email",
    "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
    "errors": [
      {
        "param": "client.email",
        "message": "must be a valid email address",
        "code": "invalid_email"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Pass your secret key in the Authorization header as a Bearer token: Authorization: Bearer sk_test_... (sandbox) or Bearer sk_live_... (production).

Keys are created in the developer portal and the plaintext secret is shown exactly once at creation. Treat them like passwords — never embed them in mobile apps or front-end code.

Path Parameters

api_key_id

string

required

Body

application/json

scopes

string[]

required

The complete scope set the key should carry from now on.

Minimum array length: 1

Response

The updated key.

string

required

Plain UUID v4 (e.g. 15a81d54-0471-...). No prefix is applied today. SDKs should treat the value as opaque.

Example:

"15a81d54-0471-4f3c-9c1f-2f0a0c7b8d31"

environment

enum<string>

required

Available options:

sandbox,

live

prefix

string

required

First few characters of the key, safe to display in lists and logs (the rest is irrecoverable after creation).

Example:

"sk_test_a89d15d0"

scopes

enum<string>[]

required

Available options:

read:clients,

write:clients,

read:connections,

write:connections,

read:accounts,

read:transactions,

read:statements,

write:statements,

read:checks,

manage:webhooks,

read:webhooks,

write:webhooks,

read:api-keys,

write:api-keys

status

enum<string>

required

Available options:

active,

revoked

created_at

string<date-time>

required

last_used_at

string<date-time> | null

revoked_at

string<date-time> | null

Health

Clients

Connections

Settings

Institutions

Accounts

Transactions

Statements

Checks

Operations

Webhooks

ApiKeys

Sandbox

Metrics

PortalGating

Change an API key's scopes

Authorizations

Path Parameters

Body

Response