Table of Contents

1. Overview
2. Authentication Overview
   1. Key Features
   2. Authentication Flow
   3. Authentication Token
   4. Security Measures

1. Overview

The Vertex API is a comprehensive Core Banking Platform that provides various services for financial operations and management. Here's a brief overview of its key features and capabilities:

• Authentication: The API includes robust authentication mechanisms for secure access to services.
• Entity Management: The API supports creating and managing organizations, including onboarding processes and KYB (Know Your Business) procedures.
• Account Management: It provides features for managing financial accounts, transactions, and reconciliations.
• Document Generation: The API can generate PDFs and handle document uploads for KYB processes.
• Bulk Operations: It supports bulk payment and transaction operations for efficient handling of multiple transactions.
• Microservices Architecture: The API is built using a microservices architecture, allowing for scalability and modularity.

External users can interact with these services through well-defined endpoints, adhering to security protocols and data formats specified in the API documentation. The API is designed to be robust, scalable, and compliant with financial industry standards.

Authentication Process Overview

The authentication model ensures that private keys are maintained by the end-user. The process of creating and exchanging credentials follows these steps:

1. Key Generation
   • End user generates an NKey pair consisting of:
     • Private seed
     • Public key
2. Public Key Sharing
   • End user shares only the public portion of the keypair
   • Private seed remains securely with the end user
3. JWT Generation
   • SAVA generates a JWT (JSON Web Token)
   • This JWT is required for connecting to the NATS server
4. Credentials File Creation
   • End user creates a credentials file by combining:
     • Their private seed
     • The provided JWT
5. Connection
   • End user connects to the NATS server using the credentials file

This process ensures secure authentication while maintaining end-user control over private keys.

2.3 Authentication Token

Upon successful login, the API returns a JWT (JSON Web Token) which should be included in the header of all subsequent requests Nats requests:

2.4 Security Measures

• NKey-based authentication ensures end-user control of private keys
• Public key infrastructure provides secure identity verification
• JWT tokens are used for secure, stateless authentication
• Credentials files combine user's private seed and JWT for secure connections
• Rate limiting is implemented to prevent abuse

For detailed information on request/response formats and error handling, please refer to the individual endpoint documentation.