Skip to main content
POST
Request an approval

Authorizations

Authorization
string
header
required

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

Body

application/json

Exactly one of signatory_internal and signatory_external is required.

file_subject
string
required
jurisdiction
enum<string>
default:AU

Sets the consent text the signatory sees. US adds the ESIGN consumer disclosures.

Available options:
AU,
NZ,
UK,
US
signatory_internal
object
signatory_external
object
metadata
object

The browser sends only user_agent, fingerprint, signature, initials and timezone_offset. The server stamps the rest at the moment of the decision.

Response

The approval

id
string
file_subject
string
task_id
string
created_at
string<date-time>
created_by
string
decided_at
string<date-time>
status
enum<string>
Available options:
in_progress,
approved,
rejected
signatory_internal
object
signatory_external
object
jurisdiction
enum<string>
default:AU

Sets the consent text the signatory sees. US adds the ESIGN consumer disclosures.

Available options:
AU,
NZ,
UK,
US
document_hash
string
read-only

SHA-256 (hex) of the file when approval was requested. A decision is refused if the file has changed since.

The statement the signatory agrees to, set on read.

sign_places
enum<string>[]
read-only

What the signatory must fill in before approving.

Available options:
signature,
initials