Therefore, we are pleased to introduce our Domain Model documentation. This documentation gives you the business context behind our data, helping you better understand Akkuro Lending and use our API schema with confidence.

What is the Unified Domain Model?​

The Unified Domain Model is a standardized, business-driven representation of real-world concepts and objects related to lending. Akkuro Lending organizes objects by functional domain, such as counterparty and collateral. The UDM forms the foundation that keeps the entire Lending ecosystem working together smoothly and serves as a guideline for data storage.

This improves communication between components, increases data consistency, reduces mapping errors and ambiguity, and simplifies integration across different systems and teams.

To learn more, check out the Domain model overview.

What our Domain Model documentation offers​

If you’re exploring how your system can integrate with us, or you simply want to understand how our lending domain is structured, this documentation is your go-to resource.

To make these concepts easy to grasp, the docs include simplified diagrams inspired by UML class diagrams. These visuals highlight the essential classes, attributes, and relationships you need to understand how data is organized. These visuals help you quickly understand how lending data is structured, plan smoother integrations, and see how different parts of the platform fit together.

Moreover, this documentation shows not just the data structure, but also explains the business meaning behind the data. It gives you the big picture of our domain model, helping you understand what the data means.

Currently, our documentation covers the following functional domains:

• Counterparties
• Collaterals
• File Documents
• Financing Execution
• Financing Solutions
• Private Financials
• Process Orchestration

How to use our documentation​

The Domain Model documentation and the API Schema are designed to work hand in hand:

• The Domain Model documentation explains the domain concepts
• The API schema shows you how to interact with the APIs

By starting with the Domain Model documentation, you’ll understand the core concepts, how objects depend on each other, and which APIs to use at each stage of a business flow. This reduces guesswork, shortens integration time, and leads to cleaner, more reliable implementations.

That’s where our brand-new Migration Assistance API comes in. It helps you move existing data from your current systems into the Akkuro Lending platform, making your data migration journey easier, faster, and more secure. Let's learn what it can offer.

What is the Migration Assistance API?​

The Migration Assistance API acts as your assistant to help you along your data migration journey. You can also think of this API as your migration safety net. It’s not just about moving data, it’s also about doing it right. With validation, an isolated staging environment, and compliance built in, you can migrate confidently without worrying about data leaks or broken records.

The migration goal is simple: move data securely, accurately, and with minimal disruption. Therefore, our Migration Assistance API is designed to make the migration process smooth, controlled, safe, and efficient without extra coding.

Currently, you can migrate data into the following Akkuro Lending domains:

• Counterparties: Includes all information related to borrowers, whether individuals or organizations.
• Collaterals: Includes all information related to assets used as security for loans.

Key benefits​

Here’s what makes the Migration Assistance API a powerful companion:

• Staging area: Upload your data to a secure, isolated environment where you can validate everything before it touches your target environment. No surprises, no risks.

• Data streaming: Large datasets? We've got you covered. We support JSON Lines (JSONL) and JSON Text Sequences (JSON-seq) data formats, so you can stream records continuously instead of wrestling with one giant file.

• Domain-specific migration: Move data into lending domains like Counterparties and Collaterals. You can choose to migrate only what you need.

• Privacy and compliance built in: No personal data in logs, isolated environments for each migration, and a full audit trail for peace of mind.

• Granular access control: Only authorized users can migrate data, and you can grant read-only access for monitoring.

Data migration journey​

To give you a quick picture of migration journey in Akkuro Lending, here’s the overall flow:

If you'd like to go deeper, dive into these resources to start your journey:

• A detailed step-by-step migration guide
• Migration Assistance API schema

These resources provide detailed instructions and API references to help you get started.

What's next​

At this initial phase, you can only migrate data into two Akkuro Lending domains: Counterparties and Collaterals. We are working to expand support for additional data domains. We will share updates as soon as they’re available.

Your data deserves a smooth landing. With Akkuro Lending’s Migration Assistance API, your data migration becomes predictable, secure, and efficient.

By reading this article, you can also explore the capabilities that we offer to help you use our APIs more efficiently.

