Authentication Tokens
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.
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
For a complete description of each field, see the Request Payload table below.
|
Property |
Type |
Editable |
Required |
Default |
Sample Values |
|---|---|---|---|---|---|
|
packageId |
string |
No |
No |
n/a |
|
|
signerId |
string |
No |
No |
n/a |
|
|
value |
string |
No |
No |
n/a |
|
Response Payload
Sender Authentication Tokens
A sender authentication token can be used to obtain a session for a sender with access only to a specific package.
HTTP Request
HTTP Headers
Request Payload
Response Payload
Signer Authentication Tokens
A signer authentication token can be used to obtain a session for a signer with access to the Signer Experience.
HTTP Request
HTTP Headers
Request Payload
Response Payload
The signer token above can be used multiple times. You can also create a single-use signer token:
HTTP Request
HTTP Headers
Request Payload
Response Payload
