Create an OAuth Client Application

Audience: Organizations

The short answer: OAuth is a standard authorization protocol that lets you securely connect external systems to your Proof account without sharing passwords. Here's how to create an OAuth client application to get started.

Only organization owners, admins, or users with API management permissions can create OAuth client applications. Read the OAuth developer docs for technical details.

⚠️
OAuth is a paid feature and must be enabled by Proof. Contact your Customer Success Manager (CSM) or have an owner/admin contact the Sales team using an email address connected to your company's Proof account.
πŸ”’
OAuth client applications provide API access to your Proof account. Store all generated secrets securely and never share them publicly.

How it works

Instead of sharing a username and password, OAuth uses tokens that provide specific, limited permissions. A common example is signing in with Google or Apple. In Proof, OAuth is offered as an alternative to API keys.

To use OAuth, you create a client application. You can create an unlimited number of client applications. Each client application:

  • Has one unique App ID
  • Can have multiple random App secrets
  • Has a scope equivalent to a full-access API key

App secrets:

  • Are displayed to you only once β€” copy and store them immediately
  • Show the date and time of creation
  • Can be deleted unless they're the only secret associated with the client application

OAuth tokens expire every 2 hours.

ℹ️
Best practice: Create separate OAuth client applications for production, testing, and development environments whenever possible.

Common use cases

  • Integrating external systems with the Proof API
  • Automating transaction creation workflows
  • Managing API authentication without sharing account credentials
  • Supporting secure third-party integrations
  • Separating production and sandbox API environments

Security considerations

  • Store OAuth client secrets in a secure credential management system.
  • Never expose OAuth secrets in source code repositories or client-side applications.
  • Rotate client secrets regularly according to your organization's security policies.
  • Revoke unused or compromised secrets immediately.

Create an OAuth client application

  1. Select Settings from the menu on the left.
  2. Select OAuth from the Settings page menu.
  3. Type the name of the client application.
  4. Select Create client application.
  5. Select Copy to clipboard to copy the secret.

    • Be sure to copy the secret β€” it will not be visible once you navigate away from this page.
    OAuth client application secrets screen showing Copy to clipboard button
⚠️
Important: If you lose the client secret, it cannot be recovered β€” a new secret must be generated.

Troubleshooting

  • If your integration cannot authenticate, verify the correct App ID and secret are being used.
  • OAuth client secrets are only visible once after creation.
  • Expired OAuth tokens must be refreshed through the OAuth flow.
  • Ensure OAuth has been enabled for your organization before attempting to create a client application.

Summary Checklist

  • OAuth must be enabled by Proof before you can create a client application β€” contact your CSM or sales.
  • Navigate to Settings β†’ OAuth, name the application, and select Create client application.
  • Copy the client secret immediately β€” it's shown only once and cannot be recovered if lost.
  • Store secrets securely and rotate them regularly. OAuth tokens expire every 2 hours.
i
Still unsure? Contact Proof Support for help.

Updated

Was this article helpful?

1 out of 1 found this helpful