Skip to main content

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/subscription
METHOD
POST

Path Params

FieldTypeDescriptionCharacters
INTEGRALIZATION-KEYstringUnique 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

FieldTypeDescription
investor_key*stringUnique investor key (UUID v4).
investor_bank_account*objectInvestor bank account data.
investor_bank_account.account_number*stringInvestor bank account number.
investor_bank_account.account_digit*stringInvestor bank account verification digit.
investor_bank_account.account_branch*stringInvestor bank branch.
investor_bank_account.financial_institution_code_number*stringInvestor's financial institution code.
investor_bank_account.financial_institution_ispb*stringInvestor's financial institution ISPB.
subscripted_quantity*integerQuantity of shares the investor wants to subscribe to.
financial_base_date*stringFinancial base date.
subscription_date*stringSubscription date.
subscription_note_template_key*stringSubscription bulletin template.

Response

STATUS
201
Response 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

FieldTypeDescription
subscription_keystringUnique subscription key (UUID v4).
investor_keystringUnique key of the investor associated with the subscription (UUID v4).
investor_namestringInvestor name.
investor_document_numberstringInvestor document number (CPF or CNPJ).
investor_bank_accountobjectinvestor_bank_account object.
subscription_datestringSubscription date (format: YYYY-MM-DD).
financial_base_datestringFinancial base date of the subscription (format: YYYY-MM-DD).
subscripted_quantityintegerQuantity of subscribed shares.
unit_pricenumberUnit price of subscribed shares.
expected_amountnumberTotal expected value of the subscription.
paid_amountnumberTotal amount paid in the subscription.
subscription_note_template_keystringUnique subscription note template key (UUID v4).
subscription_note_document_keystringUnique subscription note document key.
envelope_signature_statusstringSubscription note signature status.
envelope_signature_urlstringSubscription note signature URL.
envelope_keystringSignature envelope key.
subscription_payment_listarrayList of payments associated with the subscription.subscription_payment_list object.

investor_bank_account object

FieldTypeDescription
account_numberstringInvestor bank account number.
account_digitstringInvestor bank account verification digit.
account_branchstringInvestor bank branch.
financial_institution_code_numberstringInvestor's financial institution code.
financial_institution_ispbstringInvestor's financial institution ISPB.

subscription_payment_list object

FieldTypeDescription
subscription_payment_keystringUnique subscription payment key (UUID v4).
payment_receipt_document_keystringPayment receipt document key.
descriptionstringPayment receipt description.
amountnumberRegistered payment amount.
subscription_payment_statusstringPayment status. Possible values:waiting_confirmation, confirmed, denied.
updated_atstringDate and time of last payment update (format: ISO 8601).