The Recipient object
Recipients represent users who are assigned to documents. They can be signers, who must sign the document (signature fields are present), or they can be CC'd, with no signing fields assigned to them (such as signature, initials, or input fields).
Attributes
address
nullable string
Address of the recipient.
city
nullable string
City of the recipient.
color
string
Color of the recipient.
contact
string
ID of the recipient contact.
country
nullable string
Two-letter ISO code of the country.
created_at
string
Time at which the contact was created.
email
string
Email address of the recipient.
first_name
string
First name of the recipient.
full_name
string
Full name of the recipient.
id
string
Unique identifier for the recipient.
is_signer
boolean
Whether the recipient is signer.
job_title
string
The job title of the recipient.
last_name
string
Last name of the recipient.
organization
nullable string
Organization of the recipient.
passcode
nullable string
The passcode for opening the document.
phone_number
nullable string
Phone number of the recipient.
postal_code
nullable string
Postal code of the recipient.
role
nullable string
The recipient role in the document.
sent_at
nullable string
Time at which the document was sent to recipient.
signed_at
nullable string
Time at which the document was signed by the recipient.
state
nullable string
State of the recipient.
updated_at
string
Time at which the contact was last updated.
viewed_at
nullable string
Time at which the document was viewed by the recipient.
The Contact object
{
"address": null,
"city": null,
"color": "#83f793",
"contact": "con_itw5atndlebaj0wguoerhbpn",
"country": null,
"created_at": "2024-05-14T08:36:49+00:00",
"email": "[email protected]",
"first_name": "Brielle",
"full_name": "Brielle Turner",
"id": "1e3b4f50-10ba-3c60-83db-69ab768b8e53",
"is_signer": false,
"job_title": null,
"last_name": "Turner",
"organization": null,
"passcode": null,
"phone_number": null,
"postal_code": null,
"role": "Sender",
"sent_at": null,
"signed_at": null,
"state": null,
"updated_at": "2024-05-14T08:36:49+00:00",
"viewed_at": null
}