Skip to main content
POST
/
customers
/
{id}
/
signings
Create a new Customer signing
curl --request POST \
  --url https://api.sandbox.iron.xyz/api/customers/{id}/signings \
  --header 'Content-Type: application/json; charset=utf-8' \
  --header 'IDEMPOTENCY-KEY: <idempotency-key>' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-SUB-PARTNER-ID: <x-sub-partner-id>' \
  --data '
{
  "content_id": "019ae024-5885-7273-b60c-acadcef048fc",
  "content_type": "Document",
  "document_id": null,
  "signed": true
}
'
{
  "content_type": "Document",
  "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"
}

Authorizations

​
X-API-Key
string
header
required

API Key

Headers

​
IDEMPOTENCY-KEY
string
required

a UUID ensuring an Signing operation is only processed once

​
X-SUB-PARTNER-ID
string
required

Optional sub-partner UUID, if provided, the signing will be created under scope of the sub-partner

Path Parameters

​
id
string<uuid>
required

the ID of the Customer to create a Signing for

Body

application/json; charset=utf-8

Parameters required to create a new Signing

Params for Creating a Signing

​
signed
boolean
required

Explicit signing consent

​
content_id
string<uuid>

unique UUID of the content signed by Customer

​
content_type
enum<string>
Available options:
Document,
Url
​
document_id
string<uuid>

ID of the document signed (Soon to be deprecated, use context_id & content_type instead)

Response

POST Signing Succeeded

Signing

A signing of a document by a customer

​
content_type
enum<string>
required
Available options:
Document,
Url
​
created_at
string<date-time>
required

created_at timestamp of Signing

​
customer_id
string<uuid>
required

unique UUID of the Customer who signed

​
id
string<uuid>
required

unique UUID of Signing

​
updated_at
string<date-time>
required

updated_at timestamp of Signing

​
content_id
string<uuid>

unique UUID of the content signed by Customer

​
document_id
string<uuid>

unique UUID of the Document signed by Customer (Soon to be deprecated, use content_id & content_type instead)