Overview

Account API

The Account Management API provides a streamlined interface for partners to create business accounts within the PEAX system. The focus is on establishing a business account and associating individual members (implicitly creating their private accounts) as part of the business entity. The API requires specific mandatory fields to be submitted; if any are missing, the request is rejected with an error. Once the information is provided, the API proceeds with the account creation. The resulting business account status can be 'SUCCESSFUL', 'PENDING', or 'FAILED', depending on the outcome of the operation. The integration of this API allows partners to seamlessly onboard businesses onto the PEAX platform, where the PEAX-Core takes over for account validation and activation, ensuring a secure and robust user experience.

Partner: Initiates the account creation process by submitting the necessary details to the Account Management API.

Account Management API: Receives the request and validates the mandatory fields as specified by the business logic. If the validation fails, it responds with an error.

PEAX-Core: Upon successful validation, the core system is responsible for the actual creation of the business account and the member associations.

Account Management API: Once PEAX-Core has processed the request, the API responds back to the partner with the result, indicating the status of the business account creation.

Domain Model

Partner: Represents the client using the API to create a business account. Partners submit account information through the API.

Account Management API: The main interface that partners interact with. It processes requests to create business accounts and interacts with the PEAX-Core system.

Business Account: The central entity that is created by the API. It includes all necessary information about the business, such as name, type, UID, addresses, and subscription details.

Member: Represents individuals associated with the business account. Each member is a part of the business account entity.

Address: A reusable component representing the address details for both domicile and forwarding addresses.

PEAX-Core: The backend system that validates and activates the account. It generates responses indicating the account creation status.

Business Account Creation Response: The response object that contains the status of the account creation process, including the PEAX ID.

Process Model

Partner initiates the process by sending a POST request to the Account Management API to create a business account.

The Account Management API then requests account data validation from the PEAX-Core system.

The PEAX-Core system validates the provided data and returns the results to the API.

If the validation is successful, the PEAX-Core proceeds to create the business account and its members, then informs the API of the successful creation, including the new PEAX ID and status.

If the validation fails, the PEAX-Core sends an error response back to the API.

Finally, the Account Management API sends back a response to the Partner, either with the PEAX ID and status of the created account or with error details if the creation failed.

Account API#

Domain Model#

Process Model#

Account API

Domain Model

Process Model