Every API here is available over the APIs.io API and to AI agents over MCP.
{"components":{"schemas":{"TokenCreateRequestBody":{"properties":{"password":{"description":"The password of the API user","example":"password","type":"string"},"realm":{"description":"This will have been provided by ComplyAdvantage at onboarding. Note this is case sensitive.","example":"yourrealm","type":"string"},"username":{"description":"The username (email address) of the API user","example":"yourapiuser@yourdomain.com","format":"email","type":"string"}},"required":["username","password","realm"],"type":"object"},"TokenCreateRequestBodyV3":{"properties":{"access_key":{"description":"The access key identifying your API Credential.","example":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX","type":"string"},"secret":{"description":"The randomly generated secret associated with your API Credential, used to authenticate the request. Treat this as sensitive, store it securely and do not share it.","example":"randomsecretstring","type":"string"}},"required":["access_key","secret"],"type":"object"},"TokenCreateResponseData":{"properties":{"access_token":{"description":"The generated token that should be included in the authorization header of each call (`Authorization: Bearer {access_token}`)","example":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX","type":"string"},"expires_in":{"description":"The number of seconds until the token expires","example":86400,"type":"integer"},"scope":{"enum":["read:api write:api"],"type":"string"},"token_type":{"enum":["Bearer"],"type":"string"}},"type":"object"},"activity_AccountBalanceV3":{"description":"Represents the balance of a financial account.","properties":{"current_balance":{"$ref":"#/components/schemas/activity_MonetaryValueV3"},"current_base_balance":{"$ref":"#/components/schemas/activity_MonetaryValueV3"}},"required":["current_balance"],"type":"object"},"activity_AcquirerV3":{"description":"Represents the payment acquirer information.","properties":{"details":{"$ref":"#/components/schemas/activity_PartyIdentificationV3"},"identifier":{"description":"Unique acquirer identifier.","example":"acq_visa_usa","maxLength":50,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"activity_AddressFormatV3":{"description":"Represents the format of the address used for a party.","enum":["STRUCTURED","UNSTRUCTURED"],"example":"STRUCTURED","type":"string"},"activity_AddressTypeV3":{"description":"Represents the type of address.","enum":["RESIDENTIAL","MAILING","OPERATING","REGISTRATION","BILLING"],"example":"MAILING","type":"string"},"activity_AddressV3":{"description":"Address of the ATM.","discriminator":{"propertyName":"format"},"properties":{"format":{"$ref":"#/components/schemas/activity_AddressFormatV3"}},"required":["format"],"type":"object"},"activity_AgentRoleV3":{"description":"The roles an agent may take within a financial transaction.","enum":["COUNTERPARTY_BANK","INTERMEDIARY","DEBTOR_AGENT","CREDITOR_AGENT"],"example":"COUNTERPARTY_BANK","type":"string"},"activity_AgentV3":{"description":"Represents an agent in a financial transaction.","properties":{"bank":{"$ref":"#/components/schemas/activity_BankV3"},"index":{"description":"The position of the agent in the list. Used to track the agent's order in the original sequence.","format":"int32","nullable":true,"type":"integer"},"money_transfer_operator":{"$ref":"#/components/schemas/activity_MoneyTransferOperatorV3"},"online_remittance_platform":{"$ref":"#/components/schemas/activity_OnlineRemittancePlatformV3"},"reference_text":{"description":"The reference text supplied by an agent.","example":"Interbank Ref 9372","maxLength":512,"minLength":0,"nullable":true,"type":"string"},"role":{"$ref":"#/components/schemas/activity_AgentRoleV3"},"virtual_asset_service_provider":{"$ref":"#/components/schemas/activity_VirtualAssetServiceProviderV3"}},"required":["role"],"type":"object"},"activity_AtmChannelV3":{"allOf":[{"$ref":"#/components/schemas/activity_ChannelV3"},{"properties":{"address":{"discriminator":{"mapping":{"STRUCTURED":"#/components/schemas/activity_StructuredAddressV3"},"propertyName":"format"},"oneOf":[{"$ref":"#/components/schemas/activity_StructuredAddressV3"},{"$ref":"#/components/schemas/activity_UnstructuredAddressV3"}]},"geographic_location":{"$ref":"#/components/schemas/activity_GeographicCoordinatesV3"},"identifier":{"description":"Client-specific identifier for ATM.","type":"string"},"provider":{"description":"ATM provider name.","type":"string"}},"type":"object"}],"description":"Represents an ATM channel used for transaction processing.","required":["network_details","type"],"title":"ATM","type":"object"},"activity_AuthorizationInfoV3":{"description":"Authorization information.","properties":{"identifier":{"description":"Unique authorization identifier.","example":"auth_123456789","maxLength":50,"minLength":0,"nullable":true,"type":"string"},"response":{"$ref":"#/components/schemas/activity_AuthorizationResponseV3"},"state":{"description":"Represents the state of an authorization request.","enum":["APPROVED","DECLINED","PENDING","EXPIRED","CANCELLED"],"example":"APPROVED","nullable":true,"type":"string"},"timestamp":{"description":"Authorization timestamp.","example":"2024-01-15T10:30:00.000Z","format":"date-time","nullable":true,"type":"string"},"type":{"description":"Type of authorization for a card payment.","enum":["PREAUTHORIZATION","AUTHORIZATION"],"example":"AUTHORIZATION","nullable":true,"type":"string"},"value":{"$ref":"#/components/schemas/activity_MonetaryValueV3"}},"type":"object"},"activity_AuthorizationResponseV3":{"description":"Authorization response information.","properties":{"code":{"description":"Authorization response code.","example":"00","maxLength":10,"minLength":0,"nullable":true,"type":"string"},"reason_code":{"description":"Authorization reason code.","example":"APPROVED","maxLength":50,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"activity_BankAccountV3":{"description":"Represent bank account details","properties":{"bank":{"$ref":"#/components/schemas/activity_BankV3"},"iban":{"description":"Bank account iban number","nullable":true,"pattern":"^[a-zA-Z]{2}\\d{2}.*","type":"string"},"local":{"$ref":"#/components/schemas/activity_LocalAccountDetailsV3"}},"required":["bank"],"type":"object"},"activity_BankPaymentMonetaryTransactionTypeDetailsV3":{"allOf":[{"$ref":"#/components/schemas/activity_MonetaryTransactionTypeDetailsV3"},{"properties":{"agents":{"description":"Any intermediaries involved in the transaction between the creditor and the debtor.","items":{"$ref":"#/components/schemas/activity_AgentV3"},"maxItems":10,"minItems":0,"type":"array"},"creditor":{"$ref":"#/components/schemas/activity_PartyIdentificationV3"},"debtor":{"$ref":"#/components/schemas/activity_PartyIdentificationV3"},"payment_scheme":{"$ref":"#/components/schemas/activity_PaymentSchemeV3"},"state":{"$ref":"#/components/schemas/activity_BankPaymentStateV3"},"ultimate_creditor":{"$ref":"#/components/schemas/activity_PartyIdentificationV3"},"ultimate_debtor":{"$ref":"#/components/schemas/activity_PartyIdentificationV3"}},"type":"object"}],"description":"Models a transfer of funds from one bank account to another in a different financial institution.","required":["creditor","debtor","payment_scheme","state","type"],"title":"Bank Payment Details","type":"object"},"activity_BankPaymentStateV3":{"description":"The possible states of a bank payment transaction.","enum":["PENDING","BOOKED"],"example":"BOOKED","type":"string"},"activity_BankV3":{"description":"Represents a bank's details.","properties":{"bic":{"description":"The Business Identifier Code (BIC) of the bank. Also known as SWIFT code.","example":"ABCDGB01A1B","nullable":true,"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$","type":"string"},"legal_entity_address":{"$ref":"#/components/schemas/activity_StructuredAddressV3"},"name":{"description":"The name of the bank.","example":"Deutsche Bank","maxLength":256,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"activity_BlockchainNetworkTypeV3":{"description":"Type of the blockchain network used in the transaction.","enum":["MAIN","TEST"],"type":"string"},"activity_BlockchainV3":{"description":"Represents a blockchain network used for cryptocurrency transactions.","properties":{"identifier":{"$ref":"#/components/schemas/activity_Caip2IdentifierV3"},"network_name":{"description":"Human friendly chain name.","nullable":true,"type":"string"},"network_type":{"$ref":"#/components/schemas/activity_BlockchainNetworkTypeV3"}},"required":["identifier","network_type"],"type":"object"},"activity_BooleanEnrichmentValueV3":{"allOf":[{"$ref":"#/components/schemas/activity_EnrichmentValueV3"},{"properties":{"boolean":{"description":"The boolean value","example":true,"type":"boolean"}},"type":"object"}],"description":"Boolean representation of the enrichment value.","required":["boolean","data_type"],"title":"Boolean Value","type":"object"},"activity_Caip19IdentifierV3":{"description":"The industry standard CAIP-19 Asset Identifier (http://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-19.md)","properties":{"namespace":{"description":"The namespace covers a class of similar assets.","example":"slip44","pattern":"[-a-z0-9]{3,8}","type":"string"},"reference":{"description":"The way to identify a blockchain within a given namespace.","example":"966","pattern":"[-.%a-zA-Z0-9]{1,128}","type":"string"}},"required":["namespace","reference"],"type":"object"},"activity_Caip2IdentifierV3":{"description":"The industry standard CAIP-2 Identifier for the blockchain (https://chainagnostic.org/CAIPs/caip-2)","properties":{"namespace":{"description":"Describes an ecosystem or standard, such as e.g. cosmos or eip155. One namespace should refer to one resolution method to resolve the chain’s reference.","example":"eip155","pattern":"[-a-z0-9]{3,8}","type":"string"},"reference":{"description":"The way to identify a blockchain within a given namespace.","example":"1","pattern":"[-_a-zA-Z0-9]{1,32}","type":"string"}},"required":["namespace","reference"],"type":"object"},"activity_CardFundingTypeV3":{"description":"Defines the funding type of a payment card.","enum":["CREDIT","DEBIT","PREPAID","OTHER"],"example":"CREDIT","type":"string"},"activity_CardHolderV3":{"description":"Represents a card holder with party identification details and onboarding information.","properties":{"details":{"$ref":"#/components/schemas/activity_PartyIdentificationV3"}},"type":"object"},"activity_CardPaymentMonetaryTransactionTypeDetailsV3":{"allOf":[{"$ref":"#/components/schemas/activity_MonetaryTransactionTypeDetailsV3"},{"properties":{"acquirer":{"$ref":"#/components/schemas/activity_AcquirerV3"},"card":{"$ref":"#/components/schemas/activity_PaymentCardV3"},"card_holder":{"$ref":"#/components/schemas/activity_CardHolderV3"},"card_payment_scope":{"$ref":"#/components/schemas/activity_CardPaymentScopeV3"},"card_payment_type":{"$ref":"#/components/schemas/activity_CardPaymentTypeV3"},"card_scheme":{"$ref":"#/components/schemas/activity_CardSchemeV3"},"card_verification_results":{"$ref":"#/components/schemas/activity_CardVerificationResultsV3"},"issuer":{"$ref":"#/components/schemas/activity_IssuerV3"},"merchant":{"$ref":"#/components/schemas/activity_MerchantV3"},"payment_stage":{"$ref":"#/components/schemas/activity_CardPaymentStageV3"},"payment_stages_info":{"$ref":"#/components/schemas/activity_PaymentStagesInfoV3"},"point_of_sale":{"$ref":"#/components/schemas/activity_PointOfSaleConditionV3"},"related_transaction_identifier":{"description":"Reference ID linking to parent/related transaction.","example":"txn_ref_987654321","maxLength":100,"minLength":0,"type":"string"},"sub_merchant":{"$ref":"#/components/schemas/activity_MerchantV3"}},"type":"object"}],"description":"Models a card payment transaction where funds are transferred using a payment card.","required":["type"],"title":"Card Payment Details","type":"object"},"activity_CardPaymentScopeV3":{"description":"Defines the scope of a card payment transaction.","enum":["DOMESTIC","CROSSBORDER"],"example":"DOMESTIC","type":"string"},"activity_CardPaymentStageV3":{"description":"Defines the stage of a card payment transaction.","enum":["AUTHORIZED","SETTLED","REVERSED","PARTIALLY_SETTLED","CHARGEBACK"],"example":"SETTLED","type":"string"},"activity_CardPaymentTypeV3":{"description":"Defines the type of card payment.","enum":["REGULAR","INSTALLMENT","RECURRING","MOTO","UNSCHEDULED","TOP_UP","REFUND","OTHER","AUTH_ONLY"],"example":"REGULAR","type":"string"},"activity_CardSchemeV3":{"description":"Represents the card scheme/network that issued the card.","enum":["VISA","MASTERCARD","AMERICAN_EXPRESS","DISCOVER","JCB","UNIONPAY","DINERS_CLUB","MAESTRO","RUPAY","MIR"],"example":"VISA","type":"string"},"activity_CardVerificationResultsV3":{"description":"Represents card verification results including CVV, AVS, and identity checks.","properties":{"avs_check":{"$ref":"#/components/schemas/activity_VerificationCheckV3"},"cvc_check":{"$ref":"#/components/schemas/activity_VerificationCheckV3"},"three_d_secure_check":{"$ref":"#/components/schemas/activity_VerificationCheckV3"}},"type":"object"},"activity_CardWalletTypeV3":{"description":"Defines the type of digital wallet.","enum":["GOOGLE_PAY","APPLE_PAY","PAYPAL","REMOTE_COMMERCE_PROGRAMS","OTHER"],"example":"APPLE_PAY","type":"string"},"activity_CashPickupDetailsV3":{"description":"Represents cash pickup details for remittance transactions.","properties":{"agent_network":{"description":"The agent network facilitating the cash pickup.","example":"Western Union","maxLength":256,"minLength":0,"nullable":true,"type":"string"},"country":{"description":"The country code (ISO 3166-1 alpha-2) where the cash pickup location is located.","example":"US","maxLength":2,"minLength":2,"nullable":true,"pattern":"^[A-Z]{2}$","type":"string"},"location_identifier":{"description":"The location identifier where cash can be picked up.","example":"LOC-987654","maxLength":256,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"activity_ChannelNetworkDetailsV3":{"description":"Contains network-related information for a payment channel.","properties":{"country":{"description":"ISO 2-digit country code (alpha).","example":"GB","format":"iso-3166-alpha-2","maxLength":2,"minLength":2,"nullable":true,"type":"string"},"ip_address":{"$ref":"#/components/schemas/activity_InternetProtocolAddressV3"}},"type":"object"},"activity_ChannelV3":{"description":"Represents the channel that initiated the transaction.","discriminator":{"propertyName":"type"},"properties":{"network_details":{"$ref":"#/components/schemas/activity_ChannelNetworkDetailsV3"},"type":{"description":"Channel discriminator.","enum":["DEVICE","ATM"],"type":"string"}},"required":["network_details","type"],"type":"object"},"activity_ChargebackInfoV3":{"description":"Chargeback information.","properties":{"description":{"description":"Chargeback description.","maxLength":255,"minLength":0,"nullable":true,"type":"string"},"outcome":{"description":"Represents the outcome of a chargeback dispute.","enum":["UNDEFENDED","PENDING","WON","LOST","WITHDRAW"],"nullable":true,"type":"string"},"reason":{"description":"Chargeback reason classification.","maxLength":50,"minLength":0,"nullable":true,"type":"string"},"timestamp":{"description":"Chargeback initiation timestamp.","format":"date-time","type":"string"},"value":{"$ref":"#/components/schemas/activity_MonetaryValueV3"}},"required":["timestamp","value"],"type":"object"},"activity_ClearingIdentifierV3":{"description":"ClearingIdentifier pairs a routing system with its specific value.","properties":{"type":{"description":"ClearingIdentifierType specifies the regional system used to route payments to a specific financial institution. These align with ISO 20022 External Clearing System Identification Codes.","enum":["UK_SORT_CODE","US_ABA_ROUTING","IN_IFSC","AU_BSB","CA_TRANSIT","DE_BLZ","HK_BANK_CODE","SG_BANK_CODE","NZ_BANK_CODE","ZA_CLEARING_CODE","CH_SIC","JP_ZENGIN","OTHER"],"type":"string"},"value":{"description":"The raw string value of the code. For monitoring, this should be stored as-is without formatting/dashes.","example":"123456","type":"string"}},"required":["type","value"],"type":"object"},"activity_CounterpartyPartyIdentifierV3":{"allOf":[{"$ref":"#/components/schemas/activity_PartyIdentifierV3"},{"properties":{"bank_account":{"$ref":"#/components/schemas/activity_BankAccountV3"},"external_identifier":{"description":"Your unique identifier for Counterparty to which this Party is linked.","example":"MyCounterpartyIdentifier","maxLength":512,"minLength":0,"type":"string"}},"type":"object"}],"description":"Represents the identification details of a counterparty.","required":["type"],"title":"Counterparty Party Identifier","type":"object"},"activity_CreateCustomFieldRequest":{"properties":{"data_type":{"$ref":"#/components/schemas/activity_CustomFieldDataTypeV3"},"description":{"maxLength":1000,"minLength":0,"type":"string"},"display_name":{"maxLength":50,"minLength":0,"type":"string"},"key":{"maxLength":50,"minLength":0,"pattern":"^[a-z0-9_]+$","type":"string"}},"required":["data_type","description","display_name","key"],"type":"object"},"activity_CryptoAssetV3":{"description":"The asset that was transacted.","properties":{"identifier":{"$ref":"#/components/schemas/activity_Caip19IdentifierV3"},"symbol":{"description":"Human friendly short symbol.","example":"BTC","nullable":true,"type":"string"}},"required":["identifier"],"type":"object"},"activity_CryptoMonetaryTransactionTypeDetailsV3":{"allOf":[{"$ref":"#/components/schemas/activity_MonetaryTransactionTypeDetailsV3"},{"properties":{"agents":{"description":"List of agents associated with a crypto transaction.","items":{"$ref":"#/components/schemas/activity_AgentV3"},"type":"array"},"asset":{"$ref":"#/components/schemas/activity_CryptoAssetV3"},"chain":{"$ref":"#/components/schemas/activity_BlockchainV3"},"creditor":{"$ref":"#/components/schemas/activity_CryptoPartyV3"},"debtor":{"$ref":"#/components/schemas/activity_CryptoPartyV3"},"destination_tag":{"description":"Destination tag/memo identifying recipient.","type":"string"},"transaction_hash":{"description":"Transaction blockchain hash ID.","type":"string"}},"type":"object"}],"description":"Crypto-specific transaction details.","required":["agents","asset","chain","creditor","debtor","transaction_hash","type"],"title":"Crypto Details","type":"object"},"activity_CryptoPartyV3":{"description":"Crypto specific Party data structure. Could be counterparty or customer. Follows the model of PartyIdentification type but with additional information.","properties":{"identification":{"$ref":"#/components/schemas/activity_PartyIdentificationV3"},"wallet":{"$ref":"#/components/schemas/activity_CryptoWalletV3"}},"required":["identification","wallet"],"type":"object"},"activity_CryptoWalletV3":{"description":"Represents a cryptocurrency wallet involved in a transaction.","properties":{"chain":{"$ref":"#/components/schemas/activity_BlockchainV3"},"managing_exchange":{"description":"The human readable friendly name of the exchange that the wallet resides on, if applicable.","nullable":true,"type":"string"},"wallet_identifier":{"description":"The crypto wallet identifier. Typically the address of the wallet. (public key)","type":"string"}},"required":["chain","wallet_identifier"],"type":"object"},"activity_CustomField":{"properties":{"data_type":{"$ref":"#/components/schemas/activity_CustomFieldDataTypeV3"},"description":{"type":"string"},"display_name":{"type":"string"},"identifier":{"format":"uuid","type":"string"},"key":{"type":"string"}},"required":["data_type","description","display_name","identifier","key"],"type":"object"},"activity_CustomFieldDataTypeV3":{"description":"The type of data stored in a custom field.","enum":["TEXT","DECIMAL"],"type":"string"},"activity_CustomFieldV3":{"description":"A representation of a custom field.","properties":{"key":{"description":"The key of the custom field.","example":"field_key","type":"string"},"value":{"discriminator":{"mapping":{"DECIMAL":"#/components/schemas/activity_DecimalValueV3","TEXT":"#/components/schemas/activity_TextValueV3"},"propertyName":"data_type"},"oneOf":[{"$ref":"#/components/schemas/activity_DecimalValueV3"},{"$ref":"#/components/schemas/activity_TextValueV3"}]}},"required":["key","value"],"type":"object"},"activity_CustomFieldValueV3":{"description":"The value of the custom field.","discriminator":{"propertyName":"data_type"},"properties":{"data_type":{"$ref":"#/components/schemas/activity_CustomFieldDataTypeV3"}},"required":["data_type"],"type":"object"},"activity_CustomerPartyIdentifierV3":{"allOf":[{"$ref":"#/components/schemas/activity_PartyIdentifierV3"},{"properties":{"external_identifier":{"description":"Your unique identifier for Customer to which this Party is linked.","example":"MyCustomerIdentifier","maxLength":512,"minLength":0,"type":"string","writeOnly":true},"identifier":{"description":"Our unique identifier for Customer to which this Party is linked. We will populate this after mapping your customer identifier to ours as we process your Transaction.","example":"0195fb35-4793-7bb5-8042-e4371640d176","format":"uuid","readOnly":true,"type":"string"}},"type":"object"}],"description":"Represents the identification details of a customer party.","required":["type"],"title":"Customer Party Identifier","type":"object"},"activity_DecimalEnrichmentValueV3":{"allOf":[{"$ref":"#/components/schemas/activity_EnrichmentValueV3"},{"properties":{"decimal":{"description":"The decimal value","example":98.33,"type":"number"}},"type":"object"}],"description":"Decimal representation of the enrichment value.","required":["data_type","decimal"],"title":"Decimal Value","type":"object"},"activity_DecimalValueV3":{"allOf":[{"$ref":"#/components/schemas/activity_CustomFieldValueV3"},{"properties":{"decimal":{"description":"The decimal value","example":10.02,"type":"number"}},"type":"object"}],"description":"Decimal representation of the custom field value.","required":["data_type","decimal"],"title":"Decimal Value","type":"object"},"activity_DeviceChannelV3":{"allOf":[{"$ref":"#/components/schemas/activity_ChannelV3"},{"properties":{"fingerprint":{"description":"Device fingerprint.","type":"string"},"phone_number":{"description":"Client phone number used in the transaction.","type":"string"}},"type":"object"}],"description":"Represents the device channel used to initiate a transaction.","required":["fingerprint","network_details","type"],"title":"Device","type":"object"},"activity_EnrichmentDataTypeV3":{"description":"The type of data stored in an enrichment value.","enum":["TEXT","DECIMAL","BOOLEAN"],"type":"string"},"activity_EnrichmentTypeV3":{"description":"The type of enrichment source.","enum":["LOOKUP_LIST"],"example":"LOOKUP_LIST","type":"string"},"activity_EnrichmentV3":{"description":"A representation of a transaction enrichment.","properties":{"key":{"description":"The key of the enrichment.","example":"debtors_country_risk","type":"string"},"type":{"$ref":"#/components/schemas/activity_EnrichmentTypeV3"},"value":{"discriminator":{"mapping":{"BOOLEAN":"#/components/schemas/activity_BooleanEnrichmentValueV3","DECIMAL":"#/components/schemas/activity_DecimalEnrichmentValueV3","TEXT":"#/components/schemas/activity_TextEnrichmentValueV3"},"propertyName":"data_type"},"oneOf":[{"$ref":"#/components/schemas/activity_BooleanEnrichmentValueV3"},{"$ref":"#/components/schemas/activity_DecimalEnrichmentValueV3"},{"$ref":"#/components/schemas/activity_TextEnrichmentValueV3"}]}},"readOnly":true,"required":["key","type","value"],"type":"object"},"activity_EnrichmentValueV3":{"description":"The value of the enrichment.","discriminator":{"propertyName":"data_type"},"properties":{"data_type":{"$ref":"#/components/schemas/activity_EnrichmentDataTypeV3"}},"required":["data_type"],"type":"object"},"activity_FincenCashTransactionSubtype":{"description":"Defines the subtype of FinCEN transactions.","enum":["DEPOSIT","PAYMENT","CURRENCY_TRANSFER_OUT","NEGOTIABLE_INSTRUMENT_PURCHASE","CURRENCY_EXCHANGE","CURRENCY_TO_PREPAID_ACCESS","GAMING_INSTRUMENT_PURCHASE","CURRENCY_WAGER","BILLS_INSERTED_INTO_GAMING_DEVICES","WITHDRAWAL","ADVANCE_ON_CREDIT","CURRENCY_TRANSFER_IN","NEGOTIABLE_INSTRUMENT_CASHED","CURRENCY_FROM_PREPAID_ACCESS","GAMING_INSTRUMENT_REDEMPTION","PAYMENT_ON_WAGER","TRAVEL_COMPLIMENTARY_EXPENSES","PROMOTION_PAYMENT","OTHER"],"example":"PAYMENT","nullable":true,"type":"string"},"activity_FincenDetailsV3":{"description":"FinCEN transaction details.","properties":{"fincen_cash_transaction_subtype":{"$ref":"#/components/schemas/activity_FincenCashTransactionSubtype"},"gto_type_codes":{"description":"List of GTO type codes associated with the transaction.","example":["MSB0326GTO"],"items":{"description":"List of GTO type codes associated with the transaction.","example":"[\"MSB0326GTO\"]","type":"string"},"nullable":true,"type":"array"}},"type":"object"},"activity_GeographicCoordinatesV3":{"description":"Geographic location represented by the latitude and longitude.","properties":{"latitude":{"description":"The angular distance north or south of the Earth's equator, measured in degrees. Valid range: -90 to +90, where negative values represent southern latitudes and positive values represent northern latitudes.","example":-34.603722,"maximum":90,"minimum":-90,"type":"number"},"longitude":{"description":"The angular distance east or west of the prime meridian, measured in degrees. Valid range: -180 to +180, where negative values represent western longitudes and positive values represent eastern longitudes.","example":148.516389,"maximum":180,"minimum":-180,"type":"number"}},"required":["latitude","longitude"],"type":"object"},"activity_InternetProtocolAddressV3":{"description":"Represents an Internet Protocol (IP) address with its associated type information.","properties":{"address":{"description":"The IP address in the native format.","example":"192.168.1.1","pattern":"((^\\s*((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))\\s*$)|(^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*$))","type":"string"},"type":{"$ref":"#/components/schemas/activity_InternetProtocolInformationV3"}},"required":["address","type"],"type":"object"},"activity_InternetProtocolInformationV3":{"description":"Enumeration for available IP format values.","enum":["IPV4","IPV6"],"type":"string"},"activity_IssuerV3":{"description":"Represents the card issuer information.","properties":{"bank_identification_number":{"description":"Bank Identification Number (first 6-8 digits of card).","example":"424242","nullable":true,"pattern":"^[0-9]{6,8}$","type":"string"},"details":{"$ref":"#/components/schemas/activity_PartyIdentificationV3"}},"type":"object"},"activity_LoanProductV3":{"allOf":[{"$ref":"#/components/schemas/activity_ProductV3"},{"properties":{"base_loan_value":{"$ref":"#/components/schemas/activity_MonetaryValueV3"},"base_remaining_balance_value":{"$ref":"#/components/schemas/activity_MonetaryValueV3"},"expected_installment_count":{"description":"The expected number of loan installments to be made.","example":12,"format":"int32","type":"integer"},"expected_repayment_date":{"description":"The expected repayment date of the loan.","example":"2025-04-03T00:00:00.000Z","format":"date","type":"string"},"funded_at":{"description":"The timestamp the loan was funded.","example":"2025-04-03T11:32:00.000Z","format":"date-time","type":"string"},"loan_type":{"$ref":"#/components/schemas/activity_LoanTypeV3"},"loan_value":{"$ref":"#/components/schemas/activity_MonetaryValueV3"},"remaining_balance_value":{"$ref":"#/components/schemas/activity_MonetaryValueV3"},"settled_at":{"description":"The timestamp the loan was settled.","example":"2025-04-03T11:32:00.000Z","format":"date-time","type":"string"}},"type":"object"}],"description":"Represents a loan product.","required":["base_loan_value","base_remaining_balance_value","loan_type","type"],"title":"Loan","type":"object"},"activity_LoanTypeV3":{"description":"Defines the type of loan.","enum":["CREDIT_CARD","DEBT_CONSOLIDATION","HOME_EQUITY","GUARANTOR_LOAN","OVERDRAFT","BUY_NOW_PAY_LATER","TERM_LOAN","WORKING_CAPITAL_FINANCE","COMMERCIAL_MORTGAGE","ASSET_FINANCE","INVOICE_FINANCE","SYNDICATED_LOAN","SMALL_BUSINESS_LOAN","BRIDGING_LOAN","MICROFINANCE","CRYPTO_COLLATERALIZED_LOAN","HOME_EQUITY_LOAN","STUDENT_LOAN","DEBT_CONSOLIDATION_LOAN","CREDIT_BUILDER_LOAN","MORTGAGE","PERSONAL","PAYDAY","VEHICLE","OTHER"],"example":"BRIDGING_LOAN","type":"string"},"activity_LocalAccountDetailsV3":{"description":"Represents banking information for 'domestic rail' transactions where a global standard like IBAN is not used.","properties":{"account_number":{"description":"The primary account number (BAN).","type":"string"},"account_number_suffix":{"description":"Regional extension for specific markets. In the NZ, this is the 2-3 digit suffix distinguishing sub-accounts. In the UK, this could contain a building society roll number.","nullable":true,"type":"string"},"clearing_identifier":{"$ref":"#/components/schemas/activity_ClearingIdentifierV3"}},"required":["account_number","clearing_identifier"],"type":"object"},"activity_MerchantV3":{"description":"Represents merchant information.","properties":{"category_type":{"description":"Represents the category types for Merchant Category Codes based on industry code ranges.","enum":["AGRICULTURAL_SERVICES","CONTRACTED_SERVICES","TRANSPORTATION_SERVICES","UTILITY_SERVICES","RETAIL_OUTLET_SERVICES","CLOTHING_SHOPS","MISCELLANEOUS_SHOPS","BUSINESS_SERVICES","PROFESSIONAL_SERVICES","GOVERNMENT_SERVICES"],"example":"RETAIL_OUTLET_SERVICES","nullable":true,"type":"string"},"details":{"$ref":"#/components/schemas/activity_PartyIdentificationV3"},"mcc_category_code":{"description":"4-digit Merchant Category Code.","example":"5411","nullable":true,"pattern":"^[0-9]{4}$","type":"string"},"mcc_code_description":{"description":"Human-readable MCC description.","example":"Grocery Stores, Supermarkets","maxLength":200,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"activity_MonetaryTransactionClassificationDetailsV3":{"allOf":[{"$ref":"#/components/schemas/activity_TransactionClassificationDetailsV3"},{"properties":{"base_value":{"$ref":"#/components/schemas/activity_MonetaryValueV3"},"customer_account_balance":{"$ref":"#/components/schemas/activity_AccountBalanceV3"},"details":{"discriminator":{"mapping":{"BANK_PAYMENT":"#/components/schemas/activity_BankPaymentMonetaryTransactionTypeDetailsV3","CARD_PAYMENT":"#/components/schemas/activity_CardPaymentMonetaryTransactionTypeDetailsV3","CRYPTO":"#/components/schemas/activity_CryptoMonetaryTransactionTypeDetailsV3","REMITTANCE":"#/components/schemas/activity_RemittanceMonetaryTransactionTypeDetailsV3"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/activity_BankPaymentMonetaryTransactionTypeDetailsV3"},{"$ref":"#/components/schemas/activity_CardPaymentMonetaryTransactionTypeDetailsV3"},{"$ref":"#/components/schemas/activity_CryptoMonetaryTransactionTypeDetailsV3"},{"$ref":"#/components/schemas/activity_RemittanceMonetaryTransactionTypeDetailsV3"}]},"direction":{"$ref":"#/components/schemas/activity_MonetaryTransactionDirectionV3"},"local_value":{"$ref":"#/components/schemas/activity_MonetaryValueV3"},"payment_channel":{"$ref":"#/components/schemas/activity_PaymentChannelV3"},"product_name":{"description":"The freeform name of the product being used to perform the financial transaction.","example":"Pro
# --- truncated at 32 KB (807 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/complyadvantage/refs/heads/main/openapi/complyadvantage-mesh-api-openapi.json