What’s new?​

We’re continuously improving the Akkuro Lending API documentation to enhance the developer experience. In this release, we’ve added new documentation outlining our core principles and standards that apply across all APIs, along with feature guides detailing the capabilities currently supported.

Content types and data format​

We've standardized and documented the common content types and data formats used in API requests and responses, along with examples to help developers parse them correctly and ensure reliable data processing.

Check out Data format for more details.

Status codes and error handling​

We've added a list of all possible success and error codes returned by Akkuro Lending APIs and troubleshooting tips. We also explain the standard error message format, defined in RFC 7807, which helps you debug faster.

Check out Status codes and error handling for more details.

Pagination​

Some APIs that list or retrieve collections of items may return super-large volumes of data in a single response. This can lead to slow response, server strain, timeouts, or system failures.

Pagination helps you resolve these issues. This approach improves user experience by reducing page load times, preventing overwhelming users with too much information at once, and allowing them to navigate content more easily.

Check out Pagination for further details.

Streaming data​

If your application frequently downloads large datasets and suffers from slow responses or system strain, our streaming APIs offer a scalable solution.

Streaming APIs allow your application to download large datasets. Data is delivered incrementally as JSON objects over a persistent connection, so your application can process the data immediately as it arrives, instead of requiring the entire dataset to be available before sending.

Check out Streaming data for further details.

Webhooks​

If you need to receive near real-time notifications directly to your system, Webhooks are a great choice.

Webhooks let you subscribe to some specific events or changes happening in the Akkuro Lending platform in real-time, and your server is automatically notified and receives a delivery of data whenever those events occur.

Check out Webhooks for further details.

Explore the docs​

Explore our Akkuro Lending documentation site to discover all the latest updates. We’d love to have your feedback.

We will continue expanding our documentation to give you deeper insight into the Akkuro Lending domain model, helping you use our APIs more efficiently.

At Akkuro Lending, as we’re constantly rolling out new features and expanding our API offerings, we remain committed to delivering a developer experience that’s smooth, simple, and transparent.

What we offer​

The new Akkuro Lending API documentation site is built with developers in mind, offering:

• Intuitive navigation: Easily find what you need with a clean, user-friendly navigation bar and sidebar.

• User-friendly reading interface: Enjoy a clean design and typography for a better reading experience. Each documentation page is clearly structured with headings and a built-in table of contents, making it easier to scan and navigate.

• Comprehensive guides: Step-by-step tutorials, real-world examples, and troubleshooting tips make it easy for developers of all experience levels to get started and go deep.

• Responsive design: Whether you're on a desktop, tablet, or smartphone, our documentation adapts seamlessly. You can learn and read our documentation from any device, anywhere, in a way that fits your work style.

About our documentation site​

The first launch of the Akkuro Lending API documentation includes two sites:

• API documentation
• API schemas

API documentation​

The Akkuro Lending API documentation site includes step-by-step tutorials, integration walkthroughs, and architectural overviews to help you understand our services.

You can access the API documentation here.

You can also comfortably navigate and read our documentation on other devices.

API schemas​

The API schemas site provides technical reference for all APIs documented using OpenAPI specifications, including endpoints, parameters, data formats, and error responses.

You can access the API schemas here.

What's in the first release​

Here’s what’s included in this first release:

• Overview of the Akkuro Lending API documentation. See Akkuro Lending overview.
• Learn how to request access to our API. See Request access to the APIs.
• Understand how to work with different regions and environments. See Base URLs & Environments.
• Learn how to securely authenticate and authorize your requests. See Authentication and authorization
• Explore how to use the schema browser to navigate available APIs and schemas. See Use API schema browser.
• Learn how to specify and manage different API versions. See API Versioning.

What's next​

We’re just getting started. Our goal is to continue to actively grow and improve our documentation to better support your development journey. That means adding new guides, updating schemas, and expanding real-world use cases, so you can get the most out of our platform with ease.

Your feedback plays a vital role in shaping this experience. If you have suggestions, questions, or spot something we can do better, we’d love to hear from you.