Authenticate & Authorize

API Clients must authenticate using an API Key associated to a ProviderTrust user account. User accounts are provisioned by your ProviderTrust implementation team.

ProviderTrust recommends registering your API key to a generic email address (i.e. a distribution list address, a "noreply" address, or an integration-specific system address). This ensures your PT API key is not tied to an individual administrator or employee identity.

We utilize OAuth pattern for authentication and authorization.

To authenticate:

1. Create an API Key inside PTApp by logging in, clicking the user icon in the top right corner, and selecting "Personal API Key."
2. Authenticate using the POST Authenitcate User method.

{
   "apikey": "{{your api key here}}"
}

2. After authentication, you will receive a JWT token.

{
   "token": "{{insert token}}",
   "message": "Authentication Successful"
}

3. You must use the associated JWT token in the authorization header on all subsequent API requests ("Authorization": "Bearer {{token}}").
4. The JWT token is valid for 12 hours.