Participants

Prev Next

Participants

This part of the request describes the participants of the entire signature workflow. It’s a JSON array, containing JSON objects. Each object corresponds to a specific participant participating in the signature workflow. Table 1 describes its parameters.

Table 1: Participant Parameters

ParameterTypeOptional/Required Discerption
idstringRequiredAn internal identifier for a participant that will be referenced by other areas of the API to refer to it
NOTE
Make sure to choose a unique identifier for each participant of a specific step
name stringRequiredThe name of the participant will be used for embedding in communication messages (SMS or emails)
role stringRequiredThe role of a participant

Sample Call

"participants": [
        {
            "id": "agent",
            "name": "Dennis",
            "role": "rep"
        },
        {
            "id": "customer1",
            "name": "Naomi",
            "role": "signer"
        },
        {
            "id": "Dee",
            "name": "The customer",
            "role": "signer"
        }
    ]

Can’t find what you’re looking for?

Let us know what you need and we'll help you as soon as possible.