Create an organization seal

curl --request POST \
  --url https://api.firma.dev/functions/v1/signing-request-api/seals \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "display_name": "<string>",
  "statement": {
    "language": "<string>",
    "signatory_name": "<string>",
    "text": "<string>",
    "accepted": true,
    "signatory_title": "<string>",
    "version": 2
  },
  "signatory_title": "<string>",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "image": "<string>",
  "typed": {
    "text": "<string>",
    "style": "<string>"
  },
  "is_default": false
}
'

import requests

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

payload = {
    "name": "<string>",
    "display_name": "<string>",
    "statement": {
        "language": "<string>",
        "signatory_name": "<string>",
        "text": "<string>",
        "accepted": True,
        "signatory_title": "<string>",
        "version": 2
    },
    "signatory_title": "<string>",
    "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "image": "<string>",
    "typed": {
        "text": "<string>",
        "style": "<string>"
    },
    "is_default": False
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    display_name: '<string>',
    statement: {
      language: '<string>',
      signatory_name: '<string>',
      text: '<string>',
      accepted: true,
      signatory_title: '<string>',
      version: 2
    },
    signatory_title: '<string>',
    workspace_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    image: '<string>',
    typed: {text: '<string>', style: '<string>'},
    is_default: false
  })
};

fetch('https://api.firma.dev/functions/v1/signing-request-api/seals', 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",
  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([
    'name' => '<string>',
    'display_name' => '<string>',
    'statement' => [
        'language' => '<string>',
        'signatory_name' => '<string>',
        'text' => '<string>',
        'accepted' => true,
        'signatory_title' => '<string>',
        'version' => 2
    ],
    'signatory_title' => '<string>',
    'workspace_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'image' => '<string>',
    'typed' => [
        'text' => '<string>',
        'style' => '<string>'
    ],
    'is_default' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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.firma.dev/functions/v1/signing-request-api/seals"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"statement\": {\n    \"language\": \"<string>\",\n    \"signatory_name\": \"<string>\",\n    \"text\": \"<string>\",\n    \"accepted\": true,\n    \"signatory_title\": \"<string>\",\n    \"version\": 2\n  },\n  \"signatory_title\": \"<string>\",\n  \"workspace_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"image\": \"<string>\",\n  \"typed\": {\n    \"text\": \"<string>\",\n    \"style\": \"<string>\"\n  },\n  \"is_default\": false\n}")

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

	req.Header.Add("Authorization", "<api-key>")
	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.firma.dev/functions/v1/signing-request-api/seals")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"statement\": {\n    \"language\": \"<string>\",\n    \"signatory_name\": \"<string>\",\n    \"text\": \"<string>\",\n    \"accepted\": true,\n    \"signatory_title\": \"<string>\",\n    \"version\": 2\n  },\n  \"signatory_title\": \"<string>\",\n  \"workspace_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"image\": \"<string>\",\n  \"typed\": {\n    \"text\": \"<string>\",\n    \"style\": \"<string>\"\n  },\n  \"is_default\": false\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"statement\": {\n    \"language\": \"<string>\",\n    \"signatory_name\": \"<string>\",\n    \"text\": \"<string>\",\n    \"accepted\": true,\n    \"signatory_title\": \"<string>\",\n    \"version\": 2\n  },\n  \"signatory_title\": \"<string>\",\n  \"workspace_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"image\": \"<string>\",\n  \"typed\": {\n    \"text\": \"<string>\",\n    \"style\": \"<string>\"\n  },\n  \"is_default\": false\n}"

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,
  "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": "Validation Error",
  "message": "Invalid input data",
  "details": {
    "name": "Name is required",
    "email": "Invalid email format"
  }
}

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

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

{
  "error": "<string>",
  "code": "SEALS_DISABLED"
}

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

{
  "error": "<string>",
  "code": "<string>",
  "errors": [
    {
      "message": "<string>"
    }
  ],
  "message": "<string>",
  "details": {}
}

POST

seals

Create an organization seal

curl --request POST \
  --url https://api.firma.dev/functions/v1/signing-request-api/seals \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "display_name": "<string>",
  "statement": {
    "language": "<string>",
    "signatory_name": "<string>",
    "text": "<string>",
    "accepted": true,
    "signatory_title": "<string>",
    "version": 2
  },
  "signatory_title": "<string>",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "image": "<string>",
  "typed": {
    "text": "<string>",
    "style": "<string>"
  },
  "is_default": false
}
'

