Skip to main content
GET
Preview a contract

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

verification_id
string<uuid>
required

Query Parameters

contract_workflow
string
required

The contract workflow to preview, one the version offers.

Response

What a send would carry now, and what would refuse it.

What sending one of a verification's offers now would carry, and what would refuse it.

contract_workflow
string
required

The contract workflow previewed.

filled
Filled · object
required

The values the verification fills in, by variable. A variable it cannot fill is absent.

open
string[]
required

The variables you set with the send.

required
string[]
required

The variables in open a send has to set: every one of them, except on a contract filled from a form, which needs only those its form requires and one of each group in required_one_of. A send may leave out any other.

required_one_of
string[][]
required

Groups of variables in open of which a send has to set at least one: on a contract filled from a form, each group the form needs one of where the verification fills none of it. Empty on any other contract.

dates
string[]
required

The variables in open that take a date. Send each as YYYY-MM-DD, such as 2100-04-12, and the contract prints it as 12 April 2100.

signers
PreviewSigner · object[]
required

Everyone a send would go to, in the order they sign.

sent
ContractRecord · object[]
required

This contract workflow's contracts already sent on the verification's current run, newest first.

stamp_paper
StampPaperPreview · object | null
required

Present on a verification whose version has features.stamp_paper on, where a send gives one in stamp_paper or sends one again. Null on any other.

faults
string[]
required

Every reason a send now would be refused that setting open would not put right: the verification not waiting on signatures, its run not signed on this contract workflow, one of these already out or signed, no contract credits left, or a value or file the verification does not hold. On a contract filled from a form whose open is empty, it also names everything the form cannot print. Empty where a send with every open value set would go, unless the contract as drawn up with those values is refused for how it prints.