Connection¶
A connection is a link between Averdoc and a 3rd party service or app. The OAuth 2.0 connection handles the token exchange automatically.
When working with the Averdoc APIs, your app will access Averdoc on behalf of your users. You'll need to have each user of your app sign into averdoc.com to grant your app permission to access their data on Averdoc.
Averdoc API is designed for application partners to add E-Signature and all new features to their existing applications, including E-Certify and E-Tax.
Note
Averdoc supports OAuth 2.0 only. Before you start configuring your OAuth2.0 connection, you need to create an app via Averdoc partner portal. If you don't have a registered app or your app status is waiting for approval, you can use Postman for development purposes and testing APIs by follow Getting Started guide below. You also need an Averdoc account with any plan to test as end-user consent.
Learn more API Reference
Getting Started development with Postman¶
Authorization and request access token with Postman
| Field | Description |
|---|---|
| Grant Type | Authorization Code (With PKCE) |
| Callback URL | https://oauth.pstmn.io/v1/callback (Authorize using browser) |
| Auth URL | https://account.averdoc.com/connect/authorize |
| Access Token URL | https://account.averdoc.com/connect/token |
| Client ID | postmanapi |
| Code Challenge Method | SHA-256 |
| Code Verifier | Blank (Automatic) |
| Scope | email averdoc.api |
Note
Scope offline_access is not allowed with this Client ID
Testing your authorization token by calling this API¶
GET https://webapi.averdoc.com/api/getuserinfo
Get customer account and user information
curl --location --request GET '/api/getuserinfo' \
--header 'authorization: bearer [accesstoken]' \
| Responses | |
|---|---|
| 200: OK | Returns customer account and user information |
| 400: Bad Request | If customer not found |