Carbon Copy Recipients

A carbon copy (CC) recipient is a role that receives a copy of a transaction but does not sign it. Use CC recipients to keep stakeholders, such as managers, legal teams, or record keepers, informed without adding them to the signing workflow.

To add a CC recipient with the REST API, set the role type to CARBON_COPY_RECIPIENT.

When adding a CC recipient note the following:

• Signatures or fields cannot be added to a CC recipient.

• You cannot include a CC recipient in the signing order.

• You must ensure that each CC recipient has a valid email address, first name, and last name.

• CC recipients will only receive transactions that are in a Completed state. No other transaction statuses can be sent to a CC recipient.

For more information, contact our Support Team.

Role Types

The type property of a role determines how OneSpan Sign treats that recipient.

Adding a CC Recipient to a New Transaction

Include the CC recipient in the roles array when you create the transaction.

HTTP Request

POST /api/packages

HTTP Headers

Accept: application/json
Content-Type: application/json
Authorization: Basic api_key

Request Payload

The following example creates a transaction with one signer and one CC recipient.

{
  "name": "Service Agreement",
  "type": "PACKAGE",
  "status": "DRAFT",
  "roles": [
    {
      "id": "Signer1",
      "type": "SIGNER",
      "signers": [
        {
          "email": "wendy.darling@mailinator.com",
          "firstName": "Wendy",
          "lastName": "Darling"
        }
      ]
    },
    {
      "id": "CC1",
      "type": "CARBON_COPY_RECIPIENT",
      "signers": [
        {
          "email": "peter.pan@mailinator.com",
          "firstName": "Peter",
          "lastName": "Pan"
        }
      ]
    }
  ]
}

The CC recipient's details are defined in the signers array, even though a CC recipient does not sign.

Adding a CC Recipient to an Existing Transaction

To add a CC recipient to a draft transaction, send the role to the transaction's roles endpoint.

HTTP Request

POST /api/packages/{packageId}/roles

Request Payload

{
  "type": "CARBON_COPY_RECIPIENT",
  "signers": [
    {
      "email": "peter.pan@mailinator.com",
      "firstName": "Peter",
      "lastName": "Pan"
    }
  ]
}