Get all customer Signings

Retrieve all signings for a customer, representing the various legal agreements and consents gathered from the customer. See The KYC/Compliance section of our documentation for more info.

GET /customers/{id}/signings

Get all customer Signings

cURL

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

import requests

url = "https://api.sandbox.iron.xyz/api/customers/{id}/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}/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}/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}/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}/signings")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.iron.xyz/api/customers/{id}/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

{
  "items": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updated_at": "2023-11-07T05:31:56Z",
      "content_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "prev_cursor": null
}

"<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 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 Signings for

Query Parameters

cursor · string<uuid>

Paging: the cursor field from previous page

page_size · integer<uint32> · default: 10

Paging: the requested page size (max 100)

Response

200

application/json; charset=utf-8

GET Signings Succeeded

PagedList

A list of items with cursors used to fetch the next or previous page

items · Signing · object[] · required

The list of items

Show child attributes

cursor · string<uuid>

The cursor used to fetch the next page

prev_cursor · string<uuid>

The cursor used to fetch the previous page