API Reference
IntegrationsHelp CenterSign in

Create a party

post
https://{hostname}/v1/contracts//parties

Use this endpoint to create a counterparty in a contract.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

The unique ID of the contract.

Body Params

Request body parameters for creating a party.

The contract party with the company type is a legal entity involved in the contract. More than one participant can sign a contract on behalf of the party with the company type.

_private_ownerside
object

Contract party attributes that are private to the ownerside.

string

The country code of the contract party.

string
length between 0 and 25

The unique organization number of the contract party.

string
required
length between 1 and 100

The name of the contract party.

participants
array of objects
required
length ≥ 1

The list of the contract party participants.

participants*

The person who represents in a contract, see Participant.

_permissions
object

Defines permissions for the participant on the contract.

_private_ownerside
object

Contract participant attributes that are private to the ownerside.

string
enum
required

One of the contract delivery channels.

Allowed:
string

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

string
length between 0 and 25

The social security number of the participant.

string
required
length between 1 and 100

The participant's name.

string | null

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

string
enum

One of the sign methods.

boolean
Defaults to false

If true, the participant can sign the contract.

string
length between 0 and 100

The title of the participant.

string
enum

One of the two step authentication methods.

Allowed:
string
enum
required

Can only be company.

Allowed:
Headers
string
required
length between 40 and 40

The API key of your Oneflow account.

string
required

The email address of a registered Oneflow user.

Responses

400

Invalid format or content of the request.

401

The API token or the user email is invalid.

403

The request is not authorized by the server.

404

A required entity is missing.

409

A conflict occurred with the current state of the target resource.

Updated 9 days ago

Language
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 9 days ago