The API allows you, or your applications, to directly query Passportal to retrieve data and perform a variety of actions. These include listing all documents that meet the entered filter criteria, retrieving information on a specific topic, creating a batch of new documents or updating one or more documents.

Access to the API requires an authentication token which is passed along with each API call to validate the request. Information on access token creation and the available API calls are covered in the following sections:

  • API Information - information on the <BaseURL> used in the requests and cURLs
  • API Access Token - the steps to generate an API Access Key, create an HMAC token then obtain an API Access Token
  • Documents - the API requests available for documents, including listing, creating and updating