Authorize a Connection

curl --request POST \
  --url https://api.checkfu.com/v1/connections/authorize \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'checkfu-version: <checkfu-version>' \
  --data '
{
  "owner_principal_id": "<string>",
  "provider": "<string>",
  "label": "<string>",
  "scopes": [
    "<string>"
  ],
  "egress_rules": [
    {
      "scheme": "https",
      "host": "<string>",
      "port": 32768,
      "path_prefix": "<string>",
      "methods": [],
      "allowed_headers": [
        "<string>"
      ]
    }
  ]
}
'

import requests

url = "https://api.checkfu.com/v1/connections/authorize"

payload = {
    "owner_principal_id": "<string>",
    "provider": "<string>",
    "label": "<string>",
    "scopes": ["<string>"],
    "egress_rules": [
        {
            "scheme": "https",
            "host": "<string>",
            "port": 32768,
            "path_prefix": "<string>",
            "methods": [],
            "allowed_headers": ["<string>"]
        }
    ]
}
headers = {
    "checkfu-version": "<checkfu-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'checkfu-version': '<checkfu-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    owner_principal_id: '<string>',
    provider: '<string>',
    label: '<string>',
    scopes: ['<string>'],
    egress_rules: [
      {
        scheme: 'https',
        host: '<string>',
        port: 32768,
        path_prefix: '<string>',
        methods: [],
        allowed_headers: ['<string>']
      }
    ]
  })
};

