Get investment profile

Returns a client's investment profile, including their risk level and the instruments they are authorized to operate.

GET/v1/broker/investment-profile/{account-id}

Request

Headers

Field	Type	Required	Description
Authorization	string	Yes	Access token in Bearer ACCESS_TOKEN format

Path Parameters

Field	Type	Required	Description
account-id	integer	Yes	Account identifier.

Not applicable: Query Parameters, Body.

Response

2XX Success

Field	Type	Description
legal_entity	string	Legal entity associated with the client in the broker's OMS.
person_type	string	Type of person. Typical values: FISICA (individual), JURIDICA (legal entity/company).
person_id	string	Internal OMS identifier of the person.
name	string	Client's first name.
last_name	string	Client's last name.
country	string	Client's country of residence.
email	string	Client's email address.
genre	string	Client's gender, as recorded in the OMS.
document_type	string	Type of identity document (e.g. DNI, CUIT, PASAPORTE).
document_number	string	Identity document number.
external_id	string	External identifier of the client in the broker's systems.
investment_profile	string	Client's risk level. Possible values: LOW, MEDIUM, HIGH.
instruments	array of string	Instrument types the client is authorized to operate, derived from their risk level. Possible values: FUND, STOCKS, CEDEARS, BONDS, TREASURY_NOTES, ON, OPTIONS, REPO_ORDER, MEP_OPERATION.
expiration_date	string (ISO 8601 date, yyyy-MM-dd)	Expiration date of the client's current investment profile.
allows_short_sell	boolean	Whether the client is authorized to perform short sell operations.
allows_repo_without_cash	boolean	Whether the client is authorized to perform repo operations without available cash.

Error Codes

Status	Description
400	Bad Request — invalid or missing parameters
401	Unauthorized — invalid or missing access token
403	Forbidden — the token does not have permission to access this resource
404	Not Found — the account does not exist
500	Internal Server Error

Error structure:

{
  "code": "NOT_FOUND",
  "description": "Resource not found"
}

Code Example

cURL

curl -X GET https://b2b.allaria.cloud/v1/broker/investment-profile/12345 \
  -H "Authorization: Bearer ACCESS_TOKEN"

JavaScript

const accountId = 12345;

const response = await fetch(
  `https://b2b.allaria.cloud/v1/broker/investment-profile/${accountId}`,
  {
    method: 'GET',
    headers: { 'Authorization': 'Bearer ACCESS_TOKEN' }
  }
);
const data = await response.json();
console.log(data);

Python

import requests

account_id = 12345

response = requests.get(
  f'https://b2b.allaria.cloud/v1/broker/investment-profile/{account_id}',
  headers={ 'Authorization': 'Bearer ACCESS_TOKEN' }
)
data = response.json()
print(data)

Node.js

const axios = require('axios');

const accountId = 12345;

const response = await axios.get(
  `https://b2b.allaria.cloud/v1/broker/investment-profile/${accountId}`,
  { headers: { Authorization: 'Bearer ACCESS_TOKEN' } }
);
console.log(response.data);

2XX Success

{
  "legal_entity": "ALLARIA",
  "person_type": "FISICA",
  "person_id": "998877",
  "name": "Juan",
  "last_name": "Pérez",
  "country": "ARGENTINA",
  "email": "juan.perez@example.com",
  "genre": "M",
  "document_type": "DNI",
  "document_number": "30123456",
  "external_id": "20301234567",
  "investment_profile": "MEDIUM",
  "instruments": ["FUND", "STOCKS", "BONDS"],
  "expiration_date": "2027-03-15",
  "allows_short_sell": false,
  "allows_repo_without_cash": false
}