Skip to main content

Query quota lock

Introduction​

This resource details the information of an investor's quota lock request.

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/QUOTA_LOCK_KEY
METHOD
GET
STATUS
200

Response​

{
  "quota_lock_key": "UUID",
  "status": "pending_documents",
  "original_locked_quotas": 0.0,
  "current_locked_quotas": 0.0,
  "original_locked_value": 0.0,
  "current_locked_value": 0.0,
  "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_key": "UUID",
        "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
            }
          }
        },
        "documents": [
          {
            "document_key": "UUID",
            "document_type": "asset_document"
          }
        ]
      }
    ],
    "issuance_series": [
      {
        "issuance_serie_key": "UUID",
        "number_of_quotas": 0.0,
        "financial_value": 0.0
      },
      {
        "issuance_serie_key": "UUID",
        "number_of_quotas": 0.0,
        "financial_value": 0.0
      }
    ],
    "documents": [
      {
        "document_key": "UUID",
        "document_type": "collateral_contract"
      }
    ]
  },
  "investor_positions_locks": [
    {
      "investor_position_lock_key": "UUID",
      "investor_position_key": "UUID",
      "original_locked_quotas": 0.0,
      "current_locked_quotas": 0.0,
      "original_locked_value": 0.0,
      "current_locked_value": 0.0
    }
  ]
}

Quota Lock​

FieldTypeDescriptionCharacters
quota_lock_keystringUnique identifier of the quota lock36
statusstringQuota lock type enumeratorup to 255
typestringQuota lock type enumeratorup to 255
original_locked_quotasfloatOriginal number of locked quotas-
current_locked_quotasfloatCurrent number of locked quotas-
original_locked_valuefloatOriginal lock value-
current_locked_valuefloatCurrent lock value-
collateralJSONCollateral object-
investor_positions_locksArrayList of Investor position lock objects-

Quota Lock Status​

EnumeratorDescription
pending_documentsPending documents
pending_approvalPending approval
deniedDenied
approvedApproved

Quota Lock Type​

EnumeratorDescription
collateralCollateral

Collateral​

FieldTypeDescriptionCharacters
recipientJSONRecipient object-
borrowerJSONBorrower object-
assetsArrayList of Asset objects-
issuance_seriesArrayList of Issuance series objects-
documentsArrayList of Collateral document objects-

Issuance Serie​

FieldTypeDescriptionCharacters
issuance_serie_keystringIssuance series key36
number_of_quotasfloatNumber of locked quotas-
financial_valuefloatLocked financial value-

Recipient​

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

Borrower​

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

Person Type​

EnumeratorDescription
natural_personNatural person
legal_personLegal entity

Natural Person​

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

Representative​

FieldTypeDescriptionCharacters
namestringRepresentative nameup to 255
document_numberstringRepresentative CPF14

Asset​

FieldTypeDescriptionCharacters
asset_keystringUnique identifier of the assetup to 255
asset_typestringAsset type enumeratorup to 255
statusstringAsset status enumeratorup to 255
credit_operationJSONCredit Operation object-
documentsArrayList of Asset document objects-

Asset Status​

EnumeratorDescription
pending_approvalPending approval
donecompleted

Document​

FieldTypeDescriptionCharacters
document_keystringUnique identifier of the assetup to 255
document_typestringAsset type enumeratorup to 255

Asset Type​

EnumeratorDescription
ccbCCB
cceCCE

Credit Operation​

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

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

Locked Investor Positions​

FieldTypeDescriptionCharacters
investor_position_lock_keystringUnique identifier of the investor position lock36
investor_position_keystringUnique identifier of the investor position36
original_locked_quotasfloatOriginal number of locked quotas-
current_locked_quotasfloatCurrent number of locked quotas-
original_locked_valuefloatOriginal lock value-
current_locked_valuefloatCurrent lock value-

Errors​

Authentication, permission and host errors: see API Errors.