Sign in

v1

latestOpenAPI 3.0.02026-07-24115101.2 MB
Contract - Parties and Participants

Create a participant

Use this endpoint to add a new participant to an existing contract party.

post/contracts/{contract_id}/parties/{party_id}/participants

Path parameters

contract_idinteger required

The unique ID of the contract.

party_idinteger required

The ID of a party in a contract.

Headers

x-oneflow-api-tokenstring required

The API key of your Oneflow account.

x-oneflow-user-emailstring email required
Example:john.doe@oneflow.com

The email address of a registered Oneflow user.

Request body

delivery_channel'email' | 'sms' | 'email_and_sms' | 'same_device' | 'none' | 'unknown' required

One of the contract delivery channels.

emailstring email

The participant's email. An email is required in case of an owner-side participant or if the delivery channel is email.

identification_numberstring

The social security number of the participant.

namestring required

The participant's name.

organizerboolean

If <b>true</b>, the participant is the organizer of the contract(organizer should be an owner-side participant).

phone_numberstring nullable

The participant's phone number. If the delivery channel is phone number, then the participant's phone number is required.

sign_method'standard_esign' | 'sms' | 'swedish_bankid' | 'norwegian_bankid' | 'danish_mitid' | 'finnish_bankid' | 'handwritten_signature' | 'eid_sign'

One of the sign methods.

signatoryboolean

If <b>true</b>, the participant can sign the contract.

titlestring

The title of the participant.

two_step_authentication_method'email' | 'sms' | 'personal_identification' | 'none' | 'unknown'

One of the two step authentication methods.

type'colleague' | 'former_colleague'

Whether an ownerside participant is a colleague or a former colleague. Set this to <b>former_colleague</b> only when creating a former colleague participant.

Example request

{
  "_options": {
    "message": {
      "body": "Your colleague John Doe needs help with a draft before sending it to the counterparty.",
      "subject": "John Doe invited you to a document"
    }
  },
  "name": "Firstname Lastname"
}

Response

Returns the created participant

delivery_channel'email' | 'sms' | 'email_and_sms' | 'same_device' | 'none' | 'unknown' required

One of the contract delivery channels.

delivery_status'not_sent' | 'pending' | 'failure' | 'bounce' | 'success' | 'opened' | 'unknown' required

One of the contract delivery status.

draft_approverboolean

A flag to indicate if the participant is a draft approver.

emailstring email required
idinteger required
identification_numberstring required
my_participantboolean required
namestring nullable required
organizerboolean required

A flag to indicate if the participant is an organizer combined with the permissions.

pending_approverboolean

A flag to indicate if the participant is a pending approver.

phone_numberstring nullable required
sign_method'standard_esign' | 'sms' | 'swedish_bankid' | 'norwegian_bankid' | 'danish_mitid' | 'finnish_bankid' | 'handwritten_signature' | 'eid_sign' | 'unknown' required

One of the sign methods.

sign_state'undecided' | 'signed' | 'declined' | 'unknown' required

One of the sign states.

sign_state_updated_timestring datetime nullable required
signatoryboolean required

A flag to indicate if the participant is an signatory combined with the permissions.

titlestring required
two_step_authentication_method'email' | 'sms' | 'personal_identification' | 'none' | 'unknown' required

One of the two step authentication methods.