Developers

API reference

Generated from the live OpenAPI 3.1 document, so it always matches the API. Authentication, rate limits and errors are covered in getting started.

Signings

get/v1/signings

List signed waivers

Needs the `signings:read` permission.

Parameters

Name	In	Type	Description
page	query	integer	Page number, from 1.
per_page	query	integer	Rows per page, at most 100.
updated_since	query	string (date-time)	Changed at or after this time.
signed_since	query	string (date-time)	Signed at or after this time.
template_id	query	string (uuid)	Signed on this waiver.
location_id	query	string (uuid)	Signed at this location.
email	query	string	Signer's email, any case.
phone	query	string	Signer's phone.
last_name	query	string	Signer's last name, any case.
dob	query	string (date)	Signer's date of birth.
tag	query	string	Carries this tag.
review_status	query	"unreviewed" \| "accepted" \| "rejected"	Review decision.
external_reference	query	string	Your reference, from a signing link.
sort	query	"signed_at" \| "updated_at"	signed_at: newest first. updated_at: oldest change first, for syncing.

curl https://app.onlinewaiversoftware.com/api/v1/signings \
  -H "Authorization: Bearer $KEY"

Responses

200 OK
400 Error (problem document)
401 Error (problem document)
403 Error (problem document)
404 Error (problem document)
429 Error (problem document)

Response fields and example

Field	Type	Description
objectrequired	"list"
datarequired	array of Signing
pagerequired	integer
per_pagerequired	integer
totalrequired	integer
has_morerequired	boolean

{
  "object": "list",
  "data": [
    {
      "id": "3f2b8c1e-5d4a-4c7e-9a10-2b6f0d8e7c41",
      "object": "signing",
      "template": {
        "id": null,
        "title": null,
        "version": null
      },
      "packet": {
        "id": null,
        "name": null
      },
      "location": {
        "id": null,
        "name": null
      },
      "signer": {
        "first_name": null,
        "last_name": null,
        "email": null,
        "phone": null,
        "dob": null
      },
      "customer_id": "3f2b8c1e-5d4a-4c7e-9a10-2b6f0d8e7c41",
      "signed_at": "2026-10-27T15:04:05.000Z",
      "last_confirmed_at": "2026-10-27T15:04:05.000Z",
      "expired": true,
      "review_status": "unreviewed",
      "tags": [
        "string"
      ],
      "external_reference": "string",
      "is_test": true,
      "archived": true,
      "packet_hash": "string",
      "created_at": "2026-10-27T15:04:05.000Z",
      "updated_at": "2026-10-27T15:04:05.000Z",
      "links": {
        "pdf": "string",
        "admin": "string"
      },
      "answers": [
        null
      ],
      "files": [
        null
      ]
    }
  ],
  "page": 1,
  "per_page": 1,
  "total": 1,
  "has_more": true
}

get/v1/signings/{id}

A signed waiver with its answers

Needs the `signings:read` permission.

Parameters

Name	In	Type	Description
idrequired	path	string (uuid)

curl https://app.onlinewaiversoftware.com/api/v1/signings/id_ID \
  -H "Authorization: Bearer $KEY"

Responses

200 OK
400 Error (problem document)
401 Error (problem document)
403 Error (problem document)
404 Error (problem document)
429 Error (problem document)

Response fields and example

Field	Type	Description
idrequired	string (uuid)
objectrequired	"signing"
templaterequired	TemplateRef
packetrequired	object or null
locationrequired	object or null
signerrequired	Signer
customer_idrequired	string (uuid) or null
signed_atrequired	string (date-time)
last_confirmed_atrequired	string (date-time)
expiredrequired	boolean
review_statusrequired	"unreviewed" \| "accepted" \| "rejected"
tagsrequired	array of string
external_referencerequired	string or null
is_testrequired	boolean
archivedrequired	boolean
packet_hashrequired	string or null
created_atrequired	string (date-time)
updated_atrequired	string (date-time)
linksrequired	object
answers	array of Answer
files	array of SigningFile

