Issue an installation pairing proof

curl --request POST \
  --url https://api.checkfu.com/v1/external-installations/pairing-proofs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'checkfu-version: <checkfu-version>' \
  --data '
{
  "operation": "create",
  "provider": "<string>",
  "external_tenant_id": "<string>",
  "external_installation_id": "<unknown>"
}
'

import requests

url = "https://api.checkfu.com/v1/external-installations/pairing-proofs"

payload = {
    "operation": "create",
    "provider": "<string>",
    "external_tenant_id": "<string>",
    "external_installation_id": "<unknown>"
}
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({
    operation: 'create',
    provider: '<string>',
    external_tenant_id: '<string>',
    external_installation_id: '<unknown>'
  })
};

fetch('https://api.checkfu.com/v1/external-installations/pairing-proofs', 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/external-installations/pairing-proofs",
  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([
    'operation' => 'create',
    'provider' => '<string>',
    'external_tenant_id' => '<string>',
    'external_installation_id' => '<unknown>'
  ]),
  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/external-installations/pairing-proofs"

	payload := strings.NewReader("{\n  \"operation\": \"create\",\n  \"provider\": \"<string>\",\n  \"external_tenant_id\": \"<string>\",\n  \"external_installation_id\": \"<unknown>\"\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/external-installations/pairing-proofs")
  .header("checkfu-version", "<checkfu-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"operation\": \"create\",\n  \"provider\": \"<string>\",\n  \"external_tenant_id\": \"<string>\",\n  \"external_installation_id\": \"<unknown>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/external-installations/pairing-proofs")

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  \"operation\": \"create\",\n  \"provider\": \"<string>\",\n  \"external_tenant_id\": \"<string>\",\n  \"external_installation_id\": \"<unknown>\"\n}"

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

{
  "issued_at": "<string>",
  "expires_at": "<string>",
  "nonce": "<string>",
  "signature": "<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.idempotency_conflict",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-idempotency-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"
  }
}

Issue an installation pairing proof

Mints a short-lived, single-use pairing proof bound to the caller’s authorization scope, the named provider tenant, and one exact operation — create for a new collaboration installation, or reactivate naming the existing external_installation_id. The proof lives at most five minutes and is consumed by the operation it names; every other use is denied. Pass the returned object verbatim as pairing_proof.

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

POST

external-installations

pairing-proofs

Issue an installation pairing proof

curl --request POST \
  --url https://api.checkfu.com/v1/external-installations/pairing-proofs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'checkfu-version: <checkfu-version>' \
  --data '
{
  "operation": "create",
  "provider": "<string>",
  "external_tenant_id": "<string>",
  "external_installation_id": "<unknown>"
}
'

import requests

url = "https://api.checkfu.com/v1/external-installations/pairing-proofs"

payload = {
    "operation": "create",
    "provider": "<string>",
    "external_tenant_id": "<string>",
    "external_installation_id": "<unknown>"
}
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({
    operation: 'create',
    provider: '<string>',
    external_tenant_id: '<string>',
    external_installation_id: '<unknown>'
  })
};

fetch('https://api.checkfu.com/v1/external-installations/pairing-proofs', 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/external-installations/pairing-proofs",
  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([
    'operation' => 'create',
    'provider' => '<string>',
    'external_tenant_id' => '<string>',
    'external_installation_id' => '<unknown>'
  ]),
  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/external-installations/pairing-proofs"

	payload := strings.NewReader("{\n  \"operation\": \"create\",\n  \"provider\": \"<string>\",\n  \"external_tenant_id\": \"<string>\",\n  \"external_installation_id\": \"<unknown>\"\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/external-installations/pairing-proofs")
  .header("checkfu-version", "<checkfu-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"operation\": \"create\",\n  \"provider\": \"<string>\",\n  \"external_tenant_id\": \"<string>\",\n  \"external_installation_id\": \"<unknown>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/external-installations/pairing-proofs")

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  \"operation\": \"create\",\n  \"provider\": \"<string>\",\n  \"external_tenant_id\": \"<string>\",\n  \"external_installation_id\": \"<unknown>\"\n}"

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

{
  "issued_at": "<string>",
  "expires_at": "<string>",
  "nonce": "<string>",
  "signature": "<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.idempotency_conflict",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-idempotency-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-27

idempotency-key

string

Maximum string length: 255

Body

application/json

Option 1
Option 2

operation

enum<string>

required

Available options:

create

provider

string

required

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

external_tenant_id

string

required

Required string length: 1 - 512

external_installation_id

any

Response

Success

issued_at

string

required

Required string length: 20 - 64

expires_at

string

required

Required string length: 20 - 64

nonce

string

required

Required string length: 16 - 128

Pattern: ^[A-Za-z0-9_-]+$

signature

string

required

Required string length: 43

Pattern: ^[A-Za-z0-9_-]{43}$

Developer tools

Canonical tables

Author protocols

Generated HTTP API

Issue an installation pairing proof

Authorizations

Headers

Body

Response