Get Integralization by Key

This endpoint allows querying the details of an integralization process using its unique key.

Integralization Process (GET)

Request

ENDPOINT

/integralization/integralization_process/INTEGRALIZATION-KEY

METHOD

GET

Path Params

Field	Type	Description	Characters
`INTEGRALIZATION-KEY`	string	Unique integralization key (UUID v4).	36

Response

STATUS

200

Response Body

{
    "tenant_key": "39a0d458-c06f-41e7-92cf-a335cea90675",
    "integralization_key": "072a7cc4-1fbf-419b-8a41-f57bd86ee753",
    "operation_key": "c9cc8980-25b2-49ec-ac40-2a12b8df9dfc",
    "operation_type": "commercial_paper",
    "contract_number": "0000000002",
    "issue_number": 1,
    "issue_series": 1,
    "issuer_key": "1bc06a53-9503-4520-916c-38b5a6bb5912",
    "issuer_name": "Advanced Solutions",
    "issuer_document_number": "05120047000102",
    "issuer_bank_account": {
        "account_type": "checking",
        "account_digit": "3",
        "account_branch": "0001",
        "account_number": "4464541",
        "financial_institution_ispb": "32402502",
        "financial_institution_code_number": "329"
    },
    "subscripted_quantity": 1000000,
    "subscripted_total_amount": 1000000.0,
    "integralized_quantity": 1000000,
    "issue_quantity": 1000000,
    "integralization_status": "finished",
    "subscription_list": [
        {
            "subscription_key": "5a2100db-6bad-4fc7-9b5f-390543c63c55",
            "investor_key": "2d14cfef-7b95-4aa4-be0c-860ec8a60934",
            "investor_name": "Dynamic Group",
            "investor_document_number": "99525109000100",
            "investor_bank_account": {
                "account_digit": "0",
                "account_branch": "1234",
                "account_number": "12345678",
                "financial_institution_ispb": "12345678",
                "financial_institution_code_number": "001"
            },
            "subscription_date": "2025-01-27",
            "financial_base_date": "2025-01-27",
            "subscripted_quantity": 1000000,
            "unit_price": 1.0,
            "expected_amount": 1000000.0,
            "paid_amount": 1000000.0,
            "subscription_note_template_key": "8bfba2a3-1cda-45c4-9a97-05b2bf31e486",
            "subscription_note_document_key": "c9cc8980-25b2-49ec-ac40-2a12b8df9dfc/5a2100db-6bad-4fc7-9b5f-390543c63c55/subscription_note/8b6867d8-95c8-4e0d-b670-6a7d06f3acf7",
            "subscription_note_signature_status": "pending_creation",
            "subscription_payment_list": [
                {
                    "subscription_payment_key": "edf8a4cc-24c9-4dd9-8cae-9cb9151b40bf",
                    "payment_receipt_document_key": "072a7cc4-1fbf-419b-8a41-f57bd86ee753/5a2100db-6bad-4fc7-9b5f-390543c63c55/subscription_payment/edf8a4cc-24c9-4dd9-8cae-9cb9151b40bf",
                    "description": "Comprovante itau",
                    "amount": 1000000.0,
                    "subscription_payment_status": "confirmed",
                    "updated_at": "2025-01-27T14:30:18.741983"
                }
            ]
        }
    ]
}

Response Body Params

Field	Type	Description
`tenant_key`	string	Unique key of the tenant associated with the integralization.
`integralization_key`	string	Unique integralization key.
`operation_key`	string	Unique key of the associated operation.
`operation_type`	string	Operation type. Possible values: `commercial_paper`.
`contract_number`	string	Contract number associated with the integralization.
`issue_number`	integer	Issue number associated with the integralization.
`issue_series`	integer	Issue series associated with the integralization.
`issuer_key`	string	Unique key of the associated issuer.
`issuer_name`	string	Name of the issuer associated with the integralization.
`issuer_document_number`	string	Issuer document number
`issuer_bank_account`	object	Issuer bank account data.
`issuer_bank_account.account_type`	string	Bank account type (`checking`, etc.).
`issuer_bank_account.account_digit`	string	Bank account verification digit.
`issuer_bank_account.account_branch`	string	Bank branch.
`issuer_bank_account.account_number`	string	Bank account number.
`issuer_bank_account.financial_institution_ispb`	string	Financial institution ISPB.
`issuer_bank_account.financial_institution_code_number`	string	Financial institution code.
`subscripted_quantity`	integer	Total quantity of subscribed shares.
`subscripted_total_amount`	number	Total value of subscribed shares.
`integralized_quantity`	integer	Total quantity of integralized shares.
`issue_quantity`	integer	Total quantity of shares issued in the operation.
`integralization_status`	string	Integralization status. Possible values: `pending`, `finished`.
`subscription_list`	array	List of subscriptions associated with the integralization. subscription object

subscription object

Field	Type	Description
`subscription_key`	string	Unique subscription key.
`investor_key`	string	Unique key of the investor associated with the subscription.
`investor_name`	string	Investor name.
`investor_document_number`	string	Investor document number (CPF or CNPJ).
`investor_bank_account`	object	Investor bank data.
`subscription_date`	string	Subscription date (format: YYYY-MM-DD).
`financial_base_date`	string	Financial base date of the subscription (format: YYYY-MM-DD).
`subscripted_quantity`	integer	Quantity of subscribed shares.
`unit_price`	number	Unit price of shares.
`expected_amount`	number	Total expected value of the subscription.
`paid_amount`	number	Paid amount already confirmed of the subscription.
`subscription_note_template_key`	string	Subscription note template key.
`subscription_note_document_key`	string	Subscription note document key.
`subscription_note_signature_status`	string	Subscription note signature status.
`subscription_payment_list`	array	List of payments associated with the subscription. subscription_payment object]

subscription_payment object

Field	Type	Description
`subscription_payment_key`	string	Unique subscription payment key.
`payment_receipt_document_key`	string	Payment receipt document key.
`description`	string	Payment receipt description.
`amount`	number	Registered payment amount.
`subscription_payment_status`	string	Payment status. Possible values: `waiting_confirmation`, `confirmed`, `denied`.
`updated_at`	string	Date and time of last payment update (format: ISO 8601).

Get Integralization by Key

Integralization Process (GET)​

Request​

Path Params​

Response​

Response Body Params​

subscription object​

subscription_payment object​