Roles

This section describes the following services related to Roles:

This guide’s REST API chapter provides an overview of certain basic API calls. If you want to view all existing calls, see the REST API Object Model. Additional information about the calls can be found on the Developer Community website. That site’s Feature Guides may be especially helpful when you’re building your solution.

Retrieve All Roles for a Package

GET /packages/{packageId}/roles

Description

Retrieve all Roles for a document package.

Resource Information

HTTP Method GET
Resource Family roles
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Path Parameters

packageId Unique identifier of a OneSpan Sign package

Example Request

GET https://sandbox.e-signlive.com/api/packages/92c25181-f3a4-469c-b508-2661fcc94ec1/roles

Retrieve a Role

GET /packages/{packageId}/roles/{roleId}

Description

Retrieve a single Role associated with a package.

Resource Information

HTTP Method GET
Resource Family roles
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Path Parameters

packageId Unique identifier of a OneSpan Sign package
roldId Unique identifier of a OneSpan Sign Role

Example Request

GET https://sandbox.e-signlive.com/api/packages/92c25181-f3a4-469c-b508-2661fcc94ec1/roles/PvnDL9etdvwP

Create a Role

POST /packages/{packageId}/roles

Description

Add a new Role to an existing package.

Resource Information

HTTP Method POST
Resource Family roles
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Path Parameters

packageId Unique identifier of a OneSpan Sign package

Example Request

POST https://sandbox.e-signlive.com/api/packages/2c478c3a-85a0-4981-a52a-e52691811e42/roles

KBA Equifax USA Example

KBA Equifax Canada Example

Assign a Signing Method to a Role

POST /packages/{packageId}/roles/{roleId}/verification

Description

Assign a Signing Method to a Role.

Resource Information

HTTP Method POST
Resource Family roles
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Path Parameters

packageId Unique identifier of a OneSpan Sign package
roleId Unique identifier of a OneSpan Sign role

Example Request

POST https://sandbox.e-signlive.com/api/packages/b12db619-d3bc-454d-a8d0-2496ba2acb77/roles/mT5yYC8AYUM8/verification

Reassign a Role to Another Signer

POST /packages/{packageId}/roles/{roleId}/reassign

Description

Reassign a Role from one signer to another.

Resource Information

HTTP Method POST
Resource Family roles
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Path Parameters

packageId Unique identifier of a OneSpan Sign package
roleId Unique identifier of a OneSpan Sign Role

Example Request

POST https://sandbox.e-signlive.com/api/packages/abbdaca2-fafa-41df-9dea-c07e3f50ebe0/roles/UPe3cbwJpO08/reassign

Unlock a Role

POST /packages/{packageId}/roles/{roleId}/unlock

Description

Unlock a Role.

Resource Information

HTTP Method POST
Resource Family roles
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Path Parameters

packageId Unique identifier of a OneSpan Sign package
roleId Unique identifier of a OneSpan Sign role

Example Request

POST https://sandbox.e-signlive.com/api/packages/b12db619-d3bc-454d-a8d0-2496ba2acb77/roles/bIhMRC68aHcJ/unlock

Send an Email to the Signer(s) Linked to a Role

POST /packages/{packageId}/roles/{roleId}/notifications

Description

Send an email notification to the signer(s) linked to a Role.

Resource Information

HTTP Method POST
Resource Family roles
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Path Parameters

packageId Unique identifier of a OneSpan Sign package
roleId Unique identifier of a OneSpan Sign Role

Example Request

POST https://sandbox.e-signlive.com/api/packages/abbdaca2-fafa-41df-9dea-c07e3f50ebe0/roles/UPe3cbwJpO08/notifications

Send an SMS to the Signer(s) Linked to a Role

POST /packages/{packageId}/roles/{roleId}/sms_notification

Description

Send an SMS notification to the signer(s) linked to a role

Resource Information

HTTP Method POST
Resource Family roles
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Path Parameters

packageId Unique identifier of a OneSpan Sign package
roleId Unique identifier of a OneSpan Sign Role

Example Request

POST https://sandbox.e-signlive.com/api/packages/abbdaca2-fafa-41df-9dea-c07e3f50ebe0/roles/UPe3cbwJpO08/sms_notification

Reorder the Roles in a Package

PUT /packages/{packageId}/roles

Description

Reorder the Roles in a package.

Resource Information

HTTP Method PUT
Resource Family roles
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Path Parameters

packageId Unique identifier of a OneSpan Sign package

Example Request

PUT https://sandbox.e-signlive.com/api/packages/b12db619-d3bc-454d-a8d0-2496ba2acb77/roles

Update Role Information

PUT /packages/{packageId}/roles/{roleId}

Description

Update a single Role by overriding its existing values with those in the JSON payload.

Resource Information

HTTP Method PUT
Resource Family roles
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Path Parameters

packageId Unique identifier of a OneSpan Sign package
roleId Unique identifier of a OneSpan Sign Role

Example Request

PUT https://sandbox.e-signlive.com/api/packages/b12db619-d3bc-454d-a8d0-2496ba2acb77/roles/mT5yYC8AYUM8

Delete a Signer (Role)

DELETE /packages/{packageId}/roles/{roleId}

Description

Deletes a Role from a package (using the roleId.).

Resource Information

HTTP Method DELETE
Resource Family roles
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Required Parameters

packageId Unique identifier of a OneSpan Sign package
roleId Unique identifier of a OneSpan Sign Role

Example Request

DELETE https://sandbox.e-signlive.com/api/packages/12fedc63-c61e-40e6-a3bc-816511a648af/roles/wAABlTI9AQcT