{
  "id": "3f2b8c1e-5d4a-4c7e-9a10-2b6f0d8e7c41",
  "object": "signing",
  "template": {
    "id": "3f2b8c1e-5d4a-4c7e-9a10-2b6f0d8e7c41",
    "title": "string",
    "version": 1
  },
  "packet": {
    "id": "3f2b8c1e-5d4a-4c7e-9a10-2b6f0d8e7c41",
    "name": "string"
  },
  "location": {
    "id": "3f2b8c1e-5d4a-4c7e-9a10-2b6f0d8e7c41",
    "name": "string"
  },
  "signer": {
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "phone": "string",
    "dob": "1990-04-12"
  },
  "customer_id": "3f2b8c1e-5d4a-4c7e-9a10-2b6f0d8e7c41",
  "signed_at": "2026-10-27T15:04:05.000Z",
  "last_confirmed_at": "2026-10-27T15:04:05.000Z",
  "expired": true,
  "review_status": "unreviewed",
  "tags": [
    "string"
  ],
  "external_reference": "string",
  "is_test": true,
  "archived": true,
  "packet_hash": "string",
  "created_at": "2026-10-27T15:04:05.000Z",
  "updated_at": "2026-10-27T15:04:05.000Z",
  "links": {
    "pdf": "string",
    "admin": "string"
  },
  "answers": [
    {
      "key": "string",
      "type": "string",
      "label": "string",
      "value": {},
      "health": true,
      "withheld": null
    }
  ],
  "files": [
    {
      "id": "3f2b8c1e-5d4a-4c7e-9a10-2b6f0d8e7c41",
      "question": "string",
      "name": "string",
      "content_type": "string",
      "bytes": 1,
      "sha256": "string",
      "uploaded_at": "2026-10-27T15:04:05.000Z",
      "download_url": "string",
      "download_expires_at": "2026-10-27T15:04:05.000Z"
    }
  ]
}

get/v1/signings/{id}/pdf

Download the signer's copy as a PDF

Needs the `signings:read` permission.

Parameters

Name	In	Type	Description
idrequired	path	string (uuid)

curl https://app.onlinewaiversoftware.com/api/v1/signings/id_ID/pdf \
  -H "Authorization: Bearer $KEY"

Responses

202 Still being made; try again after Retry-After seconds.
302 Redirect to a download link that works for 15 minutes.
400 Error (problem document)
401 Error (problem document)
403 Error (problem document)
404 Error (problem document)
429 Error (problem document)

Response fields and example

Field	Type	Description
objectrequired	"pdf"
statusrequired	"pending"

{
  "object": "pdf",
  "status": "pending"
}

Customers

get/v1/customers

Find customers

Needs the `customers:read` permission.

Parameters

Name	In	Type	Description
page	query	integer	Page number, from 1.
per_page	query	integer	Rows per page, at most 100.
email	query	string	Exact email, any case.
phone	query	string	Phone number.
first_name	query	string	First name, any case.
last_name	query	string	Last name, any case.
dob	query	string (date)	Date of birth.
updated_since	query	string (date-time)	Changed at or after this time.

curl https://app.onlinewaiversoftware.com/api/v1/customers \
  -H "Authorization: Bearer $KEY"

Responses

200 OK
400 Error (problem document)
401 Error (problem document)
403 Error (problem document)
404 Error (problem document)
429 Error (problem document)

Response fields and example

Field	Type	Description
objectrequired	"list"
datarequired	array of Customer
pagerequired	integer
per_pagerequired	integer
totalrequired	integer
has_morerequired	boolean

{
  "object": "list",
  "data": [
    {
      "id": "3f2b8c1e-5d4a-4c7e-9a10-2b6f0d8e7c41",
      "object": "customer",
      "first_name": "string",
      "last_name": "string",
      "email": "string",
      "phone": "string",
      "dob": "1990-04-12",
      "is_minor": true,
      "marketing_consent": true,
      "marketing_consent_at": "2026-10-27T15:04:05.000Z",
      "marketing_consent_source": "signing",
      "email_unsubscribed": true,
      "tags": [
        "string"
      ],
      "created_at": "2026-10-27T15:04:05.000Z",
      "updated_at": "2026-10-27T15:04:05.000Z"
    }
  ],
  "page": 1,
  "per_page": 1,
  "total": 1,
  "has_more": true
}

