Firma

https://docs.firma.dev
Admin
Firma is an e-signature API platform that enables developers to add document signing, template...
Tokens:568,696
Snippets:2,717
Trust Score:6.6
Update:3 months ago
Show doc for...
Tokens:
Raw
### Finalize Domain Setup Response

Source: https://docs.firma.dev/api-reference/v01.19.00/openapi-v01.19.00.json

Example response for finalizing domain setup, providing necessary DNS records.

```json
{
  "message": "Domain finalized. Add the following DNS records to enable email sending."
```

--------------------------------

### List Webhooks Request Examples

Source: https://docs.firma.dev/api-reference/v01.16.00/webhooks/list-webhooks

Examples of how to perform a GET request to retrieve webhooks using Go, Java, and Ruby.

```go
package main  
  
import (  
	"fmt"  
	"net/http"  
	"io"  
)  
  
func main() {  
  
	url := "https://api.firma.dev/functions/v1/signing-request-api/webhooks?page=1&page_size=50&sort_by=created_on&sort_order=desc"  
  
	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))  
  
}
```

```java
HttpResponse<String> response = Unirest.get("https://api.firma.dev/functions/v1/signing-request-api/webhooks?page=1&page_size=50&sort_by=created_on&sort_order=desc")  
  .header("Authorization", "<api-key>")  
  .asString();
```

```ruby
require 'uri'  
require 'net/http'  
  
url = URI("https://api.firma.dev/functions/v1/signing-request-api/webhooks?page=1&page_size=50&sort_by=created_on&sort_order=desc")  
  
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
```

--------------------------------

### List Workspace Domains Request Examples

Source: https://docs.firma.dev/api-reference/v01.16.00/email-domains/list-workspace-domains

Examples of how to perform a GET request to retrieve workspace domains using Go, Java, and Ruby.

```go
package main  
  
import (  
	"fmt"  
	"net/http"  
	"io"  
)  
  
func main() {  
  
	url := "https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains"  
  
	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))  
  
}
```

```java
HttpResponse<String> response = Unirest.get("https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains")  
  .header("Authorization", "<api-key>")  
  .asString();
```

```ruby
require 'uri'  
require 'net/http'  
  
url = URI("https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains")  
  
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
```

--------------------------------

### Finalize Workspace Domain Setup

Source: https://docs.firma.dev/api-reference/v01.31.00/email-domains/finalize-workspace-domain-setup

Examples for finalizing a domain setup across various programming languages and environments.

```TypeScript
import { FirmaClient } from "@firma-dev/sdk";

const firma = new FirmaClient({ apiKey: "YOUR_API_KEY" });

const response = await firma.emailDomains.finalizeWorkspaceDomain({
    workspace_id: "workspace_id",
    id: "id"
});
console.log(response);
```

```bash
curl --request POST \
  --url https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains/{id}/finalize \
  --header 'Authorization: <api-key>'
```

```python
import requests

url = "https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains/{id}/finalize"

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

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

print(response.text)
```

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

fetch('https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains/{id}/finalize', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains/{id}/finalize",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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;
}
```

```go
package main

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

func main() {

	url := "https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains/{id}/finalize"

	req, _ := http.NewRequest("POST", 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))

}
```

```java
HttpResponse<String> response = Unirest.post("https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains/{id}/finalize")
  .header("Authorization", "<api-key>")
  .asString();
```

```ruby
require 'uri'
require 'net/http'

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

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

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

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

--------------------------------

### Finalize Domain Setup API Requests

Source: https://docs.firma.dev/api-reference/v01.17.00/email-domains/finalize-domain-setup

Examples of how to call the finalize domain setup endpoint using various programming languages and tools.

```bash
curl --request POST \
  --url https://api.firma.dev/functions/v1/signing-request-api/company/domains/{id}/finalize \
  --header 'Authorization: <api-key>'
```

```python
import requests  
  
url = "https://api.firma.dev/functions/v1/signing-request-api/company/domains/{id}/finalize"  
  
headers = {"Authorization": "<api-key>"}  
  
response = requests.post(url, headers=headers)  
  
print(response.text)
```

```javascript
const options = {method: 'POST', headers: {Authorization: '<api-key>'}};  
  
fetch('https://api.firma.dev/functions/v1/signing-request-api/company/domains/{id}/finalize', options)  
  .then(res => res.json())  
  .then(res => console.log(res))  
  .catch(err => console.error(err));
```

