End User APIs (1.1)

Download OpenAPI specification:Download

Our End User APIs (Open Banking API) serves as the gateway for seamless interaction between end-user interfaces and our Core Banking platform.

Client centered designed to offer flexibility and accessibility, this API empowers applications to securely access and leverage the rich functionality of our platform. Through standardized endpoints and robust authentication mechanisms, our Open Banking API facilitates the integration of diverse channels, including websites, mobile apps, and other digital platforms, enabling users to perform a wide range of operations with efficiency and anti lock in solutions.

Whether it's checking balances, performing payments, or managing accounts, our API ensures a smooth and intuitive experience for all users.

The following Methods are divided into the following categories:

Category Purpose
Authentication AurumCore APIs offer robust authentication and security methods, encompassing access control and user verification, to ensure secure and reliable transactions for financial services, enhancing overall system integrity and user trust.
Onboarding AurumCore APIs facilitate onboarding with efficient user registration methods, ensuring smooth and secure integration of new users into the financial services platform, enhancing user experience and compliance.
Profile AurumCore APIs manage user profiles efficiently, providing robust user data management capabilities, ensuring secure storage, updating, and retrieval of user information for enhanced personalization and compliance.
Debit AurumCore APIs enable comprehensive debit module functionalities, including account creation, transaction management, balance inquiries, and real-time processing, ensuring seamless debit services integration for financial institutions.
Deposit AurumCore APIs offer extensive deposit module functionalities, facilitating account creation, deposit management, interest calculations, and real-time updates, ensuring efficient and secure deposit services for financial institutions.
Transaction AurumCore APIs provide methods for managing incoming, outgoing, and internal transactions, ensuring efficient, secure, and real-time processing across financial services.

AurumCore APIs

End User APIs

Authentication

Token Client Credentials

Method to generate the initial log in token for end user applications, ensuring secure and authenticated access for new users.

path Parameters
tenant_url
string
apim_url
string

Token Open Banking

Method to generate a token for an end user application after the log in process, ensuring continuous secure access.

