Citi Custody and Securities Services APIs

openapi: 3.0.1
info:
  title: Custody Billing API
  description: >
    The Custody Billing APIs provide comprehensive visibility into fees charged
    across custody services.  These APIs cover valuation fees at the security
    and account level, corporate action and corporate  action income–related
    fees at the event level, and an aggregated invoice‑level view of all fees 
    across multiple invoices or billing periods. Together, they enable clients
    to analyze custody billing  details by charge type, description, market,
    security, account, and corporate action, supporting  transparent
    reconciliation and reporting of custody service charges.
    <br><br>**Authentication**<br><br>Client applications must supply an
    authentication token with every request, and therefore must first
    authenticate before it can proceed. A client can use the OAuth 2 client
    credential grant flow to obtain a time limited access token. To get an
    access token send a HTTP Post request to the token endpoint using basic
    authentication with the client key and secret (provided under separate
    cover).<br><br>**Request**<br><br>```POST {baseURL}/api/oauth2/token
    HTTPS/1.1 

    Authorization: Basic base64(key:secret) 

    Content-Type:application/x-www-form-urlencoded```<br><br>

    **Response**<br><br>```
      {
          "token_type": "bearer", 
          "access_token": <access token>, 
          "expires_in": <seconds until expiry>, 
          "consented_on":<timestamp>, 
          "scope": "/dod"`
      }```    <br><br>The bearer token is valid for 1800 seconds (30 minutes) after which it will expire. At this point, you would need to re-authenticate.
  version: v1.0.0
servers:
  - url: https://sandbox.api.citivelocity.com/markets/dod
    description: Sandbox server (uses test data)
  - url: https://api.citivelocity.com/markets/dod
    description: Production server
security:
  - client-Credential-Oauth-Security-Schema: []
components:
  headers:
    dod-request-id:
      schema:
        type: string
      description: The UUID representing the unique identifier of the dod request
    paging-page-number:
      schema:
        type: string
      description: The current page number
    paging-total-page-count:
      schema:
        type: string
      description: The total count of pages available
    paging-total-record-count:
      schema:
        type: string
      description: The total count of records
  responses:
    Bad-Request:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            Bad-Request-Example:
              $ref: '#/components/examples/Bad-Request-Example'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            Unauthorized-Example:
              $ref: '#/components/examples/Unauthorized-Example'
    Not-Found:
      description: Not Found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            Not-Found-Example:
              $ref: '#/components/examples/Not-Found-Example'
    Method-Not-Allowed:
      description: Method Not Allowed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            Method-Not-Allowed-Example:
              $ref: '#/components/examples/Method-Not-Allowed-Example'
    Unsupported-Media-Type:
      description: Unsupported Media Type
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            Unsupported-Media-Type-Example:
              $ref: '#/components/examples/Unsupported-Media-Type-Example'
    Internal-Server-Error:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            Internal-Server-Error-Example:
              $ref: '#/components/examples/Internal-Server-Error-Example'
  examples:
    Bad-Request-Example:
      value:
        ref_id: 444d0f3f-4x55-7g99-8b2c-0cf2a921a5ab
        errorDetails:
          - issue: path-param servicePortableId is mandatory and it cannot be empty
            action: please provide valid parameter values
            code: VC00010
    Unauthorized-Example:
      value:
        ref_id: 444d0f3f-4x55-7g99-8b2c-0cf2a921a5ab
        errorDetails:
          - issue: User not authorized for this functionality
            action: please use valid credentials to access this functionality
            code: CC00007
    Not-Found-Example:
      value:
        ref_id: 444d0f3f-4x55-7g99-8b2c-0cf2a921a5ab
        errorDetails:
          - issue: Resource that you are searching is not found
            action: Please use valid resource details
            code: CC00006
    Method-Not-Allowed-Example:
      value:
        ref_id: 444d0f3f-4x55-7g99-8b2c-0cf2a921a5ab
        errorDetails:
          - issue: Method not supported
            action: please use valid http verb
            code: CC00001
    Unsupported-Media-Type-Example:
      value:
        ref_id: 444d0f3f-4x55-7g99-8b2c-0cf2a921a5ab
        errorDetails:
          - issue: Media type not supported
            action: please use valid content-type in header
            code: CC00002
    Internal-Server-Error-Example:
      value:
        ref_id: 444d0f3f-4x55-7g99-8b2c-0cf2a921a5ab
        errorDetails:
          - issue: unable to serve your request at this moment
            action: Please refer to documentation provided or contact support team
            code: CC00004
  schemas:
    febf0553-d455-4849-b6fa-2337b4989b0f-data-schema:
      type: object
      properties:
        ACCOUNT_CURRENCY:
          type: string
          description: >-
            Account Currency is the ISO 4217 currency code corresponding to the
            base currency of the safekeeping account.
          example: SGD
        SAFE_KEEPING_ACCOUNT:
          type: string
          description: >-
            Account ID is an identifier for both a Cash Account and/or a
            Safekeeping Account that is unique within a branch.
          example: '0000000258944'
        ACTIVITY_CATEGORY:
          type: string
          description: >-
            Activity Category is the low level description of the billable
            activity (e.g. Asset Services, Settlements, Tax).
          example: Settlements
        ACTIVITY_CURRENCY:
          type: string
          description: >-
            Activity Currency is the ISO 4217 currency code corresponding to the
            market currency of the billable activity.
          example: AED
        ACTIVITY_TYPE:
          type: string
          description: >-
            Activity Type is the high level description of the billable activity
            (e.g. Valuations, Transactions, Surcharges, Other fees).
          example: Surcharges
        CLARITY_BRANCH_NAME:
          type: string
          description: >-
            Branch Name is the name of the branch for the Cash Account and/or
            Safekeeping Account.
          example: UNITED KINGDOM
        CHARGE_IN_FEE_CURENCY:
          type: number
          format: double
          description: >-
            Charge (Fee Schedule Currency) is the calculated charge for the
            billable activity in the Fee Schedule Currency.
          example: 10
        CHARGE_IN_USD:
          type: number
          format: double
          description: >-
            Charge (USD) is the calculated charge for the billable activity in
            US dollars.
          example: 1.75
        CLIENT_ID:
          type: string
          description: >-
            Client ID is an identifier for the client as set up in the core
            billing system.
          example: ID123456
        DELIVERY_METHOD:
          type: string
          description: >-
            Delivery Method indicates how the invoice is sent to the client.
            E.g. By post, by email, etc.
          example: Email
        DIRECT_DEBIT_CASH_ACCOUNT:
          type: string
          description: >-
            Direct Debit Cash Account is the account id of the cash account from
            which the invoice amount will be debited.
          example: '12727277'
        DIRECT_DEBIT_SLA_DATE:
          type: string
          description: >-
            Direct Debit SLA is the date on which the direct debit is expected
            to be taken.
          example: '2021-03-25 00:00:00.0'
        FEE_SCHEDULE_CURRENCY:
          type: string
          description: >-
            Fee Schedule Currency is the ISO 4217 currency code corresponding to
            the currency in which the rate card is published.
          example: ARS
        INVOICE_CURRENCY:
          type: string
          description: >-
            Invoice Currency is the ISO 4217 currency code corresponding to the
            currency in which the invoice is to be paid.
          example: EUR
        INVOICE_DELIVERY_DATE:
          type: string
          format: date
          description: >-
            Invoice Delivery Date is the date on which the invoice was sent to
            the client.
          example: '2020-10-28'
        BILLING_FREQUENCY:
          type: string
          description: >-
            Invoice Frequency indicates how often the invoice is calculated.
            E.g. Monthly, Quarterly, etc.
          example: Monthly
        BILLABLE_MONTH:
          type: string
          format: date
          description: >-
            Represents the billing month for which the invoice is generated. The
            date typically reflects a day within the billable month.
          example: '2020-11-30'
        BILLING_PERIOD:
          type: string
          format: date
          description: >-
            Represents the specific date or timestamp associated with the
            billing period used for invoice calculation.
          example: '2020-11-30'
        INVOICE_NUMBER:
          type: integer
          format: int64
          description: Invoice Number is the unique reference number of the invoice.
          example: 20210100647
        INVOICE_SCHEDULE_ID:
          type: integer
          format: int64
          description: >-
            Invoice Schedule Identifier is a unique reference for the schedule
            under which each invoice is created.
          example: 1965199
        REPORTING_DATE:
          type: string
          format: date-time
          description: >-
            Invoice Update Date is the date on which the invoice was last
            changed.
          example: '2020-09-18 04:17:00'
        MARKET:
          type: string
          description: >-
            Market is the name of the market or International Central Securities
            Depositories in which the billable activity has occurred.
          example: DENMARK
        PAYMENT_BASIS:
          type: string
          description: >-
            Payment Basis indicates how the invoice is expected to be paid. e.g.
            Remittance, Direct Debit.
          example: Remittance
        BILLING_CENTRE:
          type: string
          description: >-
            Place Of Settlement Code is a 3 digit code corresponding to the
            settlement location of the holding.
          example: HKG
        BILLING_CENTRE_NAME:
          type: string
          description: Place Of Settlement is the settlement location of the holding.
          example: CITIBANK
        QUANTITY_IN_ACCOUNT_CURRENCY:
          type: number
          format: double
          description: >-
            Quantity (Account Currency) is either the number of charges incurred
            or the value used in the fee calculation converted to the Account
            Currency.
          example: 4597.12
        QUANTITY_IN_FEE_SCHEDULE_CURRENCY:
          type: number
          format: double
          description: >-
            Quantity (Activity Currency) is either the number of charges
            incurred or the value used in the fee calculation converted to the
            Activity Currency.
          example: 1722.02
        QUANTITY_IN_INVOICE_CURRENCY:
          type: number
          format: double
          description: >-
            Quantity (Invoice Currency) is either the number of charges incurred
            or the value used in the fee calculation converted to the Invoice
            Currency.
          example: 533.33
        QUANTITY_IN_USD:
          type: number
          format: double
          description: >-
            Quantity (USD) is either the number of charges incurred or the value
            used in the fee calculation converted to US dollars.
          example: 30
        REGION:
          type: string
          description: >-
            Region is the name of the geographical region (if appropriate) in
            which the billable activity has occurred.
          example: Europe
        REVISED_FLAG:
          type: string
          description: >-
            Revised Flag indicates whether or not the invoice has been changed
            since it was first calculated.
          example: 'Y'
        REVISION_NUMBER:
          type: integer
          format: int32
          description: >-
            Revision Number indicates how many times the invoice has been
            revised.
          example: 7
        SALES_TAX_FEE_IN_ACCOUNT_CURRENCY:
          type: number
          format: double
          description: >-
            Sales Tax (Account Currency) is the applicable sales tax in the
            Account Currency.
          example: 10615
        SALES_TAX_FEE_IN_FEE_CURRENCY:
          type: number
          format: double
          description: >-
            Sales Tax (Fee Schedule Currency) is the applicable sales tax in the
            Fee Schedule Currency.
          example: 397.8
        SALES_TAX_FEE_IN_INVOICE_CURRENCY:
          type: number
          format: double
          description: >-
            Sales Tax (Invoice Currency) is the applicable sales tax in the
            Invoice Currency.
          example: 54.59253
        SALES_TAX_FEE_IN_USD:
          type: number
          format: double
          description: Sales Tax (USD) is the applicable sales tax in US Dollars.
          example: 24.843
        TOTAL_FEE_IN_ACCOUNT_CURRENCY:
          type: number
          format: double
          description: >-
            Total Fee (Account Currency) is the total charge for the billable
            activity in the Account Currency.
          example: 552.11
        TOTAL_FEE_IN_FEE_CURRENCY:
          type: number
          format: double
          description: >-
            Total Fee (Fee Schedule Currency) is the total charge for the
            billable activity in the Fee Schedule Currency.
          example: 461.87
        TOTAL_FEE_IN_INVOICE_CURRENCY:
          type: number
          format: double
          description: >-
            Total Fee (Invoice Currency) is the total charge for the billable
            activity in the Invoice Currency.
          example: 377.43
        TOTAL_FEE_IN_USD:
          type: number
          format: double
          description: >-
            Total Fee (USD) is the total charge for the billable activity in US
            Dollars.
          example: 163.18996
        INVOICE_YEAR:
          type: string
          description: >-
            Represents the calendar year in which the custody invoice is
            generated.
          example: '2020'
        INVOICE_MONTH:
          type: string
          description: Billable Invoice Month.
          example: '11'
        CATEGORY_CODE:
          type: string
          description: Category Code.
          example: A
        TRANSACTION_TYPE:
          type: string
          description: >-
            Type of transaction. List of available values: 'AllocBuyExt':'Buy
            Future':'Open Repo':'Open Reverse':'Buy TBA':'Buy
            Protection':'MatRepo':'IssueFunds':'OpenSwap':'Buy
            Option':'Assignment':'Call on Rights':'Scrip
            Dividend':'CASell':'Exerc. Opt.':'Expire
            Option':'CloseFX':'Sell':'VariatMarg':'Buy':'Redemption':'ChargeCash':'MatLend':'Payment':'Coupon':'CALiqu':'IniMar':'Lend':'DepMoney':'Dividend':'Loan
            Facility Fee Pay In':'Withdraw':'WdrMoney':'MatReverse':'CA Stock
            split':'CA Reverse stock split':'Rights Distribution':'Exchange
            Offer':'Deliver Collateral':'RalocCdyPor':'CABuy':'Bonus
            Issue':'DemergerMor':'DRP Scrip Dividend':'Merger':'Spin
            Off':'Worthless':'BuyFXSpot':'BuyFXFwd':'SellFXSpot':'SellFXFwd':'Deposit':'Accept
            Collateral':'Close Facility Commitment':'Open Facility
            Commitment':'AllocSellExt':'Sell Future':'Sell TBA':'Sell
            Option':'Close Opt':'BuyFXFwdDbd':'SellFXFwdDbd'.
          example: BUY FUTURE
        RESPONSIBLE_PERSON:
          type: string
          description: Responsible person.
          example: Billing
        ACCT_NME:
          type: string
          description: >-
            Account Name is the name that is assigned to the Cash Account and/or
            the Safekeeping Account. If an Alternate Account Name has been
            specified for an account it will be displayed as the Account Name.
          example: Demo - SK - Japan 2
        BR_ID:
          type: string
          description: >-
            Branch Code is the identifier of the branch for the account. For the
            Cash Account the branch code is a numeric value and for the
            Safekeeping Account it is the ISO Country code.
          example: '484'
        ALTV_CUR_CD:
          type: string
          description: Account Base Currency Code is the ISO Currency Code for the account.
          example: JPY
        ACCT_BASE_NBR:
          type: string
          description: >-
            Account Base Number is an internal client identifier that is
            associated to a Safekeeping or Cash Account.
          example: 8-DEMOCSH53JPY
        ACCT_BUS_TYP_CD:
          type: string
          description: >-
            Account Type Code indicates the type of the account. Values are: C
            (Cash Account), S (Safekeeping Account).
          example: C
        IOD_TIMESTAMP:
          type: string
          format: date-time
          description: Provides the Timestamp when data is loaded in the Data Lake.
          example: '2024-11-12 19:30:08'
    febf0553-d455-4849-b6fa-2337b4989b0f-json-response-schema:
      type: object
      properties:
        Count:
          type: number
          format: integer
        PagedList:
          type: array
          items:
            $ref: >-
              #/components/schemas/febf0553-d455-4849-b6fa-2337b4989b0f-data-schema
    febf0553-d455-4849-b6fa-2337b4989b0f-xml-response-schema:
      type: object
      properties:
        row:
          type: array
          items:
            $ref: >-
              #/components/schemas/febf0553-d455-4849-b6fa-2337b4989b0f-data-schema
      xml:
        name: data
    3291fe1b-9d6f-4285-9836-a2c66ac1dbd3-data-schema:
      type: object
      properties:
        REPORTING_DATE:
          type: string
          format: date-time
          description: >-
            Invoice Update Date is the date on which the invoice was last
            changed.
          example: '2025-08-27 07:33:00'
        BRANCH_ID:
          type: integer
          format: int32
          description: >-
            Branch Code is the identifier of the branch for the account. For the
            Cash Account the branch code is a numeric value and for the
            Safekeeping Account it is the ISO 3166 Country code.
          example: 101
        BILLING_PERIOD:
          type: string
          description: >-
            Represents the specific date or timestamp associated with the
            billing period used for invoice calculation.
          example: '2020-11-30 00:00:00'
        INVOICE_SCHEDULE_ID:
          type: integer
          format: int64
          description: >-
            Invoice Schedule Identifier is a unique reference for the schedule
            under which each invoice is created.
          example: 1965199
        SK_ACCOUNT:
          type: string
          description: >-
            Account ID is an identifier for both a Cash Account and or a
            Safekeeping Account that is unique within a branch.
          example: '12345678901'
        CLIENT_ID:
          type: string
          description: >-
            Client ID is an identifier for the client as set up in the core
            billing system.
          example: ID123456
        SK_GRP_NAME:
          type: string
          description: >-
            Safekeeping Group Name is the name of a group of safekeeping
            accounts that the client has defined and set up in the core billing
            system.
          example: AB123456
        PROFIT_CENTER:
          type: integer
          format: int32
          description: Profit Centre is an internal field not for client consumption.
          example: 1
        PROFIT_CENTER_NAME:
          type: string
          description: Profit Centre Name is an internal field not for client consumption.
          example: Foreign Bank
        CENTRE_CODE:
          type: string
          description: >-
            Place Of Settlement Code is a 3 digit code corresponding to the
            settlement location of the holding.
          example: AR3
        NAME:
          type: string
          description: Place Of Settlement is the settlement location of the holding.
          example: New York
        ASSET_TYPE:
          type: string
          description: >-
            Asset Type is a code representing the Asset Type of the security.
            Values may include EQTY Equity FI Fixed Income etc.
          example: EQTY
        CURRENCY:
          type: string
          description: >-
            Currency is the ISO 4217 currency code corresponding to the currency
            in the market. The currency of the balance/bank account, List of
            possible values: AED: UAE Dirham AFN: Afghani ALL: Lek AMD: Armenian
            Dram ANG: Netherlands Antillean Guilder AOA: Kwanza ARS: Argentine.
          example: AED
        MARKET_VALUE:
          type: number
          format: double
          description: >-
            Market Value is the market value at the Market Value Date in the
            Market Currency.
          example: 1250000.75
        AVG_MARKET_VALUE:
          type: number
          format: double
          description: >-
            Average Market Value is the average daily market value across the
            billing period in the Market Currency.
          example: 1200000.5
        AVERAGE_QUANTITY_SHARES:
          type: number
          format: double
          description: >-
            Average Quantity is the average daily settled quantity across the
            billing period.
          example: 150
        UNITS_OF_SHARE:
          type: number
          format: double
          description: Units of Share
          example: 1
        MARKET_VALUE_DATE:
          type: string
          description: Market Value Date is the date on which the Market Value is provided.
          example: '2025-03-31'
        HOLDINGS:
          type: number
          format: double
          description: >-
            Quantity is the settled quantity of the security at the Market Value
            Date.
          example: 150
        PRICE:
          type: number
          format: double
          description: Issue Price is the price of the security at the Market Value Date.
          example: 83.45
        ISIN:
          type: string
          description: >-
            ISIN International Securities Identification Number is a 12
            character alpha numerical code governed by ISO 6166 it is a uniform
            identification of a security at trading and settlement.
          example: US0378331005
        PRICE_CURRENCY:
          type: string
          description: >-
            Issue Price Currency is the ISO 4217 currency code corresponding to
            the currency in which the Issue Price is published.
          example: USD
        FEE:
          type: number
          format: double
          description: Fee is the charge in the Fee Schedule Currency.
          example: 1.11
        FEE_CURRENCY:
          type: string
          description: >-
            Total Fee Fee Schedule Currency is the total charge for the billable
            activity in the Fee Schedule Currency It is the ISO 4217 currency
            code corresponding to the currency in which the rate card is
            published.
          example: USD
        REVISION_NUMBER:
          type: integer
          format: int32
          description: >-
            Revision Number indicates how many times the invoice has been
            revised.
          example: 7
        INVOICE_NUMBER:
          type: integer
          format: int64
          description: Invoice Number is the unique reference number of the invoice.
          example: 2025030001
        CLARITY_BRANCH_NAME:
          type: string
          description: >-
            Branch Name is the name of the branch for the Cash Account and or
            Safekeeping Account.
          example: BRAZIL
        MARKET:
          type: string
          description: >-
            Market is the name of the market or International Central Securities
            Depositories in which the billable activity has occurred.
          example: HONG KONG
        REGION:
          type: string
          description: >-
            Region is the name of the geographical region if appropriate in
            which the billable activity has occurred.
          example: Europe
        FUND_MANAGER:
          type: string
          description: >-
            A fund manager is a person or company who manages a portfolio of
            investments for a funds clients Fund Manager field from Client
            Profile Table.
          example: ABC Asset Management
        LEAD_FUND_MANAGER:
          type: string
          description: >-
            A lead fund manager is a person or company who manages a portfolio
            of investments for a funds clients.
          example: John Doe
        MARKETING_GFCID_L4_NAME:
          type: string
          description: >-
            A Global Finance Customer Identifier (GFCID) is a 10-digit
            identifier assigned to represent legal entities as well as branches
            and sub accounts within ICG and other businesses This is the L4
            GFCID for the client record. Where the L4 GFCID is equal to GFCID
            the GFCID the record identifies an L4 GFCID. This represents the
            Sub-Account level as recorded in the STaRs (Service Tracking and
            Reporting System) for the specified source region.
          example: LEGAL & GENERAL REINSURANCE CO LTD
        ACCT_NME:
          type: string
          description: >-
            Account Name is the name that is assigned to the Cash Account and/or
            the Safekeeping Account. If an Alternate Account Name has been
            specified for an account it will be displayed as the Account Name.
          example: Demo - SK - Japan 2
        BR_ID:
          type: string
          description: >-
            Branch Code is the identifier of the branch for the account. For the
            Cash Account the branch code is a numeric value and for the
            Safekeeping Account it is the ISO 3166 Country code.
          example: '484'
        ALTV_CUR_CD:
          type: string
          description: >-
            Account Base Currency Code is the ISO 4217 Currency Code for the
            account.
          example: USD
        ACCT_BASE_NBR:
          type: string
          description: >-
            Account Base Number is an internal client identifier that is
            associated to a Safekeeping or Cash Account or A customer ID
            associated with a group (one or more) of accounts held by that
            customer.
          example: 8-DEMOCSH53JPY
        ACCT_BUS_TYP_CD:
          type: string
          description: >-
            A code to indicate the type of account - Cash, Safekeeping or
            E-Report.
          example: S
        SID_SEDOL:
          type: string
          description: >-
            SEDOL (Stock Exchange Daily Official List) is a unique
            identification code, consisting of seven alphanumeric characters,
            that is assigned to all securities trading on the London Stock
            Exchange.
          example: BMW2DZ3
        SID_CUSIP:
          type: string
          description: >-
            CUSIP (Committee on Uniform Securities Identification Procedures) It
            is a nine-character alphanumeric code that identifies a North
            American financial security for the purposes of facilitating
            clearing and settlement of trades.
          example: 594918AL9
        SID_TICKER_SYMB:
          type: string
          description: Ticker is the symbol used on the exchange to identify the security.
          example: MSFT
        SID_ISIN:
          type: string
          description: >-
            ISIN (International Securities Identification Number) is a
            12-character alpha-numerical code that does not contain information
            characterizing financial instruments but serves for uniform
            identification of a security at trading and settlement.
          example: US0378331005
        SEC_SHRT_NME:
          type: string
          description: Issue Name is the Security Name of the security instrument.
          example: Apple Inc
        EXCH_MNEM:
          type: string
          description: The internal code for the exchange market.
          example: XNAS
        SEC_SECURITY_CD:
          type: string
          description: >-
            Internal Security Code is the identifier of the Internal Security
            Identifier.
          example: SEC12345
        PFD_ID_CTXT_CD:
          type: string
          description: >-
            Security ID Type indicates the type of identifier of the
            corresponding Security ID field. Possible values may include: CUSIP,
            ISIN, SEDOL, LOCAL, etc.
          example: ISIN
        PFD_ISS_ID:
          type: string
          description: >-
            Security ID is the most commonly used identifier for the security in
            a given market.
          example: B2R3PV1
        DNOMD_CUR_CD:
          type: string
          description: >-
            The currency in which this security is denominated in the local
            market.
          example: USD
        BKING_CUR_CD:
          type: string
          description: >-
            The code of the native or local currency in which this cash flow is
            scheduled to actually occur.
          example: USD
        DLAY_DAYS:
          type: string
          description: Delay Days
          example: '2'
        PMT_FREQY_DESC:
          type: string
          description: >-
            Payment Frequency Description indicates how often interest is paid
            on the security. Possible values may include: Annual (00001),
            Sem-Annual (00002), One Payment Per Year (00035), etc.
          example: Annual
        PMT_FREQY:
          type: string
          description: >-
            Payment Frequency indicates how often interest is paid on the
            security. Possible values may include: 00001 (Annual), 00002
            (Sem-Annual), 00035 (One Payment Per Year), etc.
          example: '00001'
        ISS_CATG_CD:
          type: string
          description: >-
            Issue Category Code is a specific category for the security.
            Possible values may include: CSTK (Common Stock), DERIV
            (Derivatives), MBS (Mortgage Backed Securities), etc.
          example: CSTK
        ISS_CAT_NME:
          type: string
          description: The classification of the security as ADR CMO ETF etc.
          example: ETF
        IOD_TIMESTAMP:
          type: string
          format: date-time
          description: Provides the Timestamp when data is loaded in the Data Lak

# --- truncated at 32 KB (176 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/openapi/citi-custody-billing-openapi.yaml