Create a ceremony: Custom authentication

Creates a ceremony where the recipient is authenticated externally to SignatureAPI. Use this to obtain a ceremony URL for sharing with recipients.

Input

Authentication Provider · string · required

The name of the authentication provider. This value is arbitrary and will appear in the audit logs of the envelope.

Authentication Data · array of string · required

Key: Value pair containing authentication metadata. These details will be included in the envelope’s audit logs

Recipient ID · string · required

The ID of the recipient to which the ceremony will be created.

Redirect URL · string

A URL to redirect the recipient to after a ceremony is finished.

Learn more about ceremony redirect url.

Extra Properties · string

Extra properties for extensibility.

Output

Ceremony URL · string

The URL the recipient must visit to initiate the ceremony