Skip to main content
GET
/
customers
/
{id}
/
required-signings
Get customer required signings
curl --request GET \
  --url https://api.sandbox.iron.xyz/api/customers/{id}/required-signings \
  --header 'X-API-Key: <api-key>' \
  --header 'X-SUB-PARTNER-ID: <x-sub-partner-id>'
[
  {
    "display_name": "Terms and Conditions",
    "id": "019ae024-5885-7273-b60c-ac944e44ad7c",
    "type": "Url",
    "url": "https://www.google.com/terms-and-conditions"
  }
]

Authorizations

​
X-API-Key
string
header
required

API Key

Headers

​
X-SUB-PARTNER-ID
string
required

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

Path Parameters

​
id
string<uuid>
required

the ID of the Customer to get required signings for

Response

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

​
type
enum<string>
required
Available options:
Document,
Url
​
url
string
required

The URL of the terms and conditions