get/v1/customers/{id}

A customer and their signings

Needs the `customers:read` permission.

Parameters

Name	In	Type	Description
idrequired	path	string (uuid)

curl https://app.onlinewaiversoftware.com/api/v1/customers/id_ID \
  -H "Authorization: Bearer $KEY"

Responses

200 OK
400 Error (problem document)
401 Error (problem document)
403 Error (problem document)
404 Error (problem document)
429 Error (problem document)

Response fields and example

CustomerDetail

{
  "id": "3f2b8c1e-5d4a-4c7e-9a10-2b6f0d8e7c41",
  "object": "customer",
  "first_name": "string",
  "last_name": "string",
  "email": "string",
  "phone": "string",
  "dob": "1990-04-12",
  "is_minor": true,
  "marketing_consent": true,
  "marketing_consent_at": "2026-10-27T15:04:05.000Z",
  "marketing_consent_source": "signing",
  "email_unsubscribed": true,
  "tags": [
    "string"
  ],
  "created_at": "2026-10-27T15:04:05.000Z",
  "updated_at": "2026-10-27T15:04:05.000Z",
  "signings": [
    {
      "id": null,
      "template": null,
      "signed_at": null,
      "last_confirmed_at": null,
      "expired": null,
      "review_status": null,
      "external_reference": null
    }
  ]
}

get/v1/customers/{id}/status

Is this customer covered by a waiver or packet right now?

Needs the `customers:read` permission.

Parameters

Name	In	Type	Description
idrequired	path	string (uuid)
template_id	query	string (uuid)	Check one waiver. Pass this or packet_id.
packet_id	query	string (uuid)	Check every waiver in a packet. Pass this or template_id.

curl https://app.onlinewaiversoftware.com/api/v1/customers/id_ID/status \
  -H "Authorization: Bearer $KEY"

Responses

200 OK
400 Error (problem document)
401 Error (problem document)
403 Error (problem document)
404 Error (problem document)
429 Error (problem document)

Response fields and example

Field	Type	Description
objectrequired	"customer_status"
customer_idrequired	string (uuid)
template_idrequired	string (uuid) or null
packet_idrequired	string (uuid) or null
coveredrequired	boolean
reasonrequired	"covered" \| "not_signed" \| "rejected" \| "reconfirm_due"
waiversrequired	array of object
sign_urlrequired	string or null
checked_atrequired	string (date-time)

{
  "object": "customer_status",
  "customer_id": "3f2b8c1e-5d4a-4c7e-9a10-2b6f0d8e7c41",
  "template_id": "3f2b8c1e-5d4a-4c7e-9a10-2b6f0d8e7c41",
  "packet_id": "3f2b8c1e-5d4a-4c7e-9a10-2b6f0d8e7c41",
  "covered": true,
  "reason": "covered",
  "waivers": [
    {
      "template": {
        "id": "3f2b8c1e-5d4a-4c7e-9a10-2b6f0d8e7c41",
        "title": "string"
      },
      "covered": true,
      "reason": "covered",
      "signing": null
    }
  ],
  "sign_url": "string",
  "checked_at": "2026-10-27T15:04:05.000Z"
}

Signing links

post/v1/signing-links

Create a personal signing link

Needs the `signing_links:write` permission.

Request body (JSON)

Exactly one of template_id or packet_id.

Field	Type	Description
template_id	string (uuid)
packet_id	string (uuid)
first_name	string
last_name	string
email	string (email)
phone	string	A US number; stored as 10 digits.
dob	string (date)
external_reference	string
expires_at	string (date-time)	At most 90 days ahead. Default 30 days.