fetch('https://api.checkfu.com/v1/connections/authorize', 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.checkfu.com/v1/connections/authorize",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'owner_principal_id' => '<string>',
    'provider' => '<string>',
    'label' => '<string>',
    'scopes' => [
        '<string>'
    ],
    'egress_rules' => [
        [
                'scheme' => 'https',
                'host' => '<string>',
                'port' => 32768,
                'path_prefix' => '<string>',
                'methods' => [
                                
                ],
                'allowed_headers' => [
                                '<string>'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "checkfu-version: <checkfu-version>"
  ],
]);

$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.checkfu.com/v1/connections/authorize"

	payload := strings.NewReader("{\n  \"owner_principal_id\": \"<string>\",\n  \"provider\": \"<string>\",\n  \"label\": \"<string>\",\n  \"scopes\": [\n    \"<string>\"\n  ],\n  \"egress_rules\": [\n    {\n      \"scheme\": \"https\",\n      \"host\": \"<string>\",\n      \"port\": 32768,\n      \"path_prefix\": \"<string>\",\n      \"methods\": [],\n      \"allowed_headers\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}")

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

	req.Header.Add("checkfu-version", "<checkfu-version>")
	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.post("https://api.checkfu.com/v1/connections/authorize")
  .header("checkfu-version", "<checkfu-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"owner_principal_id\": \"<string>\",\n  \"provider\": \"<string>\",\n  \"label\": \"<string>\",\n  \"scopes\": [\n    \"<string>\"\n  ],\n  \"egress_rules\": [\n    {\n      \"scheme\": \"https\",\n      \"host\": \"<string>\",\n      \"port\": 32768,\n      \"path_prefix\": \"<string>\",\n      \"methods\": [],\n      \"allowed_headers\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/connections/authorize")

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

request = Net::HTTP::Post.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"owner_principal_id\": \"<string>\",\n  \"provider\": \"<string>\",\n  \"label\": \"<string>\",\n  \"scopes\": [\n    \"<string>\"\n  ],\n  \"egress_rules\": [\n    {\n      \"scheme\": \"https\",\n      \"host\": \"<string>\",\n      \"port\": 32768,\n      \"path_prefix\": \"<string>\",\n      \"methods\": [],\n      \"allowed_headers\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}"

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

{
  "connection": {
    "id": "<string>",
    "workspace_id": "<string>",
    "owner_principal_id": "<string>",
    "provider": "<string>",
    "label": "<string>",
    "scopes": [
      "<string>"
    ],
    "egress_rules": [
      {
        "scheme": "https",
        "host": "<string>",
        "port": 32768,
        "path_prefix": "<string>",
        "methods": [
          "GET"
        ],
        "allowed_headers": [
          "<string>"
        ]
      }
    ],
    "custody_adapter": "<string>",
    "lifecycle": "pending",
    "health": "pending",
    "drift": "none",
    "custody_revoke_pending": true,
    "last_health_check_at": "<string>",
    "version": 1,
    "created_at": "<string>",
    "updated_at": "<string>",
    "provider_package": {
      "name": "<string>",
      "version": 1,
      "digest": "<string>",
      "review": "curated"
    }
  },
  "connect_url": "<string>",
  "expires_at": "<string>"
}

{
  "error": {
    "type": "validation.malformed",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-malformed"
  }
}

{
  "error": {
    "type": "auth.invalid_key",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-invalid-key"
  }
}

{
  "error": {
    "type": "auth.disabled_tenancy",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-disabled-tenancy"
  }
}

{
  "error": {
    "type": "validation.not_found",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-not-found"
  }
}

{
  "error": {
    "type": "validation.conflict",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-conflict"
  }
}

{
  "error": {
    "type": "budget.exceeded",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#budget-exceeded"
  }
}

{
  "error": {
    "type": "runtime.internal",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#runtime-internal"
  }
}

Authorize a Connection

Begin one interactive provider authorization, returning the pending Connection, a short-lived hosted connect_url to send the end user to, and its expiry. The request declares the whole boundary up front: an owner Principal, a provider, a label, a non-empty scope set, and 1 to 32 default-deny egress rules. Credential custody handles the secret — Checkfu stores only an opaque handle, and the connect_url is response-only, never persisted on the Connection. Deployment-held mTLS has no interactive URL and is deliberately rejected here; use the Principal hosted-setup operation, which activates it without a credential form. Accepts an Idempotency-Key.

Checkfu support posture: alpha; hosted. Required evidence journey: connection-lifecycle. Deployment-specific readiness and the latest proven release are available from GET /v1/support/capabilities.

POST

connections

authorize

Authorize a Connection

curl --request POST \
  --url https://api.checkfu.com/v1/connections/authorize \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'checkfu-version: <checkfu-version>' \
  --data '
{
  "owner_principal_id": "<string>",
  "provider": "<string>",
  "label": "<string>",
  "scopes": [
    "<string>"
  ],
  "egress_rules": [
    {
      "scheme": "https",
      "host": "<string>",
      "port": 32768,
      "path_prefix": "<string>",
      "methods": [],
      "allowed_headers": [
        "<string>"
      ]
    }
  ]
}
'

import requests

url = "https://api.checkfu.com/v1/connections/authorize"

payload = {
    "owner_principal_id": "<string>",
    "provider": "<string>",
    "label": "<string>",
    "scopes": ["<string>"],
    "egress_rules": [
        {
            "scheme": "https",
            "host": "<string>",
            "port": 32768,
            "path_prefix": "<string>",
            "methods": [],
            "allowed_headers": ["<string>"]
        }
    ]
}
headers = {
    "checkfu-version": "<checkfu-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'checkfu-version': '<checkfu-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    owner_principal_id: '<string>',
    provider: '<string>',
    label: '<string>',
    scopes: ['<string>'],
    egress_rules: [
      {
        scheme: 'https',
        host: '<string>',
        port: 32768,
        path_prefix: '<string>',
        methods: [],
        allowed_headers: ['<string>']
      }
    ]
  })
};

