authentication
array that describes how the recipient is authenticated.
With Link via Email authentication, SignatureAPI sends the recipient a link via email. The recipient can click the link to initiate the ceremony.
With Custom authentication, the API returns a URL in the response. You have to deliver this URL to the recipient, or embed it in a web or mobile application, to initiate the ceremony.
short
and standard
. The default is standard
.Use short
when you need to share the URL in space-constrained channels such as SMS or push notifications.https://app.example.com
, but can also use wildcards, like https://*.example.com
. For all available options, refer to the frame‑ancestors documentation.
201 Created
status code along with a ceremony object after successful creation, or an error otherwise.