Retrieve a Participant

GET 
/agreements/:agreement_id/participants/:participant_id

Retrieves a participant of the Agreement.

Request

Path Parameters

agreement_id cuidrequired

GET /agreements/:agreement_id/participants/:participant_id parameter

participant_id cuidrequired

GET /agreements/:agreement_id/participants/:participant_id parameter

Responses

200

GET /agreements/:agreement_id/participants/:participant_id Successful response

application/json

Schema

Schema

version stringrequired

Possible values: [1.0]

The version of the response schema

result_type stringrequired

Possible values: [single]

A single object of the participant resource.

resource_type stringrequired

Possible values: [participant]

Data contains the participant resource.

data object

The participant resource

oneOf

MOD1

role stringrequired

Possible values: [approver]

The role of the participant

decision_made_at stringnullablerequired

UTC datetime ISO string

MOD2

role stringrequired

Possible values: [signer]

The role of the participant

signed_at stringnullablerequired

UTC datetime ISO string

signature object nullable required

The signature data for the participant

oneOf

MOD1

id cuidrequired

The unique identifier of the signature data

created_at stringrequired

UTC datetime ISO string

updated_at stringrequired

UTC datetime ISO string

MOD2

method nullnullablerequired

data nullnullablerequired

identity_enforcement object required

oneOf

MOD1

enabled booleanrequired

Possible values: [true]

If true, identity enforcement is enabled for the participant

status stringrequired

Possible values: [pending, passed, failed]

The status of the identity enforcement

enforcement_method stringrequired

Possible values: [swe_pno_crosscheck]

The enforcement method for the identity. Depending on which method is used, different signature method are available

MOD2

enabled booleanrequired

Possible values: [false]

If true, identity enforcement is enabled for the participant

status nullnullablerequired

enforcement_method nullnullablerequired

id cuidrequired

The unique identifier of the participant

resource_type stringrequired

Possible values: [participant]

name stringnullablerequired

The name of the participant. Required if no email is provided.

email stringnullablerequired

The email of the participant. Required if agreemnt is configured to send emails.

status stringrequired

Possible values: [draft, pending, initiated, processing, fulfilled, rejected]

The status of the participant

order doublenullablerequired

Possible values: <= 1.7976931348623157e+308

The queue number of the participant (if sequential signing order is enabled)

signing_group object required

oneOf

MOD1

string

118cb3b11b8a1f3b6b1e60a89f96a8be9da32a0f

version stringrequired

Possible values: [1.0]

The version of the response schema

result_type stringrequired

Possible values: [single]

A single object of the signing_group resource.

resource_type stringrequired

Possible values: [signing_group]

Data contains the signing_group resource.

data objectrequired

The resource data.

id cuidrequired

The unique identifier of the signing group

resource_type stringrequired

Possible values: [signing_group]

name stringrequired

The name of the signing group

status stringrequired

Possible values: [draft, pending, fulfilled]

The status of the signing group

order doublerequired

Possible values: >= 5e-324 and <= 1.7976931348623157e+308

The queue number of the signing group

participants object required

oneOf

MOD1

Array [

string

]

MOD3

string

agreement cuidrequired

The unique identifier of the agreement this signing group belongs to

created_at stringrequired

UTC datetime ISO string

updated_at stringrequired

UTC datetime ISO string

MOD3

string

agreement cuidrequired

The unique identifier for the agreement this participant belongs to

signing_room_url urlnullablerequired

The URL to the signing room for the participant. Only available after the agreement has been finalized for signing.

signing_room_link objectnullable

The current Signing Room Link for the participant. Null before the agreement is finalized, or when no current link exists.

version stringrequired

Possible values: [1.0]

The version of the response schema

result_type stringrequired

Possible values: [single]

A single object of the signing_room_link resource.

resource_type stringrequired

Possible values: [signing_room_link]

Data contains the signing_room_link resource.

data objectrequired

The resource data.

id cuidrequired

The unique identifier of the Signing Room Link

resource_type stringrequired

Possible values: [signing_room_link]

agreement_id cuidrequired

The unique identifier of the agreement the link opens

url urlrequired

The full signing room URL. It is a bearer credential: anyone with it can open the signing room for this participant.

status stringrequired

Possible values: [active, expired, revoked]

Whether the link still grants access to the signing room. An expired link can be rotated; a revoked link cannot.

expires_at stringrequired

When the link stops granting access to the signing room

created_at stringrequired

UTC datetime ISO string

updated_at stringrequired

UTC datetime ISO string

locale stringnullable

Possible values: [sv-SE, en-US]

The locale for the participant. Can be overridden from the signing room, but this value serves as the default if nothing else is specified.

created_at stringrequired

UTC datetime ISO string

updated_at stringrequired

UTC datetime ISO string

Example (from schema)

{
  "version": "1.0",
  "result_type": "single",
  "resource_type": "participant",
  "data": {
    "role": "approver",
    "decision_made_at": "2024-01-01T00:00:00.000Z"
  }
}

400

GET /agreements/:agreement_id/participants/:participant_id Error response

application/json

Schema

Schema

status stringrequired

Possible values: [error]

error objectrequired
type stringrequired
Possible values: [input_validation_error, bad_request, authorization_error, forbidden_error, not_found_error, conflict_error, internal_server_error]
input_validation_error (400): the request input is invalid. bad_request (400): the request cannot be processed. authorization_error (401): the access token is missing or invalid. forbidden_error (403): the client is not allowed to perform the request. not_found_error (404): the resource does not exist. conflict_error (409): a concurrent change made the request invalid, e.g. the agreement stopped being editable while the request was processed. Re-fetch the resource before retrying. internal_server_error (500): an unexpected error occurred.
code int64required
Possible values: >= 400 and <= 599
message stringrequired
request_id uuidrequired

Example (from schema)

{
  "status": "error",
  "error": {
    "type": "input_validation_error",
    "code": 0,
    "message": "string",
    "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

Loading...