```php
<?php  
  
$curl = curl_init();  
  
curl_setopt_array($curl, [  
  CURLOPT_URL => "https://api.firma.dev/functions/v1/signing-request-api/company/domains/{id}/finalize",  
  CURLOPT_RETURNTRANSFER => true,  
  CURLOPT_ENCODING => "",  
  CURLOPT_MAXREDIRS => 10,  
  CURLOPT_TIMEOUT => 30,  
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,  
  CURLOPT_CUSTOMREQUEST => "POST",  
  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;  
}
```

```go
package main  
  
import (  
	"fmt"  
	"net/http"  
	"io"  
)  
  
func main() {  
  
	url := "https://api.firma.dev/functions/v1/signing-request-api/company/domains/{id}/finalize"  
  
	req, _ := http.NewRequest("POST", 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))  
  
}
```

```java
HttpResponse<String> response = Unirest.post("https://api.firma.dev/functions/v1/signing-request-api/company/domains/{id}/finalize")  
  .header("Authorization", "<api-key>")  
  .asString();
```

```ruby
require 'uri'  
require 'net/http'  
  
url = URI("https://api.firma.dev/functions/v1/signing-request-api/company/domains/{id}/finalize")  
  
http = Net::HTTP.new(url.host, url.port)  
http.use_ssl = true  
  
request = Net::HTTP::Post.new(url)  
request["Authorization"] = '<api-key>'  
  
response = http.request(request)  
puts response.read_body
```

--------------------------------

### List Company Domains Request Examples

Source: https://docs.firma.dev/api-reference/v01.31.00/email-domains/list-company-domains

Examples of how to perform a GET request to retrieve company domains using Go, Java, and Ruby.

```go
package main  
  
import (  
	"fmt"  
	"net/http"  
	"io"  
)  
  
func main() {  
  
	url := "https://api.firma.dev/functions/v1/signing-request-api/company/domains"  
  
	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))  
  
}
```

```java
HttpResponse<String> response = Unirest.get("https://api.firma.dev/functions/v1/signing-request-api/company/domains")  
  .header("Authorization", "<api-key>")  
  .asString();
```

```ruby
require 'uri'  
require 'net/http'  
  
url = URI("https://api.firma.dev/functions/v1/signing-request-api/company/domains")  
  
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
```

--------------------------------

### Get Signing Request API Examples

Source: https://docs.firma.dev/api-reference/v01.16.00/signing-requests/get-signing-request

Examples for retrieving a signing request using various programming languages and HTTP clients.

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

```python
import requests  
  
url = "https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}"  
  
headers = {"Authorization": "<api-key>"}  
  
response = requests.get(url, headers=headers)  
  
print(response.text)
```

```javascript
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};  
  
fetch('https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}', options)  
  .then(res => res.json())  
  .then(res => console.log(res))  
  .catch(err => console.error(err));
```

```php
<?php  
  
$curl = curl_init();  
  
curl_setopt_array($curl, [  
  CURLOPT_URL => "https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{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;  
}
```

```go
package main  
  
import (  
	"fmt"  
	"net/http"  
	"io"  
)  
  
func main() {  
  
	url := "https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{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))  
  
}
```

```java
HttpResponse<String> response = Unirest.get("https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}")  
  .header("Authorization", "<api-key>")  
  .asString();
```

```ruby
require 'uri'  
require 'net/http'  
  
url = URI("https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{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
```

--------------------------------

### Finalize domain setup requests

Source: https://docs.firma.dev/api-reference/v01.17.00/email-domains/finalize-domain-setup

Examples of how to perform the POST request to finalize a domain using various programming languages.

```go
package main  
  
import (  
	"fmt"  
	"net/http"  
	"io"  
)  
  
func main() {  
  
	url := "https://api.firma.dev/functions/v1/signing-request-api/company/domains/{id}/finalize"  
  
	req, _ := http.NewRequest("POST", 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))  
  
}
```

```java
HttpResponse<String> response = Unirest.post("https://api.firma.dev/functions/v1/signing-request-api/company/domains/{id}/finalize")  
  .header("Authorization", "<api-key>")  
  .asString();
```

```ruby
require 'uri'  
require 'net/http'  
  
url = URI("https://api.firma.dev/functions/v1/signing-request-api/company/domains/{id}/finalize")  
  
http = Net::HTTP.new(url.host, url.port)  
http.use_ssl = true  
  
request = Net::HTTP::Post.new(url)  
request["Authorization"] = '<api-key>'  
  
response = http.request(request)  
puts response.read_body
```

--------------------------------

### List Company Signer Terms Request Examples

