Skip to main content
POST
/
sign
/
envelopes
/
{envelopeID}
/
participants
Create Participant(s) by Envelope ID
curl --request POST \
  --url https://api.gonitro.dev/sign/envelopes/{envelopeID}/participants \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "role": "signer",
  "authentication": {
    "type": "AccessCode",
    "accessCode": "<string>"
  }
}
'
{
  "items": [
    {
      "ID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "<string>",
      "role": "<string>",
      "authentication": {
        "type": "AccessCode",
        "accessCode": "<string>"
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
envelopeID
string<uuid>
required

A unique UUIDv4 string that identifies the envelope in the Nitro system.

Body

application/json
  • Single Participant Request
  • Bulk Participant Request

Participant creation request. Can be either a single participant object or a list of participants. Create a single participant

​
role
enum<string>
required

Role of the participant.

  • signer: A participant with the signer role can have fields assigned to them in order to sign the documents in the envelope.
  • cc: A participant with the cc role has read-only access. They can view the documents but cannot interact with them, so you cannot assign fields to a cc participant.
Available options:
signer,
cc
​
email
string

The email address of the participant

​
authentication
object

Participant authentication

When inviting a participant to a Nitro Sign flow, you must define how they will authenticate before signing the document.

There are two supported methods:

  • Access code: A static code that you provide to the participant.
  • SMS code: A dynamic code that is sent to the participant's phone number.
  • Access Code
  • SMS

Response

Multiple participants created successfully. Returns an object with an 'items' array containing all created participants.

Response containing multiple created participants wrapped in an items array

​
items
Participants · object[]
required

List of all participants created in this request. Each participant contains its unique ID and configuration.