curl -X POST https://app.onlinewaiversoftware.com/api/v1/signing-links \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "template_id": "3f2b8c1e-5d4a-4c7e-9a10-2b6f0d8e7c41",
  "packet_id": "3f2b8c1e-5d4a-4c7e-9a10-2b6f0d8e7c41",
  "first_name": "string",
  "last_name": "string",
  "email": "dana@example.com",
  "phone": "string",
  "dob": "1990-04-12",
  "external_reference": "string",
  "expires_at": "2026-10-27T15:04:05.000Z"
}'

Responses

201 Created
400 Error (problem document)
401 Error (problem document)
403 Error (problem document)
404 Error (problem document)
429 Error (problem document)

Response fields and example

Field	Type	Description
idrequired	string (uuid)
objectrequired	"signing_link"
urlrequired	string
short_urlrequired	string or null
template_idrequired	string (uuid) or null
packet_idrequired	string (uuid) or null
external_referencerequired	string or null
prefillrequired	object
expires_atrequired	string (date-time)
opened_atrequired	string (date-time) or null
signed_atrequired	string (date-time) or null
signing_idrequired	string (uuid) or null
created_atrequired	string (date-time)

{
  "id": "3f2b8c1e-5d4a-4c7e-9a10-2b6f0d8e7c41",
  "object": "signing_link",
  "url": "string",
  "short_url": "string",
  "template_id": "3f2b8c1e-5d4a-4c7e-9a10-2b6f0d8e7c41",
  "packet_id": "3f2b8c1e-5d4a-4c7e-9a10-2b6f0d8e7c41",
  "external_reference": "string",
  "prefill": {
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "phone": "string",
    "dob": "1990-04-12"
  },
  "expires_at": "2026-10-27T15:04:05.000Z",
  "opened_at": "2026-10-27T15:04:05.000Z",
  "signed_at": "2026-10-27T15:04:05.000Z",
  "signing_id": "3f2b8c1e-5d4a-4c7e-9a10-2b6f0d8e7c41",
  "created_at": "2026-10-27T15:04:05.000Z"
}

get/v1/signing-links/{id}

A signing link, and whether it has been opened and signed

Needs the `signing_links:write` permission.

Parameters

Name	In	Type	Description
idrequired	path	string (uuid)

curl https://app.onlinewaiversoftware.com/api/v1/signing-links/id_ID \
  -H "Authorization: Bearer $KEY"

Responses

200 OK
400 Error (problem document)
401 Error (problem document)
403 Error (problem document)
404 Error (problem document)
429 Error (problem document)

Response fields and example

Field	Type	Description
idrequired	string (uuid)
objectrequired	"signing_link"
urlrequired	string
short_urlrequired	string or null
template_idrequired	string (uuid) or null
packet_idrequired	string (uuid) or null
external_referencerequired	string or null
prefillrequired	object
expires_atrequired	string (date-time)
opened_atrequired	string (date-time) or null
signed_atrequired	string (date-time) or null
signing_idrequired	string (uuid) or null
created_atrequired	string (date-time)

{
  "id": "3f2b8c1e-5d4a-4c7e-9a10-2b6f0d8e7c41",
  "object": "signing_link",
  "url": "string",
  "short_url": "string",
  "template_id": "3f2b8c1e-5d4a-4c7e-9a10-2b6f0d8e7c41",
  "packet_id": "3f2b8c1e-5d4a-4c7e-9a10-2b6f0d8e7c41",
  "external_reference": "string",
  "prefill": {
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "phone": "string",
    "dob": "1990-04-12"
  },
  "expires_at": "2026-10-27T15:04:05.000Z",
  "opened_at": "2026-10-27T15:04:05.000Z",
  "signed_at": "2026-10-27T15:04:05.000Z",
  "signing_id": "3f2b8c1e-5d4a-4c7e-9a10-2b6f0d8e7c41",
  "created_at": "2026-10-27T15:04:05.000Z"
}

Waivers and locations

get/v1/templates

Published waivers

Any API key.

