Skip to navigation

Authentication

View as Markdown

All calls to the Docusign Agreement Manager API are authenticated using an access token that your app obtains using one of the standard OAuth 2.0 grants supported by Docusign:

Note: See Choose an OAuth type for details on when to use each authentication type.

The only difference between authenticating with the Agreement Manager API and the eSignature API is that, when requesting the access token in your OAuth2 scenario, you must request a special Docusign Agreement Manager scope in addition to your other Docusign eSignature Authentication scopes.

ScopeDescription
adm_store_unified_repo_readRequired to read agreement data from the Agreement Manager API.
adm_store_unified_repo_writeRequired to write agreement data to the Agreement Manager API.
document_uploader_readRequired for the getBulkUploadJob() endpoint.
document_uploader_writeRequired for the createBulkUploadJob() and UploadComplete
public_dms_document_readRequired to call the download_url property of an agreement object so you can download the agreement
search_readRequired when filtering the list of agreements returned by the API using text-based search with the $search parameter

Important: If the required Docusign Agreement Manager API scopes were not explicitly requested, calls to the Docusign Agreement Manager API will fail.

Next steps