---
description: >-
  The Partner API documentation provides a foundation for partners to seamlessly
  integrate with our platform.
---

# Getting Started

The API is divided into separate modules, each adhering to the single responsibility principle while being supported by robust security mechanisms that safeguard all sensitive data. All underlying systems comprising the API are guaranteed to maintain compliance with GDPR, MiCA, and DORA regulations.

Before proceeding further, partners should review the differences between these modules, along with other terminology used throughout the documentation. Having a clear understanding and the ability to distinguish among these concepts is essential for successful implementation.

## Terminology

### Partner

A partner is an entity that utilizes our platform to deliver services to its customers. Partners integrate with our system through the Partner API to access comprehensive functionality and manage their operations.

### Integrator

An integrator is an individual responsible for establishing and maintaining the technical integration between the partner and our platform through the Partner API.

### Organization

An organization is a representation of the partner within our platform. Each partner is associated with a single organization that serves as their operational entity for all platform interactions.

### User

A user is an entity that interacts with our platform on behalf of the organization. Each user is assigned specific permissions that determine the actions they are authorized to perform within the platform.

## Modules

### Auth

The Auth module manages authentication operations, including JWT token generation, refresh, and revocation. The Partner API utilizes JWT authentication for secure access. Additional information regarding authentication security can be found on the [security.md](essentials/security.md "mention") page.

API Reference: [auth.md](api-reference/auth.md "mention")

### Observability

The Observability module provides system health monitoring to ensure the Partner API operates within expected parameters.

API Reference: [observability.md](api-reference/observability.md "mention")

### Organization

The Organization module manages all data and configurations associated with the partner organization, including operational parameters, credentials, and related entities essential for platform functionality.

API Reference: [organization.md](api-reference/organization.md "mention")

***

Navigate through the documentation using the buttons below, or explore specific topics in the sidebar. Should assistance be required or questions arise, the support team is available on Slack to provide guidance.