Set the signer

Set the person who signs the contract documents and how they relate to the company.

Use this endpoint to say who signs the company's contract documents. The signer reviews and signs them in the hosted experience (see Create a contract signing session).

📘

Part of People and ownership. For how this fits into onboarding, see the guide: Collecting company information: the people.

This is a full replacement: whatever was on file for the signer, including identity details, is replaced by what you send.

Relationship

relationship says how the signer relates to the company's ownership, and decides what else is needed:

relationshipWhat it means
CONTROL_PERSONThe signer is the company's control person. Their name must match the control person on file (first and last name, ignoring case), or SIGNER_RELATIONSHIP appears in readiness.missing. No identity is needed; they're verified through the control person record.
BENEFICIAL_OWNERThe signer is a beneficial owner, or a control person who owns 25% or more. Their name must match a person on file, or SIGNER_RELATIONSHIP appears in readiness.missing. No identity is needed.
NEITHERThe signer is neither. Send identity (without it, SIGNER_IDENTITY stays in readiness.missing); the signer's identity is verified separately, and a certificate of authority is required (see Upload a certificate of authority).

identity takes either an ssn, or a passportNumber and passportCountry, but not both. Dates of birth must be for someone between 18 and 120 years old.

When you can call this

Only while the onboarding is a DRAFT and the contract documents haven't been signed. Otherwise it returns 409.

Errors

StatusMeaning
400identity is invalid: an unrealistic date of birth, or an SSN and passport together (or neither).
401The API key is missing, malformed or expired.
404No company with this ID belongs to your partner account.
409The onboarding is no longer a DRAFT, or the contract has been signed.
422A required field is missing or malformed.
Path Params
integer
required

The company's ID, as returned when the company was created.

Body Params
string
required
string
required
string
required

The signer's title at the company.

string
required

The signer's email address.

string
required

10-digit US phone number. Formatting characters are allowed.

string
enum
required

How the signer relates to the company's ownership.

Allowed:
identity
object

The signer's identity details. Needed when relationship is NEITHER; ignored otherwise, because a control person or beneficial owner is verified through their own record.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json