Oneflow Integration Platform

Use the Oneflow API to build powerful integrations to automate your contract management.

Participant

A participant represents a real person in the contract.

🚧

Note:

There can be at most 30 participants across all parties in one contract.

Contract participant attributes

The following attributes are available for a contract participant:

Attribute

Type

Description

_permissions

object

Defines permissions for the contract participant. See Permissions.

_private_ownerside

object

Contains attributes visible only to the owner-side participant. See Private owner-side.

delivery_channel

string(enum)

The name of the delivery channel. One of the Delivery channels.

delivery_status

string(enum)

Indicates the status of the notification that sends the contract participant. One of the Delivery statuses.

email

string(email)

The participant's email address.

id

integer

The unique ID of the participant.

identification_number

string

The date of birth, SSN, personal number, etc., of the participant.

my_participant

boolean

Whether the participant represents the current user or not.

name

string

The name of the participant.

organizer

boolean

A flag to indicate if the participant is an owner-side internal participant. Only for the owner-side participants.

phone_number

string(phone_number)

The mobile phone number of the participant.

sign_method

string(enum)

Shows the selected method of signing contracts. One of the Sign methods.

sign_state

string(enum)

The current state of the contract in the singing process. One of the Sign states.

sign_state_updated_time

string(datetime)

The time the sign state was last updated.

signatory

boolean

Indicates if the participant can sign the contract.

title

string

The title of the participant.

two_step_authentication_method

string(enum)

Shows the selected two-step authentication methods. One of the
Two-step authentication method options
.

Permissions

Indicates what permissions the contract participant has in the contract.

Attribute

Attribute

Description

contract:update

boolean

Indicates whether the participant is allowed to make changes in the contract.

Combining participant flags and permissions

The table below shows all the possible combinations of the participant flags for signatory and organizer, and permissions to update and sign the contract.

📘

Note:

Combining the participant and signatory flags with permissions, you can set up roles available in Oneflow:
Signatory – can edit the contract and expected to sign the contract.
Influencer – can edit the contract.
Viewer – cannot edit the contract, can only view and comment.
Organizer – same as an influencer, but only visible to other participants in the same party.

signatoryorganizercontract:updateDescription
truefalsetrueThe participant should sign the contract and has all the appropriate permissions to edit and update the contract.
falsefalsetrueThe participant cannot sign the contract but otherwise has all the appropriate permissions to edit and update the contract.
falsetruetrueOnly possible for an owner-side participant. An owner-side internal participant cannot sign the contract but can update it.
falsefalsefalseThe participant can only view the contract.

Sign states

The sign_state attribute denotes the current state of the contract in the singing process.

State

Description

undecided

The initial sign state.

signed

The participant has signed the contract.

declined

The participant has declined the contract. The contract is declined.

unknown

Used for future extensions. Not valid for create contract endpoint.

Private owner-side

Contains attributes visible only to the owner-side party.

Attribute

Attribute

Description

created_time

string(datetime)

The time when the participant was created.

first_visited_time

string(datetime)

The time when the participant first opened the contract. null if they have not yet opened the contract.

last_visited_time

string(datetime)

The time when the participant last opened the contract. null if they have not yet opened the contract.

updated_time

string(datetime)

The time when the participant was last updated.

visits

integer

The number of times the participant has opened the contract.

Delivery status

Indicates the status of the notification (invitation) that sends the contract to the participant.

Status

Description

not_sent

The contract has not been sent to the participant.

pending

The delivery of the contract is pending.

failure

The delivery of the contract failed.

bounce

The contract cannot be delivered to the provided email address.

success

The contract was successfully delivered to the participant.

opened

The participant opened the delivered contract.

unknown

Used for future extensions. Not valid for create contract endpoint.

Updated 3 months ago


Participant


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.