import requests

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

payload = {
    "name": "<string>",
    "display_name": "<string>",
    "statement": {
        "language": "<string>",
        "signatory_name": "<string>",
        "text": "<string>",
        "accepted": True,
        "signatory_title": "<string>",
        "version": 2
    },
    "signatory_title": "<string>",
    "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "image": "<string>",
    "typed": {
        "text": "<string>",
        "style": "<string>"
    },
    "is_default": False
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    display_name: '<string>',
    statement: {
      language: '<string>',
      signatory_name: '<string>',
      text: '<string>',
      accepted: true,
      signatory_title: '<string>',
      version: 2
    },
    signatory_title: '<string>',
    workspace_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    image: '<string>',
    typed: {text: '<string>', style: '<string>'},
    is_default: false
  })
};

fetch('https://api.firma.dev/functions/v1/signing-request-api/seals', 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",
  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([
    'name' => '<string>',
    'display_name' => '<string>',
    'statement' => [
        'language' => '<string>',
        'signatory_name' => '<string>',
        'text' => '<string>',
        'accepted' => true,
        'signatory_title' => '<string>',
        'version' => 2
    ],
    'signatory_title' => '<string>',
    'workspace_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'image' => '<string>',
    'typed' => [
        'text' => '<string>',
        'style' => '<string>'
    ],
    'is_default' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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.firma.dev/functions/v1/signing-request-api/seals"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"statement\": {\n    \"language\": \"<string>\",\n    \"signatory_name\": \"<string>\",\n    \"text\": \"<string>\",\n    \"accepted\": true,\n    \"signatory_title\": \"<string>\",\n    \"version\": 2\n  },\n  \"signatory_title\": \"<string>\",\n  \"workspace_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"image\": \"<string>\",\n  \"typed\": {\n    \"text\": \"<string>\",\n    \"style\": \"<string>\"\n  },\n  \"is_default\": false\n}")

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

	req.Header.Add("Authorization", "<api-key>")
	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.firma.dev/functions/v1/signing-request-api/seals")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"statement\": {\n    \"language\": \"<string>\",\n    \"signatory_name\": \"<string>\",\n    \"text\": \"<string>\",\n    \"accepted\": true,\n    \"signatory_title\": \"<string>\",\n    \"version\": 2\n  },\n  \"signatory_title\": \"<string>\",\n  \"workspace_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"image\": \"<string>\",\n  \"typed\": {\n    \"text\": \"<string>\",\n    \"style\": \"<string>\"\n  },\n  \"is_default\": false\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"statement\": {\n    \"language\": \"<string>\",\n    \"signatory_name\": \"<string>\",\n    \"text\": \"<string>\",\n    \"accepted\": true,\n    \"signatory_title\": \"<string>\",\n    \"version\": 2\n  },\n  \"signatory_title\": \"<string>\",\n  \"workspace_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"image\": \"<string>\",\n  \"typed\": {\n    \"text\": \"<string>\",\n    \"style\": \"<string>\"\n  },\n  \"is_default\": false\n}"

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,
  "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": "Validation Error",
  "message": "Invalid input data",
  "details": {
    "name": "Name is required",
    "email": "Invalid email format"
  }
}

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

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

{
  "error": "<string>",
  "code": "SEALS_DISABLED"
}

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

{
  "error": "<string>",
  "code": "<string>",
  "errors": [
    {
      "message": "<string>"
    }
  ],
  "message": "<string>",
  "details": {}
}

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.

Body

application/json

Request body to create an organization seal.

name

string

required

Internal name for the seal

Maximum string length: 120

display_name

string

required

Display name rendered on the seal image

Maximum string length: 200

kind

enum<string>

required

How the seal image was created

Available options:

uploaded,

typed,

drawn

scope

enum<string>

required

Scope of the seal. Company-scope requires a protected API key.

Available options:

company,

workspace

statement

object

required

Attestation statement affirming authority to apply the seal.

Show child attributes

signatory_title

string | null

Signatory title rendered on the seal image

Maximum string length: 200

workspace_id

string<uuid>

Required when scope is 'workspace'

image

string

Base64-encoded PNG data URI (data:image/png;base64,...). Required for 'uploaded' and 'drawn' kinds.

typed

object

Typed seal parameters. Required for 'typed' kind.

Show child attributes

is_default

boolean

default:false

Set as default seal for this scope

Response

Seal created 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

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