Create Composed Contract Preview

post

https://api-sandbox.urbanpayx.com/api/v1/contracts/previews/compose

Preview a composed contract before sending it

Takes exactly the body of a compose-and-send and returns a link to the
document it would send, as it stands before the signers act: every
variable and pre-filled value is filled in. Nobody is notified, no
contract is created and no Contract Flow is saved, whatever
save_as_flow says. The body is checked exactly as a compose-and-send
is, so this returns the same errors. The link opens with no headers and
works for one hour.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

template_version_id

string

required

ID of the contract template version to send

signers

array of objects

required

length ≥ 1

Ordered list of signers for this contract

Signers*

role

string

required

length between 1 and 255

Signer role name as defined in the template

source

string

enum

required

Who fills this signer: client, user, business, or external

Allowed:

external

ExternalSignerInfo | null

Details for an external signer; required when source is external

user_id

ID of the registered user signing; required when source is user

business_customer_id

ID of the business customer signing; required when source is business

field_values

object

Pre-filled template field values for this signer

expire_after_hours

1 to 2160

Hours this signer has to sign once it is their turn; null means no expiration. Not allowed on auto-signing signers.

parallel_with_previous

boolean

Defaults to false

Sign at the same time as the previous signer instead of waiting for them. Signers that sign together must all carry the same expire_after_hours. Ignored on the first signer, who always starts the first group.

payment_gate

ComposeAndSendPaymentGate | null

Hold signing until a linked transaction succeeds

save_as_flow

boolean

Defaults to false

Persist this ad-hoc setup as a reusable workflow

flow_name

length ≤ 255

Name for the saved workflow when save_as_flow is true

project_id

ID of the project this contract belongs to

transaction_id

ID of a payment transaction to link to this contract

variables

object

Template variable values for this contract

email_notifications

object

Email notification + attachment config for the workflow created by this send

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response

400Bad Request

401Unauthorized

403Forbidden

404Not Found

409Conflict

422Validation Error

429Too Many Requests