Get customer required signings

Get all required signings for a customer

GET /customers/{id}/required-signings

Get customer required signings

cURL

curl --request GET \
  --url https://api.sandbox.iron.xyz/api/customers/{id}/required-signings \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.sandbox.iron.xyz/api/customers/{id}/required-signings"

headers = {"X-API-Key": "<api-key>"}

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

print(response.text)

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

fetch('https://api.sandbox.iron.xyz/api/customers/{id}/required-signings', 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.sandbox.iron.xyz/api/customers/{id}/required-signings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <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.sandbox.iron.xyz/api/customers/{id}/required-signings"

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

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.sandbox.iron.xyz/api/customers/{id}/required-signings")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.iron.xyz/api/customers/{id}/required-signings")

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

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

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

200

[
  {
    "display_name": "Terms and Conditions",
    "id": "019f713b-279f-7310-9a1c-ddea56728181",
    "url": "https://www.google.com/terms-and-conditions"
  }
]

"<string>"

"<string>"

"<string>"

"<string>"

{
  "message": "<string>",
  "trace_id": "<string>"
}

Authorizations

X-API-Key · string · header · required

API Key

Headers

X-SUB-PARTNER-ID · string

Optional sub-partner UUID, if provided, the required signings will be filtered for the sub-partner

X-API-Version · string

Selects the API version for this request, as an ISO date (YYYY-MM-DD). Omit to use the default version (2025-03-13). Supported versions: 2025-03-13, 2026-07-01.

Path Parameters

id · string<uuid> · required

the ID of the Customer to get required signings for

Response

200

application/json; charset=utf-8

GET Required Signings Succeeded

display_name · string · required

the display name of the terms and conditions

id · string<uuid> · required

The unique identifier for the terms and conditions url

url · string · required

The URL of the terms and conditions