Sign a contractor document

put

https://api.gusto-demo.com/v1/documents/{document_uuid}/sign

Sign a contractor document.

scope: contractor_documents:write

Path Params

document_uuid

string

required

The UUID of the document

Body Params

fields

array of objects

required

List of fields and the values they will be set to.

fields*

agree

boolean

required

Whether you agree to sign electronically

signed_by_ip_address

string

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.

Headers

x-gusto-client-ip

string

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.

X-Gusto-API-Version

string

enum

Defaults to 2026-02-01

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

Allowed:

Responses

404

Not Found

The requested resource does not exist. Make sure the provided UUID is valid.

Language

Credentials

Bearer

Loading…

Response

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

application/json

200Example response

422Unprocessable Entity This may happen when the body of your request contains errors such as invalid_attribute_value, or the request fails due to an invalid_operation. See the Errors Categories guide for more details.