curl https://app.onlinewaiversoftware.com/api/v1/templates \
  -H "Authorization: Bearer $KEY"

Responses

200 OK
400 Error (problem document)
401 Error (problem document)
403 Error (problem document)
404 Error (problem document)
429 Error (problem document)

Response fields and example

Field	Type	Description
objectrequired	"list"
datarequired	array of Template
pagerequired	integer
per_pagerequired	integer
totalrequired	integer
has_morerequired	boolean

{
  "object": "list",
  "data": [
    {
      "id": "3f2b8c1e-5d4a-4c7e-9a10-2b6f0d8e7c41",
      "object": "template",
      "title": "string",
      "version": 1,
      "share_url": "string",
      "updated_at": "2026-10-27T15:04:05.000Z"
    }
  ],
  "page": 1,
  "per_page": 1,
  "total": 1,
  "has_more": true
}

get/v1/packets

Waiver packets ready to sign

Any API key.

curl https://app.onlinewaiversoftware.com/api/v1/packets \
  -H "Authorization: Bearer $KEY"

Responses

200 OK
400 Error (problem document)
401 Error (problem document)
403 Error (problem document)
404 Error (problem document)
429 Error (problem document)

Response fields and example

Field	Type	Description
objectrequired	"list"
datarequired	array of Packet
pagerequired	integer
per_pagerequired	integer
totalrequired	integer
has_morerequired	boolean

{
  "object": "list",
  "data": [
    {
      "id": "3f2b8c1e-5d4a-4c7e-9a10-2b6f0d8e7c41",
      "object": "packet",
      "name": "string",
      "templates": [
        {
          "id": null,
          "title": null,
          "rule": null
        }
      ],
      "updated_at": "2026-10-27T15:04:05.000Z"
    }
  ],
  "page": 1,
  "per_page": 1,
  "total": 1,
  "has_more": true
}

get/v1/locations

Active locations

Any API key.

curl https://app.onlinewaiversoftware.com/api/v1/locations \
  -H "Authorization: Bearer $KEY"

Responses

200 OK
400 Error (problem document)
401 Error (problem document)
403 Error (problem document)
404 Error (problem document)
429 Error (problem document)

Response fields and example

Field	Type	Description
objectrequired	"list"
datarequired	array of Location
pagerequired	integer
per_pagerequired	integer
totalrequired	integer
has_morerequired	boolean

{
  "object": "list",
  "data": [
    {
      "id": "3f2b8c1e-5d4a-4c7e-9a10-2b6f0d8e7c41",
      "object": "location",
      "name": "string",
      "address": "string",
      "city": "string",
      "state": "string",
      "zip": "string",
      "phone": "string",
      "timezone": "string",
      "is_primary": true
    }
  ],
  "page": 1,
  "per_page": 1,
  "total": 1,
  "has_more": true
}

Webhooks

get/v1/webhooks

Webhook endpoints

Needs the `webhooks:manage` permission.

curl https://app.onlinewaiversoftware.com/api/v1/webhooks \
  -H "Authorization: Bearer $KEY"

Responses

200 OK
400 Error (problem document)
401 Error (problem document)
403 Error (problem document)
404 Error (problem document)
429 Error (problem document)

Response fields and example

Field	Type	Description
objectrequired	"list"
datarequired	array of WebhookEndpoint
pagerequired	integer
per_pagerequired	integer
totalrequired	integer
has_morerequired	boolean

{
  "object": "list",
  "data": [
    {
      "id": "3f2b8c1e-5d4a-4c7e-9a10-2b6f0d8e7c41",
      "object": "webhook_endpoint",
      "url": "string",
      "description": "string",
      "events": [
        "signing.completed"
      ],
      "enabled": true,
      "disabled_reason": "string",
      "created_at": "2026-10-27T15:04:05.000Z"
    }
  ],
  "page": 1,
  "per_page": 1,
  "total": 1,
  "has_more": true
}

post/v1/webhooks

Add a webhook endpoint (the answer shows its signing secret once)

Needs the `webhooks:manage` permission.

