Skip to main content

Request quota lock


Introduction​

This resource is used to create a quota lock request for an investor.

Input / Output:​

The lock type and the information specific to the lock type must be sent.

As output, the quota_lock_key that represents the quota lock is delivered.

Available on
ProfileHostRequired permission
Managermanager-apiWrite
Consultantconsultant-apiGranted by the integration team

Base URL for each host: Environments (Hosts).

Request​

ENDPOINT
/quota_lock/investor/INVESTOR_KEY/quota_lock
METHOD
POST
STATUS
201
Quota lock as collateral - CCE - natural person
{
"type": "collateral",
"collateral": {
"recipient": {
"name": "Sample Recipient Name",
"document_number": "000.000.000-00",
"person_type": "natural_person",
"natural_person": {
"birthdate": "YYYY-MM-DD",
"mother_name": "Sample Recipient Mother Name"
}
},
"borrower": {
"name": "Sample Borrower Name",
"document_number": "000.000.000-00",
"person_type": "natural_person",
"natural_person": {
"birthdate": "YYYY-MM-DD",
"mother_name": "Sample Borrower Mother Name"
}
},
"assets": [
{
"asset_type": "cce",
"credit_operation": {
"contract_number": "1000000001",
"principal_value": 0.0,
"interest_rate_type": "post_fixed",
"pre_fixed": {
"monthly_rate": 0.0,
"calendar_base": "calendar_360"
},
"post_fixed": {
"calendar_base": "workdays",
"indexer": "di",
"rate": 1,
"lag": {
"reference": "daily",
"amount": 1
}
}
}
}
],
"issuance_series": [
{
"issuance_serie_key": "UUID",
"number_of_quotas": 0.00,
"financial_value": 0.00
},
{
"issuance_serie_key": "UUID",
"number_of_quotas": 0.00,
"financial_value": 0.00
}
],
"bank_account_key": "UUID"
}
}
Quota lock as collateral - CCE - legal entity
{
"type": "collateral",
"collateral": {
"recipient": {
"name": "Sample Recipient Name",
"document_number": "00.000.000/0000-00",
"person_type": "legal_person",
"legal_person": {
"activity_code": "00.00-0-00",
"representatives": [
{
"name": "Sample Recipient Representative Name",
"document_number": "000.000.000-00"
}
]
}
},
"borrower": {
"name": "Sample Borrower Name",
"document_number": "00.000.000/0000-00",
"person_type": "legal_person",
"legal_person": {
"activity_code": "00.00-0-00",
"representatives": [
{
"name": "Sample Borrower Representative Name",
"document_number": "000.000.000-00"
}
]
}
},
"assets": [
{
"asset_type": "cce",
"credit_operation": {
"contract_number": "1000000001",
"principal_value": 0.0,
"interest_rate_type": "post_fixed",
"pre_fixed": {
"monthly_rate": 0.0,
"calendar_base": "calendar_360"
},
"post_fixed": {
"calendar_base": "workdays",
"indexer": "di",
"rate": 1,
"lag": {
"reference": "daily",
"amount": 1
}
}
}
}
],
"issuance_series": [
{
"issuance_serie_key": "UUID",
"number_of_quotas": 0.00,
"financial_value": 0.00
},
{
"issuance_serie_key": "UUID",
"number_of_quotas": 0.00,
"financial_value": 0.00
}
],
"bank_account_key": "UUID"
}
}
Quota lock as collateral - rental contract - natural person
{
"type": "collateral",
"collateral": {
"recipient": {
"name": "Sample Recipient Name",
"document_number": "000.000.000-00",
"person_type": "natural_person",
"natural_person": {
"birthdate": "YYYY-MM-DD",
"mother_name": "Sample Recipient Mother Name"
}
},
"borrower": {
"name": "Sample Borrower Name",
"document_number": "000.000.000-00",
"person_type": "natural_person",
"natural_person": {
"birthdate": "YYYY-MM-DD",
"mother_name": "Sample Borrower Mother Name"
}
},
"assets": [
{
"asset_type": "rental_contract",
"rental_contract": {
"monthly_value": 0.0,
"property_address": {
"street": "Sample Street",
"number": "123",
"neighborhood": "Sample Neighborhood",
"city": "Sample City",
"uf": "SP",
"complement": "Sample Complement",
"postal_code": "00000-000",
"country": "BRA"
},
"start_date": "YYYY-MM-DD",
"end_date": "YYYY-MM-DD",
"readjustment_index": 0.0
}
}
],
"issuance_series": [
{
"issuance_serie_key": "UUID",
"number_of_quotas": 0.00,
"financial_value": 0.00
}
],
"bank_account_key": "UUID"
}
}
Quota lock as collateral - rental contract - legal entity
{
"type": "collateral",
"collateral": {
"recipient": {
"name": "Sample Recipient Name",
"document_number": "00.000.000/0000-00",
"person_type": "legal_person",
"legal_person": {
"activity_code": "00.00-0-00",
"representatives": [
{
"name": "Sample Recipient Representative Name",
"document_number": "000.000.000-00"
}
]
}
},
"borrower": {
"name": "Sample Borrower Name",
"document_number": "00.000.000/0000-00",
"person_type": "legal_person",
"legal_person": {
"activity_code": "00.00-0-00",
"representatives": [
{
"name": "Sample Borrower Representative Name",
"document_number": "000.000.000-00"
}
]
}
},
"assets": [
{
"asset_type": "rental_contract",
"rental_contract": {
"monthly_value": 0.0,
"property_address": {
"street": "Sample Street",
"number": "123",
"neighborhood": "Sample Neighborhood",
"city": "Sample City",
"uf": "SP",
"complement": "Sample Complement",
"postal_code": "00000-000",
"country": "BRA"
},
"start_date": "YYYY-MM-DD",
"end_date": "YYYY-MM-DD",
"readjustment_index": 0.0
}
}
],
"issuance_series": [
{
"issuance_serie_key": "UUID",
"financial_application_keys": [
"UUID",
"UUID"
]
}
],
"bank_account_key": "UUID"
}
}

