Alliance and Partner Security

The Documents API allows for documents to be stored at two different levels:

  • Alliance
  • Partner

By default, your usage of the API and the level at which documents are stored are based on your API key which will be setup on your behalf with the relevant details when you generate your API Key. However if you wish to upload documents for a specific parter which you have access to, please follow the guide below.

Creating a Partner level document

When uploading a document using one of the upload APIs you can specify a request header Partner-Code. Fill this in with the partner code you wish to use.

Retrieving a Partner level document

When retrieving a document you can specify a request header Partner-Code. Fill this in with the partner code you wish to use to retrieve the document. If your document was uploaded with a Partner Code originally you must provide this information in order to retrieve the document otherwise your API call will fail.


Did this page help you?