Source: https://docs.firma.dev/api-reference/v01.31.00/signer-terms/list-company-signer-terms

Examples of how to perform a GET request to retrieve company signer terms using Go, Java, and Ruby.

```go
package main  
  
import (  
	"fmt"  
	"net/http"  
	"io"  
)  
  
func main() {  
  
	url := "https://api.firma.dev/functions/v1/signing-request-api/company/signer-terms"  
  
	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))  
  
}
```

```java
HttpResponse<String> response = Unirest.get("https://api.firma.dev/functions/v1/signing-request-api/company/signer-terms")  
  .header("Authorization", "<api-key>")  
  .asString();
```

```ruby
require 'uri'  
require 'net/http'  
  
url = URI("https://api.firma.dev/functions/v1/signing-request-api/company/signer-terms")  
  
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
```

--------------------------------

### Retrieve Workspace Details

Source: https://docs.firma.dev/api-reference/v01.16.00/workspaces/get-a-workspace

Examples of how to perform a GET request to fetch workspace data across various programming languages.

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

```python
import requests  
  
url = "https://api.firma.dev/functions/v1/signing-request-api/workspaces/{id}"  
  
headers = {"Authorization": "<api-key>"}  
  
response = requests.get(url, headers=headers)  
  
print(response.text)
```

```javascript
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};  
  
fetch('https://api.firma.dev/functions/v1/signing-request-api/workspaces/{id}', options)  
  .then(res => res.json())  
  .then(res => console.log(res))  
  .catch(err => console.error(err));
```

```php
<?php  
  
$curl = curl_init();  
  
curl_setopt_array($curl, [  
  CURLOPT_URL => "https://api.firma.dev/functions/v1/signing-request-api/workspaces/{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;  
}
```

```go
package main  
  
import (  
	"fmt"  
	"net/http"  
	"io"  
)  
  
func main() {  
  
	url := "https://api.firma.dev/functions/v1/signing-request-api/workspaces/{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))  
  
}
```

```java
HttpResponse<String> response = Unirest.get("https://api.firma.dev/functions/v1/signing-request-api/workspaces/{id}")  
  .header("Authorization", "<api-key>")  
  .asString();
```

```ruby
require 'uri'  
require 'net/http'  
  
url = URI("https://api.firma.dev/functions/v1/signing-request-api/workspaces/{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
```

--------------------------------

### Download Signing Request API Examples

Source: https://docs.firma.dev/api-reference/v01.16.00/signing-requests/download-signing-request

Use these examples to perform a GET request to the signing request download endpoint. Replace {id} with the specific request ID and <api-key> with your authorization token.

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

```python
import requests  
  
url = "https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/download"  
  
headers = {"Authorization": "<api-key>"}  
  
response = requests.get(url, headers=headers)  
  
print(response.text)
```

```javascript
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};  
  
fetch('https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/download', options)  
  .then(res => res.json())  
  .then(res => console.log(res))  
  .catch(err => console.error(err));
```

```php
<?php  
  
$curl = curl_init();  
  
curl_setopt_array($curl, [  
  CURLOPT_URL => "https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/download",  
  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;  
}
```

```go
package main  
  
import (  
	"fmt"  
	"net/http"  
	"io"  
)  
  
func main() {  
  
	url := "https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/download"  
  
	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))  
  
}
```

```java
HttpResponse<String> response = Unirest.get("https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/download")  
  .header("Authorization", "<api-key>")  
  .asString();
```

```ruby
require 'uri'
require 'net/http'
  
url = URI("https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/download")
  
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
```

--------------------------------

### Retrieve Company Information Example

Source: https://docs.firma.dev/api-reference/v01.17.00/openapi-v01.17.00.json

Example response body for the GET /company endpoint.

```json
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Acme Corporation",
  "language": "en",
  "account_owner": "John Doe",
  "account_owner_email": "john@acme.com"
```

--------------------------------

### Install the Firma.dev SDK

Source: https://docs.firma.dev/guides/typescript-sdk

Install the package using your preferred package manager.

```bash
npm install @firma-dev/sdk
```

```bash
pnpm add @firma-dev/sdk
```

```bash
yarn add @firma-dev/sdk
```

--------------------------------

### Finalize domain setup with Go

Source: https://docs.firma.dev/api-reference/v01.16.00/email-domains/finalize-domain-setup

Use the net/http package to perform the POST request.

