Authentication Tokens

To download the full code sample see our Code Share site.

An authentication token is used to obtain a valid session for a particular user of the system. This topic introduces the following types of authentication tokens:

• userAuthToken
• senderAuthToken
• signerAuthToken
• singleUseSignerAuthToken.

With the exception of signerAuthToken these tokens are all single-use. The default expiry time for all these tokens is 30 minutes.

The Code

User Authentication Tokens

A user authentication token is a token that can be used to obtain a session for a user with complete access to the account. The following code will create a user authentication token:

 string userAuthToken = eslClient.AuthenticationTokenService.CreateUserAuthenticationToken(); 

Using the user authentication token, you can access your OneSpan Sign account by building the following URL:

Sender Authentication Tokens

A sender authentication token is a token that can be used to obtain a session for a sender with access only to a specific package. The following code will create a sender authentication token:

 string senderAuthToken = eslClient.AuthenticationTokenService.CreateSenderAuthenticationToken(new PackageId(packageId)); 

Using the sender authentication token, you can access the transaction by building the following URL:

Signer Authentication Tokens

A signer authentication token is a token that can be used to obtain a session for a signer with access to the Signer Experience.The following code will create a signer authentication token:

 string signerAuthToken = eslClient.AuthenticationTokenService.CreateSignerAuthenticationToken(new PackageId(packageId), signerId); 

The signer token above can be used multiple times.You can also create a signer token with a single use:

 string singleUseToken = eslClient.AuthenticationTokensService.CreateSignerAuthenticationTokenForSingleUse(packageId, signerId, signerSessionFields); 

Using the signer authentication token, you can obtain a signing session by building the following URL:

To download the full code sample see our Code Share site.

An authentication token is used to obtain a valid session for a particular user of the system. This topic introduces the following types of authentication tokens:

• userAuthToken
• senderAuthToken
• signerAuthToken
• singleUseSignerAuthToken.

With the exception of signerAuthToken these tokens are all single-use. The default expiry time for all these tokens is 30 minutes.

The Code

User Authentication Tokens

A user authentication token is a token that can be used to obtain a session for a user with complete access to the account. The following code will create a user authentication token:

HTTP Request

HTTP Headers

 Accept: application/json   Authorization: Basic api_key 

For a complete description of each field, see the Request Payload table below.

Response Payload

 {   "value": "MjY0MjQ4MzgtMTJlOS00MzhjLTgzODMtMzJmMGNiZTg3ODBl"   } 

Using the user authentication token, you can access your OneSpan Sign account by building the following URL:

Sender Authentication Tokens

A sender authentication token is a token that can be used to obtain a session for a sender with access only to a specific package. The following code will create a sender authentication token:

HTTP Request

HTTP Headers

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

Request Payload

 {   "packageId": "5vjLRY5MWrDJ6MzRAEyCKOy5IH0="   } 

Response Payload

 {   "value": "MjY0MjQ4MzgtMTJlOS00MzhjLTgzODMtMzJmMGNiZTg3ODBl"   } 

Using the sender authentication token, you can access the transaction by building the following URL:

Signer Authentication Tokens

A signer authentication token is a token that can be used to obtain a session for a signer with access to the Signer Experience. The following code will create a signer authentication token:

HTTP Request

HTTP Headers

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

Request Payload

 {   "packageId": "5vjLRY5MWrDJ6MzRAEyCKOy5IH0=",   "signerId": "8b734331-bc5b-4843-9784-d4ece4b7dc22"   } 

Response Payload

 {   "packageId":"5vjLRY5MWrDJ6MzRAEyCKOy5IH0=",   "signerId":"8b734331-bc5b-4843-9784-d4ece4b7dc22",   "value":"ZDNmMDNiNGUtNGYxOC00YWZiLTkwMmUtNWE5YmIwZTRjZDg1"   } 

The signer token above can be used multiple times. You can also create a signer token with a single use:

HTTP Request

HTTP Headers

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

Request Payload

 {   "packageId":"s-wy6PFASBlAKfnLJjcbzoaMyTg=",   "signerId":"[email protected]"   } 

Response Payload

 {   "packageId":"s-wy6PFASBlAKfnLJjcbzoaMyTg=",   "sessionFields": null,   "signerId":"[email protected]",   "value":"ZDNmMDNiNGUtNGYxOC00YWZiLTkwMmUtNWE5YmIwZTRjZDg1"   } 

Using the signer authentication token, you can obtain a signing session by building the following URL:

Request Payload Table

To download the full code sample see our Code Share site.

An authentication token is used to obtain a valid session for a particular user of the system. This topic introduces the following types of authentication tokens:

• userAuthToken
• senderAuthToken
• signerAuthToken
• singleUseSignerAuthToken.

With the exception of signerAuthToken these tokens are all single-use. The default expiry time for all these tokens is 30 minutes.

The Code

User Authentication Tokens

A user authentication token is a token that can be used to obtain a session for a user with complete access to the account. The following code will create a user authentication token:

 public String createUserAuthenticationToken() 

Using the user authentication token, you can access your OneSpan Sign account by building the following URL:

Sender Authentication Tokens

A sender authentication token is token that can be used to obtain a session for a sender with access only to a specific package. The following code will create a sender authentication token:

 public String createSenderAuthenticationToken(String packageId) 

Using the sender authentication token, you can access the transaction by building the following URL:

Signer Authentication Tokens

A signer authentication token is a token that can be used to obtain a session for a signer with access to the Signer Experience. The following code will create a signer authentication token:

 public String createSignerAuthenticationTokenForMultiUse(String packageId, String signerId) 

The signer token above can be used multiple times. You can also create a signer token with a single use:

 public String createSignerAuthenticationTokenForSingleUse(String packageId, String signerId) 

Signer ID in this function can also be replaced by Signer Email.Using the signer authentication token, you can obtain a signing session by building the following URL: