DocumentationAPI Reference
API ChangelogOpenAPIStatus

API Keys

To access the Persona API, you'll need an API key. Each environment has its own API key; select the API key for the specific environment you would like to use.

Getting an API Key

Sandbox

Sign up to get immediate access to a sandbox API key and start evaluating the API with sample data.

Production

When you're ready to use the API in production using live data, please contact us.

Already have an account?

If you already have an account in the Dashboard, you can find your API keys in the API Keys Section.

❗️

Keep your keys secure

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

Permissions

Each API key can be configured with specific permissions in order to limit read or write access to specific API resources. This list can change at any time and should not be considered to be exhaustive. You can configure permissions for your API key in the Dashboard>> by going to API > API Keys > Edit > Permissions.

PermissionDescription
account.readRead Accounts
account.writeCreate/Update Accounts
api_log.readRead API Logs
api_key.writeCreate/Update API Keys
api_key.readRead API Keys
api_key.scimUse for SCIM Integrations
case.readRead Cases
case.writeCreate/Update Cases
document.readRead Documents
document.writeCreate/Update Documents
event.readRead Events
importer.readRead Importers
importer.writeCreate/Update Importers
inquiry.readRead Inquiries
inquiry.writeCreate Inquiries
list.readRead Lists
list.writeCreate/Update Lists
report.readRead Reports
report.writeCreate/Update Reports
txn.readRead Transactions
txn.writeCreate/Update Transactions
user_audit_log.readRead User Audit Logs
verification.readRead Verifications
verification.writeCreate/Update Verifications
webhook.readRead Webhooks
webhook.writeCreate/Update Webhooks
workflow.triggerTrigger Workflows