```go
package main  
  
import (  
	"fmt"  
	"net/http"  
	"io"  
)  
  
func main() {  
  
	url := "https://api.firma.dev/functions/v1/signing-request-api/company/domains/{id}/finalize"  
  
	req, _ := http.NewRequest("POST", 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))  
  
}
```

--------------------------------

### Finalize domain setup with Ruby

Source: https://docs.firma.dev/api-reference/v01.16.00/email-domains/finalize-domain-setup

Use the Net::HTTP library to perform the POST request.

```ruby
require 'uri'  
require 'net/http'  
  
url = URI("https://api.firma.dev/functions/v1/signing-request-api/company/domains/{id}/finalize")  
  
http = Net::HTTP.new(url.host, url.port)  
http.use_ssl = true  
  
request = Net::HTTP::Post.new(url)  
request["Authorization"] = '<api-key>'  
  
response = http.request(request)  
puts response.read_body
```

--------------------------------

### Get Template Users Response Example

Source: https://docs.firma.dev/api-reference/v01.21.00/openapi-v01.21.00.json

Example JSON response body containing a list of users associated with a specific template.

```json
{
  "results": [
    {
      "id": "abc12345-e89b-12d3-a456-426614174000",
      "name": "John Doe",
      "email": "john@example.com",
      "first_name": "John",
      "last_name": "Doe"
```

--------------------------------

### Get embedded signing request data examples

Source: https://docs.firma.dev/api-reference/v01.16.00/signing-requests/get-embedded-signing-request-data-jwt-authenticated

Examples for retrieving signing request data across various programming languages.

```curl
curl --request POST \
  --url https://api.firma.dev/functions/v1/signing-request-api/get-embedded-signing-request \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "companies_workspaces_signing_requests_id": "123e4567-e89b-12d3-a456-426614174000"
}
'
```

```python
import requests  
  
url = "https://api.firma.dev/functions/v1/signing-request-api/get-embedded-signing-request"  
  
payload = { "companies_workspaces_signing_requests_id": "123e4567-e89b-12d3-a456-426614174000" }  
headers = {  
    "Authorization": "<api-key>",  
    "Content-Type": "application/json"  
}  
  
response = requests.post(url, json=payload, headers=headers)  
  
print(response.text)
```

```javascript
const options = {  
  method: 'POST',  
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},  
  body: JSON.stringify({  
    companies_workspaces_signing_requests_id: '123e4567-e89b-12d3-a456-426614174000'  
  })  
};  
  
fetch('https://api.firma.dev/functions/v1/signing-request-api/get-embedded-signing-request', options)  
  .then(res => res.json())  
  .then(res => console.log(res))  
  .catch(err => console.error(err));
```

```php
<?php  
  
$curl = curl_init();  
  
curl_setopt_array($curl, [  
  CURLOPT_URL => "https://api.firma.dev/functions/v1/signing-request-api/get-embedded-signing-request",  
  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([  
    'companies_workspaces_signing_requests_id' => '123e4567-e89b-12d3-a456-426614174000'  
  ]),  
  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;  
}
```

```go
package main  
  
import (  
	"fmt"  
	"strings"  
	"net/http"  
	"io"  
)  
  
func main() {  
  
	url := "https://api.firma.dev/functions/v1/signing-request-api/get-embedded-signing-request"  
  
payload := strings.NewReader("{\n  \"companies_workspaces_signing_requests_id\": \"123e4567-e89b-12d3-a456-426614174000\"\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))  
  
}
```

```java
HttpResponse<String> response = Unirest.post("https://api.firma.dev/functions/v1/signing-request-api/get-embedded-signing-request")  
  .header("Authorization", "<api-key>")  
  .header("Content-Type", "application/json")  
  .body("{\n  \"companies_workspaces_signing_requests_id\": \"123e4567-e89b-12d3-a456-426614174000\"\n}")  
  .asString();
```

```ruby
require 'uri'  
require 'net/http'  
  
url = URI("https://api.firma.dev/functions/v1/signing-request-api/get-embedded-signing-request")  
  
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  \"companies_workspaces_signing_requests_id\": \"123e4567-e89b-12d3-a456-426614174000\"\n}"  
  
response = http.request(request)  
puts response.read_body
```

--------------------------------

### Create Signing Request Examples

Source: https://docs.firma.dev/api-reference/v01.31.00/signing-requests/create-signing-request

Examples showing how to send a POST request to create a signing request using different programming languages.

```php
<?php  
  
$curl = curl_init();  
  
curl_setopt_array($curl, [  
  CURLOPT_URL => "https://api.firma.dev/functions/v1/signing-request-api/signing-requests",  
  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' => 'Updated Contract Name',  
    'expiration_hours' => 72  
  ]),  
  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;  
}
```

