Skip to main content
On the Pro and Pro+AI plans, MSP Process offers several public APIs that allow you to integrate features like end-user verification, secure data sharing, and contact update forms into your existing workflows or custom applications. This article explains how to generate a Public API key and test it using our Swagger documentation.

Generating a Public API Key

  1. Log in to MSP Process as an admin-level user and navigate to Settings > Account Settings > API Keys.
  2. Click the Public API key button to generate a new key.
  3. A modal will appear displaying your new API key. Copy this key and keep it secure. From this modal, you can also click the Swagger documentation link to access the API endpoints (or navigate directly to api.mspprocess.com).

Authorizing and Testing the API via Swagger

Once you have your API key, you can explore and test the available endpoints, which include sending contact update forms, sending end-user verification requests (via email, phone, Microsoft Authenticator, or Duo), and securely sharing data.
  1. On the Swagger documentation page, click the Authorize button in the top right corner.
  2. Paste your copied API key into the Value field and click Authorize.
  3. Locate the endpoint you want to test (for example, sending a verification code via email) and click Try it out.
  4. Modify the request body with the necessary parameters (such as the target email address) and click Execute to send the test request. You will see the curl command and the server’s response below.

Enabling the End-User Verification API

Note: By default, the End-User Verification API is disabled. If you attempt to use these specific endpoints without enabling them, you will receive an error. You must enable the API and link it to your PSA so the system knows which contacts to verify against.
  1. In the MSP Process portal, navigate to Identity Management > Verification > Verification Settings.
  2. Click to expand the API Settings section.
  3. Check the Enable box and select your primary PSA Integration from the dropdown menu.
  4. Click Submit to save your changes
  5. Return to the Swagger documentation and click Execute again. Your API call should now process successfully (e.g., returning a user not found message if the test email isn’t in your PSA, or a success message if it is).