Request body (JSON)

Field	Type	Description
urlrequired	string (uri)	https only.
description	string or null
eventsrequired	array of "signing.completed" \| "signing.reattested" \| "signing.accepted" \| "signing.rejected" \| "signing.tagged" \| "customer.created" \| "customer.updated" \| "signing_link.opened"

curl -X POST https://app.onlinewaiversoftware.com/api/v1/webhooks \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://example.com",
  "description": "string",
  "events": [
    "signing.completed"
  ]
}'

Responses

201 Created
400 Error (problem document)
401 Error (problem document)
403 Error (problem document)
404 Error (problem document)
429 Error (problem document)

Response fields and example

WebhookEndpointWithSecret

{
  "id": "3f2b8c1e-5d4a-4c7e-9a10-2b6f0d8e7c41",
  "object": "webhook_endpoint",
  "url": "string",
  "description": "string",
  "events": [
    "signing.completed"
  ],
  "enabled": true,
  "disabled_reason": "string",
  "created_at": "2026-10-27T15:04:05.000Z",
  "secret": "string"
}

get/v1/webhooks/{id}

A webhook endpoint

Needs the `webhooks:manage` permission.

Parameters

Name	In	Type	Description
idrequired	path	string (uuid)

curl https://app.onlinewaiversoftware.com/api/v1/webhooks/id_ID \
  -H "Authorization: Bearer $KEY"

Responses

200 OK
400 Error (problem document)
401 Error (problem document)
403 Error (problem document)
404 Error (problem document)
429 Error (problem document)

Response fields and example

Field	Type	Description
idrequired	string (uuid)
objectrequired	"webhook_endpoint"
urlrequired	string
descriptionrequired	string or null
eventsrequired	array of "signing.completed" \| "signing.reattested" \| "signing.accepted" \| "signing.rejected" \| "signing.tagged" \| "customer.created" \| "customer.updated" \| "signing_link.opened"
enabledrequired	boolean
disabled_reasonrequired	string or null
created_atrequired	string (date-time)

{
  "id": "3f2b8c1e-5d4a-4c7e-9a10-2b6f0d8e7c41",
  "object": "webhook_endpoint",
  "url": "string",
  "description": "string",
  "events": [
    "signing.completed"
  ],
  "enabled": true,
  "disabled_reason": "string",
  "created_at": "2026-10-27T15:04:05.000Z"
}

patch/v1/webhooks/{id}

Change a webhook endpoint, or turn it back on

Needs the `webhooks:manage` permission.

Parameters

Name	In	Type	Description
idrequired	path	string (uuid)

Request body (JSON)

Field	Type	Description
url	string (uri)
description	string or null
events	array of "signing.completed" \| "signing.reattested" \| "signing.accepted" \| "signing.rejected" \| "signing.tagged" \| "customer.created" \| "customer.updated" \| "signing_link.opened"
enabled	boolean

curl -X PATCH https://app.onlinewaiversoftware.com/api/v1/webhooks/id_ID \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://example.com",
  "description": "string",
  "events": [
    "signing.completed"
  ],
  "enabled": true
}'

Responses

200 OK
400 Error (problem document)
401 Error (problem document)
403 Error (problem document)
404 Error (problem document)
429 Error (problem document)

Response fields and example

Field	Type	Description
idrequired	string (uuid)
objectrequired	"webhook_endpoint"
urlrequired	string
descriptionrequired	string or null
eventsrequired	array of "signing.completed" \| "signing.reattested" \| "signing.accepted" \| "signing.rejected" \| "signing.tagged" \| "customer.created" \| "customer.updated" \| "signing_link.opened"
enabledrequired	boolean
disabled_reasonrequired	string or null
created_atrequired	string (date-time)

{
  "id": "3f2b8c1e-5d4a-4c7e-9a10-2b6f0d8e7c41",
  "object": "webhook_endpoint",
  "url": "string",
  "description": "string",
  "events": [
    "signing.completed"
  ],
  "enabled": true,
  "disabled_reason": "string",
  "created_at": "2026-10-27T15:04:05.000Z"
}

