Get an organization seal

curl --request GET \
  --url https://api.firma.dev/functions/v1/signing-request-api/seals/{id} \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.firma.dev/functions/v1/signing-request-api/seals/{id}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.firma.dev/functions/v1/signing-request-api/seals/{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.firma.dev/functions/v1/signing-request-api/seals/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.firma.dev/functions/v1/signing-request-api/seals/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.firma.dev/functions/v1/signing-request-api/seals/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "lineage_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "version": 2,
  "companies_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companies_workspaces_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "authority_name": "<string>",
  "name": "<string>",
  "display_name": "<string>",
  "signatory_title": "<string>",
  "kind": "uploaded",
  "is_default": 0,
  "statement_language": "<string>",
  "statement_version": 2,
  "statement_text": "<string>",
  "statement_hash": "<string>",
  "signatory_name": "<string>",
  "signatory_title_attested": "<string>",
  "attested_at": "2023-11-07T05:31:56Z",
  "revoked_on": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "deleted": 0
}

{
  "error": "Unauthorized",
  "message": "Invalid API key"
}

{
  "error": "Forbidden",
  "message": "You do not have permission to access this resource"
}

{
  "error": "Not Found",
  "message": "The requested resource was not found"
}

{
  "error": "Rate Limit Exceeded",
  "message": "Too many requests. Please wait before retrying.",
  "details": {
    "retry_after": 45
  }
}

GET

seals

{id}

Get an organization seal

curl --request GET \
  --url https://api.firma.dev/functions/v1/signing-request-api/seals/{id} \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.firma.dev/functions/v1/signing-request-api/seals/{id}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.firma.dev/functions/v1/signing-request-api/seals/{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.firma.dev/functions/v1/signing-request-api/seals/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.firma.dev/functions/v1/signing-request-api/seals/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.firma.dev/functions/v1/signing-request-api/seals/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "lineage_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "version": 2,
  "companies_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companies_workspaces_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "authority_name": "<string>",
  "name": "<string>",
  "display_name": "<string>",
  "signatory_title": "<string>",
  "kind": "uploaded",
  "is_default": 0,
  "statement_language": "<string>",
  "statement_version": 2,
  "statement_text": "<string>",
  "statement_hash": "<string>",
  "signatory_name": "<string>",
  "signatory_title_attested": "<string>",
  "attested_at": "2023-11-07T05:31:56Z",
  "revoked_on": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "deleted": 0
}

{
  "error": "Unauthorized",
  "message": "Invalid API key"
}

{
  "error": "Forbidden",
  "message": "You do not have permission to access this resource"
}

{
  "error": "Not Found",
  "message": "The requested resource was not found"
}

{
  "error": "Rate Limit Exceeded",
  "message": "Too many requests. Please wait before retrying.",
  "details": {
    "retry_after": 45
  }
}

Authorizations

Authorization

string

header

required

API key for authentication. Use your API key directly without any prefix (e.g., 'your-api-key'). Bearer prefix is optional but not required.

Path Parameters

string<uuid>

required

Seal ID

Response

Seal retrieved successfully

Organization seal metadata (image and statement internals are stripped from list/get responses).

string<uuid>

lineage_id

string<uuid>

Shared across versions of the same seal

version

integer

Required range: x >= 1

companies_id

string<uuid>

companies_workspaces_id

string<uuid> | null

Null for company-scope seals

authority_name

string | null

The name the seal was attested for: the company for company scope or the protected workspace, otherwise the workspace. Null for seals whose lineage was created before pinning; they certify in the company's current name.

name

string

Maximum string length: 120

display_name

string

Maximum string length: 200

signatory_title

string | null

Maximum string length: 200

kind

enum<string>

Available options:

uploaded,

typed,

drawn

is_default

enum<integer>

1 if this is the default seal for its scope

Available options:

0,

1

statement_language

string

statement_version

integer

Required range: x >= 1

statement_text

string

The authority statement the seal was attested under, stored verbatim. Write-once: it never changes across versions of a lineage.

statement_hash

string

SHA-256 of statement_text (UTF-8), lowercase hex.

signatory_name

string

Maximum string length: 200

signatory_title_attested

string | null

Maximum string length: 200

attested_at

string<date-time>

revoked_on

string<date-time> | null

created_at

string<date-time>

deleted

enum<integer>

Available options:

0,

1