Authentication
Authentication for certain API endpoints is primarily handled through the use of an `x-api-key` header. This key serves as a foundational layer of security, identifying the application or service making the request.
For APIs that require a deeper level of authorization—specifically those that need to operate within a user's unique context—a more granular authentication mechanism is employed: the user-specific bearer token. This token is not static; it is dynamically generated. The generation process necessitates both the `x-api-key` and the individual user ID. The `x-api-key` authenticates the application, while the user ID specifies the particular user whose context is required. Once generated, this bearer token is then included in subsequent API requests, typically in the `Authorization` header with the `Bearer` scheme (e.g., `Authorization: Bearer `). This two-tiered approach ensures that while the API endpoint recognizes the requesting service via the `x-api-key`, it also verifies the specific user's identity and permissions for context-sensitive operations.
Authentication for certain API endpoints is primarily handled through the use of an x-api-key header. This key serves as a foundational layer of security, identifying the application or service making the request. For APIs that require a deeper level of authorization—specifically those that need to operate within a user's unique context—a more granular authentication mechanism is employed: the user-specific bearer token. This token is dynamically generated using both the x-api-key and the individual userId.
Once generated, the bearer token is included in API requests via the Authorization header:
Authorization: Bearer
Token Generation Endpoint:
curl --location 'https://api.neuralfin.tech/v1/auth/user' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data '{
"userId": ""
}'
LLM Trained on Indian Financial Data
This API provides access to a specialized LLM, extensively trained on Indian financial regulations (SEBI, RBI, etc.), market nuances, and common financial queries in the Indian context.
API Endpoints
Query LLM
Send a natural language query to the specialized LLM.
Request:
curl --location 'https://api.neuralfin.tech/v1/llm/query' \
--header 'Content-Type: application/json' \
--header 'x-api-key: test' \
--data '{
"model": "neualfin-ind-0.9",
"message": {}
}'
Response:
{
"content": ""
}
List All Goals
Retrieves a list of all financial goals set by the user, along with their current status and associated plans.
Request:
curl --location 'https://api.neuralfin.tech/v1/goals' \
--header 'Authorization: Bearer TOKEN'
Response:
[
{
“id”, 1,
“goal”: “”
}
]
Update Goal
Updates an existing financial goal or its parameters
Request:
curl --location --request PUT 'https://api.neuralfin.tech/v1/goals/1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer TOKEN' \
--data '{
"message": ""
}
'
Response:
{
“id”, 1,
“goal”: “”
}
Goal Progress
Tracking and progressing the goals, AI-driven plan for achieving a specific financial goal, including recommended actions, savings targets, and investment strategies.
Request:
curl --location 'https://api.neuralfin.tech/v1/goals/1/progress' \
--header 'Authorization: Bearer TOKEN'
LLM Based Goal Planning and Management
This functionality leverages a Large Language Model (LLM) to help users define, plan, and manage their financial goals. It can interpret natural language goal descriptions, create actionable steps, and provide guidance on achieving them.
API Endpoints
Create Goals
Creates a new financial goal for the user based on their input. The LLM processes the natural language input to structure the goal.
Request:
curl --location 'https://api.neuralfin.tech/v1/goals' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer TOKEN' \
--data '{
"message": ""
}
'
Response:
{
“id”, 1,
“goal”: “”
}
List All Goals
Retrieves a list of all financial goals set by the user, along with their current status and associated plans.
Request:
curl --location 'https://api.neuralfin.tech/v1/goals' \
--header 'Authorization: Bearer TOKEN'
Response:
[
{
“id”, 1,
“goal”: “”
}
]
Update Goal
Updates an existing financial goal or its parameters
Request:
curl --location --request PUT 'https://api.neuralfin.tech/v1/goals/1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer TOKEN' \
--data '{
"message": ""
}
'
Response:
{
“id”, 1,
“goal”: “”
}
Goal Progress
Tracking and progressing the goals, AI-driven plan for achieving a specific financial goal, including recommended actions, savings targets, and investment strategies.
Request:
curl --location 'https://api.neuralfin.tech/v1/goals/1/progress' \
--header 'Authorization: Bearer TOKEN'
Account Aggregator-based Smart Nudges
This service integrates with Account Aggregators to securely access a user's consolidated financial data (with consent). It then uses AI to analyze this data and deliver timely, personalized "smart nudges" to encourage better financial behavior or highlight opportunities.
API Endpoints
Get Nudges
Retrieves a list of personalized smart nudges for the user
Request:
curl --location 'https://api.neuralfin.tech/v1/nudges'
--header 'Authorization: Bearer TOKEN'
Dismiss Nudges
Allows the user to dismiss a specific nudge, providing feedback if necessary
Request:
curl --location --request POST 'https://api.neuralfin.tech/v1/nudges/1/dimiss'
--header 'Authorization: Bearer TOKEN'
Realtime Portfolio Creation
This functionality enables users to create and optimize investment portfolios in real-time, considering their financial goals, risk tolerance, and market conditions. It can suggest asset allocation and specific investment products.
API Endpoints
Create Portfolio
Creates a new investment portfolio for the user based on their input
Get Portfolio
Retrieves the details of a specific investment portfolio, including its current holdings, performance, and asset allocation.
Update Portfolio
Update the investment portfolio
AI Recommendation
Get an AI-driven optimization process for the specified portfolio, suggesting adjustments to holdings or asset allocation based on defined criteria
Note on Account Aggregator Data: The consuming business entity (caller) will provide the necessary Account Aggregator data, with the specific format and integration details to be defined per contract.