fetch('https://api.checkfu.com/v1/connections/authorize', 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.checkfu.com/v1/connections/authorize",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'owner_principal_id' => '<string>',
    'provider' => '<string>',
    'label' => '<string>',
    'scopes' => [
        '<string>'
    ],
    'egress_rules' => [
        [
                'scheme' => 'https',
                'host' => '<string>',
                'port' => 32768,
                'path_prefix' => '<string>',
                'methods' => [
                                
                ],
                'allowed_headers' => [
                                '<string>'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "checkfu-version: <checkfu-version>"
  ],
]);

$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.checkfu.com/v1/connections/authorize"

	payload := strings.NewReader("{\n  \"owner_principal_id\": \"<string>\",\n  \"provider\": \"<string>\",\n  \"label\": \"<string>\",\n  \"scopes\": [\n    \"<string>\"\n  ],\n  \"egress_rules\": [\n    {\n      \"scheme\": \"https\",\n      \"host\": \"<string>\",\n      \"port\": 32768,\n      \"path_prefix\": \"<string>\",\n      \"methods\": [],\n      \"allowed_headers\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}")

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

	req.Header.Add("checkfu-version", "<checkfu-version>")
	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.post("https://api.checkfu.com/v1/connections/authorize")
  .header("checkfu-version", "<checkfu-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"owner_principal_id\": \"<string>\",\n  \"provider\": \"<string>\",\n  \"label\": \"<string>\",\n  \"scopes\": [\n    \"<string>\"\n  ],\n  \"egress_rules\": [\n    {\n      \"scheme\": \"https\",\n      \"host\": \"<string>\",\n      \"port\": 32768,\n      \"path_prefix\": \"<string>\",\n      \"methods\": [],\n      \"allowed_headers\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/connections/authorize")

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

request = Net::HTTP::Post.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"owner_principal_id\": \"<string>\",\n  \"provider\": \"<string>\",\n  \"label\": \"<string>\",\n  \"scopes\": [\n    \"<string>\"\n  ],\n  \"egress_rules\": [\n    {\n      \"scheme\": \"https\",\n      \"host\": \"<string>\",\n      \"port\": 32768,\n      \"path_prefix\": \"<string>\",\n      \"methods\": [],\n      \"allowed_headers\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}"

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

{
  "connection": {
    "id": "<string>",
    "workspace_id": "<string>",
    "owner_principal_id": "<string>",
    "provider": "<string>",
    "label": "<string>",
    "scopes": [
      "<string>"
    ],
    "egress_rules": [
      {
        "scheme": "https",
        "host": "<string>",
        "port": 32768,
        "path_prefix": "<string>",
        "methods": [
          "GET"
        ],
        "allowed_headers": [
          "<string>"
        ]
      }
    ],
    "custody_adapter": "<string>",
    "lifecycle": "pending",
    "health": "pending",
    "drift": "none",
    "custody_revoke_pending": true,
    "last_health_check_at": "<string>",
    "version": 1,
    "created_at": "<string>",
    "updated_at": "<string>",
    "provider_package": {
      "name": "<string>",
      "version": 1,
      "digest": "<string>",
      "review": "curated"
    }
  },
  "connect_url": "<string>",
  "expires_at": "<string>"
}

{
  "error": {
    "type": "validation.malformed",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-malformed"
  }
}

{
  "error": {
    "type": "auth.invalid_key",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-invalid-key"
  }
}

{
  "error": {
    "type": "auth.disabled_tenancy",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-disabled-tenancy"
  }
}

{
  "error": {
    "type": "validation.not_found",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-not-found"
  }
}

{
  "error": {
    "type": "validation.conflict",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-conflict"
  }
}

{
  "error": {
    "type": "budget.exceeded",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#budget-exceeded"
  }
}

{
  "error": {
    "type": "runtime.internal",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#runtime-internal"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

checkfu-version

enum<string>

required

Available options:

2026-08-24

idempotency-key

string

Maximum string length: 255

Body

application/json

owner_principal_id

string

required

Pattern: ^prin_[0-9a-f]{32}$

provider

string

required

Pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$

label

string

required

Required string length: 1 - 8192

scopes

string[]

required

Required array length: 1 - 256 elements

Required string length: 1 - 512

Pattern: ^[^\s,]+$

egress_rules

object[]

required

Required array length: 1 - 32 elements

Show child attributes

Response

Success

connection

object

required

Show child attributes

connect_url

string

required

Maximum string length: 2048

Pattern: ^https:\/\/[^\s]+$

expires_at

string

required

Developer tools

Canonical tables

Author protocols

Generated HTTP API

Authorize a Connection

Authorizations

Headers

Body

Response