v1

latestOpenAPI 3.1.02026-07-243113441.2 MB

Contractor Documents

Sign a contractor document

Sign a contractor document.

scope: contractor_documents:write

put/v1/documents/{document_uuid}/sign

Path parameters

document_uuidstring required

The UUID of the document

Headers

X-Gusto-API-Version'2026-06-15'

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

x-gusto-client-ipstring

Optional header to supply the IP address. This can be used to supply the IP address for signature endpoints instead of the signed_by_ip_address parameter.

Request body

agreeboolean required

Whether you agree to sign electronically

signed_by_ip_addressstring

The IP address of the signatory who signed the form. You must provide the IP address with either this parameter OR you can leave out this parameter and set the IP address in the request header using the x-gusto-client-ip header instead.

Response

Example response

uuidstring

The UUID of the document

titlestring

The title of the document

namestring

The type identifier of the document

recipient_type'Company' | 'Employee' | 'Contractor'

The type of recipient associated with the document (will be Contractor for Contractor Documents)

recipient_uuidstring

Unique identifier for the recipient associated with the document

signed_atstring nullable

When the document was signed (will be null if unsigned)

descriptionstring

The description of the document

requires_signingboolean

A boolean flag that indicates whether the document needs signing or not. Note that this value will change after the document is signed.

draftboolean

If the document is in a draft state

yearinteger nullable

The year of this document. This value is nullable and will not be present on all documents.

quarterinteger nullable

The quarter of this document. This value is nullable and will not be present on all documents.