Subscription Registration
This endpoint allows registering an investor's intention to subscribe to a specific quantity of shares in an integralization.
Subscription Registration (POST)
Request
ENDPOINT
/integralization/integralization_process/INTEGRALIZATION-KEY/subscriptionMETHOD
POSTPath Params
| Field | Type | Description | Characters |
|---|---|---|---|
INTEGRALIZATION-KEY | string | Unique integralization key (UUID v4). | 36 |
Request Body
{
"investor_key": "123e4567-e89b-12d3-a456-426614174000",
"investor_bank_account": {
"account_number": "12345678",
"account_digit": "0",
"account_branch": "1234",
"financial_institution_code_number": "001",
"financial_institution_ispb": "12345678"
},
"subscription_date": "2025-01-01",
"financial_base_date": "2025-01-01",
"subscription_note_template_key": "c649c01a-dd24-47b7-b93e-5a6bac50bcf0",
"subscripted_quantity": 100000
}
Request Body Params
| Field | Type | Description |
|---|---|---|
investor_key* | string | Unique investor key (UUID v4). |
investor_bank_account* | object | Investor bank account data. |
investor_bank_account.account_number* | string | Investor bank account number. |
investor_bank_account.account_digit* | string | Investor bank account verification digit. |
investor_bank_account.account_branch* | string | Investor bank branch. |
investor_bank_account.financial_institution_code_number* | string | Investor's financial institution code. |
investor_bank_account.financial_institution_ispb* | string | Investor's financial institution ISPB. |
subscripted_quantity* | integer | Quantity of shares the investor wants to subscribe to. |
financial_base_date* | string | Financial base date. |
subscription_date* | string | Subscription date. |
subscription_note_template_key* | string | Subscription bulletin template. |
Response
STATUS
201Response Body
{
"subscription_key": "2f7e00b5-988f-4214-bb46-4728d9081148",
"investor_key": "a76e408a-c733-4a68-963a-dc93ff0bc3e3",
"investor_name": "Global Enterprises",
"investor_document_number": "89206257000108",
"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": "6d4c5168-b7c7-4092-9931-4c76aea6af80",
"subscription_note_document_key": "5ea88fca-4ca3-4dfe-aea4-35e431aef3c5/2f7e00b5-988f-4214-bb46-4728d9081148/subscription_note/f206d799-cb94-48d5-81c5-5988ecef8079",
"envelope_signature_status": "pending_creation",
"envelope_signature_url": "https://certifiqi.com.br/envelope_key",
"envelope_key": "6d4c5168-b7c7-4092-9931-4c76aea6af80",
"subscription_payment_list": [
{
"subscription_payment_key": "7e51be5b-fdfd-4f2f-ba1a-0d81cdb08177",
"payment_receipt_document_key": "f352de14-222f-4787-bd67-2063524f8d9f/2f7e00b5-988f-4214-bb46-4728d9081148/subscription_payment/7e51be5b-fdfd-4f2f-ba1a-0d81cdb08177",
"description": "Comprovante itau",
"amount": 1000000.0,
"subscription_payment_status": "confirmed",
"updated_at": "2025-01-27T14:33:54.214891"
}
]
}
Response Body Params
| Field | Type | Description |
|---|---|---|
subscription_key | string | Unique subscription key (UUID v4). |
investor_key | string | Unique key of the investor associated with the subscription (UUID v4). |
investor_name | string | Investor name. |
investor_document_number | string | Investor document number (CPF or CNPJ). |
investor_bank_account | object | investor_bank_account object. |
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 subscribed shares. |
expected_amount | number | Total expected value of the subscription. |
paid_amount | number | Total amount paid in the subscription. |
subscription_note_template_key | string | Unique subscription note template key (UUID v4). |
subscription_note_document_key | string | Unique subscription note document key. |
envelope_signature_status | string | Subscription note signature status. |
envelope_signature_url | string | Subscription note signature URL. |
envelope_key | string | Signature envelope key. |
subscription_payment_list | array | List of payments associated with the subscription.subscription_payment_list object. |
investor_bank_account object
| Field | Type | Description |
|---|---|---|
account_number | string | Investor bank account number. |
account_digit | string | Investor bank account verification digit. |
account_branch | string | Investor bank branch. |
financial_institution_code_number | string | Investor's financial institution code. |
financial_institution_ispb | string | Investor's financial institution ISPB. |
subscription_payment_list object
| Field | Type | Description |
|---|---|---|
subscription_payment_key | string | Unique subscription payment key (UUID v4). |
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). |