▲ Top

Accounts

This section describes the following services related to Accounts:

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 Details about an Account

GET /account

Description

Retrieve details about an Account.

Resource Information

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

Example Request

GET https://sandbox.e-signlive.com/api/account

Retrieve a List of Users in an Account

GET /account/senders

Description

Retrieve the list of users in an Account.

Resource Information

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

Optional Query Parameters

search The character string for a search filter. Only users whose First Name, Last Name or Email Address matches this string will be listed in the search results.
dir The direction in which users are sorted. The value asc (the default value) sorts them alphabetically by their Email Address. The value des reverses the sorting direction (asc = ascending; des = descending).
from The indexes of the first user and last user to be retrieved. For example, suppose that 100 users match the search string, and that from = 1 and to = 10. In this case, only users 1 through 10 from the list of 100 will appear in the search results. These parameters are useful for paging search results.
to

Example Request

GET https://sandbox.e-signlive.com/api/account/senders

Retrieve Detailed Account Information about a User

GET /account/senders/{senderUid}

Description

Retrieve detailed Account information about a user.

Resource Information

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

Path Parameters

senderUid Unique identifier of a OneSpan Sign sender

Example Request

GET https://sandbox.e-signlive.com/api/account/senders/58fe143e-6465-48b9-a724-d9fa1b28f3f8

Create a New User in an Account

POST /account/senders

Description

Create a new user in an Account.

Resource Information

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

Example Request

POST https://sandbox.e-signlive.com/api/account/senders
{
  "email":"wwhite@gmail.com"
}

Reset the Password for a User

POST /account/senders/{senderUid}/resetpassword

Description

Reset a user's password.

Resource Information

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

Path Parameters

senderUid Unique identifier of a OneSpan Sign sender

Example Request

POST https://sandbox.e-signlive.com/api/account/senders/VZ5ZTPUxkQMU/resetpassword

Response Payload

no content