```go
package main  
  
import (  
	"fmt"  
	"strings"  
	"net/http"  
	"io"  
)  
  
func main() {  
  
	url := "https://api.firma.dev/functions/v1/signing-request-api/signing-requests"  
  
	payload := strings.NewReader("{\n  \"name\": \"Updated Contract Name\",\n  \"expiration_hours\": 72\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))  
  
}
```

```java
HttpResponse<String> response = Unirest.post("https://api.firma.dev/functions/v1/signing-request-api/signing-requests")  
  .header("Authorization", "<api-key>")  
  .header("Content-Type", "application/json")  
  .body("{\n  \"name\": \"Updated Contract Name\",\n  \"expiration_hours\": 72\n}")  
  .asString();
```

```ruby
require 'uri'
require 'net/http'
  
url = URI("https://api.firma.dev/functions/v1/signing-request-api/signing-requests")
  
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\": \"Updated Contract Name\",\n  \"expiration_hours\": 72\n}"
  
response = http.request(request)
puts response.read_body
```

--------------------------------

### Finalize domain setup with JavaScript

Source: https://docs.firma.dev/api-reference/v01.16.00/email-domains/finalize-domain-setup

Use the fetch API to perform the POST request.

```javascript
const options = {method: 'POST', headers: {Authorization: '<api-key>'}};  
  
fetch('https://api.firma.dev/functions/v1/signing-request-api/company/domains/{id}/finalize', options)  
  .then(res => res.json())  
  .then(res => console.log(res))  
  .catch(err => console.error(err));
```

--------------------------------

### Finalize domain setup with PHP

Source: https://docs.firma.dev/api-reference/v01.16.00/email-domains/finalize-domain-setup

Use the cURL extension to execute the POST request.

```php
<?php  
  
$curl = curl_init();  
  
curl_setopt_array($curl, [  
  CURLOPT_URL => "https://api.firma.dev/functions/v1/signing-request-api/company/domains/{id}/finalize",  
  CURLOPT_RETURNTRANSFER => true,  
  CURLOPT_ENCODING => "",  
  CURLOPT_MAXREDIRS => 10,  
  CURLOPT_TIMEOUT => 30,  
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,  
  CURLOPT_CUSTOMREQUEST => "POST",  
  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;  
}
```

--------------------------------

### Get Workspace Email Template Request

Source: https://docs.firma.dev/api-reference/v01.16.00/email-templates/get-workspace-email-template

Examples of how to perform a GET request to retrieve an email template using various programming languages.

```go
package main  
  
import (  
	"fmt"  
	"net/http"  
	"io"  
)  
  
func main() {  
  
	url := "https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/email-templates/{email_type}"  
  
	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))  
  
}
```

```java
HttpResponse<String> response = Unirest.get("https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/email-templates/{email_type}")  
  .header("Authorization", "<api-key>")  
  .asString();
```

```ruby
require 'uri'  
require 'net/http'  
  
url = URI("https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/email-templates/{email_type}")  
  
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
```

--------------------------------

### Update Workspace Settings API Examples

Source: https://docs.firma.dev/api-reference/v01.31.00/workspace-settings/update-workspace-settings

Examples demonstrating how to perform a PUT request to update workspace settings using Go, Java (Unirest), and Ruby.

```go
package main  
  
import (  
	"fmt"  
	"strings"  
	"net/http"  
	"io"  
)  
  
func main() {  
  
	url := "https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/settings"  
  
	payload := strings.NewReader("{\n  \"signing_request_email_header\": \"<string>\",\n  \"signing_request_email_body\": \"<string>\",\n  \"team_email\": \"jsmith@example.com\",\n  \"timezone\": \"<string>\",\n  \"show_credit_cost_in_editor\": true,\n  \"require_otp_verification\": true,\n  \"require_terms_acceptance\": true,\n  \"disable_guided_navigation\": true,\n  \"show_signature_frame\": true,\n  \"color_primary\": \"<string>\",\n  \"color_primary_fg\": \"<string>\",\n  \"color_background\": \"<string>\",\n  \"color_foreground\": \"<string>\",\n  \"color_card\": \"<string>\",\n  \"color_border\": \"<string>\",\n  \"color_accent\": \"<string>\",\n  \"color_accent_fg\": \"<string>\",\n  \"color_canvas\": \"<string>\",\n  \"color_muted\": \"<string>\",\n  \"color_muted_fg\": \"<string>\",\n  \"email_local_part\": \"<string>\",\n  \"allow_presigning_download\": true,\n  \"show_partial_watermark\": true,\n  \"show_qr_code\": true,\n  \"signing_button_label_overrides\": {}\n}")  
  
	req, _ := http.NewRequest("PUT", 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))  
  
}
```

