Pearsana Docs

Appearance

Release v3.3.0 ​

Introducing the Partner API — enabling education platforms and systems to integrate directly with Pearsana.

What's new ​

Partner API ​

Education platforms such as Slate, Banner, Workday, and others can now connect to Pearsana through a secure REST API. This means your institution's existing systems can exchange data with Pearsana automatically — no manual imports or exports required.

What partners can do:

  • Create and invite users — onboard students individually or in bulk, with invitation emails sent automatically
  • Link external references — connect student IDs, transcript codes, and other identifiers from your system to Pearsana users for easy cross-system lookups
  • Submit documents — send individual or batch documents into a student's Wallet, with optional verification
  • Monitor API activity — view real-time API logs and usage from the developer portal
  • Manage credentials — create and manage secure API credentials from within the Wallet

Developer portal ​

Organisation administrators now have access to a Developer Portal inside the Wallet — a dedicated area for managing API integrations.

Highlights:

  • Create, view, and delete API credentials with fine-grained permission controls
  • Real-time API log viewer with filtering by route, time range, and more
  • Time-based queries from the last 5 minutes up to 30 days
  • Fully accessible with keyboard navigation

Secure by design ​

The Partner API is built with security and privacy at its core:

  • OAuth2 authentication — partners authenticate securely and receive a bearer token for all requests
  • Permission-based access — each API credential has specific permissions, so partners only access what they need
  • Tenant isolation — each organisation's data is completely isolated; partners can only access their own students and documents
  • Privacy compliant — personal information is protected throughout, with email masking and visibility controls on all data

API versioning ​

The Partner API uses date-based versioning, ensuring stability for existing integrations while allowing Pearsana to evolve. Partners specify their API version with each request, and older versions continue to work until they are formally retired with advance notice.

Improvements ​

  • Smaller, faster backend — behind-the-scenes optimisations make the platform faster and more efficient
  • Updated infrastructure — platform components have been updated to the latest supported versions for improved performance and security

Need help? ​

Email support@pearsana.com — the team can help with API integration, developer portal setup, or anything else.