Quota Lock​

FieldTypeDescriptionCharacters
typestringQuota lock type enumeratorup to 255
collateralJSONCollateral object-

Quota Lock Type​

EnumeratorDescription
collateralCollateral

Collateral​

FieldTypeDescriptionCharactersRequired
recipientJSONRecipient object-Yes
borrowerJSONBorrower object-Yes
assetsArrayList of Asset objects-Yes
issuance_seriesArrayList of Issuance series objects-Yes
bank_account_keystringUUID of the bank account associated with the collateral-No

Recipient​

FieldTypeDescriptionCharactersRequired
namestringRecipient nameup to 255Yes
document_numberstringRecipient CPF / CNPJ14 or 18Yes
person_typestringNatural person or legal entity enumeratorup to 255Yes
natural_personJSONNatural Person object-No
legal_personJSONLegal Person object-No

Borrower​

FieldTypeDescriptionCharactersRequired
namestringBorrower nameup to 255Yes
document_numberstringBorrower CPF / CNPJ14 or 18Yes
person_typestringNatural person or legal entity enumeratorup to 255Yes
natural_personJSONNatural Person object-No
legal_personJSONLegal Person object-No

Person Type​

EnumeratorDescription
natural_personNatural person
legal_personLegal entity

Natural Person​

FieldTypeDescriptionCharactersRequired
birthdatestringDate of birth10Yes
mother_namestringMother's nameup to 255Yes
FieldTypeDescriptionCharactersRequired
activity_codestringNational Classification of Economic Activities (CNAE)10Yes
representativesarrayList of Representative objects-Yes

Representative​

FieldTypeDescriptionCharactersRequired
namestringRepresentative nameup to 255Yes
document_numberstringRepresentative CPF14Yes

Asset​

FieldTypeDescriptionCharactersRequired
asset_typestringAsset type enumeratorup to 255Yes
credit_operationJSONCredit Operation object-No
rental_contractJSONRental Contract object-No

Asset Type​

EnumeratorDescription
ccbCCB
cceCCE
rental_contractRental contract

Credit Operation​

FieldTypeDescriptionCharactersRequired
contract_numberstringContract numberup to 255Yes
principal_valuestringPrincipal value of the operation-Yes
interest_rate_typestringPost-fixed / pre-fixed enumeratorup to 255Yes
pre_fixedJSONPre-fixed object-No
post_fixedJSONPost-fixed object-No

Interest Rate Type​

EnumeratorDescription
pre_fixedPre-fixed
post_fixedPost-fixed

Pre fixed​

FieldTypeDescriptionCharacters
calendar_basestringBusiness days / 360 calendar / 365 calendar enumeratorup to 255
monthly_ratefloatMonthly rate-

Post fixed​

FieldTypeDescriptionCharacters
calendar_basestringBusiness days / 360 calendar / 365 calendar enumeratorup to 255
indexerstringDI / IPCA enumeratorup to 255
ratefloatRate-
lagJSONLag object-

calendar_base​

EnumeratorDescription
workdaysBusiness days
calendar_360360-day calendar
calendar_365365-day calendar

Indexer​

EnumeratorDescription
diDI
ipcaIPCA

Lag​

FieldTypeDescriptionCharacters
referencestringDaily / Monthly enumeratorup to 255
amountintegerLag amount-

Reference​

EnumeratorDescription
dailyDaily
monthlyMonthly

Rental Contract​

FieldTypeDescriptionCharactersRequired
monthly_valuefloatMonthly rent value-Yes
property_addressJSONAddress object of the property-Yes
start_datestringContract start date (YYYY-MM-DD)10Yes
end_datestringContract end date (YYYY-MM-DD)10Yes
readjustment_indexfloatContract readjustment index-No

Address​

FieldTypeDescriptionCharactersRequired
streetstringStreetup to 255No
numberstringNumber-No
neighborhoodstringNeighborhoodup to 255No
citystringCityup to 255No
ufstringFederative unit (2-letter code)2No
complementstringComplementup to 255No
postal_codestringCEP in the 00000-000 format9No
countrystringCountry code (3 letters)3No

Issuance Serie​

FieldTypeDescriptionCharactersRequired
issuance_serie_keystringIssuance series key36Yes
number_of_quotasfloatNumber of quotas to be locked-No
financial_valuefloatFinancial value to be locked-No

Responses​

Response Body
{
"quota_lock_key": "UUID"
}

Errors​

Authentication, permission and host errors: see API Errors.