delete/v1/webhooks/{id}

Delete a webhook endpoint

Needs the `webhooks:manage` permission.

Parameters

Name	In	Type	Description
idrequired	path	string (uuid)

curl -X DELETE https://app.onlinewaiversoftware.com/api/v1/webhooks/id_ID \
  -H "Authorization: Bearer $KEY"

Responses

200 OK
400 Error (problem document)
401 Error (problem document)
403 Error (problem document)
404 Error (problem document)
429 Error (problem document)

Response fields and example

Field	Type	Description
idrequired	string (uuid)
objectrequired	"webhook_endpoint"
deletedrequired	boolean

{
  "id": "3f2b8c1e-5d4a-4c7e-9a10-2b6f0d8e7c41",
  "object": "webhook_endpoint",
  "deleted": true
}

post/v1/webhooks/{id}/rotate-secret

Replace an endpoint's signing secret (the answer shows the new one once)

Needs the `webhooks:manage` permission.

Parameters

Name	In	Type	Description
idrequired	path	string (uuid)

curl -X POST https://app.onlinewaiversoftware.com/api/v1/webhooks/id_ID/rotate-secret \
  -H "Authorization: Bearer $KEY"

Responses

200 OK
400 Error (problem document)
401 Error (problem document)
403 Error (problem document)
404 Error (problem document)
429 Error (problem document)

Response fields and example

WebhookEndpointWithSecret

{
  "id": "3f2b8c1e-5d4a-4c7e-9a10-2b6f0d8e7c41",
  "object": "webhook_endpoint",
  "url": "string",
  "description": "string",
  "events": [
    "signing.completed"
  ],
  "enabled": true,
  "disabled_reason": "string",
  "created_at": "2026-10-27T15:04:05.000Z",
  "secret": "string"
}

Other

post/v1/partner/token

Partners: swap a connect-flow code for a key to that business

For approved partners only. Send the customer to `/connect/<client_id>?redirect_uri=<registered address>&state=<8 to 500 characters>` (state is required; PKCE is supported: add code_challenge, the base64url SHA-256 of your code_verifier, and code_challenge_method=S256); after the owner approves, their browser comes back to redirect_uri with `code` and `state`. The code works once and expires in 5 minutes. Post it here with your client_id and client_secret; the access_token is an API key for that one business, sent as `Authorization: Bearer` like any other. A code presented twice also revokes the key it bought. Limited to 20 attempts a minute per address and per client_id.

Request body (JSON)

Field	Type	Description
grant_typerequired	"authorization_code"
coderequired	string
client_idrequired	string
client_secretrequired	string
redirect_urirequired	string (uri)	Exactly as used on /connect.
code_verifierrequired	string	Required when the connect address carried a code_challenge (PKCE, S256).

curl -X POST https://app.onlinewaiversoftware.com/api/v1/partner/token \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "grant_type": "authorization_code",
  "code": "string",
  "client_id": "string",
  "client_secret": "string",
  "redirect_uri": "https://example.com",
  "code_verifier": "string"
}'

Responses

200 OK
400 Error (problem document)
401 Error (problem document)
403 Error (problem document)
404 Error (problem document)
429 Error (problem document)

Response fields and example

Field	Type	Description
access_tokenrequired	string	An API key for the one business that approved.
token_typerequired	"bearer"
businessrequired	object
scopesrequired	array of "signings:read" \| "signings:read_health" \| "customers:read" \| "signing_links:write" \| "webhooks:manage"

{
  "access_token": "string",
  "token_type": "bearer",
  "business": {
    "id": "3f2b8c1e-5d4a-4c7e-9a10-2b6f0d8e7c41",
    "name": "string"
  },
  "scopes": [
    "signings:read"
  ]
}

Errors

Every error is a problem document. code is stable, so match on it rather than on the message.

Field	Type	Description
type	string
titlerequired	string
statusrequired	integer
coderequired	string
detailrequired	string
fixrequired	string