Asset Query
This endpoint allows querying the details of an asset using its unique key.
Request
ENDPOINT
/security/security/SECURITY-KEYMETHOD
GETPath Params
| Field | Type | Description | Characters |
|---|---|---|---|
SECURITY-KEY | string | Unique security key (UUID v4). | 36 |
Response
STATUS
200Response Body
{
"tenant_key": "13a6a1d5-7a3c-4627-a0a6-9fd746662ca4",
"security_key": "42bd7161-5ec1-4f64-ac0c-861d93ffb4c2",
"operation_key": "8eb2291e-2dbf-4af1-9d12-f29fac665ed2",
"operation_type": "commercial_paper",
"contract_number": "0000000027",
"issuer_key": "9e08fd62-ce43-4c95-99e0-4386e980d618",
"issuer_name": "Blue Logic",
"issuer_document_number": "97.923.586/0001-06",
"issuer_bank_account": {
"account_type": "checking",
"account_digit": "3",
"account_branch": "0001",
"account_number": "4464541",
"financial_institution_ispb": "32402502",
"financial_institution_code_number": "329"
},
"financial_base_date": "2025-02-18",
"current_unit_price": 1.0,
"latest_accrual_date": "2025-02-18",
"integralized_quantity": 100000,
"issue_quantity": 100000,
"security_status": "active",
"is_defaulted": false,
"financial": {
"financial_base_date": "2025-02-18",
"issue_quantity": 100000,
"unit_price": 1.0,
"issue_amount": 100000.0,
"released_amount": 100000.0,
"cet": 1.0,
"annual_cet": 12.68,
"number_of_installments": 5,
"prefixed_interest_rate": {
"daily_rate": 0.0003271877,
"annual_rate": 0.1268250301,
"monthly_rate": 0.01,
"interest_base": "calendar_days_365"
},
"post_fixed_interest_rate": null,
"financial_index": null,
"fine_delay_rate": {
"daily_rate": 0.00032719,
"annual_rate": 0.12682503,
"monthly_rate": 0.01,
"interest_base": "calendar_days_365"
},
"contract_fine_rate": 0.02,
"fees": [
{
"type": "internal",
"amount": 2.0,
"fee_type": "implementation_fee",
"fee_amount": 2000.0,
"amount_type": "percentage"
},
{
"type": "external",
"amount": 5.0,
"fee_type": "implementation_fee",
"fee_amount": 5000.0,
"amount_type": "percentage"
}
],
"installment_list": [
{
"installment_key": "959a1d8f-9f7f-4b5b-b963-828693caad58",
"installment_status": "opened",
"installment_number": 5,
"workdays": 21,
"calendar_days": 30,
"principal_amortization_unit_price": 0.20395804,
"principal_amortization_amount": 20395.80431829,
"interest_amount": 201.13568171,
"interest_amount_unit_price": 0.00201136,
"post_fixed_interest_amount": 0.0,
"post_fixed_interest_amount_unit_price": 0.0,
"amount": 20596.94,
"due_principal": 20395.80431829,
"due_interest": 0.0,
"due_date": "2025-07-18",
"has_interest": true,
"current_unit_price": 0.20395804,
"latest_accrual_date": "2025-02-18",
"paid_at": null,
"paid_amount": 0.0,
"settlement_process_list": []
},
{
"installment_key": "b1f4fc31-7b73-45b8-bce7-4256394b974e",
"installment_status": "paid",
"installment_number": 1,
"workdays": 18,
"calendar_days": 28,
"principal_amortization_unit_price": 0.19676756,
"principal_amortization_amount": 19676.75638427,
"interest_amount": 920.18361573,
"interest_amount_unit_price": 0.00920184,
"post_fixed_interest_amount": 0.0,
"post_fixed_interest_amount_unit_price": 0.0,
"amount": 20596.94,
"due_principal": 100000.0,
"due_interest": 0.0,
"due_date": "2025-03-18",
"has_interest": true,
"current_unit_price": 0.19676756,
"latest_accrual_date": "2025-02-18",
"paid_at": "2025-02-18T18:39:47.174392",
"paid_amount": 20596.94,
"settlement_process_list": [
{
"settlement_process_key": "a9030b64-5003-4f82-be4f-8296a4e0b140",
"installment_key": "b1f4fc31-7b73-45b8-bce7-4256394b974e",
"due_date": "2025-03-18",
"reference_date": "2025-03-18",
"current_integralized_quantity": 100000,
"principal_amortization_amount": 19676.75638427,
"interest_amount": 920.18361573,
"post_fixed_interest_amount": 0.0,
"fine_amount": 0.0,
"total_amount": 20596.94,
"expected_total_amount": 20596.94,
"paid_amount": 20596.94,
"settlement_process_status": "paid",
"paid_at": "2025-02-18T18:39:47.185004",
"settlement_process_payment_list": [
{
"settlement_process_payment_key": "69615875-ed71-44f2-9a06-20f6ea4276f3",
"investment": {
"investment_key": "4b705afb-18cb-4fe5-922a-5eab71c2b558",
"acquisition_date": "2025-02-18",
"acquisition_unit_price": 1.0,
"acquisition_amount": 100000.0,
"acquisition_quantity": 100000.0,
"investor_key": "a1a75b66-6f7e-4bcc-9ff5-6f8adf7cae09",
"investor_name": "Ultimate Cascade",
"investor_document_number": "31.424.651/0001-32",
"investor_bank_account": {
"account_type": "checking",
"account_digit": "3",
"account_branch": "0001",
"account_number": "33400254",
"financial_institution_ispb": "32402502",
"financial_institution_code_number": "329"
},
"total_sell_amount": 0.0,
"total_yield_amount": 920.18,
"total_amortization_amount": 20596.94,
"current_quantity": 100000,
"investment_transaction_list": [
{
"transaction_type": "integralization",
"transaction_date": "2025-02-18",
"transaction_unit_price": 1.0,
"transaction_amount": 100000.0,
"transaction_quantity": 100000.0,
"amortization_amount": 0.0,
"yield_amount": 0.0,
"old_quantity": 0.0,
"new_quantity": 100000.0,
"investment_transaction_origin": "subscription",
"investment_transaction_origin_key": "8549efc4-76e3-4e62-abd1-71162b383b4e"
},
{
"transaction_type": "maturity",
"transaction_date": "2025-03-18",
"transaction_unit_price": 0.2059694,
"transaction_amount": 20596.94,
"transaction_quantity": 0.0,
"amortization_amount": 20596.94,
"yield_amount": 920.18,
"old_quantity": 100000.0,
"new_quantity": 100000.0,
"investment_transaction_origin": "settlement_process_payment",
"investment_transaction_origin_key": "69615875-ed71-44f2-9a06-20f6ea4276f3"
}
]
},
"investment_quantity": 100000,
"amount": 20596.94,
"paid_at": "2025-02-18T18:39:47.159822",
"settlement_process_payment_status": "paid",
"settlement_process_payment_type": "manual",
"settlement_process_payment_receipt_list": [
{
"settlement_process_payment_receipt_key": "47fa434a-68cc-47d4-af8c-6a84061f38a6",
"settlement_process_payment_receipt_status": "confirmed",
"updated_at": "2025-02-18T18:39:47.153603"
}
]
}
]
}
]
},
{
"installment_key": "dafc9683-a2b3-4bde-bf9a-ff4b2ea2599f",
"installment_status": "opened",
"installment_number": 2,
"workdays": 23,
"calendar_days": 35,
"principal_amortization_unit_price": 0.19671978,
"principal_amortization_amount": 19671.97807672,
"interest_amount": 924.96192328,
"interest_amount_unit_price": 0.00924962,
"post_fixed_interest_amount": 0.0,
"post_fixed_interest_amount_unit_price": 0.0,
"amount": 20596.94,
"due_principal": 80323.24361573,
"due_interest": 0.0,
"due_date": "2025-04-22",
"has_interest": true,
"current_unit_price": 0.19671978,
"latest_accrual_date": "2025-02-18",
"paid_at": null,
"paid_amount": 0.0,
"settlement_process_list": []
},
{
"installment_key": "aab04935-763e-4431-b0e8-d3d341d5c563",
"installment_status": "opened",
"installment_number": 3,
"workdays": 18,
"calendar_days": 27,
"principal_amortization_unit_price": 0.20058857,
"principal_amortization_amount": 20058.85739386,
"interest_amount": 538.08260614,
"interest_amount_unit_price": 0.00538083,
"post_fixed_interest_amount": 0.0,
"post_fixed_interest_amount_unit_price": 0.0,
"amount": 20596.94,
"due_principal": 60651.26553901,
"due_interest": 0.0,
"due_date": "2025-05-19",
"has_interest": true,
"current_unit_price": 0.20058857,
"latest_accrual_date": "2025-02-18",
"paid_at": null,
"paid_amount": 0.0,
"settlement_process_list": []
},
{
"installment_key": "6a76fd8f-631b-4b42-ac2e-daae8f87401d",
"installment_status": "opened",
"installment_number": 4,
"workdays": 22,
"calendar_days": 30,
"principal_amortization_unit_price": 0.20196604,
"principal_amortization_amount": 20196.60382686,
"interest_amount": 400.33617314,
"interest_amount_unit_price": 0.00400336,
"post_fixed_interest_amount": 0.0,
"post_fixed_interest_amount_unit_price": 0.0,
"amount": 20596.94,
"due_principal": 40592.40814515,
"due_interest": 0.0,
"due_date": "2025-06-18",
"has_interest": true,
"current_unit_price": 0.20196604,
"latest_accrual_date": "2025-02-18",
"paid_at": null,
"paid_amount": 0.0,
"settlement_process_list": []
}
]
},
"investment_list": [
{
"investment_key": "4b705afb-18cb-4fe5-922a-5eab71c2b558",
"acquisition_date": "2025-02-18",
"acquisition_unit_price": 1.0,
"acquisition_amount": 100000.0,
"acquisition_quantity": 100000.0,
"investor_key": "a1a75b66-6f7e-4bcc-9ff5-6f8adf7cae09",
"investor_name": "Ultimate Cascade",
"investor_document_number": "31.424.651/0001-32",
"investor_bank_account": {
"account_type": "checking",
"account_digit": "3",
"account_branch": "0001",
"account_number": "33400254",
"financial_institution_ispb": "32402502",
"financial_institution_code_number": "329"
},
"total_sell_amount": 0.0,
"total_yield_amount": 920.18,
"total_amortization_amount": 20596.94,
"current_quantity": 100000,
"investment_transaction_list": [
{
"transaction_type": "integralization",
"transaction_date": "2025-02-18",
"transaction_unit_price": 1.0,
"transaction_amount": 100000.0,
"transaction_quantity": 100000.0,
"amortization_amount": 0.0,
"yield_amount": 0.0,
"old_quantity": 0.0,
"new_quantity": 100000.0,
"investment_transaction_origin": "subscription",
"investment_transaction_origin_key": "8549efc4-76e3-4e62-abd1-71162b383b4e"
},
{
"transaction_type": "maturity",
"transaction_date": "2025-03-18",
"transaction_unit_price": 0.2059694,
"transaction_amount": 20596.94,
"transaction_quantity": 0.0,
"amortization_amount": 20596.94,
"yield_amount": 920.18,
"old_quantity": 100000.0,
"new_quantity": 100000.0,
"investment_transaction_origin": "settlement_process_payment",
"investment_transaction_origin_key": "69615875-ed71-44f2-9a06-20f6ea4276f3"
}
]
}
]
}
Response Body Params
| Field | Type | Description |
|---|---|---|
tenant_key | string | Unique key of the tenant associated with the security. |
security_key | string | Unique security key. |
operation_key | string | Unique key of the operation associated with the security. |
operation_type | string | Operation type. Possible values: commercial_paper. |
contract_number | string | Contract number associated with the security. |
issuer_key | string | Unique key of the associated issuer. |
issuer_name | string | Name of the security issuer. |
issuer_document_number | string | Issuer document number (CPF/CNPJ). |
issuer_bank_account | object | issuer_bank_account object. |
financial_base_date | string | Financial base date of the security. |
current_unit_price | number | Current unit price of the security. |
latest_accrual_date | string | Date of the last accrual performed. |
integralized_quantity | integer | Total quantity of integralized shares. |
issue_quantity | integer | Total quantity of shares issued in the operation. |
security_status | string | Security status. Possible values: active, inactive. |
is_defaulted | boolean | Indicates if the security is in default (true or false). |
financial | object | financial object. |
investment_list | array | Investment list. investment object. |
bank_account object
| Field | Type | Description |
|---|---|---|
account_number | string | Issuer's bank account number. |
account_digit | string | Issuer's bank account verification digit. |
account_branch | string | Issuer's bank branch. |
financial_institution_ispb | string | ISPB of the issuer's financial institution. |
financial_institution_code_number | string | Code of the issuer's financial institution. |
financial object
| Field | Type | Description |
|---|---|---|
financial_base_date | string | Financial base date. |
issue_quantity | integer | Quantity of shares issued. |
unit_price | number | Unit price of shares. |
issue_amount | number | Total issue amount. |
released_amount | number | Total released amount. |
cet | number | Total effective cost (CET). |
annual_cet | number | Annualized total effective cost. |
number_of_installments | integer | Total number of installments. |
prefixed_interest_rate | object | prefixed_interest_rate object. |
post_fixed_interest_rate | object | post_fixed_interest_rate object. |
financial_index | object | financial_index object. |
fine_delay_rate | object | fine_delay_rate object. |
contract_fine_rate | number | Contractual fine. |
fees | array | Fee list. fees object. |
installment_list | array | Installment list. installment object. |
investment object
| Field | Type | Description |
|---|---|---|
investment_key | string | Unique investment key. |
acquisition_date | string | Investment acquisition date. |
acquisition_unit_price | number | Unit price at acquisition. |
acquisition_amount | number | Total acquisition amount. |
acquisition_quantity | integer | Quantity of shares acquired. |
investor_key | string | Unique investor key. |
investor_name | string | Investor name. |
investor_document_number | string | Investor document (CPF/CNPJ). |
investor_bank_account | object | investor_bank_account object. |
total_sell_amount | number | Total amount of sales made. |
total_yield_amount | number | Total yield amount. |
total_amortization_amount | number | Total amortization amount. |
current_quantity | integer | Current quantity of shares. |
investment_transaction_list | array | Transaction list. investment_transaction object. |
investment_transaction object
| Field | Type | Description |
|---|---|---|
transaction_type | string | Transaction type (integralization, maturity). |
transaction_date | string | Transaction date. |
transaction_unit_price | number | Unit price in the transaction. |
transaction_amount | number | Total transaction amount. |
transaction_quantity | integer | Quantity of shares transacted. |
amortization_amount | number | Amortization amount in the transaction. |
yield_amount | number | Yield amount in the transaction. |
old_quantity | integer | Quantity of shares before the transaction. |
new_quantity | integer | Quantity of shares after the transaction. |
investment_transaction_origin | string | Transaction origin (subscription, settlement_process_payment). |
investment_transaction_origin_key | string | Origin key of the transaction. |
prefixed_interest_rate object
| Field | Type | Description |
|---|---|---|
daily_rate | number | Daily prefixed interest rate. |
annual_rate | number | Annual prefixed interest rate. |
monthly_rate | number | Monthly prefixed interest rate. |
interest_base | string | Interest calculation base (calendar_days_365). |
post_fixed_interest_rate object
| Field | Type | Description |
|---|---|---|
daily_rate | number | Daily post-fixed interest rate. |
annual_rate | number | Annual post-fixed interest rate. |
monthly_rate | number | Monthly post-fixed interest rate. |
interest_base | string | Interest calculation base (calendar_days_365). |
financial_index object
| Field | Type | Description |
|---|---|---|
index_type | string | Financial index type (CDI, IPCA, etc.). |
index_value | number | Financial index value. |
fine_delay_rate object
| Field | Type | Description |
|---|---|---|
daily_rate | number | Daily interest rate for payment delay. |
annual_rate | number | Annual interest rate for payment delay. |
monthly_rate | number | Monthly interest rate for payment delay. |
interest_base | string | Interest calculation base (calendar_days_365). |
fees object
| Field | Type | Description |
|---|---|---|
type | string | Fee type (internal, external). |
amount | number | Percentage or absolute value of the fee. |
fee_type | string | Fee type (implementation_fee). |
fee_amount | number | Monetary value of the applied fee. |
amount_type | string | Value type (percentage, absolute). |
installment object
| Field | Type | Description |
|---|---|---|
installment_key | string | Unique installment key. |
installment_status | string | Installment status |
installment_number | integer | Installment number in the schedule sequence. |
workdays | integer | Number of business days until maturity. |
calendar_days | integer | Number of calendar days until maturity. |
principal_amortization_unit_price | number | Unit value of principal amortization. |
principal_amortization_amount | number | Total principal amortization amount. |
interest_amount | number | Total interest amount of the installment. |
interest_amount_unit_price | number | Unit interest value of the installment. |
post_fixed_interest_amount | number | Total post-fixed interest amount of the installment. |
post_fixed_interest_amount_unit_price | number | Unit post-fixed interest value of the installment. |
amount | number | Total installment amount. |
due_principal | number | Principal amount due before the installment. |
due_interest | number | Interest amount due before the installment. |
due_date | string | Installment maturity date. |
has_interest | boolean | Indicates if the installment contains interest (true or false). |
current_unit_price | number | Updated unit price of the installment. |
latest_accrual_date | string | Date of the last accrual of the installment. |
paid_at | string | Installment payment date (if applicable). |
paid_amount | number | Total amount paid of the installment (if applicable). |
settlement_process_list | array | Settlement process list. settlement_process object |
settlement_process object
| Field | Type | Description |
|---|---|---|
settlement_process_key | string | Unique settlement process key. |
installment_key | string | Unique key of the installment associated with the settlement. |
due_date | string | Maturity date of the associated installment. |
reference_date | string | Settlement reference date. |
current_integralized_quantity | integer | Quantity of integralized shares at the time of settlement. |
principal_amortization_amount | number | Principal amortization amount. |
interest_amount | number | Total interest amount paid in the settlement. |
post_fixed_interest_amount | number | Post-fixed interest amount paid in the settlement. |
fine_amount | number | Fine amount applied (if any). |
total_amount | number | Total settlement amount. |
expected_total_amount | number | Expected total settlement amount. |
paid_amount | number | Total amount paid in the settlement. |
settlement_process_status | string | Settlement status (waiting_payment, paid, canceled). |
paid_at | string | Settlement payment date (if applicable). |
settlement_process_payment_list | array | Payment list associated with the settlement. settlement_process_payment object |
settlement_process_payment object
| Field | Type | Description |
|---|---|---|
settlement_process_payment_key | string | Unique settlement process payment key. |
investment | object | Investment information. investment object. |
investment_quantity | integer | Quantity of investment shares involved in the payment. |
amount | number | Payment amount made. |
paid_at | string | Payment date and time (ISO 8601 format). |
settlement_process_payment_status | string | Payment status (waiting_payment, paid, canceled). |
settlement_process_payment_type | string | Payment type (manual). |
settlement_process_payment_receipt_list | array | Payment receipt list. settlement_process_payment_receipt object. |
settlement_process_payment_receipt object
| Field | Type | Description |
|---|---|---|
settlement_process_payment_receipt_key | string | Unique settlement process payment receipt key. |
settlement_process_payment_receipt_status | string | Receipt status (waiting_confirmation, confirmed, denied). |
amount | number | Receipt amount. |
updated_at | string | Date and time of last receipt update (ISO 8601 format). |
security_status Enumerators
| Enum | Description |
|---|---|
issued | The security was issued but is not yet active. |
active | The security is active and ongoing. |
matured | The security has reached maturity. |
canceled | The security was canceled. |
installment_status Enumerators
| Enum | Description |
|---|---|
created | The installment was created but is not yet available for payment. |
opened | The installment is open. |
waiting_payment | The installment is waiting for payment by the investor. |
paid_partial | The installment was partially paid. |
paid | The installment was fully paid. |
paid_early | The installment was paid early. |
overdue | The installment matured and was not paid. |
paid_partial_overdue | The installment was partially paid after maturity. |
paid_overdue | The installment was paid after maturity. |
canceled | The installment was canceled and does not need to be paid. |
unmonitored | The installment is not monitored for payments. |