```java
HttpResponse<String> response = Unirest.put("https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/settings")  
  .header("Authorization", "<api-key>")  
  .header("Content-Type", "application/json")  
  .body("{\n  \"signing_request_email_header\": \"<string>\",\n  \"signing_request_email_body\": \"<string>\",\n  \"team_email\": \"jsmith@example.com\",\n  \"timezone\": \"<string>\",\n  \"show_credit_cost_in_editor\": true,\n  \"require_otp_verification\": true,\n  \"require_terms_acceptance\": true,\n  \"disable_guided_navigation\": true,\n  \"show_signature_frame\": true,\n  \"color_primary\": \"<string>\",\n  \"color_primary_fg\": \"<string>\",\n  \"color_background\": \"<string>\",\n  \"color_foreground\": \"<string>\",\n  \"color_card\": \"<string>\",\n  \"color_border\": \"<string>\",\n  \"color_accent\": \"<string>\",\n  \"color_accent_fg\": \"<string>\",\n  \"color_canvas\": \"<string>\",\n  \"color_muted\": \"<string>\",\n  \"color_muted_fg\": \"<string>\",\n  \"email_local_part\": \"<string>\",\n  \"allow_presigning_download\": true,\n  \"show_partial_watermark\": true,\n  \"show_qr_code\": true,\n  \"signing_button_label_overrides\": {}\n}")  
  .asString();
```

```ruby
require 'uri'  
require 'net/http'  
  
url = URI("https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/settings")  
  
http = Net::HTTP.new(url.host, url.port)  
http.use_ssl = true  
  
request = Net::HTTP::Put.new(url)  
request["Authorization"] = '<api-key>'  
request["Content-Type"] = 'application/json'  
request.body = "{\n  \"signing_request_email_header\": \"<string>\",\n  \"signing_request_email_body\": \"<string>\",\n  \"team_email\": \"jsmith@example.com\",\n  \"timezone\": \"<string>\",\n  \"show_credit_cost_in_editor\": true,\n  \"require_otp_verification\": true,\n  \"require_terms_acceptance\": true,\n  \"disable_guided_navigation\": true,\n  \"show_signature_frame\": true,\n  \"color_primary\": \"<string>\",\n  \"color_primary_fg\": \"<string>\",\n  \"color_background\": \"<string>\",\n  \"color_foreground\": \"<string>\",\n  \"color_card\": \"<string>\",\n  \"color_border\": \"<string>\",\n  \"color_accent\": \"<string>\",\n  \"color_accent_fg\": \"<string>\",\n  \"color_canvas\": \"<string>\",\n  \"color_muted\": \"<string>\",\n  \"color_muted_fg\": \"<string>\",\n  \"email_local_part\": \"<string>\",\n  \"allow_presigning_download\": true,\n  \"show_partial_watermark\": true,\n  \"show_qr_code\": true,\n  \"signing_button_label_overrides\": {}\n}"  
  
response = http.request(request)  
puts response.read_body
```

--------------------------------

### Get Workspace Domain API Requests

Source: https://docs.firma.dev/api-reference/v01.16.00/email-domains/get-workspace-domain

Examples of how to perform a GET request to retrieve domain information using various programming languages.

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

```python
import requests  
  
url = "https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains/{id}"  
  
headers = {"Authorization": "<api-key>"}  
  
response = requests.get(url, headers=headers)  
  
print(response.text)
```

```javascript
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};  
  
fetch('https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains/{id}', options)  
  .then(res => res.json())  
  .then(res => console.log(res))  
  .catch(err => console.error(err));
```

```php
<?php  
  
$curl = curl_init();  
  
curl_setopt_array($curl, [  
  CURLOPT_URL => "https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains/{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;  
}
```

```go
package main  
  
import (  
	"fmt"  
	"net/http"  
	"io"  
)  
  
func main() {  
  
	url := "https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains/{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))  
  
}
```

```java
HttpResponse<String> response = Unirest.get("https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains/{id}")  
  .header("Authorization", "<api-key>")  
  .asString();
```

```ruby
require 'uri'
require 'net/http'
  
url = URI("https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains/{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
```
Tokens:
Raw