Skip to main content

This is the content of /docs/api-documents/data-type/tracking-additaional-params.md

Parameter Keys Documentation

Overview​

The ParamKey constants define available parameter keys used for filtering and configuration throughout the application. These keys represent various data points that can be used in API requests, database queries, or business logic operations.

Constants Reference​

CPE_OR_CMPJ​

  • Key: "cpf_or_cmpj"
  • Description: Represents either CPF (Brazilian individual taxpayer registry) or CNPJ (Brazilian company registry) identifier
  • Data Type: String identifier
  • Use Case: Brazilian tax document validation and user identification

DESTINATION_COUNTRY​

  • Key: "destination_country"
  • Description: Indicates the target country for shipping or service delivery
  • Data Type: Country code or name
  • Use Case: International shipping, geographic filtering

NUMBER_TYPE​

  • Key: "number_type"
  • Description: Specifies the classification type of a number (e.g., phone, document, account)
  • Data Type: Enumeration or string
  • Use Case: Number categorization and validation

PARAMETER​

  • Key: "parameter"
  • Description: Serves as a generic parameter key for flexible configuration
  • Data Type: Dynamic
  • Use Case: Custom or dynamic parameter passing

PHONE_NUMBER​

  • Key: "phone_number"
  • Description: Contains complete telephone number including country and area codes
  • Data Type: String (formatted phone number)
  • Use Case: User contact information, SMS services

PHONE_NUMBER_LAST_4​

  • Key: "phone_number_last_4"
  • Description: Stores the last 4 digits of a phone number for partial matching
  • Data Type: String (4 digits)
  • Use Case: Phone number verification, privacy-sensitive operations

POSTAL_CODE​

  • Key: "postal_code"
  • Description: Represents zip code or postal code for address-based operations
  • Data Type: String
  • Use Case: Address validation, shipping calculations, geographic services

RECEIVER_SENDER_TYPE​

  • Key: "receiver_sender_type"
  • Description: Defines the role type in transaction contexts (receiver/sender)
  • Data Type: Enumeration
  • Use Case: Transaction processing, role-based operations

SHIP_DATE​

  • Key: "ship_date"
  • Description: Indicates the date when shipment was or will be dispatched
  • Data Type: Date/DateTime
  • Use Case: Shipping logistics, delivery tracking