path Parameters
{apim_url
string

Clients_APIM_URL

tenant_url
string

Clients_TENANT_URL

Profile

TermsAndConditions

Method to consult the terms and conditions from which the user registered, ensuring users are informed about the relevant policies and agreements of their service provider.

path Parameters
mgtw_url
string
tenant_name
string

RegisterCreate

Method to create a new username and password for a specific end user, ensuring secure and personalized access to the application.

path Parameters
mgtw_url
string
tenant_name
string

OTPValidate

Method to validate OTP (first and second validation) for mobile phone number and email, ensuring secure user verification.

path Parameters
mgtw_url
string
tenant_name
string

OTPSend

Method to resend OTP if it does not arrive, ensuring users can complete the verification process securely and successfully.

path Parameters
mgtw_url
string
tenant_name
string

RegisterUpdateInfo - Fisica

Method to update information about an end user for entities such as companies or individuals, ensuring accurate and up-to-date user data.

path Parameters
mgtw_url
string
tenant_name
string

Address

Method to consult address catalogs using postal code, providing details such as state, municipality, and city for accurate location information.

path Parameters
mgtw_url
string
tenant_name
string

BusinessLine

Method to consult the catalog for business activities, providing detailed information on various business sectors and classifications.

path Parameters
mgtw_url
string
tenant_name
string

MaritalState

Method to consult the marital status catalog, providing detailed information on various marital status classifications for user profiles.

path Parameters
mgtw_url
required
string
tenant_name
required
string

Countries

Method to consult the country catalog, providing detailed information and IDs for various countries for accurate user and data classification.

path Parameters
mgtw_url
string
tenant_name
string

Beneficiaries

Method to obtain beneficiaries and their percentage of benefit, providing detailed information on designated beneficiaries and their respective shares for accurate and effective account management.

path Parameters
mgtw_url
string
tenant_name
string

References

Method to get references related to the end user, providing comprehensive information on associated references for better user and account management.

path Parameters
mgtw_url
string
tenant_name
string

CreateReference

Method to create a reference for an account holder, allowing the addition of detailed reference information to enhance user profiles and account management.

path Parameters
mgtw_url
string
tenant_name
string

UpdateReference

Method to update an existing account holder reference, ensuring current and accurate information is maintained for effective account and user management.

path Parameters
mgtw_url
string
tenant_name
string

UpdateBeneficiary

Method to update an existing account holder beneficiary, ensuring beneficiary information is current and accurate for effective account management and distribution of benefits.

path Parameters
mgtw_url
string
tenant_name
string

Profile

Method to obtain account holder information, providing detailed and up-to-date data for effective account management and user profiling.

path Parameters
mgtw_url
string
tenant_name
string

UpdateProfile

Method to obtain account holder information, providing detailed and up-to-date data for effective account management and user profiling.

path Parameters
mgtw_url
string
tenant_name
string

ValidatePassword

Method to validate your end user's password, ensuring secure authentication and access control for account management.

path Parameters
mgtw_url
string
tenant_name
string

UpdatePassword

Method to update the password by sending the old one and setting the new one, ensuring secure and efficient password management for end users.

path Parameters
mgtw_url
string
tenant_name
string

Debit

Accounts

Method to retrieve all accounts of an account holder, encompassing all financial products such as debit cards and savings accounts, ensuring users can easily access and manage their diverse financial assets in one place.

path Parameters
mgtw_url
string
tenant_name
string

AccountByAccountID

Method to obtain information for a single account product using an account ID, providing detailed insights and data for the specific financial account securely and efficiently.

path Parameters
mgtw_url
string
tenant_name
string

Balances

Method to obtain balances for all accounts of an account holder. For credit accounts, it provides cut-off date, unpaid balance, and total payment. For term investments, it provides the investment balance, ensuring comprehensive and detailed financial information for effective account management.

path Parameters
mgtw_url
string
tenant_name
string

BalanceByAccountID

Method to obtain the account balance of an account ID from an account holder, ensuring detailed financial information for effective account management.

path Parameters
mgtw_url
string
tenant_name
string

UpdateStatus

Method to generate a lock or unlock for the account holder (1 for lock, 0 for unlock). If a user is locked, they cannot perform any incoming or outgoing monetary transactions, ensuring security and control over account activity.

path Parameters
mgtw_url
string
tenant_name
string

UpdateAccount

Method to assign a nickname to an account, allowing users to personalize and easily identify their accounts for better management and convenience.

path Parameters
mgtw_url
string
tenant_name
string

CreateAccount

Method to create a parent account and child accounts with the default scheme. System configuration defines the default scheme when creating accounts, ensuring standardized account structures and management.

path Parameters
mgtw_url
string
tenant_name
string

GetCard

Method to get card details, streamlining the process of managing card functionalities within our platform. While third-party providers handle the cards, our platform serves as the central hub, enabling users to effortlessly associate their cards with preferred financial products and manage functionalities like locking and unlocking.

path Parameters
mgtw_url
string
tenant_name
string

CardState

Method to toggle card lock or unlock, allowing users to manage the security of their cards by enabling or disabling their usage through the platform, ensuring control and flexibility over card functionalities.

path Parameters
mgtw_url
string
tenant_name
string

CardLock

Method to lock a card, preventing any transactions and ensuring security by disabling its usage through the platform.

path Parameters
mgtw_url
string
tenant_name
string

CardUnLock

Method to unlock a card, re-enabling its usage and allowing transactions through the platform, providing flexibility and control over card functionalities.

path Parameters
mgtw_url
string
tenant_name
string

Transaction

Transactions

Method to get transactions from all accounts of an account holder, providing a comprehensive overview of all financial activities across their accounts, ensuring users can track and manage their transactions effectively and efficiently.

path Parameters
mgtw_url
string
tenant_name
string

AccountTransactions

Method to obtain transactions from an account holder's particular account, providing detailed insights into financial activities for that specific account, ensuring accurate tracking and effective account management.

path Parameters
mgtw_url
string
tenant_name
string

DomesticPaymentState

Method to obtain information and status of a generated P2P or interbanking transaction, providing detailed insights and updates for effective transaction tracking and management.

path Parameters
mgtw_url
string
tenant_name
string

DomesticPayment

Method to generate an interbanking or P2P transfer transaction, facilitating secure and efficient fund transfers between accounts.

path Parameters
mgtw_url
string
tenant_name
string

Deposit

Categories

Method to get categories of fixed-term investment products, providing detailed information on various investment options available for effective financial planning and management.

path Parameters
mgtw_url
string
tenant_name
string

Deposit-Products

Method to obtain a list of fixed-term investment products available to the user, providing comprehensive options for informed investment decisions and financial planning.

path Parameters
mgtw_url
string
tenant_name
string

Deposit-ProductDetail

Method to obtain the details of a fixed-term investment product, providing in-depth information for users to make informed investment decisions and manage their financial assets effectively.

path Parameters
mgtw_url
string
tenant_name
string

Deposit-Product Miscellaneous

Method to obtain the details of the miscellaneous aspects of a fixed-term investment product, providing comprehensive information for thorough understanding and effective management of the investment.

path Parameters
mgtw_url
string
tenant_name
string

Create Deposit Account

Method to create an investment with parameters of amount, term, expiration instruction, and source account, ensuring tailored and effective investment management.

path Parameters
mgtw_url
string
tenant_name
string