Login as Subaccount API

This new API provides a secure and efficient way for your parent account to directly access and operate as one of its linked sub-accounts. Imagine having the ability to manage transactions, execute FX, and perform payouts directly from the sub-account's perspective, all through our robust API.

Why is this API important for you?

This API is a game-changer for partner referral setups, offering several key advantages:

• Direct Sub-Account Transactions: For partner referral accounts, funds cannot be swept to the parent account. This API enables you to initiate and complete all transactions, including Foreign Exchange (FX) and payouts, directly at the sub-account level. This ensures a clear and compliant fund flow for your referred clients.
• Enhanced Sub-Account Control: Gain comprehensive control over your sub-accounts. This API opens up access to additional features at the sub-account level, empowering you to manage their financial activities with greater precision.
• Streamlined Operations: Experience a more consistent and efficient approach to managing your sub-accounts. This API mirrors the intuitive account switching functionality you might already be familiar with in our user interface (UI), ensuring a smooth transition between parent and sub-account operations.

How it Works

The "Login as Sub Account" API is straightforward to integrate and use:

• Authenticate as Parent: Your parent account will first authenticate with the API, providing the necessary credentials to identify both your parent account and the specific sub-account you wish to log into.
• Receive JWT Token: Upon successful authentication, the API will generate a secure JSON Web Token (JWT). This token acts as your temporary access pass, allowing you to perform actions on behalf of the sub-account. The JWT token expires after 1 hours. Then the parent account will have to authenticate again.
• Execute Sub-Account Operations: Use this JWT token in the authorization header of all subsequent API calls to conduct transactions, access information, and utilize features specific to that sub-account. All these operations will be attributed to the sub-account.

API Details (Technical Overview)

Endpoint: https://api-company-sandbox.vertofx.com/sub-accounts/{subCompanyId}/login
Method: POST Parameters:

• subCompanyId: This is the unique identifier for the sub-account to be accessed.

Successful Response Example:

{
  "userId": "string",
  "companyId": "string",
  "jwt": "string"
}