{"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"},"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"}},"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":"The address of the party.","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"],"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"}},"required":["role"],"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_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"],"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_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"],"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"],"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_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_CounterpartyPartyIdentifierV3":{"allOf":[{"$ref":"#/components/schemas/activity_PartyIdentifierV3"},{"properties":{"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"],"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"],"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"],"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"],"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","type":"string"},"activity_FincenDetailsV3":{"description":"FinCEN transaction details.","properties":{"fincen_cash_transaction_subtype":{"$ref":"#/components/schemas/activity_FincenCashTransactionSubtype"}},"required":["fincen_cash_transaction_subtype"],"type":"object"},"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_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","REMITTANCE":"#/components/schemas/activity_RemittanceMonetaryTransactionTypeDetailsV3"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/activity_BankPaymentMonetaryTransactionTypeDetailsV3"},{"$ref":"#/components/schemas/activity_CardPaymentMonetaryTransactionTypeDetailsV3"},{"$ref":"#/components/schemas/activity_RemittanceMonetaryTransactionTypeDetailsV3"}]},"direction":{"$ref":"#/components/schemas/activity_MonetaryTransactionDirectionV3"},"payment_channel":{"$ref":"#/components/schemas/activity_PaymentChannelV3"},"product_name":{"description":"The freeform name of the product being used to perform the financial transaction.","example":"Product X, Issue 1","maxLength":256,"minLength":0,"type":"string"},"reference_text":{"description":"The reference text supplied as part of the financial transaction (if any).","example":"Invoice 1234","maxLength":512,"minLength":0,"type":"string"},"value":{"$ref":"#/components/schemas/activity_MonetaryValueV3"}},"type":"object"}],"description":"Details related to a monetary transaction.","required":["base_value","classification","details"],"type":"object"},"activity_MonetaryTransactionDirectionV3":{"description":"Defines the direction of the flow of value in the transaction in relation to the primary Customer in a Monetary Transaction.","enum":["OUTBOUND","INBOUND"],"readOnly":true,"type":"string"},"activity_MonetaryTransactionTypeDetailsV3":{"description":"Details specific to the a Monetary Transaction.","discriminator":{"propertyName":"type"},"properties":{"type":{"$ref":"#/components/schemas/activity_MonetaryTransactionTypeV3"}},"required":["type"],"type":"object"},"activity_MonetaryTransactionTypeV3":{"description":"Defines the type of a monetary transaction.","enum":["BANK_PAYMENT","CARD_PAYMENT","REMITTANCE"],"example":"BANK_PAYMENT","type":"string"},"activity_MonetaryValueV3":{"description":"Represents a combination of a decimal amount with a currency.","properties":{"amount":{"description":"The decimal amount/value.","example":10.02,"type":"number"},"currency":{"description":"3 letter currency code as defined by ISO-4217.","example":"EUR","format":"iso-4217","maxLength":3,"minLength":3,"type":"string"}},"required":["amount","currency"],"type":"object"},"activity_MoneyTransferOperatorV3":{"description":"Represents a money transfer operator's details.","properties":{"identifier":{"description":"A unique identifier for the money transfer operator, such as a SWIFT BIC or regulatory identifier.","example":"WUIBUS6S","maxLength":256,"minLength":0,"nullable":true,"type":"string"},"name":{"description":"The legal name of the money transfer operator.","example":"Western Union","maxLength":256,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"activity_OnlineRemittancePlatformV3":{"description":"Represents an online remittance platform's details.","properties":{"identifier":{"description":"A unique identifier for the online remittance platform.","example":"remittance-identifier","maxLength":256,"minLength":0,"nullable":true,"type":"string"},"name":{"description":"The brand or platform name of the online remittance service.","example":"Wise","maxLength":256,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"activity_PartyIdentificationV3":{"description":"Represents the identification details of a party. This includes not just the party's identifier, but also any other identifying information specific to the transaction such as alternate names or addresses.","properties":{"address":{"discriminator":{"mapping":{"STRUCTURED":"#/components/schemas/activity_StructuredAddressV3","UNSTRUCTURED":"#/components/schemas/activity_UnstructuredAddressV3"},"propertyName":"format"},"nullable":true,"oneOf":[{"$ref":"#/components/schemas/activity_StructuredAddressV3"},{"$ref":"#/components/schemas/activity_UnstructuredAddressV3"}]},"identifier":{"discriminator":{"mapping":{"COUNTERPARTY":"#/components/schemas/activity_CounterpartyPartyIdentifierV3","CUSTOMER":"#/components/schemas/activity_CustomerPartyIdentifierV3"},"propertyName":"type"},"nullable":true,"oneOf":[{"$ref":"#/components/schemas/activity_CounterpartyPartyIdentifierV3"},{"$ref":"#/components/schemas/activity_CustomerPartyIdentifierV3"}]},"name":{"description":"The name of the party.","example":"John Doe","maxLength":256,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"activity_PartyIdentifierV3":{"description":"Party identifier details","discriminator":{"propertyName":"type"},"properties":{"type":{"description":"The type of party identifier.","enum":["CUSTOMER","COUNTERPARTY"],"example":"CUSTOMER","type":"string"}},"required":["type"],"type":"object"},"activity_PaymentCardV3":{"description":"Details about a payment card used in a transaction.","properties":{"fingerprint":{"description":"Unique hashed card identifier for tracking.","example":"card_fingerprint_123456","maxLength":100,"minLength":0,"type":"string"},"funding_type":{"$ref":"#/components/schemas/activity_CardFundingTypeV3"},"wallet_identifier":{"description":"Digital wallet identifier if applicable.","example":"wallet_12345678","maxLength":50,"minLength":0,"nullable":true,"type":"string"},"wallet_type":{"$ref":"#/components/schemas/activity_CardWalletTypeV3"}},"required":["fingerprint"],"type":"object"},"activity_PaymentChannelV3":{"description":"The channel used for a payment.","enum":["OTHER","MOBILE","WEB","BRANCH","TELEPHONE","ATM"],"example":"MOBILE","type":"string"},"activity_PaymentSchemeV3":{"description":"The payment scheme that was used to initiate the financial transaction.","enum":["OTHER","SWIFT","SEPA","SEPA_INSTANT","FASTER_PAYMENTS","CHAPS","BACS","FEDNOW"],"example":"SWIFT","type":"string"},"activity_PaymentStagesInfoV3":{"description":"Payment stages information.","properties":{"authorization":{"$ref":"#/components/schemas/activity_AuthorizationInfoV3"},"chargeback":{"$ref":"#/components/schemas/activity_ChargebackInfoV3"},"refund":{"$ref":"#/components/schemas/activity_RefundInfoV3"},"reversal":{"$ref":"#/components/schemas/activity_ReversalInfoV3"},"settlement":{"$ref":"#/components/schemas/activity_SettlementInfoV3"}},"type":"object"},"activity_PointOfSaleConditionCodeV3":{"description":"Point of sale condition code and description","properties":{"code":{"description":"2-digit POS condition code","example":"59","nullable":true,"pattern":"^[0-9]{2}$","type":"string"},"description":{"description":"Human-readable POS condition description","example":"E-commerce transaction - card not present","maxLength":200,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"activity_PointOfSaleConditionV3":{"description":"Contains contextual information about the card payment environment.","properties":{"condition":{"$ref":"#/components/schemas/activity_PointOfSaleConditionCodeV3"},"entry_mode":{"$ref":"#/components/schemas/activity_PointOfSaleEntryModeV3"}},"type":"object"},"activity_PointOfSaleEntryModeV3":{"description":"Point of sale entry mode code and description","properties":{"code":{"description":"3-digit POS entry mode code","example":"012","nullable":true,"pattern":"^[0-9]{3}$","type":"string"},"description":{"description":"Human-readable POS entry mode description","example":"E-commerce transaction","maxLength":200,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"activity_ProblemDetailErrorResponse":{"additionalProperties":true,"properties":{"detail":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","type":"string"},"instance":{"format":"uri","nullable":true,"type":"string"},"status":{"format":"int32","nullable":true,"type":"integer"},"timestamp":{"format":"date-time","type":"string"},"title":{"nullable":true,"type":"string"},"type":{"format":"uri","nullable":true,"type":"string"}},"required":["identifier","timestamp"],"type":"object"},"activity_RefundInfoV3":{"description":"Refund information.","properties":{"reason":{"$ref":"#/components/schemas/activity_RefundReasonV3"},"timestamp":{"description":"Refund timestamp.","format":"date-time","type":"string"}},"required":["timestamp"],"type":"object"},"activity_RefundReasonV3":{"description":"Refund reason information.","properties":{"code":{"description":"Reason code for refund.","maxLength":50,"minLength":0,"nullable":true,"type":"string"},"description":{"description":"Reason description.","maxLength":200,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"activity_RegulatoryReportDetailsV3":{"description":"Regulatory reporting transaction details.","properties":{"fincen_details":{"$ref":"#/components/schemas/activity_FincenDetailsV3"}},"type":"object"},"activity_RemittanceCreditorV3":{"description":"Represents the creditor in a remittance transaction.","properties":{"cash_pickup":{"$ref":"#/components/schemas/activity_CashPickupDetailsV3"},"details":{"$ref":"#/components/schemas/activity_PartyIdentificationV3"}},"required":["details"],"type":"object"},"activity_RemittanceMonetaryTransactionTypeDetailsV3":{"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"},"collection_method":{"$ref":"#/components/schemas/activity_RemittancePaymentMethodV3"},"creditor":{"$ref":"#/components/schemas/activity_RemittanceCreditorV3"},"debtor":{"$ref":"#/components/schemas/activity_PartyIdentificationV3"},"payment_scheme":{"$ref":"#/components/schemas/activity_PaymentSchemeV3"},"purpose_of_payment":{"$ref":"#/components/schemas/activity_RemittancePurposeV3"},"relationship":{"$ref":"#/components/schemas/activity_RemittanceRelationshipV3"},"service_provider":{"$ref":"#/components/schemas/activity_RemittanceServiceProviderV3"},"source_of_funds":{"$ref":"#/components/schemas/activity_RemittanceSourceOfFundsV3"},"source_payment_method":{"$ref":"#/components/schemas/activity_RemittancePaymentMethodV3"},"ultimate_creditor":{"$ref":"#/components/schemas/activity_PartyIdentificationV3"},"ultimate_debtor":{"$ref":"#/components/schemas/activity_PartyIdentificationV3"}},"type":"object"}],"description":"Models a cross-border remittance payment transaction between parties in different countries.","required":["creditor","debtor","type"],"type":"object"},"activity_RemittancePaymentMethodV3":{"description":"The payment method used for remittance transactions.","enum":["CASH","CREDIT_CARD","DEBIT_CARD","BANK_TRANSFER","MOBILE_WALLET","PREPAID_CARD","CHEQUE","CRYPTOCURRENCY","GIFT_CARD","POSTAL_ORDER","BARTER","OTHER"],"example":"CASH","type":"string"},"activity_RemittancePurposeV3":{"description":"The purpose of the remittance payment.","enum":["FAMILY_SUPPORT","EDUCATION","MEDICAL","BUSINESS","PROPERTY","EMERGENCY","SAVINGS","GIFT","TRAVEL","DEBT_REPAYMENT","PURCHASE","SALARY","RENT","OTHER"],"type":"string"},"activity_RemittanceRelationshipV3":{"description":"The relationship between the sender and receiver in a remittance transaction.","enum":["SPOUSE","FAMILY","FRIEND","BUSINESS_PARTNER","EMPLOYEE","OTHER"],"type":"string"},"activity_RemittanceServiceProviderTypeV3":{"description":"The type of service provider facilitating the remittance transaction.","enum":["TRADITIONAL_BANK","MONEY_TRANSFER_OPERATOR","DIGITAL_PLATFORM","ONLINE_PAYMENT_SERVICE","MOBILE_MONEY_SERVICE","CRYPTOCURRENCY_PLATFORM","NEOBANK","OTHER"],"example":"MONEY_TRANSFER_OPERATOR","type":"string"},"activity_RemittanceServiceProviderV3":{"description":"Represents a remittance service provider's details.","properties":{"identifier":{"description":"The unique identifier for the remittance service provider.","example":"RSP-12345","maxLength":256,"minLength":0,"nullable":true,"type":"string"},"name":{"description":"The name of the remittance service provider.","example":"Western Union","maxLength":256,"minLength":0,"nullable":true,"type":"string"},"type":{"$ref":"#/components/schemas/activity_RemittanceServiceProviderTypeV3"}},"type":"object"},"activity_RemittanceSourceOfFundsV3":{"description":"The source of funds for the remittance transaction.","enum":["SALARY","BUSINESS_INCOME","SAVINGS","INVESTMENTS","PENSION","LOAN","GIFT","INHERITANCE","ASSET_SALE","INSURANCE_PAYOUT","GOVERNMENT_BENEFITS","TRUST_DISTRIBUTION","CRYPTO_LIQUIDATION","CROWDFUNDING","GAMBLING_WINNINGS","OTHER"],"type":"string"},"activity_ReversalInfoV3":{"description":"Reversal information.","properties":{"identifier":{"description":"Unique reversal identifier.","maxLength":50,"minLength":0,"nullable":true,"type":"string"},"timestamp":{"description":"Reversal timestamp.","format":"date-time","type":"string"},"value":{"$ref":"#/components/schemas/activity_MonetaryValueV3"}},"required":["timestamp","value"],"type":"object"},"activity_ReviewDecisionRequestBody":{"properties":{"review_decision":{"description":"Represents the states of review decision","enum":["RELEASE","REJECT"],"example":"RELEASE","type":"string"}},"required":["review_decision"],"type":"object"},"activity_ReviewDecisionResponse":{"properties":{"account_identifier":{"description":"Our unique identifier for customer that the Transaction is associated with. 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"},"created_at":{"description":"The timestamp of the decision.","example":"2025-04-03T03:32:00.000Z","format":"date-time","type":"string"},"created_by":{"description":"The user who made the decision.","example":"0195fb35-4793-7bb5-8042-e4371640d176","format":"uuid","readOnly":true,"type":"string"},"review_decision":{"description":"Represents the states of review decision","enum":["RELEASE","REJECT"],"example":"RELEASE","type":"string"},"transaction_identifier":{"description":"Our unique identifier for your Transaction. We generate this when we process your Transaction and you are not able to specify it.","format":"uuid","nullable":true,"readOnly":true,"type":"string"}},"required":["account_identifier","created_at","created_by","review_decision"],"type":"object"},"activity_SettlementInfoV3":{"description":"Settlement information.","properties":{"timestamp":{"description":"Settlement timestamp.","example":"2024-01-16T08:15:00.000Z","format":"date-time","type":"string"},"value":{"$ref":"#/components/schemas/activity_MonetaryValueV3"}},"required":["timestamp","value"],"type":"object"},"activity_StructuredAddressV3":{"allOf":[{"$ref":"#/components/schemas/activity_AddressV3"},{"properties":{"address_line1":{"description":"The first line of the address.","example":"123 Main St","maxLength":256,"minLength":0,"type":"string"},"address_line2":{"description":"The second line of the address.","example":"Apt 4B","maxLength":256,"minLength":0,"type":"string"},"address_type":{"$ref":"#/components/schemas/activity_AddressTypeV3"},"country":{"description":"2 letter country code as defined by iso-3166-alpha-2.","example":"GB","format":"iso-3166-alpha-2","maxLength":2,"minLength":2,"type":"string"},"country_subdivision":{"description":"The country subdivision (e.g., state, province).","example":"Greater London","maxLength":256,"minLength":0,"type":"string"},"postal_code":{"description":"The postal code of the address.","example":"SW1A 0AA","maxLength":256,"minLength":0,"type":"string"},"town_name":{"description":"The town or city name.","example":"London","maxLength":256,"minLength":0,"type":"string"}},"type":"object"}],"description":"Represents a structured address with detailed components.","required":["format"],"type":"object"},"activity_TextEnrichmentValueV3":{"allOf":[{"$ref":"#/components/schemas/activity_EnrichmentValueV3"},{"properties":{"text":{"description":"The text content.","example":"HIGH","maxLength":256,"minLength":0,"type":"string"}},"type":"object"}],"description":"String representation of the enrichment value.","required":["data_type","text"],"type":"object"},"activity_TextValueV3":{"allOf":[{"$ref":"#/components/schemas/activity_CustomFieldValueV3"},{"properties":{"text":{"description":"The text content.","example":"Text Field Value","maxLength":256,"minLength":0,"type":"string"}},"type":"object"}],"description":"String representation of the custom field value.","required":["data_type","text"],"type":"object"},"activity_TransactionClassificationDetailsV3":{"description":"Details specific to the Transaction classification.","discriminator":{"propertyName":"classification"},"properties":{"classification":{"$ref":"#/components/schemas/activity_TransactionClassificationV3"}},"required":["classification"],"type":"object"},"activity_TransactionClassificationV3":{"description":"Classifies a transaction as a specific high-level class of transaction.","enum":["MONETARY"],"example":"MONETARY","type":"string"},"activity_TransactionRiskTypesRequestBody":{"description":"Request body for setting transaction risk types.","properties":{"risk_types":{"description":"List of risk types for the transaction.","example":["r_fraud"],"items":{"description":"Allowed transaction risk types.","enum":["r_fraud"],"example":"r_fraud","type":"string"},"type":"array"}},"required":["risk_types"],"type":"object"},"activity_TransactionV3":{"description":"Represents a Transaction performed by a Customer. A Transaction can be either monetary or non-monetary.","properties":{"custom_fields":{"description":"A list of custom fields attached to the Transaction.","items":{"$ref":"#/components/schemas/activity_CustomFieldV3"},"maxItems":10,"minItems":0,"nullable":true,"type":"array"},"customer_external_identifier":{"description":"Your unique identifier for customer that the Transaction is associated with. We will populate this after mapping your customer identifier to ours as we process your Transaction.","example":"MyUniqueCustomerReference","maxLength":512,"minLength":0,"type":"string","writeOnly":true},"customer_identifier":{"description":"Our unique identifier for customer that the Transaction is associated with. 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"},"details":{"discriminator":{"mapping":{"MONETARY":"#/components/schemas/activity_MonetaryTransactionClassificationDetailsV3"},"propertyName":"classification"},"oneOf":[{"$ref":"#/components/schemas/activity_MonetaryTransactionClassificationDetailsV3"}]},"enrichments":{"description":"A list of enrichments applied to the Transaction.","items":{"$ref":"#/components/schemas/activity_EnrichmentV3"},"nullable":true,"readOnly":true,"type":"array"},"evaluation_outcome":{"description":"The combined outcome of all transaction evaluations.","enum":["PENDING","PROCESS","ALLOW","HOLD","ERROR"],"readOnly":true,"type":"string"},"external_identifier":{"description":"Your unique identifier for the Transaction. You will use this to reference the Transaction within our systems. This cannot be changed after submitting the Transaction.","example":"MyUniqueIdentifier","maxLength":512,"minLength":0,"type":"string"},"identifier":{"description":"Our unique identifier for your Transaction. We generate this when we process your Transaction and you are not able to specify it.","format":"uuid","nullable":true,"readOnly":true,"type":"string"},"occurred_at":{"description":"The timestamp of the Transaction. This is the timestamp you want us to use as this transactions position in time for the purposes of risk analysis. This timestamp can contain offset information.","example":"2025-04-03T03:32:00.000Z","format":"date-time","type":"string"},"received_at":{"description":"The timestamp the Transaction event was received by us.","example":"2025-04-03T11:32:00.000Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"regulatory_reporting_details":{"$ref":"#/components/schemas/activity_RegulatoryReportDetailsV3"},"review_decision":{"description":"Represents the states of review decision","enum":["NOT_APPLICABLE","NOT_REVIEWED","RELEASE","REJECT"],"readOnly":true,"type":"string"}},"required":["customer_external_identifier","customer_identifier","details","evaluation_outcome","external_identifier","occurred_at","review_decision"],"type":"object"},"activity_UnstructuredAddressV3":{"allOf":[{"$ref":"#/components/schemas/activity_AddressV3"},{"properties":{"country":{"description":"An unstructured text representation of a country","example":"Spain","type":"string"},"local_details":{"description":"The local details of the address.","example":"123 Main Street, London","maxLength":512,"minLength":0,"type":"string"}},"type":"object"}],"description":"Represents an unstructured address with local details and country.","required":["format"],"type":"object"},"activity_VerificationCheckResultV3":{"description":"Represents the result of a verification check.","enum":["PASS","FAIL","UNAVAILABLE","UNCHECKED"],"example":"PASS","type":"string"},"activity_VerificationCheckV3":{"description":"Represents a verification check with result and optional description.","properties":{"description":{"description":"Human-readable verification check description.","example":"Address and ZIP code match","maxLength":200,"minLength":0,"nullable":true,"type":"string"},"result":{"$ref":"#/components/schemas/activity_VerificationCheckResultV3"}},"type":"object"},"am_AlertMuteDTO":{"properties":{"created_at":{"format":"date-time","type":"string"},"customer_identifier":{"format":"uuid","type":"string"},"id":{"format":"uuid","type":"string"},"profile_identifier":{"type":"string"},"risk_identifier":{"format":"uuid","nullable":true,"type":"string"}},"required":["created_at","customer_identifier","id","profile_identifier"],"type":"object"},"am_CreateAlertMuteRequest":{"properties":{"customer_identifier":{"format":"uuid","nullable":true,"type":"string"},"profile_identifier":{"type":"string"},"risk_identifier":{"format":"uuid","nullable":true,"type":"string"}},"required":["profile_identifier"],"type":"object"},"am_GetAlertMutesResponse":{"properties":{"alert_mutes":{"items":{"$ref":"#/components/schemas/am_AlertMuteDTO"},"type":"array"},"first":{"type":"string"},"next":{"nullable":true,"type":"string"},"prev":{"nullable":true,"type":"string"},"self":{"type":"string"},"total_count":{"format":"int64","nullable":true,"type":"integer"}},"required":["alert_mutes","first","self"],"type":"object"},"am_ProblemDetailErrorResponse":{"additionalProperties":true,"properties":{"detail":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","type":"string"},"instance":{"format":"uri","nullable":true,"type":"string"},"status":{"format":"int32","nullable":true,"type":"integer"},"timestamp":{"format":"date-time","type":"string"},"title":{"nullable":true,"type":"string"},"type":{"format":"uri","nullable":true,"type":"string"}},"required":["identifier","timestamp"],"type":"object"},"am_RiskStatusUpdatePayload":{"properties":{"decision":{"enum":["NOT_REVIEWED","IN_REVIEW","FALSE_POSITIVE","TRUE_POSITIVE"],"type":"string"}},"required":["decision"],"type":"object"},"am_Scenario":{"properties":{"description":{"type":"string"},"identifier":{"format":"uuid","type":"string"},"name":{"type":"string"},"version":{"format":"int32","type":"integer"}},"required":["description","identifier","name","version"],"type":"object"},"am_Segment":{"properties":{"identifiers":{"items":{"format":"uuid","type":"string"},"type":"array"},"name":{"type":"string"},"outcome":{"enum":["ALLOW","HOLD"],"type":"string"},"priority":{"description":"Priority 1 is the highest while 9 is the lowest","format":"int32","maximum":9,"minimum":1,"type":"integer"}},"required":["identifiers","name","outcome","priority"],"type":"object"},"am_Transaction":{"properties":{"external_identifier":{"type":"string"},"identifier":{"format":"uuid","type":"string"},"type":{"enum":["BANK_PAYMENT"],"type":"string"}},"required":["external_identifier","identifier","type"],"type":"object"},"am_TransactionMonitoringRisk":{"properties":{"created_at":{"format":"date-time","type":"string"},"detail":{"$ref":"#/components/schemas/am_TransactionMonitoringRiskDetail"},"identifier":{"format":"uuid","type":"string"},"type":{"enum":["TRANSACTION_MONITORING"],"type":"string"}},"required":["created_at","detail","identifier","type"],"type":"object"},"am_TransactionMonitoringRiskDetail":{"properties":{"scenario":{"$ref":"#/components/schemas/am_Scenario"},"transaction":{"$ref":"#/components/schemas/am_Transaction"},"triggered_segment":{"$ref":"#/components/schemas/am_Segment"}},"required":["scenario","transaction","triggered_segment"],"type":"object"},"am_TransactionMonitoringRisksResponse":{"properties":{"first":{"description":"The URL path to the first page.","example":"/v1/resource?page_number=1","type":"string"},"next":{"description":"The URL path to the next page.","example":"/v1/resource?page_number=4","nullable":true,"type":"string"},"prev":{"description":"The URL path to the previous page.","example":"/v1/resource?page_number=2","nullable":true,"type":"string"},"risks":{"items":{"$ref":"#/components/schemas/am_TransactionMonitoringRisk"},"type":"array"},"self":{"description":"The URL path to the current page.","example":"/v1/resource?page_number=3","type":"string"},"total_count":{"description":"Total number of items.","example":60,"format":"int64","nullable":true,"type":"integer"}},"required":["first","risks","self"],"type":"object"},"am_TransitionStatePayload":{"properties":{"state":{"enum":["NOT_STARTED","IN_PROGRESS","POSITIVE_END_STATE","NEGATIVE_END_STATE"],"type":"string"}},"required":["state"],"type":"object"},"audit_ActionedBy":{"properties":{"identifier":{"format":"uuid","nullable":true,"type":"string"},"type":{"enum":["SYSTEM","USER"],"type":"string"}},"required":["type"],"type":"object"},"audit_Alert":{"properties":{"identifier":{"format":"uuid","type":"string"}},"required":["identifier"],"type":"object"},"audit_AlertAddedToCaseDetailV2":{"properties":{"alert_identifiers":{"items":{"format":"uuid","type":"string"},"type":"array","uniqueItems":true},"case":{"$ref":"#/components/schemas/audit_Case"}},"required":["alert_identifiers","case"],"type":"object"},"audit_AlertAddedToCaseLogV2":{"properties":{"actioned_by":{"$ref":"#/components/schemas/audit_ActionedBy"},"detail":{"$ref":"#/components/schemas/audit_AlertAddedToCaseDetailV2"},"grouping_key":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","type":"string"},"occurred_at":{"format":"date-time","type":"string"},"type":{"enum":["ALERT_ADDED_TO_CASE"],"type":"string"}},"required":["detail","identifier","occurred_at","type"],"type":"object"},"audit_AlertMuteForRiskDetailV2":{"properties":{"case":{"$ref":"#/components/schemas/audit_Case"},"customer":{"$ref":"#/components/schemas/audit_Customer"},"mute_key":{"type":"string"},"risk":{"$ref":"#/components/schemas/audit_RiskWithSource"}},"required":["customer","mute_key","risk"],"type":"object"},"audit_AlertMutedForRiskLogV2":{"properties":{"actioned_by":{"$ref":"#/components/schemas/audit_ActionedBy"},"detail":{"$ref":"#/components/schemas/audit_AlertMuteForRiskDetailV2"},"grouping_key":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","type":"string"},"occurred_at":{"format":"date-time","type":"string"},"type":{"enum":["ALERT_MUTED_FOR_RISK"],"type":"string"}},"required":["detail","identifier","occurred_at","type"],"type":"object"},"audit_AlertStateUpdatedDetailV2":{"properties":{"alert":{"$ref":"#/components/schemas/audit_Alert"},"previous_state":{"enum":["NOT_STARTED","IN_PROGRESS","POSITIVE_END_STATE","NEGATIVE_END_STATE","UNSPECIFIED"],"nullable":true,"type":"string"},"state":{"enum":["NOT_STARTED","IN_PROGRESS","POSITIVE_END_STATE","NEGATIVE_END_STATE","UNSPECIFIED"],"nullable":true,"type":"string"}},"required":["alert"],"type":"object"},"audit_AlertStateUpdatedLogV2":{"properties":{"actioned_by":{"$ref":"#/components/schemas/audit_ActionedBy"},"detail":{"$ref":"#/components/schemas/audit_AlertStateUpdatedDetailV2"},"grouping_key":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","type":"string"},"occurred_at":{"format":"date-time","type":"string"},"type":{"enum":["ALERT_STATE_UPDATED"],"type":"string"}},"required":["detail","identifier","occurred_at","type"],"type":"object"},"audit_AlertUnmutedForRiskLogV2":{"properties":{"actioned_by":{"$ref":"#/components/schemas/audit_ActionedBy"},"detail":{"$ref":"#/components/schemas/audit_AlertMuteForRiskDetailV2"},"grouping_key":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","type":"string"},"occurred_at":{"format":"date-time","type":"string"},"type":{"enum":["ALERT_UNMUTED_FOR_RISK"],"type":"string"}},"required":["detail","identifier","occurred_at","type"],"type":"object"},"audit_Assignee":{"properties":{"identifier":{"format":"uuid","type":"string"}},"required":["identifier"],"type":"object"},"audit_Case":{"properties":{"identifier":{"example":"018d0dd4-9b7c-7537-aaac-13f2f48877af","format":"uuid","type":"string"}},"required":["identifier"],"type":"object"},"audit_CaseAssignedDetailV2":{"properties":{"assignee":{"$ref":"#/components/schemas/audit_Assignee"},"case":{"$ref":"#/components/schemas/audit_CaseInfoV2"},"customer":{"$ref":"#/components/schemas/audit_CustomerReference"},"previous_assignee":{"$ref":"#/components/schemas/audit_Assignee"}},"required":["case","customer"],"type":"object"},"audit_CaseAssignedLogV2":{"properties":{"actioned_by":{"$ref":"#/components/schemas/audit_ActionedBy"},"detail":{"$ref":"#/components/schemas/audit_CaseAssignedDetailV2"},"grouping_key":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","type":"string"},"occurred_at":{"format":"date-time","type":"string"},"type":{"enum":["CASE_ASSIGNED"],"type":"string"}},"required":["detail","identifier","occurred_at","type"],"type":"object"},"audit_CaseAuditLogsPageV2":{"properties":{"audit_logs":{"items":{"discriminator":{"mapping":{"ALERT_ADDED_TO_CASE":"#/components/schemas/audit_AlertAddedToCaseLogV2","ALERT_STATE_UPDATED":"#/components/schemas/audit_AlertStateUpdatedLogV2","CASE_ASSIGNED":"#/components/schemas/audit_CaseAssignedLogV2","CASE_CREATED":"#/components/schemas/audit_CaseCreatedLogV2","CASE_STAGE_TRANSITIONED":"#/components/schemas/audit_CaseTransitionedLogV2","CUSTOMER_SCREENED":"#/components/schemas/audit_CustomerScreenedLogV2","NOTE_CREATED_TO_CASE_ACTION":"#/components/schemas/audit_NoteCreatedToCaseActionLogV2","NOTE_TO_CASE_OBJECT":"#/components/schemas/audit_NoteToCaseObjectLogV2","NOTE_TO_RISK":"#/components/schemas/audit_NoteToRiskLogV2","RISK_STATUS_UPDATED":"#/components/schemas/audit_RiskSignalTransitionedLogV2"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/audit_CaseCreatedLogV2"},{"$ref":"#/components/schemas/audit_CaseAssignedLogV2"},{"$ref":"#/components/schemas/audit_CaseTransitionedLogV2"},{"$ref":"#/components/schemas/audit_RiskSignalTransitionedLogV2"},{"$ref":"#/components/schemas/audit_CustomerScreenedLogV2"},{"$ref":"#/components/schemas/audit_NoteToCaseObjectLogV2"},{"$ref":"#/components/schemas/audit_NoteCreatedToCaseActionLogV2"},{"$ref":"#/components/schemas/audit_NoteToRiskLogV2"},{"$ref":"#/components/schemas/audit_AlertAddedToCaseLogV2"},{"$ref":"#/components/schemas/audit_AlertStateUpdatedLogV2"}],"type":"object"},"type":"array"},"first":{"description":"The URL path to the first page.","example":"/v1/resource?page_number=1","type":"string"},"next":{"description":"The URL path to the next page.","example":"/v1/resource?page_number=4","nullable":true,"type":"string"},"prev":{"description":"The URL path to the previous page.","example":"/v1/resource?page_number=2","nullable":true,"type":"string"},"self":{"description":"The URL path to the current page.","example":"/v1/resource?page_number=3","type":"string"},"total_count":{"description":"Total number of items.","example":60,"format":"int64","nullable":true,"type":"integer"}},"required":["audit_logs","first","self"],"type":"object"},"audit_CaseCreatedDetailV2":{"properties":{"case":{"$ref":"#/components/schemas/audit_CaseInfoV2"},"customer":{"$ref":"#/components/schemas/audit_CustomerReference"}},"required":["case","customer"],"type":"object"},"audit_CaseCreatedLogV2":{"properties":{"actioned_by":{"$ref":"#/components/schemas/audit_ActionedBy"},"detail":{"$ref":"#/components/schemas/audit_CaseCreatedDetailV2"},"grouping_key":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","type":"string"},"occurred_at":{"format":"date-time","type":"string"},"type":{"enum":["CASE_CREATED"],"type":"string"}},"required":["detail","identifier","occurred_at","type"],"type":"object"},"audit_CaseInfoV2":{"properties":{"identifier":{"format":"uuid","type":"string"},"subject":{"$ref":"#/components/schemas/audit_CaseSubjectInfo"},"type":{"enum":["CUSTOMER_ONBOARDING","CUSTOMER_MONITORING","PAYMENT_SCREENING","TRANSACTION_MONITORING"],"type":"string"}},"required":["identifier","subject","type"],"type":"object"},"audit_CaseSubjectInfo":{"properties":{"identifier":{"type":"string"},"type":{"enum":["CUSTOMER","PAYMENT","COUNTERPARTY"],"type":"string"}},"required":["identifier","type"],"type":"object"},"audit_CaseTransitionedDetailV2":{"properties":{"case":{"$ref":"#/components/schemas/audit_CaseInfoV2"},"customer":{"$ref":"#/components/schemas/audit_CustomerReference"},"previous_stage":{"$ref":"#/components/schemas/audit_Stage"},"stage":{"$ref":"#/components/schemas/audit_Stage"}},"required":["case","customer","previous_stage","stage"],"type":"object"},"audit_CaseTransitionedLogV2":{"properties":{"actioned_by":{"$ref":"#/components/schemas/audit_ActionedBy"},"detail":{"$ref":"#/components/schemas/audit_CaseTransitionedDetailV2"},"grouping_key":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","type":"string"},"occurred_at":{"format":"date-time","type":"string"},"type":{"enum":["CASE_STAGE_TRANSITIONED"],"type":"string"}},"required":["detail","identifier","occurred_at","type"],"type":"object"},"audit_Customer":{"properties":{"identifier":{"format":"uuid","type":"string"}},"required":["identifier"],"type":"object"},"audit_CustomerAuditLogsPageV2":{"properties":{"audit_logs":{"items":{"discriminator":{"mapping":{"ALERT_MUTED_FOR_RISK":"#/components/schemas/audit_AlertMutedForRiskLogV2","ALERT_UNMUTED_FOR_RISK":"#/components/schemas/audit_AlertUnmutedForRiskLogV2","CASE_CREATED":"#/components/schemas/audit_CaseCreatedLogV2","CASE_STAGE_TRANSITIONED":"#/components/schemas/audit_CaseTransitionedLogV2","CUSTOMER_CREATED":"#/components/schemas/audit_CustomerCreatedLogV2","CUSTOMER_INFO_UPDATED":"#/components/schemas/audit_CustomerInfoUpdatedLogV2","CUSTOMER_LABELS_UPDATED":"#/components/schemas/audit_CustomerLabelsUpdatedLogV2","CUSTOMER_MIGRATED":"#/components/schemas/audit_CustomerMigratedLogV2","CUSTOMER_MONITORING_CONFIGURATION_UPDATED":"#/components/schemas/audit_CustomerMonitoringConfigurationUpdatedLogV2","CUSTOMER_PRODUCT_UPDATED":"#/components/schemas/audit_CustomerProductUpdatedLogV2","CUSTOMER_SCREENED":"#/components/schemas/audit_CustomerScreenedLogV2","CUSTOMER_SEGMENTS_UPDATED":"#/components/schemas/audit_CustomerSegmentsUpdatedLogV2","CUSTOMER_STATUS_UPDATED":"#/components/schemas/audit_CustomerStatusUpdatedLogV2","NOTE_CREATED_TO_CUSTOMER":"#/components/schemas/audit_NoteToCustomerLogV2","RISK_SCORE_CALCULATED":"#/components/schemas/audit_RiskScoreAssignedToCustomerLogV2"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/audit_CustomerMigratedLogV2"},{"$ref":"#/components/schemas/audit_CaseCreatedLogV2"},{"$ref":"#/components/schemas/audit_CaseTransitionedLogV2"},{"$ref":"#/components/schemas/audit_RiskScoreAssignedToCustomerLogV2"},{"$ref":"#/components/schemas/audit_CustomerCreatedLogV2"},{"$ref":"#/components/schemas/audit_CustomerInfoUpdatedLogV2"},{"$ref":"#/components/schemas/audit_CustomerStatusUpdatedLogV2"},{"$ref":"#/components/schemas/audit_CustomerProductUpdatedLogV2"},{"$ref":"#/components/schemas/audit_CustomerMonitoringConfigurationUpdatedLogV2"},{"$ref":"#/components/schemas/audit_CustomerLabelsUpdatedLogV2"},{"$ref":"#/components/schemas/audit_CustomerSegmentsUpdatedLogV2"},{"$ref":"#/components/schemas/audit_CustomerScreenedLogV2"},{"$ref":"#/components/schemas/audit_AlertMutedForRiskLogV2"},{"$ref":"#/components/schemas/audit_AlertUnmutedForRiskLogV2"},{"$ref":"#/components/schemas/audit_NoteToCustomerLogV2"}],"type":"object"},"type":"array"},"first":{"description":"The URL path to the first page.","example":"/v1/resource?page_number=1","type":"string"},"next":{"description":"The URL path to the next page.","example":"/v1/resource?page_number=4","nullable":true,"type":"string"},"prev":{"description":"The URL path to the previous page.","example":"/v1/resource?page_number=2","nullable":true,"type":"string"},"self":{"description":"The URL path to the current page.","example":"/v1/resource?page_number=3","type":"string"},"total_count":{"description":"Total number of items.","example":60,"format":"int64","nullable":true,"type":"integer"}},"required":["audit_logs","first","self"],"type":"object"},"audit_CustomerConfigurationUpdatedDetailV2":{"properties":{"customer":{"$ref":"#/components/schemas/audit_CustomerReference"},"monitoring":{"$ref":"#/components/schemas/audit_CustomerMonitoring"},"previous_monitoring":{"$ref":"#/components/schemas/audit_CustomerMonitoring"}},"required":["customer","monitoring","previous_monitoring"],"type":"object"},"audit_CustomerCreatedDetailV2":{"properties":{"customer":{"$ref":"#/components/schemas/audit_CustomerReference"}},"required":["customer"],"type":"object"},"audit_CustomerCreatedLogV2":{"properties":{"actioned_by":{"$ref":"#/components/schemas/audit_ActionedBy"},"detail":{"$ref":"#/components/schemas/audit_CustomerCreatedDetailV2"},"grouping_key":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","type":"string"},"occurred_at":{"format":"date-time","type":"string"},"type":{"enum":["CUSTOMER_CREATED"],"type":"string"}},"required":["detail","identifier","occurred_at","type"],"type":"object"},"audit_CustomerInfoUpdatedDetailV2":{"properties":{"customer":{"$ref":"#/components/schemas/audit_CustomerReference"},"previous_customer":{"$ref":"#/components/schemas/audit_CustomerReference"}},"required":["customer"],"type":"object"},"audit_CustomerInfoUpdatedLogV2":{"properties":{"actioned_by":{"$ref":"#/components/schemas/audit_ActionedBy"},"detail":{"$ref":"#/components/schemas/audit_CustomerInfoUpdatedDetailV2"},"grouping_key":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","type":"string"},"occurred_at":{"format":"date-time","type":"string"},"type":{"enum":["CUSTOMER_INFO_UPDATED"],"type":"string"}},"required":["detail","identifier","occurred_at","type"],"type":"object"},"audit_CustomerLabelsUpdatedDetailV2":{"properties":{"added_label_identifiers":{"items":{"format":"uuid","type":"string"},"type":"array","uniqueItems":true},"customer":{"$ref":"#/components/schemas/audit_CustomerReference"},"removed_label_identifiers":{"items":{"format":"uuid","type":"string"},"type":"array","uniqueItems":true}},"required":["added_label_identifiers","customer","removed_label_identifiers"],"type":"object"},"audit_CustomerLabelsUpdatedLogV2":{"properties":{"actioned_by":{"$ref":"#/components/schemas/audit_ActionedBy"},"detail":{"$ref":"#/components/schemas/audit_CustomerLabelsUpdatedDetailV2"},"grouping_key":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","type":"string"},"occurred_at":{"format":"date-time","type":"string"},"type":{"enum":["CUSTOMER_LABELS_UPDATED"],"type":"string"}},"required":["detail","identifier","occurred_at","type"],"type":"object"},"audit_CustomerMigratedDetailV2":{"properties":{"csom_search_ref":{"type":"string"},"customer":{"$ref":"#/components/schemas/audit_Customer"}},"required":["csom_search_ref","customer"],"type":"object"},"audit_CustomerMigratedLogV2":{"properties":{"actioned_by":{"$ref":"#/components/schemas/audit_ActionedBy"},"detail":{"$ref":"#/components/schemas/audit_CustomerMigratedDetailV2"},"grouping_key":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","type":"string"},"occurred_at":{"format":"date-time","type":"string"},"type":{"enum":["CUSTOMER_MIGRATED"],"type":"string"}},"required":["detail","identifier","occurred_at","type"],"type":"object"},"audit_CustomerMonitoring":{"properties":{"configuration_identifier":{"nullable":true,"type":"string"},"enabled":{"type":"boolean"}},"required":["enabled"],"type":"object"},"audit_CustomerMonitoringConfigurationUpdatedLogV2":{"properties":{"actioned_by":{"$ref":"#/components/schemas/audit_ActionedBy"},"detail":{"$ref":"#/components/schemas/audit_CustomerConfigurationUpdatedDetailV2"},"grouping_key":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","type":"string"},"occurred_at":{"format":"date-time","type":"string"},"type":{"enum":["CUSTOMER_MONITORING_CONFIGURATION_UPDATED"],"type":"string"}},"required":["detail","identifier","occurred_at","type"],"type":"object"},"audit_CustomerProductUpdatedDetailV2":{"properties":{"created_products":{"items":{"$ref":"#/components/schemas/audit_ProductDetail"},"type":"array","uniqueItems":true},"customer":{"$ref":"#/components/schemas/audit_CustomerReference"},"deleted_products":{"items":{"$ref":"#/components/schemas/audit_ProductDetail"},"type":"array","uniqueItems":true}},"required":["created_products","customer","deleted_products"],"type":"object"},"audit_CustomerProductUpdatedLogV2":{"properties":{"actioned_by":{"$ref":"#/components/schemas/audit_ActionedBy"},"detail":{"$ref":"#/components/schemas/audit_CustomerProductUpdatedDetailV2"},"grouping_key":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","type":"string"},"occurred_at":{"format":"date-time","type":"string"},"type":{"enum":["CUSTOMER_PRODUCT_UPDATED"],"type":"string"}},"required":["detail","identifier","occurred_at","type"],"type":"object"},"audit_CustomerReference":{"properties":{"identifier":{"format":"uuid","type":"string"},"version":{"format":"int32","type":"integer"}},"required":["identifier","version"],"type":"object"},"audit_CustomerScreenedDetailV2":{"properties":{"alert":{"$ref":"#/components/schemas/audit_Alert"},"case":{"$ref":"#/components/schemas/audit_Case"},"customer":{"$ref":"#/components/schemas/audit_CustomerReference"},"risk_identifiers":{"items":{"format":"uuid","type":"string"},"type":"array"},"risk_source":{"enum":["CUSTOMER_SCREENING","KYB","PAYMENT_SCREENING","TRANSACTION_MONITORING"],"type":"string"},"screening_configuration":{"$ref":"#/components/schemas/audit_Screening"}},"required":["customer","risk_identifiers","risk_source","screening_configuration"],"type":"object"},"audit_CustomerScreenedLogV2":{"properties":{"actioned_by":{"$ref":"#/components/schemas/audit_ActionedBy"},"detail":{"$ref":"#/components/schemas/audit_CustomerScreenedDetailV2"},"grouping_key":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","type":"string"},"occurred_at":{"format":"date-time","type":"string"},"type":{"enum":["CUSTOMER_SCREENED"],"type":"string"}},"required":["detail","identifier","occurred_at","type"],"type":"object"},"audit_CustomerSegmentsUpdatedDetailV2":{"properties":{"added_segment_identifiers":{"items":{"$ref":"#/components/schemas/audit_SegmentIdentifier"},"type":"array","uniqueItems":true},"customer":{"$ref":"#/components/schemas/audit_CustomerReference"},"removed_segment_identifiers":{"items":{"$ref":"#/components/schemas/audit_SegmentIdentifier"},"type":"array","uniqueItems":true}},"required":["added_segment_identifiers","customer","removed_segment_identifiers"],"type":"object"},"audit_CustomerSegmentsUpdatedLogV2":{"properties":{"actioned_by":{"$ref":"#/components/schemas/audit_ActionedBy"},"detail":{"$ref":"#/components/schemas/audit_CustomerSegmentsUpdatedDetailV2"},"grouping_key":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","type":"string"},"occurred_at":{"format":"date-time","type":"string"},"type":{"enum":["CUSTOMER_SEGMENTS_UPDATED"],"type":"string"}},"required":["detail","identifier","occurred_at","type"],"type":"object"},"audit_CustomerStatusUpdatedDetailV2":{"properties":{"customer":{"$ref":"#/components/schemas/audit_CustomerWithStatus"}},"required":["customer"],"type":"object"},"audit_CustomerStatusUpdatedLogV2":{"properties":{"actioned_by":{"$ref":"#/components/schemas/audit_ActionedBy"},"detail":{"$ref":"#/components/schemas/audit_CustomerStatusUpdatedDetailV2"},"grouping_key":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","type":"string"},"occurred_at":{"format":"date-time","type":"string"},"type":{"enum":["CUSTOMER_STATUS_UPDATED"],"type":"string"}},"required":["detail","identifier","occurred_at","type"],"type":"object"},"audit_CustomerWithStatus":{"properties":{"identifier":{"format":"uuid","type":"string"},"previous_status":{"enum":["ONBOARDING","ACTIVE","CLOSED","PROCESSING","ONBOARDING_CASE"],"nullable":true,"type":"string"},"status":{"enum":["ONBOARDING","ACTIVE","CLOSED","PROCESSING","ONBOARDING_CASE"],"type":"string"},"version":{"format":"int32","type":"integer"}},"required":["identifier","status","version"],"type":"object"},"audit_Note":{"properties":{"content":{"type":"string"},"identifier":{"format":"uuid","type":"string"},"version":{"format":"int32","type":"integer"}},"required":["content","identifier","version"],"type":"object"},"audit_NoteCreatedToCaseActionLogV2":{"properties":{"actioned_by":{"$ref":"#/components/schemas/audit_ActionedBy"},"detail":{"$ref":"#/components/schemas/audit_NoteToCaseActionDetailV2"},"grouping_key":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","type":"string"},"occurred_at":{"format":"date-time","type":"string"},"type":{"enum":["NOTE_CREATED_TO_CASE_ACTION"],"type":"string"}},"required":["detail","identifier","occurred_at","type"],"type":"object"},"audit_NoteToCaseActionDetailV2":{"properties":{"case":{"$ref":"#/components/schemas/audit_Case"},"note":{"$ref":"#/components/schemas/audit_Note"}},"required":["case","note"],"type":"object"},"audit_NoteToCaseObjectDetailV2":{"properties":{"case":{"$ref":"#/components/schemas/audit_Case"},"note":{"$ref":"#/components/schemas/audit_Note"}},"required":["case","note"],"type":"object"},"audit_NoteToCaseObjectLogV2":{"properties":{"actioned_by":{"$ref":"#/components/schemas/audit_ActionedBy"},"detail":{"$ref":"#/components/schemas/audit_NoteToCaseObjectDetailV2"},"grouping_key":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","type":"string"},"occurred_at":{"format":"date-time","type":"string"},"type":{"enum":["NOTE_TO_CASE_OBJECT"],"type":"string"}},"required":["detail","identifier","occurred_at","type"],"type":"object"},"audit_NoteToCustomerDetailV2":{"properties":{"customer_identifier":{"format":"uuid","type":"string"},"note":{"$ref":"#/components/schemas/audit_Note"}},"required":["customer_identifier","note"],"type":"object"},"audit_NoteToCustomerLogV2":{"properties":{"actioned_by":{"$ref":"#/components/schemas/audit_ActionedBy"},"detail":{"$ref":"#/components/schemas/audit_NoteToCustomerDetailV2"},"grouping_key":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","type":"string"},"occurred_at":{"format":"date-time","type":"string"},"type":{"enum":["NOTE_CREATED_TO_CUSTOMER"],"type":"string"}},"required":["detail","identifier","occurred_at","type"],"type":"object"},"audit_NoteToRiskDetailV2":{"properties":{"case":{"$ref":"#/components/schemas/audit_Case"},"note":{"$ref":"#/components/schemas/audit_Note"},"risk":{"$ref":"#/components/schemas/audit_Risk"}},"required":["case","note","risk"],"type":"object"},"audit_NoteToRiskLogV2":{"properties":{"actioned_by":{"$ref":"#/components/schemas/audit_ActionedBy"},"detail":{"$ref":"#/components/schemas/audit_NoteToRiskDetailV2"},"grouping_key":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","type":"string"},"occurred_at":{"format":"date-time","type":"string"},"type":{"enum":["NOTE_TO_RISK"],"type":"string"}},"required":["detail","identifier","occurred_at","type"],"type":"object"},"audit_PaymentScreenedDetailV2":{"properties":{"case":{"$ref":"#/components/schemas/audit_Case"},"risk_identifiers":{"example":["018d0dd4-9b7c-7537-aaac-13f2f48877af"],"items":{"format":"uuid","type":"string"},"type":"array","uniqueItems":true},"transaction":{"$ref":"#/components/schemas/audit_TransactionWithType"}},"required":["risk_identifiers","transaction"],"type":"object"},"audit_PaymentScreenedLogV2":{"properties":{"actioned_by":{"$ref":"#/components/schemas/audit_ActionedBy"},"detail":{"$ref":"#/components/schemas/audit_PaymentScreenedDetailV2"},"grouping_key":{"example":"transaction-group-123","nullable":true,"type":"string"},"identifier":{"example":"018d0dd4-9b7c-7537-aaac-13f2f48877af","format":"uuid","type":"string"},"occurred_at":{"example":"2024-01-15T10:30:00.000Z","format":"date-time","type":"string"},"type":{"enum":["PAYMENT_SCREENED"],"type":"string"}},"required":["detail","identifier","occurred_at","type"],"type":"object"},"audit_ProblemDetailErrorResponse":{"additionalProperties":true,"properties":{"detail":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","type":"string"},"instance":{"format":"uri","nullable":true,"type":"string"},"status":{"format":"int32","nullable":true,"type":"integer"},"timestamp":{"format":"date-time","type":"string"},"title":{"nullable":true,"type":"string"},"type":{"format":"uri","nullable":true,"type":"string"}},"required":["identifier","timestamp"],"type":"object"},"audit_ProductDetail":{"properties":{"identifier":{"format":"uuid","type":"string"},"name":{"type":"string"}},"required":["identifier","name"],"type":"object"},"audit_Risk":{"properties":{"identifier":{"format":"uuid","type":"string"}},"required":["identifier"],"type":"object"},"audit_RiskScore":{"properties":{"identifier":{"format":"uuid","type":"string"},"overall_level":{"enum":["LOW","MEDIUM","HIGH","PROHIBITED","SKIPPED"],"nullable":true,"type":"string"},"overall_value":{"format":"double","type":"number"},"type":{"enum":["PARTIAL","FULL","MANUAL"],"nullable":true,"type":"string"}},"required":["identifier","overall_value"],"type":"object"},"audit_RiskScoreAssignedToCustomerDetailV2":{"properties":{"customer":{"$ref":"#/components/schemas/audit_CustomerReference"},"override_reason":{"nullable":true,"type":"string"},"previous_override_reason":{"nullable":true,"type":"string"},"previous_risk_score":{"$ref":"#/components/schemas/audit_RiskScore"},"risk_score":{"$ref":"#/components/schemas/audit_RiskScore"}},"required":["customer","risk_score"],"type":"object"},"audit_RiskScoreAssignedToCustomerLogV2":{"properties":{"actioned_by":{"$ref":"#/components/schemas/audit_ActionedBy"},"detail":{"$ref":"#/components/schemas/audit_RiskScoreAssignedToCustomerDetailV2"},"grouping_key":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","type":"string"},"occurred_at":{"format":"date-time","type":"string"},"type":{"enum":["RISK_SCORE_CALCULATED"],"type":"string"}},"required":["detail","identifier","occurred_at","type"],"type":"object"},"audit_RiskSignalTransitionedDetailV2":{"properties":{"account_identifier":{"format":"uuid","type":"string"},"case":{"$ref":"#/components/schemas/audit_Case"},"customer":{"$ref":"#/components/schemas/audit_CustomerReference"},"new_profile_hit_state":{"enum":["NEW","IN_REVIEW","TRUE_POSITIVE","FALSE_POSITIVE","UPDATED"],"type":"string"},"risk":{"$ref":"#/components/schemas/audit_RiskWithType"}},"required":["account_identifier","case","customer","new_profile_hit_state","risk"],"type":"object"},"audit_RiskSignalTransitionedLogV2":{"properties":{"actioned_by":{"$ref":"#/components/schemas/audit_ActionedBy"},"detail":{"$ref":"#/components/schemas/audit_RiskSignalTransitionedDetailV2"},"grouping_key":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","type":"string"},"occurred_at":{"format":"date-time","type":"string"},"type":{"enum":["RISK_STATUS_UPDATED"],"type":"string"}},"required":["detail","identifier","occurred_at","type"],"type":"object"},"audit_RiskWithSource":{"properties":{"identifier":{"format":"uuid","nullable":true,"type":"string"},"source":{"enum":["CUSTOMER_SCREENING","KYB","PAYMENT_SCREENING","TRANSACTION_MONITORING"],"type":"string"}},"required":["source"],"type":"object"},"audit_RiskWithType":{"properties":{"identifier":{"format":"uuid","type":"string"},"type":{"enum":["ENTITY_SCREENING","PAYMENT_SCREENING","TRANSACTION_MONITORING"],"nullable":true,"type":"string"}},"required":["identifier"],"type":"object"},"audit_ScenarioConfiguration":{"properties":{"identifier":{"example":"018d0dd4-9b7c-7537-aaac-13f2f48877af","format":"uuid","type":"string"},"outcome":{"enum":["ALLOW","HOLD","PROCESS","PENDING","ERROR"],"example":"HOLD","type":"string"}},"required":["identifier","outcome"],"type":"object"},"audit_ScenarioEvaluations":{"properties":{"configurations":{"items":{"$ref":"#/components/schemas/audit_ScenarioConfiguration"},"type":"array","uniqueItems":true},"outcome":{"enum":["ALLOW","HOLD","PROCESS","PENDING","ERROR"],"example":"HOLD","type":"string"}},"required":["configurations","outcome"],"type":"object"},"audit_Screening":{"properties":{"configuration_identifier":{"nullable":true,"type":"string"},"configuration_version":{"format":"int32","nullable":true,"type":"integer"},"screening_type":{"enum":["UNSPECIFIED","MONITORING","SCREENING"],"type":"string"}},"required":["screening_type"],"type":"object"},"audit_SegmentIdentifier":{"properties":{"identifier":{"format":"uuid","type":"string"},"version":{"format":"int32","type":"integer"}},"required":["identifier","version"],"type":"object"},"audit_Stage":{"properties":{"identifier":{"format":"uuid","type":"string"},"version":{"format":"int32","type":"integer"}},"required":["identifier","version"],"type":"object"},"audit_Transaction":{"properties":{"identifier":{"example":"018d0dd4-9b7c-7537-aaac-13f2f48877af","format":"uuid","type":"string"}},"required":["identifier"],"type":"object"},"audit_TransactionAddedToCaseDetailV2":{"properties":{"case":{"$ref":"#/components/schemas/audit_Case"},"transaction":{"$ref":"#/components/schemas/audit_TransactionWithType"}},"required":["case","transaction"],"type":"object"},"audit_TransactionAddedToCaseLogV2":{"properties":{"actioned_by":{"$ref":"#/components/schemas/audit_ActionedBy"},"detail":{"$ref":"#/components/schemas/audit_TransactionAddedToCaseDetailV2"},"grouping_key":{"example":"transaction-group-123","nullable":true,"type":"string"},"identifier":{"example":"018d0dd4-9b7c-7537-aaac-13f2f48877af","format":"uuid","type":"string"},"occurred_at":{"example":"2024-01-15T10:30:00.000Z","format":"date-time","type":"string"},"type":{"enum":["TRANSACTION_ADDED_TO_CASE"],"type":"string"}},"required":["detail","identifier","occurred_at","type"],"type":"object"},"audit_TransactionAuditLogsPageV2":{"properties":{"audit_logs":{"items":{"discriminator":{"mapping":{"CASE_ASSIGNED":"#/components/schemas/audit_CaseAssignedLogV2","CASE_CREATED":"#/components/schemas/audit_CaseCreatedLogV2","CASE_STAGE_TRANSITIONED":"#/components/schemas/audit_CaseTransitionedLogV2","PAYMENT_SCREENED":"#/components/schemas/audit_PaymentScreenedLogV2","TRANSACTION_ADDED_TO_CASE":"#/components/schemas/audit_TransactionAddedToCaseLogV2","TRANSACTION_MONITORED":"#/components/schemas/audit_TransactionMonitoredLogV2","TRANSACTION_RECEIVED":"#/components/schemas/audit_TransactionReceivedLogV2","TRANSACTION_RELEASE_DECISION":"#/components/schemas/audit_TransactionReleaseDecisionLogV2"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/audit_CaseCreatedLogV2"},{"$ref":"#/components/schemas/audit_CaseTransitionedLogV2"},{"$ref":"#/components/schemas/audit_CaseAssignedLogV2"},{"$ref":"#/components/schemas/audit_PaymentScreenedLogV2"},{"$ref":"#/components/schemas/audit_TransactionMonitoredLogV2"},{"$ref":"#/components/schemas/audit_TransactionReceivedLogV2"},{"$ref":"#/components/schemas/audit_TransactionAddedToCaseLogV2"},{"$ref":"#/components/schemas/audit_TransactionReleaseDecisionLogV2"}],"type":"object"},"type":"array"},"first":{"description":"The URL path to the first page.","example":"/v1/resource?page_number=1","type":"string"},"next":{"description":"The URL path to the next page.","example":"/v1/resource?page_number=4","nullable":true,"type":"string"},"prev":{"description":"The URL path to the previous page.","example":"/v1/resource?page_number=2","nullable":true,"type":"string"},"self":{"description":"The URL path to the current page.","example":"/v1/resource?page_number=3","type":"string"},"total_count":{"description":"Total number of items.","example":60,"format":"int64","nullable":true,"type":"integer"}},"required":["audit_logs","first","self"],"type":"object"},"audit_TransactionMonitoredDetailV2":{"properties":{"risk_identifiers":{"example":["018d0dd4-9b7c-7537-aaac-13f2f48877af"],"items":{"format":"uuid","type":"string"},"type":"array","uniqueItems":true},"risk_source":{"enum":["CUSTOMER_SCREENING","KYB","PAYMENT_SCREENING","TRANSACTION_MONITORING"],"example":"TRANSACTION_MONITORING","type":"string"},"scenario_evaluations":{"$ref":"#/components/schemas/audit_ScenarioEvaluations"},"transaction":{"$ref":"#/components/schemas/audit_TransactionWithType"}},"required":["risk_identifiers","risk_source","scenario_evaluations","transaction"],"type":"object"},"audit_TransactionMonitoredLogV2":{"properties":{"actioned_by":{"$ref":"#/components/schemas/audit_ActionedBy"},"detail":{"$ref":"#/components/schemas/audit_TransactionMonitoredDetailV2"},"grouping_key":{"example":"transaction-group-123","nullable":true,"type":"string"},"identifier":{"example":"018d0dd4-9b7c-7537-aaac-13f2f48877af","format":"uuid","type":"string"},"occurred_at":{"example":"2024-01-15T10:30:00.000Z","format":"date-time","type":"string"},"type":{"enum":["TRANSACTION_MONITORED"],"type":"string"}},"required":["detail","identifier","occurred_at","type"],"type":"object"},"audit_TransactionReceivedDetailV2":{"properties":{"transaction":{"$ref":"#/components/schemas/audit_TransactionWithTypeAndReceivedAt"}},"required":["transaction"],"type":"object"},"audit_TransactionReceivedLogV2":{"properties":{"actioned_by":{"$ref":"#/components/schemas/audit_ActionedBy"},"detail":{"$ref":"#/components/schemas/audit_TransactionReceivedDetailV2"},"grouping_key":{"example":"transaction-group-123","nullable":true,"type":"string"},"identifier":{"example":"018d0dd4-9b7c-7537-aaac-13f2f48877af","format":"uuid","type":"string"},"occurred_at":{"example":"2024-01-15T10:30:00.000Z","format":"date-time","type":"string"},"type":{"enum":["TRANSACTION_RECEIVED"],"type":"string"}},"required":["detail","identifier","occurred_at","type"],"type":"object"},"audit_TransactionReleaseDecisionDetailV2":{"properties":{"review_decision":{"enum":["NOT_APPLICABLE","NOT_REVIEWED","RELEASE","REJECT"],"example":"RELEASE","type":"string"},"transaction":{"$ref":"#/components/schemas/audit_Transaction"}},"required":["review_decision","transaction"],"type":"object"},"audit_TransactionReleaseDecisionLogV2":{"properties":{"actioned_by":{"$ref":"#/components/schemas/audit_ActionedBy"},"detail":{"$ref":"#/components/schemas/audit_TransactionReleaseDecisionDetailV2"},"grouping_key":{"example":"transaction-group-123","nullable":true,"type":"string"},"identifier":{"example":"018d0dd4-9b7c-7537-aaac-13f2f48877af","format":"uuid","type":"string"},"occurred_at":{"example":"2024-01-15T10:30:00.000Z","format":"date-time","type":"string"},"type":{"enum":["TRANSACTION_RELEASE_DECISION"],"type":"string"}},"required":["detail","identifier","occurred_at","type"],"type":"object"},"audit_TransactionWithType":{"properties":{"identifier":{"example":"018d0dd4-9b7c-7537-aaac-13f2f48877af","format":"uuid","type":"string"},"type":{"enum":["BANK_PAYMENT","CARD_PAYMENT","REMITTANCE","CRYPTO"],"example":"BANK_PAYMENT","type":"string"}},"required":["identifier","type"],"type":"object"},"audit_TransactionWithTypeAndReceivedAt":{"properties":{"identifier":{"example":"018d0dd4-9b7c-7537-aaac-13f2f48877af","format":"uuid","type":"string"},"received_at":{"example":"2024-01-15T10:30:00.000Z","format":"date-time","type":"string"},"type":{"enum":["BANK_PAYMENT","CARD_PAYMENT","REMITTANCE","CRYPTO"],"example":"BANK_PAYMENT","type":"string"}},"required":["identifier","received_at","type"],"type":"object"},"bulk_Batch":{"properties":{"account_identifier":{"format":"uuid","type":"string"},"created_at":{"format":"date-time","type":"string"},"created_by":{"format":"uuid","nullable":true,"type":"string"},"errors":{"$ref":"#/components/schemas/bulk_BatchErrors"},"identifier":{"format":"uuid","type":"string"},"request":{"$ref":"#/components/schemas/bulk_BatchRequest"},"statistics":{"$ref":"#/components/schemas/bulk_BatchStatistics"},"status":{"enum":["NOT_STARTED","VALIDATING","VALIDATING_ERROR","PROCESSING","PROCESSING_ERROR","COMPLETED","INTERNAL_ERROR"],"type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["account_identifier","created_at","identifier","request","status","updated_at"],"type":"object"},"bulk_BatchErrors":{"properties":{"file_errors":{"items":{"$ref":"#/components/schemas/bulk_FileError"},"type":"array","uniqueItems":true},"reason":{"enum":["INTERNAL_ERROR","MALFORMED_FILE","INVALID_ROWS","INVALID_SEQUENCE_KEY"],"nullable":true,"type":"string"},"row_errors":{"items":{"$ref":"#/components/schemas/bulk_RowError"},"type":"array","uniqueItems":true}},"required":["file_errors","row_errors"],"type":"object"},"bulk_BatchReport":{"properties":{"workflows_download_link":{"format":"url","nullable":true,"type":"string"}},"type":"object"},"bulk_BatchRequest":{"properties":{"file_name":{"type":"string"},"upload_method":{"enum":["HTTP","SFTP"],"type":"string"},"workflow_type":{"enum":["create-and-screen","create-and-monitor","manage-lookup-list"],"type":"string"}},"required":["file_name","upload_method","workflow_type"],"type":"object"},"bulk_BatchStatistics":{"properties":{"num_of_completed_workflows":{"format":"int32","type":"integer"},"num_of_created_workflows":{"format":"int32","type":"integer"},"num_of_errored_workflows":{"format":"int32","type":"integer"},"num_of_processed_rows":{"format":"int64","type":"integer"},"num_of_validated_rows":{"format":"int32","type":"integer"}},"required":["num_of_completed_workflows","num_of_created_workflows","num_of_errored_workflows","num_of_processed_rows","num_of_validated_rows"],"type":"object"},"bulk_DeletedBatch":{"properties":{"identifier":{"format":"uuid","type":"string"}},"required":["identifier"],"type":"object"},"bulk_ErrorAttributes":{"properties":{"affected_rows":{"items":{"format":"int64","type":"integer"},"type":"array","uniqueItems":true},"column_names":{"items":{"type":"string"},"type":"array","uniqueItems":true},"column_options":{"items":{"items":{"type":"string"},"type":"array","uniqueItems":true},"type":"array","uniqueItems":true},"expected_range":{"items":{"format":"int64","type":"integer"},"type":"array","uniqueItems":true},"max_row_limit":{"format":"int64","nullable":true,"type":"integer"},"rejected_values":{"items":{"type":"string"},"type":"array","uniqueItems":true},"required_format":{"deprecated":true,"type":"string"},"required_formats":{"items":{"type":"string"},"type":"array","uniqueItems":true}},"required":["affected_rows","column_names","column_options","expected_range","rejected_values","required_format","required_formats"],"type":"object"},"bulk_FileError":{"properties":{"attributes":{"$ref":"#/components/schemas/bulk_ErrorAttributes"},"code":{"enum":["UNSUPPORTED_MIMETYPE","MULTIPLE_SHEETS_FOUND","MALFORMED_CONTENT","UNSUPPORTED_COLUMN","MAX_ROW_LIMIT_EXCEEDED","INVALID_CUSTOM_LIST_IDENTIFIER","INVALID_LOOKUP_LIST_IDENTIFIER","INVALID_LOOKUP_LIST_STATUS"],"type":"string"}},"required":["code"],"type":"object"},"bulk_PaginatedResponseBatch":{"properties":{"batches":{"items":{"$ref":"#/components/schemas/bulk_Batch"},"type":"array"},"first":{"description":"The URL path to the first page.","example":"/v1/resource?page_number=1","type":"string"},"next":{"description":"The URL path to the next page.","example":"/v1/resource?page_number=4","nullable":true,"type":"string"},"prev":{"description":"The URL path to the previous page.","example":"/v1/resource?page_number=2","nullable":true,"type":"string"},"self":{"description":"The URL path to the current page.","example":"/v1/resource?page_number=3","type":"string"},"total_count":{"description":"Total number of items.","example":60,"format":"int64","nullable":true,"type":"integer"}},"required":["first","self","batches"],"type":"object"},"bulk_RowError":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/bulk_RowErrorMessage"},"type":"array","uniqueItems":true},"row_number":{"format":"int64","type":"integer"}},"required":["errors","row_number"],"type":"object"},"bulk_RowErrorMessage":{"properties":{"attributes":{"$ref":"#/components/schemas/bulk_ErrorAttributes"},"code":{"enum":["MANDATORY_COLUMN_MISSING","ONE_OF_REQUIRED","MUTUALLY_EXCLUSIVE","INVALID_RESIDENTIAL_STATUS","INVALID_CURRENCY_CODE","INVALID_COUNTRY_CODE","INVALID_COUNTRY_SUBDIVISION_CODE","INVALID_IDENTIFIER","INVALID_NUMBER","INVALID_BIRTH_DATE_YEAR","INVALID_PHONE_NUMBER","INVALID_EMAIL_ADDRESS","INVALID_URL","INVALID_GENDER","INVALID_COMPANY_STATUS","INVALID_ADDRESS_TYPE","INVALID_ADDRESS_TYPE_PERSON","INVALID_ADDRESS_TYPE_COMPANY","INVALID_PERSONAL_IDENTIFICATION_TYPE","CUSTOMER_LABEL_NOT_FOUND","SCREENING_CONFIGURATION_NOT_FOUND","MAX_SIZE_LIMIT_REACHED","MIN_SIZE_LIMIT_REACHED","INVALID_IBAN","INVALID_IP_ADDRESS","INVALID_DATE","DATE_NOT_IN_PAST","DATE_EXCEEDS_PRESENT","INVALID_DATE_OF_EXPIRY","INVALID_SALARY_AMOUNT","INVALID_SALARY_CURRENCY","INVALID_BIC","INVALID_CHARACTER","INVALID_BOOLEAN","INVALID_TIMESTAMP","INVALID_TRANSACTION_TYPE","INVALID_TRANSACTION_CLASSIFICATION","INVALID_BANK_PAYMENT_STATE","INVALID_CARD_PAYMENT_STAGE","INVALID_CARD_SCHEME","INVALID_CARD_PAYMENT_SCOPE","INVALID_BANK_IDENTIFICATION_NUMBER","TOO_MANY_CUSTOM_FIELDS","INVALID_PAYMENT_SCHEME","INVALID_PAYMENT_CHANNEL","INVALID_REMITTANCE_PAYMENT_METHOD","INVALID_REMITTANCE_RELATIONSHIP","INVALID_REMITTANCE_PURPOSE","INVALID_REMITTANCE_SOURCE_OF_FUNDS","INVALID_REMITTANCE_SERVICE_PROVIDER_TYPE","INVALID_BLOCKCHAIN_NETWORK_TYPE","INVALID_CASH_PICKUP_METHOD_MISMATCH","INVALID_CARD_VERIFICATION_RESULT","TOO_MANY_AGENTS","INVALID_AGENT_ROLE","INVALID_SCENARIO_CONFIGURATION_IDENTIFIER","TOO_MANY_SCENARIO_CONFIGURATION_IDENTIFIERS","INVALID_CUSTOMER_EXTERNAL_IDENTIFIER","MULTIPLE_CUSTOMERS","CUSTOMER_EXTERNAL_IDENTIFIER_MISMATCH","MIXED_CUSTOMER_DATA_TYPES","CARD_PARTY_CUSTOMER_IDENTIFIER_MISMATCH","INVALID_CARD_PAYMENT_TYPE","INVALID_POS_CONDITION_CODE","INVALID_POS_ENTRY_MODE_CODE","INVALID_CARD_WALLET_TYPE","INVALID_ALPHANUMERIC_VALUE","INVALID_CARD_FUNDING_TYPE","INVALID_MERCHANT_CATEGORY_TYPE","INVALID_MERCHANT_CATEGORY_CODE","INVALID_CARD_CHARGEBACK_OUTCOME","INVALID_CARD_AUTHORIZATION_RESPONSE_CODE","INVALID_CARD_AUTHORIZATION_STATE","INVALID_CARD_AUTHORIZATION_TYPE","CUSTOM_LIST_NOT_FOUND","CUSTOM_LIST_IDENTIFIER_MISMATCH","COUNTERPARTY_NOT_ALLOWED_ON_ULTIMATE_PARTY","INVALID_CAIP_2_IDENTIFIER","INVALID_CAIP_19_IDENTIFIER","INVALID_LATITUDE","INVALID_LONGITUDE","INVALID_CLEARING_IDENTIFIER_TYPE"],"type":"string"}},"required":["code"],"type":"object"},"case-management_AlertsSummary":{"description":"Summary of alerts information, including the highest priority.","properties":{"count":{"format":"int32","type":"integer"},"highest_priority":{"description":"The highest priority of alerts associated with the case.\n\nAlerts priority:\n\n1-3 -> High\n\n4-6 -> Medium\n\n7-9 -> Low\n\n`null` -> No priority","format":"int32","maximum":9,"minimum":1,"nullable":true,"type":"integer"}},"required":["count","highest_priority"],"type":"object"},"case-management_AssignCaseBulkActionPayload":{"properties":{"assignee":{"description":"User identifier to whom the case should be assigned, or null to un-assign.","format":"uuid","nullable":true,"type":"string"},"note":{"description":"Note: content to be associated with case assignment (optional).","example":"Assigning case to John Doe due to his expertise.","maxLength":5000,"minLength":0,"nullable":true,"type":"string"}},"required":["assignee"],"type":"object"},"case-management_AssignCasesRequest":{"description":"Assign multiple cases (bulk action).","properties":{"payload":{"$ref":"#/components/schemas/case-management_AssignCaseBulkActionPayload"},"query":{"$ref":"#/components/schemas/case-management_BulkActionQuery"}},"required":["payload","query"],"type":"object"},"case-management_AssignedCaseResponse":{"description":"Assignee case information.","properties":{"assignee":{"description":"The user identifier to whom the case is assigned, or null if unassigned.","format":"uuid","nullable":true,"type":"string"},"updated_at":{"description":"The date and time at which this case was last updated.","format":"date-time","type":"string"},"updated_by":{"description":"The user identifier that last updated this case.","format":"uuid","nullable":true,"type":"string"}},"required":["updated_at"],"type":"object"},"case-management_BankPaymentSubject":{"description":"Transaction subject as a bank payment.","properties":{"detail":{"$ref":"#/components/schemas/case-management_BankPaymentSubjectDetail"},"external_identifier":{"description":"Transaction external identifier.","type":"string"},"identifier":{"description":"Transaction unique identifier.","format":"uuid","type":"string"},"type":{"enum":["TRANSACTION"],"example":"TRANSACTION","type":"string"}},"required":["detail","external_identifier","identifier","type"],"type":"object"},"case-management_BankPaymentSubjectDetail":{"description":"Bank payment subject detail.","properties":{"type":{"enum":["BANK_PAYMENT"],"example":"BANK_PAYMENT","type":"string"}},"required":["type"],"type":"object"},"case-management_BankPaymentSummaryResponse":{"description":"Summary of a Bank Payment.","properties":{"external_identifier":{"description":"Payment external identifier.","type":"string"},"identifier":{"description":"Payment unique identifier.","format":"uuid","type":"string"},"type":{"description":"Payment type.","enum":["BANK_PAYMENT"],"example":"BANK_PAYMENT","type":"string"}},"required":["external_identifier","identifier","type"],"type":"object"},"case-management_BulkActionError":{"description":"An error in a bulk action.","nullable":true,"properties":{"detail":{"description":"Detail on the particular instance of the error.","type":"string"},"message":{"description":"Summary of the error.","type":"string"}},"required":["detail","message"],"type":"object"},"case-management_BulkActionPayloadNote":{"description":"Bulk action for adding a note to Cases.","properties":{"note":{"description":"The contents of the note to be created (up to 5000 characters).","example":"These cases need to be double-checked.","maxLength":5000,"minLength":0,"type":"string"}},"required":["note"],"type":"object"},"case-management_BulkActionQuery":{"description":"The case to be updated will be those that match the properties in this object.","properties":{"identifier":{"description":"The unique identifier of cases to be updated in bulk action.","items":{"description":"The unique identifier of cases to be updated in bulk action.","format":"uuid","type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"required":["identifier"],"type":"object"},"case-management_BulkActionResponse":{"description":"Contains all the results of a bulk action.","properties":{"results":{"description":"Results of the bulk action.","items":{"$ref":"#/components/schemas/case-management_BulkActionResult"},"nullable":true,"type":"array"}},"required":["results"],"type":"object"},"case-management_BulkActionResult":{"description":"A single result of a bulk action.","nullable":true,"properties":{"errors":{"description":"Errors of bulk action.","items":{"$ref":"#/components/schemas/case-management_BulkActionError"},"nullable":true,"type":"array"},"identifier":{"description":"The identifier of a case for which an update was attempted.","format":"uuid","type":"string"},"success":{"description":"Boolean indicating if this case was successfully updated.","type":"boolean"}},"required":["identifier","success"],"type":"object"},"case-management_CardPaymentSubject":{"description":"Transaction subject as a card payment.","properties":{"detail":{"$ref":"#/components/schemas/case-management_CardPaymentSubjectDetail"},"external_identifier":{"description":"Transaction external identifier.","type":"string"},"identifier":{"description":"Transaction unique identifier.","format":"uuid","type":"string"},"type":{"enum":["TRANSACTION"],"example":"TRANSACTION","type":"string"}},"required":["detail","external_identifier","identifier","type"],"type":"object"},"case-management_CardPaymentSubjectDetail":{"description":"Card payment subject detail.","properties":{"type":{"enum":["CARD_PAYMENT"],"example":"CARD_PAYMENT","type":"string"}},"required":["type"],"type":"object"},"case-management_CardPaymentSummaryResponse":{"description":"Summary of a Card Payment.","properties":{"external_identifier":{"description":"Payment external identifier.","type":"string"},"identifier":{"description":"Payment unique identifier.","format":"uuid","type":"string"},"type":{"description":"Payment type.","enum":["CARD_PAYMENT"],"example":"CARD_PAYMENT","type":"string"}},"required":["external_identifier","identifier","type"],"type":"object"},"case-management_CaseAlertResponseV2":{"description":"Case alert response.","properties":{"identifier":{"description":"Alert unique identifier.","format":"uuid","type":"string"},"priority":{"description":"Alerts priority:\n\n1-3 -> High\n\n4-6 -> Medium\n\n7-9 -> Low\n\n`null` -> No priority","format":"int32","maximum":9,"minimum":1,"nullable":true,"type":"integer"},"risk_source":{"description":"The sources of risk.","enum":["CUSTOMER_SCREENING","PAYMENT_SCREENING","TRANSACTION_MONITORING"],"type":"string"},"state":{"description":"Alert state.","enum":["NOT_STARTED","IN_PROGRESS","POSITIVE_END_STATE","NEGATIVE_END_STATE"],"type":"string"},"title":{"description":"Alert title.","example":"Customer screening","type":"string"},"type":{"description":"Alert type.","enum":["CUSTOMER_SCREENING","MONITORING","PAYMENT_SCREENING","TRANSACTION_MONITORING"],"type":"string"},"updated_at":{"description":"Alert last updated date and time.","format":"date-time","type":"string"},"updated_by":{"description":"User identifier who last updated the alert.","format":"uuid","nullable":true,"type":"string"}},"required":["identifier","priority","risk_source","state","title","type","updated_at"],"type":"object"},"case-management_CaseAssignment":{"description":"Case assignment update request.","properties":{"assignee":{"description":"The user identifier to whom the case should be assigned, or null to un-assign.","format":"uuid","nullable":true,"type":"string"}},"type":"object"},"case-management_CaseAssignmentNoteResponse":{"description":"Note associated to a case assignment action.","properties":{"contents":{"description":"The contents of the note.","type":"string"},"created_at":{"description":"The date and time at which this note was created.","format":"date-time","type":"string"},"created_by":{"description":"The user identifier that created this note.","format":"uuid","type":"string"},"current_assignee":{"description":"Current case assigned user identifier. When null, case was un-assigned.","format":"uuid","nullable":true,"type":"string"},"identifier":{"description":"Unique identifier of the note.","format":"uuid","type":"string"},"previous_assignee":{"description":"Previous case assigned user identifier. When null, case was un-assigned.","format":"uuid","nullable":true,"type":"string"},"type":{"description":"Defines the type of a note.","enum":["CASE_ASSIGNMENT"],"example":"CASE_ASSIGNMENT","type":"string"}},"required":["contents","created_at","created_by","identifier","type"],"type":"object"},"case-management_CaseCustomerSummaryResponse":{"description":"Customer summary that is associated to a case.","properties":{"external_identifier":{"description":"Customer external identifier.","nullable":true,"type":"string"},"identifier":{"description":"Customer unique identifier.","format":"uuid","type":"string"},"name":{"description":"Customer name.","type":"string"},"risk_level":{"description":"Customer current risk level.","enum":["LOW","MEDIUM","HIGH","PROHIBITED","SKIPPED"],"type":"string"},"type":{"description":"Customer type.","enum":["PERSON","COMPANY","UNDEFINED"],"type":"string"},"version":{"description":"Customer version.","format":"int32","type":"integer"}},"required":["identifier","name","risk_level","type","version"],"type":"object"},"case-management_CaseNoteResponse":{"description":"Note associated to a case.","properties":{"contents":{"description":"The contents of the note.","type":"string"},"created_at":{"description":"The date and time at which this note was created.","format":"date-time","type":"string"},"created_by":{"description":"The user identifier that created this note.","format":"uuid","type":"string"},"identifier":{"description":"Unique identifier of the note.","format":"uuid","type":"string"},"type":{"description":"Defines the type of a note.","enum":["CASE"],"example":"CASE","type":"string"}},"required":["contents","created_at","created_by","identifier","type"],"type":"object"},"case-management_CaseResponse":{"description":"Case result detail.","properties":{"assignee":{"description":"User unique identifier that is currently assigned to case.\n\n null if un-assigned.","format":"uuid","nullable":true,"type":"string"},"created_at":{"description":"Case created date and time.","format":"date-time","type":"string"},"customer":{"$ref":"#/components/schemas/case-management_CaseCustomerSummaryResponse"},"identifier":{"description":"Case unique identifier.","format":"uuid","type":"string"},"last_user_stage":{"$ref":"#/components/schemas/case-management_Stage"},"last_user_state":{"deprecated":true,"description":"The last state the case was transitioned to by a user (as opposed to a system action).\n\nFor those using the deprecated case_state, if any new case stages are added the case state response for these will be returned as  USER_DEFINED","enum":["ONBOARDING_NOT_STARTED","ONBOARDING_IN_PROGRESS","ONBOARDING_ESCALATED","ONBOARDING_BLOCKED","ONBOARDING_POSITIVE_END_STATE","ONBOARDING_MANAGEABLE_RISK_POSITIVE_END_STATE","ONBOARDING_NEGATIVE_END_STATE","MONITORING_NOT_STARTED","MONITORING_IN_PROGRESS","MONITORING_ESCALATED","MONITORING_BLOCKED","MONITORING_NO_RISK_DETECTED_POSITIVE_END_STATE","MONITORING_RISK_DETECTED_POSITIVE_END_STATE","MONITORING_RISK_DETECTED_NEGATIVE_END_STATE","PAYMENT_SCREENING_NOT_STARTED","PAYMENT_SCREENING_IN_PROGRESS","PAYMENT_SCREENING_ESCALATED","PAYMENT_SCREENING_BLOCKED","PAYMENT_SCREENING_AWAITING_INFORMATION","PAYMENT_SCREENING_PROCESS_PAYMENT_END_STATE","PAYMENT_SCREENING_REJECT_PAYMENT_END_STATE","TRANSACTION_MONITORING_NOT_STARTED","TRANSACTION_MONITORING_IN_PROGRESS","TRANSACTION_MONITORING_ESCALATED","TRANSACTION_MONITORING_BLOCKED","TRANSACTION_MONITORING_ACCEPTED_POSITIVE_END_STATE","TRANSACTION_MONITORING_ESCALATED_NEGATIVE_END_STATE","USER_DEFINED"],"example":"ONBOARDING_POSITIVE_END_STATE","nullable":true,"type":"string"},"payment":{"$ref":"#/components/schemas/case-management_PaymentSummaryResponse"},"review_items_count":{"description":"Number of items to review in case.","format":"int32","type":"integer"},"risk_catalog_risk_types":{"description":"Risk catalog risk types associated with the case","items":{"$ref":"#/components/schemas/case-management_RiskCatalogResponse"},"type":"array"},"risk_types":{"description":"Risk types of case.","items":{"$ref":"#/components/schemas/case-management_RiskTypesResponse"},"type":"array"},"stage":{"$ref":"#/components/schemas/case-management_Stage"},"state":{"deprecated":true,"description":"The current state of the case.\n\nFor those using the deprecated case_state, if any new case stages are added the case state response for these will be returned as USER_DEFINED","enum":["ONBOARDING_NOT_STARTED","ONBOARDING_IN_PROGRESS","ONBOARDING_ESCALATED","ONBOARDING_BLOCKED","ONBOARDING_POSITIVE_END_STATE","ONBOARDING_MANAGEABLE_RISK_POSITIVE_END_STATE","ONBOARDING_NEGATIVE_END_STATE","MONITORING_NOT_STARTED","MONITORING_IN_PROGRESS","MONITORING_ESCALATED","MONITORING_BLOCKED","MONITORING_NO_RISK_DETECTED_POSITIVE_END_STATE","MONITORING_RISK_DETECTED_POSITIVE_END_STATE","MONITORING_RISK_DETECTED_NEGATIVE_END_STATE","PAYMENT_SCREENING_NOT_STARTED","PAYMENT_SCREENING_IN_PROGRESS","PAYMENT_SCREENING_ESCALATED","PAYMENT_SCREENING_BLOCKED","PAYMENT_SCREENING_AWAITING_INFORMATION","PAYMENT_SCREENING_PROCESS_PAYMENT_END_STATE","PAYMENT_SCREENING_REJECT_PAYMENT_END_STATE","TRANSACTION_MONITORING_NOT_STARTED","TRANSACTION_MONITORING_IN_PROGRESS","TRANSACTION_MONITORING_ESCALATED","TRANSACTION_MONITORING_BLOCKED","TRANSACTION_MONITORING_ACCEPTED_POSITIVE_END_STATE","TRANSACTION_MONITORING_ESCALATED_NEGATIVE_END_STATE","USER_DEFINED"],"example":"ONBOARDING_POSITIVE_END_STATE","type":"string"},"subjects":{"description":"Subjects associated with the case.","items":{"$ref":"#/components/schemas/case-management_Subject"},"type":"array"},"type":{"description":"Case type.","enum":["CUSTOMER_ONBOARDING","CUSTOMER_MONITORING","PAYMENT_SCREENING","TRANSACTION_MONITORING"],"example":"CUSTOMER_ONBOARDING","type":"string"},"updated_at":{"description":"Case last updated date and time.","format":"date-time","type":"string"},"updated_by":{"description":"Last state of case set by an user.","format":"uuid","nullable":true,"type":"string"}},"required":["created_at","identifier","review_items_count","risk_catalog_risk_types","risk_types","stage","state","subjects","type","updated_at"],"type":"object"},"case-management_CaseResultResponse":{"description":"Case result detail for list endpoint.","properties":{"alerts":{"$ref":"#/components/schemas/case-management_AlertsSummary"},"assignee":{"description":"User identifier that is currently assigned to case.\n\n null if un-assigned.","format":"uuid","nullable":true,"type":"string"},"created_at":{"description":"Case created date and time.","format":"date-time","type":"string"},"customer":{"$ref":"#/components/schemas/case-management_CaseCustomerSummaryResponse"},"identifier":{"description":"Case unique identifier.","format":"uuid","type":"string"},"last_user_stage":{"$ref":"#/components/schemas/case-management_Stage"},"last_user_state":{"deprecated":true,"description":"The last state the case was transitioned to by a user (as opposed to a system action).\n\nFor those using the deprecated case_state, if any new case stages are added the case state response for these will be returned as  USER_DEFINED","enum":["ONBOARDING_NOT_STARTED","ONBOARDING_IN_PROGRESS","ONBOARDING_ESCALATED","ONBOARDING_BLOCKED","ONBOARDING_POSITIVE_END_STATE","ONBOARDING_MANAGEABLE_RISK_POSITIVE_END_STATE","ONBOARDING_NEGATIVE_END_STATE","MONITORING_NOT_STARTED","MONITORING_IN_PROGRESS","MONITORING_ESCALATED","MONITORING_BLOCKED","MONITORING_NO_RISK_DETECTED_POSITIVE_END_STATE","MONITORING_RISK_DETECTED_POSITIVE_END_STATE","MONITORING_RISK_DETECTED_NEGATIVE_END_STATE","PAYMENT_SCREENING_NOT_STARTED","PAYMENT_SCREENING_IN_PROGRESS","PAYMENT_SCREENING_ESCALATED","PAYMENT_SCREENING_BLOCKED","PAYMENT_SCREENING_AWAITING_INFORMATION","PAYMENT_SCREENING_PROCESS_PAYMENT_END_STATE","PAYMENT_SCREENING_REJECT_PAYMENT_END_STATE","TRANSACTION_MONITORING_NOT_STARTED","TRANSACTION_MONITORING_IN_PROGRESS","TRANSACTION_MONITORING_ESCALATED","TRANSACTION_MONITORING_BLOCKED","TRANSACTION_MONITORING_ACCEPTED_POSITIVE_END_STATE","TRANSACTION_MONITORING_ESCALATED_NEGATIVE_END_STATE","USER_DEFINED"],"example":"ONBOARDING_POSITIVE_END_STATE","nullable":true,"type":"string"},"payment":{"$ref":"#/components/schemas/case-management_PaymentSummaryResponse"},"review_items_count":{"description":"Number of items to review in case.","format":"int32","type":"integer"},"risk_catalog_risk_types":{"description":"Risk catalog risk types associated with the case","items":{"$ref":"#/components/schemas/case-management_RiskCatalogResponse"},"type":"array"},"risk_types":{"description":"Risk types of case.","items":{"$ref":"#/components/schemas/case-management_RiskTypesResponse"},"type":"array"},"stage":{"$ref":"#/components/schemas/case-management_Stage"},"state":{"deprecated":true,"description":"The current state of the case.\n\nFor those using the deprecated case_state, if any new case stages are added the case state response for these will be returned as USER_DEFINED","enum":["ONBOARDING_NOT_STARTED","ONBOARDING_IN_PROGRESS","ONBOARDING_ESCALATED","ONBOARDING_BLOCKED","ONBOARDING_POSITIVE_END_STATE","ONBOARDING_MANAGEABLE_RISK_POSITIVE_END_STATE","ONBOARDING_NEGATIVE_END_STATE","MONITORING_NOT_STARTED","MONITORING_IN_PROGRESS","MONITORING_ESCALATED","MONITORING_BLOCKED","MONITORING_NO_RISK_DETECTED_POSITIVE_END_STATE","MONITORING_RISK_DETECTED_POSITIVE_END_STATE","MONITORING_RISK_DETECTED_NEGATIVE_END_STATE","PAYMENT_SCREENING_NOT_STARTED","PAYMENT_SCREENING_IN_PROGRESS","PAYMENT_SCREENING_ESCALATED","PAYMENT_SCREENING_BLOCKED","PAYMENT_SCREENING_AWAITING_INFORMATION","PAYMENT_SCREENING_PROCESS_PAYMENT_END_STATE","PAYMENT_SCREENING_REJECT_PAYMENT_END_STATE","TRANSACTION_MONITORING_NOT_STARTED","TRANSACTION_MONITORING_IN_PROGRESS","TRANSACTION_MONITORING_ESCALATED","TRANSACTION_MONITORING_BLOCKED","TRANSACTION_MONITORING_ACCEPTED_POSITIVE_END_STATE","TRANSACTION_MONITORING_ESCALATED_NEGATIVE_END_STATE","USER_DEFINED"],"example":"ONBOARDING_POSITIVE_END_STATE","type":"string"},"subjects":{"description":"Subjects associated with the case.","items":{"$ref":"#/components/schemas/case-management_Subject"},"type":"array"},"type":{"description":"Case type.","enum":["CUSTOMER_ONBOARDING","CUSTOMER_MONITORING","PAYMENT_SCREENING","TRANSACTION_MONITORING"],"example":"CUSTOMER_ONBOARDING","type":"string"},"updated_at":{"description":"Case last updated date and time.","format":"date-time","type":"string"},"updated_by":{"description":"Last state of case set by an user.","format":"uuid","nullable":true,"type":"string"}},"required":["alerts","created_at","identifier","last_user_stage","payment","review_items_count","risk_catalog_risk_types","risk_types","stage","state","subjects","type","updated_at"],"type":"object"},"case-management_CaseStageTransitionRequest":{"description":"Case stage update request.","properties":{"note":{"description":"Note: content to be associated with case transition. Only required if case transition is an end stage.","example":"Case accepted after confirmation from user.","maxLength":5000,"minLength":0,"nullable":true,"type":"string"},"stage_identifier":{"description":"The stage identifier to which the case should be transitioned.","format":"uuid","type":"string"}},"required":["stage_identifier"],"type":"object"},"case-management_CaseStateTransitionRequest":{"deprecated":true,"description":"Case state update request.","properties":{"note":{"description":"Note: content to be associated with case transition. Only required if case transition is an end state.","example":"Case accepted after confirmation from user.","maxLength":5000,"minLength":0,"nullable":true,"type":"string"},"state":{"description":"Available state to transition a case.","enum":["ONBOARDING_NOT_STARTED","ONBOARDING_IN_PROGRESS","ONBOARDING_ESCALATED","ONBOARDING_BLOCKED","ONBOARDING_POSITIVE_END_STATE","ONBOARDING_MANAGEABLE_RISK_POSITIVE_END_STATE","ONBOARDING_NEGATIVE_END_STATE","MONITORING_NOT_STARTED","MONITORING_IN_PROGRESS","MONITORING_ESCALATED","MONITORING_BLOCKED","MONITORING_NO_RISK_DETECTED_POSITIVE_END_STATE","MONITORING_RISK_DETECTED_POSITIVE_END_STATE","MONITORING_RISK_DETECTED_NEGATIVE_END_STATE","PAYMENT_SCREENING_NOT_STARTED","PAYMENT_SCREENING_IN_PROGRESS","PAYMENT_SCREENING_ESCALATED","PAYMENT_SCREENING_BLOCKED","PAYMENT_SCREENING_AWAITING_INFORMATION","PAYMENT_SCREENING_PROCESS_PAYMENT_END_STATE","PAYMENT_SCREENING_REJECT_PAYMENT_END_STATE","TRANSACTION_MONITORING_NOT_STARTED","TRANSACTION_MONITORING_IN_PROGRESS","TRANSACTION_MONITORING_ESCALATED","TRANSACTION_MONITORING_BLOCKED","TRANSACTION_MONITORING_ACCEPTED_POSITIVE_END_STATE","TRANSACTION_MONITORING_ESCALATED_NEGATIVE_END_STATE"],"example":"ONBOARDING_POSITIVE_END_STATE","type":"string"}},"required":["state"],"type":"object"},"case-management_CaseStatesResponse":{"description":"Case state & type.","properties":{"case_type":{"description":"Case type.","enum":["CUSTOMER_ONBOARDING","CUSTOMER_MONITORING","PAYMENT_SCREENING","TRANSACTION_MONITORING"],"example":"CUSTOMER_ONBOARDING","type":"string"},"name":{"description":"The current state of the case.","enum":["ONBOARDING_NOT_STARTED","ONBOARDING_IN_PROGRESS","ONBOARDING_ESCALATED","ONBOARDING_BLOCKED","ONBOARDING_POSITIVE_END_STATE","ONBOARDING_MANAGEABLE_RISK_POSITIVE_END_STATE","ONBOARDING_NEGATIVE_END_STATE","MONITORING_NOT_STARTED","MONITORING_IN_PROGRESS","MONITORING_ESCALATED","MONITORING_BLOCKED","MONITORING_NO_RISK_DETECTED_POSITIVE_END_STATE","MONITORING_RISK_DETECTED_POSITIVE_END_STATE","MONITORING_RISK_DETECTED_NEGATIVE_END_STATE","PAYMENT_SCREENING_NOT_STARTED","PAYMENT_SCREENING_IN_PROGRESS","PAYMENT_SCREENING_ESCALATED","PAYMENT_SCREENING_BLOCKED","PAYMENT_SCREENING_AWAITING_INFORMATION","PAYMENT_SCREENING_PROCESS_PAYMENT_END_STATE","PAYMENT_SCREENING_REJECT_PAYMENT_END_STATE","TRANSACTION_MONITORING_NOT_STARTED","TRANSACTION_MONITORING_IN_PROGRESS","TRANSACTION_MONITORING_ESCALATED","TRANSACTION_MONITORING_BLOCKED","TRANSACTION_MONITORING_ACCEPTED_POSITIVE_END_STATE","TRANSACTION_MONITORING_ESCALATED_NEGATIVE_END_STATE","USER_DEFINED"],"example":"ONBOARDING_POSITIVE_END_STATE","type":"string"}},"required":["case_type","name"],"type":"object"},"case-management_CaseTransitionNoteResponse":{"description":"Note associated to a case state transition action.","properties":{"contents":{"description":"The contents of the note.","type":"string"},"created_at":{"description":"The date and time at which this note was created.","format":"date-time","type":"string"},"created_by":{"description":"The user identifier that created this note.","format":"uuid","type":"string"},"identifier":{"description":"Unique identifier of the note.","format":"uuid","type":"string"},"stage":{"$ref":"#/components/schemas/case-management_Stage"},"state":{"deprecated":true,"description":"Available state to transition a case.","enum":["ONBOARDING_NOT_STARTED","ONBOARDING_IN_PROGRESS","ONBOARDING_ESCALATED","ONBOARDING_BLOCKED","ONBOARDING_POSITIVE_END_STATE","ONBOARDING_MANAGEABLE_RISK_POSITIVE_END_STATE","ONBOARDING_NEGATIVE_END_STATE","MONITORING_NOT_STARTED","MONITORING_IN_PROGRESS","MONITORING_ESCALATED","MONITORING_BLOCKED","MONITORING_NO_RISK_DETECTED_POSITIVE_END_STATE","MONITORING_RISK_DETECTED_POSITIVE_END_STATE","MONITORING_RISK_DETECTED_NEGATIVE_END_STATE","PAYMENT_SCREENING_NOT_STARTED","PAYMENT_SCREENING_IN_PROGRESS","PAYMENT_SCREENING_ESCALATED","PAYMENT_SCREENING_BLOCKED","PAYMENT_SCREENING_AWAITING_INFORMATION","PAYMENT_SCREENING_PROCESS_PAYMENT_END_STATE","PAYMENT_SCREENING_REJECT_PAYMENT_END_STATE","TRANSACTION_MONITORING_NOT_STARTED","TRANSACTION_MONITORING_IN_PROGRESS","TRANSACTION_MONITORING_ESCALATED","TRANSACTION_MONITORING_BLOCKED","TRANSACTION_MONITORING_ACCEPTED_POSITIVE_END_STATE","TRANSACTION_MONITORING_ESCALATED_NEGATIVE_END_STATE","USER_DEFINED"],"example":"ONBOARDING_POSITIVE_END_STATE","type":"string"},"type":{"description":"Defines the type of a note.","enum":["CASE_TRANSITION"],"example":"CASE_TRANSITION","type":"string"}},"required":["contents","created_at","created_by","identifier","stage","state","type"],"type":"object"},"case-management_CaseTransitionRequest":{"oneOf":[{"$ref":"#/components/schemas/case-management_CaseStateTransitionRequest"},{"$ref":"#/components/schemas/case-management_CaseStageTransitionRequest"}],"type":"object"},"case-management_CaseTransitionResponse":{"description":"Case transition response.","properties":{"last_user_stage_identifier":{"description":"The stage identifier to which the case was last transitioned by a user.","format":"uuid","nullable":true,"type":"string"},"last_user_state":{"deprecated":true,"description":"The last state the case was transitioned to by a user (as opposed to a system action).\n\nFor those using the deprecated case_state, if any new case stages are added the case state response for these will be returned as  USER_DEFINED","enum":["ONBOARDING_NOT_STARTED","ONBOARDING_IN_PROGRESS","ONBOARDING_ESCALATED","ONBOARDING_BLOCKED","ONBOARDING_POSITIVE_END_STATE","ONBOARDING_MANAGEABLE_RISK_POSITIVE_END_STATE","ONBOARDING_NEGATIVE_END_STATE","MONITORING_NOT_STARTED","MONITORING_IN_PROGRESS","MONITORING_ESCALATED","MONITORING_BLOCKED","MONITORING_NO_RISK_DETECTED_POSITIVE_END_STATE","MONITORING_RISK_DETECTED_POSITIVE_END_STATE","MONITORING_RISK_DETECTED_NEGATIVE_END_STATE","PAYMENT_SCREENING_NOT_STARTED","PAYMENT_SCREENING_IN_PROGRESS","PAYMENT_SCREENING_ESCALATED","PAYMENT_SCREENING_BLOCKED","PAYMENT_SCREENING_AWAITING_INFORMATION","PAYMENT_SCREENING_PROCESS_PAYMENT_END_STATE","PAYMENT_SCREENING_REJECT_PAYMENT_END_STATE","TRANSACTION_MONITORING_NOT_STARTED","TRANSACTION_MONITORING_IN_PROGRESS","TRANSACTION_MONITORING_ESCALATED","TRANSACTION_MONITORING_BLOCKED","TRANSACTION_MONITORING_ACCEPTED_POSITIVE_END_STATE","TRANSACTION_MONITORING_ESCALATED_NEGATIVE_END_STATE","USER_DEFINED"],"example":"ONBOARDING_POSITIVE_END_STATE","nullable":true,"type":"string"},"stage_identifier":{"description":"The stage identifier to which the case has been transitioned.","format":"uuid","type":"string"},"state":{"deprecated":true,"description":"The current state of the case.\n\nFor those using the deprecated case_state, if any new case stages are added the case state response for these will be returned as USER_DEFINED","enum":["ONBOARDING_NOT_STARTED","ONBOARDING_IN_PROGRESS","ONBOARDING_ESCALATED","ONBOARDING_BLOCKED","ONBOARDING_POSITIVE_END_STATE","ONBOARDING_MANAGEABLE_RISK_POSITIVE_END_STATE","ONBOARDING_NEGATIVE_END_STATE","MONITORING_NOT_STARTED","MONITORING_IN_PROGRESS","MONITORING_ESCALATED","MONITORING_BLOCKED","MONITORING_NO_RISK_DETECTED_POSITIVE_END_STATE","MONITORING_RISK_DETECTED_POSITIVE_END_STATE","MONITORING_RISK_DETECTED_NEGATIVE_END_STATE","PAYMENT_SCREENING_NOT_STARTED","PAYMENT_SCREENING_IN_PROGRESS","PAYMENT_SCREENING_ESCALATED","PAYMENT_SCREENING_BLOCKED","PAYMENT_SCREENING_AWAITING_INFORMATION","PAYMENT_SCREENING_PROCESS_PAYMENT_END_STATE","PAYMENT_SCREENING_REJECT_PAYMENT_END_STATE","TRANSACTION_MONITORING_NOT_STARTED","TRANSACTION_MONITORING_IN_PROGRESS","TRANSACTION_MONITORING_ESCALATED","TRANSACTION_MONITORING_BLOCKED","TRANSACTION_MONITORING_ACCEPTED_POSITIVE_END_STATE","TRANSACTION_MONITORING_ESCALATED_NEGATIVE_END_STATE","USER_DEFINED"],"example":"ONBOARDING_POSITIVE_END_STATE","type":"string"},"updated_at":{"description":"The date and time at which this case was last updated.","format":"date-time","type":"string"},"updated_by":{"description":"The user identifier that last updated this case.","format":"uuid","nullable":true,"type":"string"}},"required":["stage_identifier","state","updated_at"],"type":"object"},"case-management_CompanySubject":{"description":"Company customer subject.","properties":{"detail":{"$ref":"#/components/schemas/case-management_CompanySubjectDetail"},"external_identifier":{"description":"Customer external identifier.","nullable":true,"type":"string"},"identifier":{"description":"Customer unique identifier.","format":"uuid","type":"string"},"name":{"description":"Customer name.","type":"string"},"risk_level":{"description":"Customer current risk level.","enum":["LOW","MEDIUM","HIGH","PROHIBITED","SKIPPED"],"nullable":true,"type":"string"},"type":{"enum":["CUSTOMER"],"example":"CUSTOMER","type":"string"},"version":{"description":"Customer version.","format":"int32","type":"integer"}},"required":["detail","identifier","name","type","version"],"type":"object"},"case-management_CompanySubjectDetail":{"description":"Company customer subject detail.","properties":{"type":{"enum":["COMPANY"],"example":"COMPANY","type":"string"}},"required":["type"],"type":"object"},"case-management_CounterpartySubject":{"description":"Counterparty subject.","properties":{"external_identifier":{"description":"Counterparty external identifier.","type":"string"},"name":{"description":"Counterparty name.","nullable":true,"type":"string"},"type":{"enum":["COUNTERPARTY"],"example":"COUNTERPARTY","type":"string"}},"required":["external_identifier","type"],"type":"object"},"case-management_CreateCaseNoteRequest":{"description":"Create case note request.","properties":{"contents":{"description":"The contents of the note to be created (up to 5000 characters).","maxLength":5000,"minLength":0,"type":"string"}},"required":["contents"],"type":"object"},"case-management_CreateCasesNoteRequest":{"description":"Add note to multiple cases (bulk action).","properties":{"payload":{"$ref":"#/components/schemas/case-management_BulkActionPayloadNote"},"query":{"$ref":"#/components/schemas/case-management_BulkActionQuery"}},"required":["payload","query"],"type":"object"},"case-management_CryptoPaymentSubject":{"description":"Transaction subject as a crypto payment.","properties":{"detail":{"$ref":"#/components/schemas/case-management_CryptoPaymentSubjectDetail"},"external_identifier":{"description":"Transaction external identifier.","type":"string"},"identifier":{"description":"Transaction unique identifier.","format":"uuid","type":"string"},"type":{"enum":["TRANSACTION"],"example":"TRANSACTION","type":"string"}},"required":["detail","external_identifier","identifier","type"],"type":"object"},"case-management_CryptoPaymentSubjectDetail":{"description":"Crypto payment subject detail.","properties":{"type":{"enum":["CRYPTO"],"example":"CRYPTO","type":"string"}},"required":["type"],"type":"object"},"case-management_CryptoPaymentSummaryResponse":{"description":"Summary of a Crypto Payment.","properties":{"external_identifier":{"description":"Payment external identifier.","type":"string"},"identifier":{"description":"Payment unique identifier.","format":"uuid","type":"string"},"type":{"description":"Payment type.","enum":["CRYPTO"],"example":"CRYPTO","type":"string"}},"required":["external_identifier","identifier","type"],"type":"object"},"case-management_CustomerSubject":{"description":"Customer subject.","discriminator":{"mapping":{"COMPANY":"#/components/schemas/case-management_CompanySubject","PERSON":"#/components/schemas/case-management_PersonSubject","UNDEFINED":"#/components/schemas/case-management_UndefinedSubject"},"propertyName":"detail.type"},"oneOf":[{"$ref":"#/components/schemas/case-management_PersonSubject"},{"$ref":"#/components/schemas/case-management_CompanySubject"},{"$ref":"#/components/schemas/case-management_UndefinedSubject"}],"type":"object"},"case-management_ExistingStage":{"description":"The existing Stage to be updated or remain unchanged","properties":{"decision_type":{"description":"The decision type of the stage (decision stages only).","enum":["POSITIVE","NEGATIVE","PARTIAL_POSITIVE"],"nullable":true,"type":"string"},"display_name":{"description":"The display name of the stage.","maxLength":30,"minLength":3,"type":"string"},"display_order":{"description":"The display order of the stage.","format":"int32","minimum":1,"type":"integer"},"identifier":{"description":"Stage identifier.","format":"uuid","type":"string"},"stage_type":{"description":"The type of the stage.","enum":["INITIAL","REVIEW","DECISION"],"type":"string"}},"required":["display_name","display_order","identifier","stage_type"],"type":"object"},"case-management_NewStage":{"additionalProperties":false,"description":"The stage to be created","properties":{"decision_type":{"description":"The decision type of the stage (decision stages only).","enum":["POSITIVE","NEGATIVE","PARTIAL_POSITIVE"],"nullable":true,"type":"string"},"display_name":{"description":"The display name of the stage.","maxLength":30,"minLength":3,"type":"string"},"display_order":{"description":"The display order of the stage.","format":"int32","minimum":1,"type":"integer"},"stage_type":{"description":"The type of the stage.","enum":["INITIAL","REVIEW","DECISION"],"type":"string"}},"required":["display_name","display_order","stage_type"],"type":"object"},"case-management_NoteResponse":{"description":"Base note model.","discriminator":{"mapping":{"CASE":"#/components/schemas/case-management_CaseNoteResponse","CASE_ASSIGNMENT":"#/components/schemas/case-management_CaseAssignmentNoteResponse","CASE_TRANSITION":"#/components/schemas/case-management_CaseTransitionNoteResponse"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/case-management_CaseNoteResponse"},{"$ref":"#/components/schemas/case-management_CaseAssignmentNoteResponse"},{"$ref":"#/components/schemas/case-management_CaseTransitionNoteResponse"}],"properties":{"contents":{"description":"The contents of the note.","type":"string"},"created_at":{"description":"The date and time at which this note was created.","format":"date-time","type":"string"},"created_by":{"description":"The user identifier that created this note.","format":"uuid","type":"string"},"identifier":{"description":"Unique identifier of the note.","format":"uuid","type":"string"},"type":{"description":"Defines the type of a note.","enum":["CASE","CASE_ASSIGNMENT","CASE_TRANSITION"],"type":"string"}},"required":["contents","created_at","created_by","identifier","type"],"type":"object"},"case-management_PaginatedResponseCaseAlertResponseV2":{"properties":{"alerts":{"items":{"$ref":"#/components/schemas/case-management_CaseAlertResponseV2"},"type":"array"},"first":{"description":"The URL path to the first page.","example":"/v1/resource?page_number=1","type":"string"},"next":{"description":"The URL path to the next page.","example":"/v1/resource?page_number=4","nullable":true,"type":"string"},"prev":{"description":"The URL path to the previous page.","example":"/v1/resource?page_number=2","nullable":true,"type":"string"},"self":{"description":"The URL path to the current page.","example":"/v1/resource?page_number=3","type":"string"},"total_count":{"description":"Total number of items.","example":60,"format":"int64","nullable":true,"type":"integer"}},"required":["first","self","alerts"],"type":"object"},"case-management_PaginatedResponseCaseResponse":{"properties":{"cases":{"items":{"$ref":"#/components/schemas/case-management_CaseResponse"},"type":"array"},"first":{"description":"The URL path to the first page.","example":"/v1/resource?page_number=1","type":"string"},"next":{"description":"The URL path to the next page.","example":"/v1/resource?page_number=4","nullable":true,"type":"string"},"prev":{"description":"The URL path to the previous page.","example":"/v1/resource?page_number=2","nullable":true,"type":"string"},"self":{"description":"The URL path to the current page.","example":"/v1/resource?page_number=3","type":"string"},"total_count":{"description":"Total number of items.","example":60,"format":"int64","nullable":true,"type":"integer"}},"required":["first","self","cases"],"type":"object"},"case-management_PaginatedResponseCaseResultResponse":{"properties":{"cases":{"items":{"$ref":"#/components/schemas/case-management_CaseResultResponse"},"type":"array"},"first":{"description":"The URL path to the first page.","example":"/v1/resource?page_number=1","type":"string"},"next":{"description":"The URL path to the next page.","example":"/v1/resource?page_number=4","nullable":true,"type":"string"},"prev":{"description":"The URL path to the previous page.","example":"/v1/resource?page_number=2","nullable":true,"type":"string"},"self":{"description":"The URL path to the current page.","example":"/v1/resource?page_number=3","type":"string"},"total_count":{"description":"Total number of items.","example":60,"format":"int64","nullable":true,"type":"integer"}},"required":["first","self","cases"],"type":"object"},"case-management_PaginatedResponseCaseStatesResponse":{"properties":{"case_states":{"items":{"$ref":"#/components/schemas/case-management_CaseStatesResponse"},"type":"array"},"first":{"description":"The URL path to the first page.","example":"/v1/resource?page_number=1","type":"string"},"next":{"description":"The URL path to the next page.","example":"/v1/resource?page_number=4","nullable":true,"type":"string"},"prev":{"description":"The URL path to the previous page.","example":"/v1/resource?page_number=2","nullable":true,"type":"string"},"self":{"description":"The URL path to the current page.","example":"/v1/resource?page_number=3","type":"string"},"total_count":{"description":"Total number of items.","example":60,"format":"int64","nullable":true,"type":"integer"}},"required":["first","self","case_states"],"type":"object"},"case-management_PaginatedResponseNoteResponse":{"properties":{"first":{"description":"The URL path to the first page.","example":"/v1/resource?page_number=1","type":"string"},"next":{"description":"The URL path to the next page.","example":"/v1/resource?page_number=4","nullable":true,"type":"string"},"notes":{"items":{"$ref":"#/components/schemas/case-management_NoteResponse"},"type":"array"},"prev":{"description":"The URL path to the previous page.","example":"/v1/resource?page_number=2","nullable":true,"type":"string"},"self":{"description":"The URL path to the current page.","example":"/v1/resource?page_number=3","type":"string"},"total_count":{"description":"Total number of items.","example":60,"format":"int64","nullable":true,"type":"integer"}},"required":["first","self","notes"],"type":"object"},"case-management_PaginatedResponseWorkflowResponse":{"properties":{"first":{"description":"The URL path to the first page.","example":"/v1/resource?page_number=1","type":"string"},"next":{"description":"The URL path to the next page.","example":"/v1/resource?page_number=4","nullable":true,"type":"string"},"prev":{"description":"The URL path to the previous page.","example":"/v1/resource?page_number=2","nullable":true,"type":"string"},"self":{"description":"The URL path to the current page.","example":"/v1/resource?page_number=3","type":"string"},"total_count":{"description":"Total number of items.","example":60,"format":"int64","nullable":true,"type":"integer"},"workflows":{"items":{"$ref":"#/components/schemas/case-management_WorkflowResponse"},"type":"array"}},"required":["first","self","workflows"],"type":"object"},"case-management_PaymentSummaryResponse":{"description":"Summary of payment information.","oneOf":[{"$ref":"#/components/schemas/case-management_BankPaymentSummaryResponse"},{"$ref":"#/components/schemas/case-management_CardPaymentSummaryResponse"},{"$ref":"#/components/schemas/case-management_RemittancePaymentSummaryResponse"},{"$ref":"#/components/schemas/case-management_CryptoPaymentSummaryResponse"}],"type":"object"},"case-management_PersonSubject":{"description":"Person customer subject.","properties":{"detail":{"$ref":"#/components/schemas/case-management_PersonSubjectDetail"},"external_identifier":{"description":"Customer external identifier.","nullable":true,"type":"string"},"identifier":{"description":"Customer unique identifier.","format":"uuid","type":"string"},"name":{"description":"Customer name.","type":"string"},"risk_level":{"description":"Customer current risk level.","enum":["LOW","MEDIUM","HIGH","PROHIBITED","SKIPPED"],"nullable":true,"type":"string"},"type":{"enum":["CUSTOMER"],"example":"CUSTOMER","type":"string"},"version":{"description":"Customer version.","format":"int32","type":"integer"}},"required":["detail","identifier","name","type","version"],"type":"object"},"case-management_PersonSubjectDetail":{"description":"Person customer subject detail.","properties":{"type":{"enum":["PERSON"],"example":"PERSON","type":"string"}},"required":["type"],"type":"object"},"case-management_ProblemDetailErrorResponse":{"additionalProperties":true,"properties":{"detail":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","type":"string"},"instance":{"format":"uri","nullable":true,"type":"string"},"status":{"format":"int32","nullable":true,"type":"integer"},"timestamp":{"format":"date-time","type":"string"},"title":{"nullable":true,"type":"string"},"type":{"format":"uri","nullable":true,"type":"string"}},"required":["identifier","timestamp"],"type":"object"},"case-management_RemittancePaymentSubject":{"description":"Transaction subject as a remittance payment.","properties":{"detail":{"$ref":"#/components/schemas/case-management_RemittancePaymentSubjectDetail"},"external_identifier":{"description":"Transaction external identifier.","type":"string"},"identifier":{"description":"Transaction unique identifier.","format":"uuid","type":"string"},"type":{"enum":["TRANSACTION"],"example":"TRANSACTION","type":"string"}},"required":["detail","external_identifier","identifier","type"],"type":"object"},"case-management_RemittancePaymentSubjectDetail":{"description":"Remittance payment subject detail.","properties":{"type":{"enum":["REMITTANCE"],"example":"REMITTANCE","type":"string"}},"required":["type"],"type":"object"},"case-management_RemittancePaymentSummaryResponse":{"description":"Summary of a Remittance Payment.","properties":{"external_identifier":{"description":"Payment external identifier.","type":"string"},"identifier":{"description":"Payment unique identifier.","format":"uuid","type":"string"},"type":{"description":"Payment type.","enum":["REMITTANCE"],"example":"REMITTANCE","type":"string"}},"required":["external_identifier","identifier","type"],"type":"object"},"case-management_RiskCatalogResponse":{"description":"Risk catalog response containing catalog key and associated risk types.","properties":{"catalog_key":{"description":"Unique key for the risk catalog","type":"string"},"risk_types":{"description":"List of risk types associated with this risk catalog","items":{"$ref":"#/components/schemas/case-management_RiskCatalogRiskTypesResponse"},"type":"array"}},"required":["catalog_key","risk_types"],"type":"object"},"case-management_RiskCatalogRiskTypesResponse":{"description":"Risk type.","properties":{"key":{"description":"Unique key for the risk type","type":"string"}},"required":["key"],"type":"object"},"case-management_RiskTypesChildResponse":{"description":"Risk child.","properties":{"name":{"description":"Risk child name.","enum":["ADVERSE_MEDIA_CYBERCRIME","ADVERSE_MEDIA_EU_AML_DIRECTIVE","ADVERSE_MEDIA_FINANCIAL_AML_CFT","ADVERSE_MEDIA_FINANCIAL_CRIME","ADVERSE_MEDIA_FINANCIAL_DIFFICULTY","ADVERSE_MEDIA_FRAUD_LINKED","ADVERSE_MEDIA_FRAUD","ADVERSE_MEDIA_GENERAL_AML_CFT","ADVERSE_MEDIA_GENERAL","ADVERSE_MEDIA_HIGH_RISK","ADVERSE_MEDIA_NARCOTICS_AML_CFT","ADVERSE_MEDIA_NARCOTICS","ADVERSE_MEDIA_OTHER_FINANCIAL","ADVERSE_MEDIA_OTHER_MINOR","ADVERSE_MEDIA_OTHER_SERIOUS","ADVERSE_MEDIA_PROPERTY","ADVERSE_MEDIA_REGULATORY","ADVERSE_MEDIA_SEXUAL_CRIME","ADVERSE_MEDIA_TERRORISM","ADVERSE_MEDIA_VIOLENCE_AML_CFT","ADVERSE_MEDIA_VIOLENCE_NON_AML_CFT","ADVERSE_MEDIA_VIOLENT_CRIME","ADVERSE_MEDIA","FITNESS_PROBITY","PEP_CLASS_1_TO_3","PEP_CLASS_1","PEP_CLASS_2","PEP_CLASS_3","PEP_CLASS_4","PEP","SANCTION_RELATED","SANCTION","WARNING"],"type":"string"}},"required":["name"],"type":"object"},"case-management_RiskTypesResponse":{"description":"Risk reference.","properties":{"children":{"description":"Risk type children. Only PEP and ADVERSE_MEDIA risk types have child objects.","items":{"$ref":"#/components/schemas/case-management_RiskTypesChildResponse"},"type":"array"},"name":{"description":"Risk type name.","enum":["ADVERSE_MEDIA_CYBERCRIME","ADVERSE_MEDIA_EU_AML_DIRECTIVE","ADVERSE_MEDIA_FINANCIAL_AML_CFT","ADVERSE_MEDIA_FINANCIAL_CRIME","ADVERSE_MEDIA_FINANCIAL_DIFFICULTY","ADVERSE_MEDIA_FRAUD_LINKED","ADVERSE_MEDIA_FRAUD","ADVERSE_MEDIA_GENERAL_AML_CFT","ADVERSE_MEDIA_GENERAL","ADVERSE_MEDIA_HIGH_RISK","ADVERSE_MEDIA_NARCOTICS_AML_CFT","ADVERSE_MEDIA_NARCOTICS","ADVERSE_MEDIA_OTHER_FINANCIAL","ADVERSE_MEDIA_OTHER_MINOR","ADVERSE_MEDIA_OTHER_SERIOUS","ADVERSE_MEDIA_PROPERTY","ADVERSE_MEDIA_REGULATORY","ADVERSE_MEDIA_SEXUAL_CRIME","ADVERSE_MEDIA_TERRORISM","ADVERSE_MEDIA_VIOLENCE_AML_CFT","ADVERSE_MEDIA_VIOLENCE_NON_AML_CFT","ADVERSE_MEDIA_VIOLENT_CRIME","ADVERSE_MEDIA","FITNESS_PROBITY","PEP_CLASS_1_TO_3","PEP_CLASS_1","PEP_CLASS_2","PEP_CLASS_3","PEP_CLASS_4","PEP","SANCTION_RELATED","SANCTION","WARNING"],"type":"string"},"priority":{"description":"Risk type priority. This can be used to sort cases by priority.\nPriorities are:\n1. ADVERSE_MEDIA\n2. FITNESS_PROBITY\n3. WARNING\n4. PEP\n5. SANCTION_RELATED\n6. SANCTION","format":"int32","type":"integer"}},"required":["children","name","priority"],"type":"object"},"case-management_Stage":{"description":"Stage","properties":{"decision_type":{"description":"The decision type of the stage (decision stages only).","enum":["POSITIVE","NEGATIVE","PARTIAL_POSITIVE"],"nullable":true,"type":"string"},"display_name":{"description":"The display name of the stage.","maxLength":30,"minLength":3,"type":"string"},"display_order":{"description":"The display order of the stage.","format":"int32","minimum":1,"type":"integer"},"identifier":{"description":"Stage unique identifier.","format":"uuid","type":"string"},"stage_type":{"description":"The type of the stage.","enum":["INITIAL","REVIEW","DECISION"],"type":"string"}},"required":["display_name","display_order","identifier","stage_type"],"type":"object"},"case-management_StageData":{"oneOf":[{"$ref":"#/components/schemas/case-management_ExistingStage"},{"$ref":"#/components/schemas/case-management_NewStage"}],"type":"object"},"case-management_Subject":{"description":"Case subject.","discriminator":{"mapping":{"COUNTERPARTY":"#/components/schemas/case-management_CounterpartySubject","CUSTOMER":"#/components/schemas/case-management_CustomerSubject","TRANSACTION":"#/components/schemas/case-management_TransactionSubject"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/case-management_CustomerSubject"},{"$ref":"#/components/schemas/case-management_TransactionSubject"},{"$ref":"#/components/schemas/case-management_CounterpartySubject"}],"properties":{"type":{"description":"The type of the subject.","enum":["CUSTOMER","TRANSACTION","COUNTERPARTY"],"example":"CUSTOMER","type":"string"}},"required":["type"],"type":"object"},"case-management_TransactionSubject":{"description":"Transaction subject.","discriminator":{"mapping":{"BANK_PAYMENT":"#/components/schemas/case-management_BankPaymentSubject","CARD_PAYMENT":"#/components/schemas/case-management_CardPaymentSubject","CRYPTO":"#/components/schemas/case-management_CryptoPaymentSubject","REMITTANCE":"#/components/schemas/case-management_RemittancePaymentSubject"},"propertyName":"detail.type"},"oneOf":[{"$ref":"#/components/schemas/case-management_BankPaymentSubject"},{"$ref":"#/components/schemas/case-management_CardPaymentSubject"},{"$ref":"#/components/schemas/case-management_RemittancePaymentSubject"},{"$ref":"#/components/schemas/case-management_CryptoPaymentSubject"}],"type":"object"},"case-management_TransitionCaseBulkActionPayload":{"oneOf":[{"$ref":"#/components/schemas/case-management_TransitionCaseStateBulkActionPayload"},{"$ref":"#/components/schemas/case-management_TransitionCaseStageBulkActionPayload"}],"type":"object"},"case-management_TransitionCaseStageBulkActionPayload":{"properties":{"note":{"description":"Note: content to be associated with case transition. Only required if case transition is an end stage.","example":"Case accepted after confirmation from company.","maxLength":5000,"minLength":0,"nullable":true,"type":"string"},"stage_identifier":{"description":"The stage identifier to which the cases should be transitioned. To get this identifier for the API call, you can find it within the responses of either the 'Get list of case workflows' or 'Get a specific case workflow' endpoints.","format":"uuid","type":"string"}},"required":["stage_identifier"],"type":"object"},"case-management_TransitionCaseStateBulkActionPayload":{"deprecated":true,"properties":{"note":{"deprecated":true,"description":"Note: content to be associated with case transition. Only required if case transition is an end state.","example":"Case accepted after confirmation from company.","maxLength":5000,"minLength":0,"nullable":true,"type":"string"},"state":{"deprecated":true,"description":"Note: Fixed case states are deprecated and replaced with case stages as part of a configurable case workflow.\n\nAvailable state to transition a case.","enum":["ONBOARDING_NOT_STARTED","ONBOARDING_IN_PROGRESS","ONBOARDING_ESCALATED","ONBOARDING_BLOCKED","ONBOARDING_POSITIVE_END_STATE","ONBOARDING_MANAGEABLE_RISK_POSITIVE_END_STATE","ONBOARDING_NEGATIVE_END_STATE","MONITORING_NOT_STARTED","MONITORING_IN_PROGRESS","MONITORING_ESCALATED","MONITORING_BLOCKED","MONITORING_NO_RISK_DETECTED_POSITIVE_END_STATE","MONITORING_RISK_DETECTED_POSITIVE_END_STATE","MONITORING_RISK_DETECTED_NEGATIVE_END_STATE","PAYMENT_SCREENING_NOT_STARTED","PAYMENT_SCREENING_IN_PROGRESS","PAYMENT_SCREENING_ESCALATED","PAYMENT_SCREENING_BLOCKED","PAYMENT_SCREENING_AWAITING_INFORMATION","PAYMENT_SCREENING_PROCESS_PAYMENT_END_STATE","PAYMENT_SCREENING_REJECT_PAYMENT_END_STATE","TRANSACTION_MONITORING_NOT_STARTED","TRANSACTION_MONITORING_IN_PROGRESS","TRANSACTION_MONITORING_ESCALATED","TRANSACTION_MONITORING_BLOCKED","TRANSACTION_MONITORING_ACCEPTED_POSITIVE_END_STATE","TRANSACTION_MONITORING_ESCALATED_NEGATIVE_END_STATE"],"example":"ONBOARDING_POSITIVE_END_STATE","type":"string"}},"required":["state"],"type":"object"},"case-management_TransitionCasesRequest":{"description":"Bulk action for case state transition.","properties":{"payload":{"$ref":"#/components/schemas/case-management_TransitionCaseBulkActionPayload"},"query":{"$ref":"#/components/schemas/case-management_BulkActionQuery"}},"required":["payload","query"],"type":"object"},"case-management_UndefinedSubject":{"description":"Undefined customer subject.","properties":{"detail":{"$ref":"#/components/schemas/case-management_UndefinedSubjectDetail"},"external_identifier":{"description":"Customer external identifier.","nullable":true,"type":"string"},"identifier":{"description":"Customer unique identifier.","format":"uuid","type":"string"},"name":{"description":"Customer name.","type":"string"},"risk_level":{"description":"Customer current risk level.","enum":["LOW","MEDIUM","HIGH","PROHIBITED","SKIPPED"],"nullable":true,"type":"string"},"type":{"enum":["CUSTOMER"],"example":"CUSTOMER","type":"string"},"version":{"description":"Customer version.","format":"int32","type":"integer"}},"required":["detail","identifier","name","type","version"],"type":"object"},"case-management_UndefinedSubjectDetail":{"description":"Undefined customer subject detail.","properties":{"type":{"enum":["UNDEFINED"],"example":"UNDEFINED","type":"string"}},"required":["type"],"type":"object"},"case-management_UpdateWorkflowRequest":{"properties":{"alert_grouping_enabled":{"description":"Clients can enable or disable grouping of multiple alerts in a case via this configuration. When enabled, if new alerts are generated, these will continue to group within an existing open case rather than trigger the creation of new cases. We recommend that this configuration must always remain enabled for Transaction monitoring cases, as having alerts grouped in a single case provides an overall view of alert activity for a given customer or counterparty.","nullable":true,"type":"boolean"},"stages":{"items":{"$ref":"#/components/schemas/case-management_StageData"},"type":"array"}},"required":["stages"],"type":"object"},"case-management_WorkflowResponse":{"description":"Workflow","properties":{"alert_grouping_enabled":{"description":"Clients can enable or disable grouping of multiple alerts in a case via this configuration. When enabled, if new alerts are generated, these will continue to group within an existing open case rather than trigger the creation of new cases. We recommend that this configuration must always remain enabled for Transaction monitoring cases, as having alerts grouped in a single case provides an overall view of alert activity for a given customer or counterparty.","type":"boolean"},"case_type":{"description":"The type of the case to which the workflow applies.","enum":["CUSTOMER_ONBOARDING","CUSTOMER_MONITORING","PAYMENT_SCREENING","TRANSACTION_MONITORING"],"type":"string"},"created_at":{"description":"Workflow created date and time.","format":"date-time","type":"string"},"created_by":{"description":"User identifier that created the workflow; null if created by a system action.","format":"uuid","nullable":true,"type":"string"},"identifier":{"description":"Workflow unique identifier.","format":"uuid","type":"string"},"stages":{"description":"List of all stages in the workflow.","items":{"$ref":"#/components/schemas/case-management_Stage"},"type":"array"},"version":{"description":"The version of the workflow.","format":"int32","type":"integer"}},"required":["alert_grouping_enabled","case_type","created_at","identifier","stages","version"],"type":"object"},"cert_PaginatedResponseReport":{"properties":{"first":{"description":"The URL path to the first page.","example":"/v1/resource?page_number=1","type":"string"},"next":{"description":"The URL path to the next page.","example":"/v1/resource?page_number=4","nullable":true,"type":"string"},"prev":{"description":"The URL path to the previous page.","example":"/v1/resource?page_number=2","nullable":true,"type":"string"},"reports":{"items":{"$ref":"#/components/schemas/cert_Report"},"nullable":true,"type":"array"},"self":{"description":"The URL path to the current page.","example":"/v1/resource?page_number=3","type":"string"},"total_count":{"description":"Total number of items.","example":60,"format":"int64","nullable":true,"type":"integer"}},"required":["first","self"],"type":"object"},"cert_ProblemDetailErrorResponse":{"additionalProperties":true,"properties":{"detail":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","type":"string"},"instance":{"format":"uri","nullable":true,"type":"string"},"status":{"format":"int32","nullable":true,"type":"integer"},"timestamp":{"format":"date-time","type":"string"},"title":{"nullable":true,"type":"string"},"type":{"format":"uri","nullable":true,"type":"string"}},"required":["identifier","timestamp"],"type":"object"},"cert_Report":{"properties":{"created_at":{"description":"Timestamp at which the report was generated","format":"date-time","type":"string"},"created_by":{"description":"User that generated the report","format":"uuid","type":"string"},"download_url":{"description":"The type of report being downloaded","example":"https://example.com","nullable":true,"type":"string"},"expires_at":{"description":"Timestamp at which the download_url expires","format":"date-time","type":"string"},"report_type":{"description":"Url to download the certificate","enum":["SCREENING_REPORT"],"type":"string"},"status":{"description":"Status of the report","enum":["READY","NOT_READY"],"type":"string"}},"required":["created_at","created_by","expires_at","report_type","status"],"type":"object"},"cert_ReportsRequest":{"properties":{"report_type":{"enum":["SCREENING_REPORT"],"type":"string"}},"required":["report_type"],"type":"object"},"customer-manager_Address":{"properties":{"address_line1":{"maxLength":150,"minLength":0,"nullable":true,"type":"string"},"address_line2":{"maxLength":150,"minLength":0,"nullable":true,"type":"string"},"country":{"enum":["AF","AX","AL","AN","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","MK","RO","RU","RW","RE","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","US","UY","UZ","VU","VE","VN","VG","VI","WF","EH","XK","XT","XX","YE","ZM","ZW"],"format":"iso-3166-alpha-2","nullable":true,"type":"string"},"country_subdivision":{"maxLength":50,"minLength":0,"nullable":true,"type":"string"},"postal_code":{"maxLength":50,"minLength":0,"nullable":true,"type":"string"},"town_name":{"maxLength":50,"minLength":0,"nullable":true,"type":"string"},"type":{"enum":["RESIDENTIAL_ADDRESS","MAILING_ADDRESS","OPERATING_ADDRESS","REGISTRATION_ADDRESS","BILLING_ADDRESS"],"nullable":true,"type":"string"}},"type":"object"},"customer-manager_Bank":{"properties":{"bic":{"maxLength":11,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"customer-manager_BankAccount":{"allOf":[{"properties":{"account_number":{"maxLength":34,"minLength":0,"type":"string"},"bank":{"$ref":"#/components/schemas/customer-manager_Bank"},"bban":{"maxLength":30,"minLength":0,"type":"string"},"iban":{"type":"string"},"sort_code":{"maxLength":11,"minLength":0,"type":"string"}},"type":"object"}],"type":"object"},"customer-manager_Company":{"allOf":[{"properties":{"address":{"items":{"$ref":"#/components/schemas/customer-manager_Address"},"type":"array"},"alias":{"items":{"type":"string"},"type":"array"},"company_type":{"maxLength":50,"minLength":0,"type":"string"},"custom_fields":{"items":{"$ref":"#/components/schemas/customer-manager_CustomFieldInstance"},"type":"array"},"incorporation_date":{"$ref":"#/components/schemas/customer-manager_Date"},"industry":{"maxLength":50,"minLength":0,"type":"string"},"legal_name":{"maxLength":256,"minLength":0,"type":"string"},"place_of_registration":{"format":"iso-3166-2","maxLength":6,"minLength":2,"type":"string"},"registration_authority_identification":{"maxLength":50,"minLength":0,"type":"string"},"source_of_income":{"maxLength":50,"minLength":0,"type":"string"},"status_summary":{"enum":["UNKNOWN","ACTIVE","INACTIVE"],"type":"string"}},"type":"object"}],"required":["legal_name"],"type":"object"},"customer-manager_CompanyForSearch":{"properties":{"legal_name":{"type":"string"}},"required":["legal_name"],"type":"object"},"customer-manager_ContactInformation":{"properties":{"email_address":{"items":{"type":"string"},"nullable":true,"type":"array"},"fax_number":{"items":{"type":"string"},"nullable":true,"type":"array"},"phone_number":{"items":{"type":"string"},"nullable":true,"type":"array"},"url":{"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"},"customer-manager_CreateCustomFieldRequest":{"properties":{"customer_type":{"enum":["PERSON","COMPANY","VESSEL","UNDEFINED"],"type":"string"},"data_type":{"$ref":"#/components/schemas/customer-manager_CustomFieldDataType"},"display_name":{"maxLength":50,"minLength":0,"type":"string"},"key":{"maxLength":50,"minLength":0,"type":"string"}},"required":["customer_type","data_type","display_name","key"],"type":"object"},"customer-manager_CryptoWallet":{"allOf":[{"properties":{"managing_exchange":{"maxLength":50,"minLength":0,"type":"string"},"wallet_identifier":{"maxLength":256,"minLength":0,"type":"string"}},"type":"object"}],"type":"object"},"customer-manager_CustomField":{"description":"List of custom fields.","properties":{"customer_type":{"enum":["PERSON","COMPANY","VESSEL"],"type":"string"},"data_type":{"$ref":"#/components/schemas/customer-manager_CustomFieldDataType"},"display_name":{"type":"string"},"identifier":{"format":"uuid","type":"string"},"key":{"type":"string"}},"required":["customer_type","data_type","display_name","identifier","key"],"type":"object"},"customer-manager_CustomFieldDataType":{"description":"The type of data stored in a custom field.","enum":["TEXT","INTEGER","DECIMAL"],"type":"string"},"customer-manager_CustomFieldInstance":{"description":"The instance of a custom field as it relates to a specific customer.","properties":{"key":{"description":"The key of the custom field.","example":"field_key","type":"string"},"value":{"oneOf":[{"$ref":"#/components/schemas/customer-manager_DecimalValue"},{"$ref":"#/components/schemas/customer-manager_IntegerValue"},{"$ref":"#/components/schemas/customer-manager_TextValue"}]}},"required":["key","value"],"type":"object"},"customer-manager_CustomFieldValue":{"description":"The value of the custom field.","discriminator":{"mapping":{"DECIMAL":"#/components/schemas/customer-manager_DecimalValue","INTEGER":"#/components/schemas/customer-manager_IntegerValue","TEXT":"#/components/schemas/customer-manager_TextValue"},"propertyName":"data_type"},"properties":{"data_type":{"$ref":"#/components/schemas/customer-manager_CustomFieldDataType"}},"required":["data_type"],"type":"object"},"customer-manager_CustomerEntityScreeningMonitoring":{"properties":{"configuration_identifier":{"description":"The identifier of the screening monitor configuration","example":"0f17930c-a4e6-4fef-b913-6a12ad5afd12","format":"uuid","nullable":true,"type":"string"},"enabled":{"type":"boolean"}},"required":["enabled"],"type":"object"},"customer-manager_CustomerEntityScreeningMonitoringApi":{"properties":{"configuration_identifier":{"description":"The identifier of the screening monitor configuration","example":"0f17930c-a4e6-4fef-b913-6a12ad5afd12","format":"uuid","nullable":true,"type":"string"},"enabled":{"nullable":true,"type":"boolean"}},"type":"object"},"customer-manager_CustomerForSearch":{"properties":{"acquisition_source":{"nullable":true,"type":"string"},"company":{"$ref":"#/components/schemas/customer-manager_CompanyForSearch"},"created_at":{"format":"date-time","nullable":true,"type":"string"},"customer_identifier":{"format":"uuid","type":"string"},"external_identifier":{"nullable":true,"type":"string"},"monitor":{"$ref":"#/components/schemas/customer-manager_MonitorStatus"},"person":{"$ref":"#/components/schemas/customer-manager_PersonForSearch"},"scores":{"$ref":"#/components/schemas/customer-manager_RiskScore"},"status":{"enum":["ACTIVE","CLOSED","PROCESSING"],"nullable":true,"type":"string"},"undefined_customer_type":{"$ref":"#/components/schemas/customer-manager_UndefinedForSearch"},"updated_at":{"format":"date-time","nullable":true,"type":"string"},"vessel":{"$ref":"#/components/schemas/customer-manager_VesselForSearch"}},"required":["customer_identifier"],"type":"object"},"customer-manager_CustomerMonitoringData":{"properties":{"entity_screening":{"$ref":"#/components/schemas/customer-manager_CustomerEntityScreeningMonitoring"}},"type":"object"},"customer-manager_CustomerMonitoringDataApi":{"properties":{"entity_screening":{"$ref":"#/components/schemas/customer-manager_CustomerEntityScreeningMonitoringApi"}},"required":["entity_screening"],"type":"object"},"customer-manager_CustomerTypeUndefined":{"allOf":[{"properties":{"birth_year":{"format":"int32","type":"integer"},"country":{"format":"iso-3166-alpha-2","items":{"enum":["AF","AX","AL","AN","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","MK","RO","RU","RW","RE","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","US","UY","UZ","VU","VE","VN","VG","VI","WF","EH","XK","XT","XX","YE","ZM","ZW"],"format":"iso-3166-alpha-2","type":"string"},"type":"array"},"name":{"maxLength":256,"minLength":0,"type":"string"}},"type":"object"}],"required":["name"],"type":"object"},"customer-manager_CustomerV2":{"properties":{"acquisition_source":{"maxLength":256,"minLength":0,"nullable":true,"type":"string"},"company":{"$ref":"#/components/schemas/customer-manager_Company"},"created_at":{"format":"date-time","type":"string"},"customer_identifier":{"format":"uuid","type":"string"},"customer_since":{"$ref":"#/components/schemas/customer-manager_Date"},"external_identifier":{"maxLength":256,"minLength":0,"type":"string"},"person":{"$ref":"#/components/schemas/customer-manager_Person"},"status":{"enum":["ACTIVE","CLOSED","PROCESSING"],"type":"string"},"undefined":{"$ref":"#/components/schemas/customer-manager_CustomerTypeUndefined"},"updated_at":{"format":"date-time","type":"string"},"version":{"format":"int32","type":"integer"},"vessel":{"$ref":"#/components/schemas/customer-manager_Vessel"}},"required":["created_at","customer_identifier","external_identifier","status","updated_at","version"],"type":"object"},"customer-manager_CustomersList":{"properties":{"customers":{"items":{"$ref":"#/components/schemas/customer-manager_CustomerForSearch"},"type":"array"},"page_number":{"format":"int32","type":"integer"},"page_size":{"format":"int32","type":"integer"},"total_count":{"format":"int64","type":"integer"}},"required":["customers","page_number","page_size","total_count"],"type":"object"},"customer-manager_Date":{"properties":{"day":{"format":"int32","nullable":true,"type":"integer"},"month":{"format":"int32","nullable":true,"type":"integer"},"year":{"format":"int32","nullable":true,"type":"integer"}},"type":"object"},"customer-manager_DecimalValue":{"allOf":[{"$ref":"#/components/schemas/customer-manager_CustomFieldValue"},{"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"],"type":"object"},"customer-manager_EntityScreeningStatus":{"properties":{"enabled":{"nullable":true,"type":"boolean"}},"type":"object"},"customer-manager_InBranch":{"allOf":[{"properties":{"branch_identifier":{"maxLength":256,"minLength":0,"type":"string"}},"type":"object"}],"type":"object"},"customer-manager_IntegerValue":{"allOf":[{"$ref":"#/components/schemas/customer-manager_CustomFieldValue"},{"properties":{"integer":{"description":"The integer content.","example":30,"format":"int64","type":"integer"}},"type":"object"}],"description":"Integer representation of the custom field value.","required":["data_type","integer"],"type":"object"},"customer-manager_LabelV2":{"properties":{"identifier":{"format":"uuid","type":"string"},"name":{"type":"string"}},"required":["identifier","name"],"type":"object"},"customer-manager_LongRange":{"properties":{"high":{"format":"int64","type":"integer"},"low":{"format":"int64","type":"integer"}},"required":["high","low"],"type":"object"},"customer-manager_MonitorStatus":{"properties":{"entity_screening":{"$ref":"#/components/schemas/customer-manager_EntityScreeningStatus"}},"required":["entity_screening"],"type":"object"},"customer-manager_NetWorth":{"properties":{"amount":{"format":"int64","nullable":true,"type":"integer"},"currency":{"enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","XXX","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","SHP","WST","STN","SAR","RSD","SCR","SLL","SLE","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","TZS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VED","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XAU","XPD","XPT","XAG"],"format":"iso-4217","nullable":true,"type":"string"}},"type":"object"},"customer-manager_OnboardingChannelApi":{"properties":{"in_branch":{"$ref":"#/components/schemas/customer-manager_InBranch"},"online":{"$ref":"#/components/schemas/customer-manager_Online"}},"type":"object"},"customer-manager_Online":{"allOf":[{"properties":{"device_identifier":{"maxLength":256,"minLength":0,"type":"string"},"device_type":{"maxLength":50,"minLength":0,"type":"string"},"ip_address":{"type":"string"},"ip_format":{"enum":["IPV4","IPV6"],"type":"string"}},"type":"object"}],"type":"object"},"customer-manager_PaginatedAcquisitionSourcesV2Response":{"properties":{"acquisition_sources":{"description":"List of acquisition sources.","example":["source a","source b","source c"],"items":{"description":"List of acquisition sources.","example":"[\"source a\",\"source b\",\"source c\"]","type":"string"},"type":"array"},"first":{"description":"The URL path to the first page.","example":"/v2/resource?page_number=1","type":"string"},"next":{"description":"The URL path to the next page.","example":"/v2/resource?page_number=4","nullable":true,"type":"string"},"prev":{"description":"The URL path to the previous page.","example":"/v2/resource?page_number=2","nullable":true,"type":"string"},"self":{"description":"The URL path to the current page.","example":"/v2/resource?page_number=3","type":"string"},"total_count":{"description":"Total number of items.","example":5,"format":"int64","nullable":true,"type":"integer"}},"required":["acquisition_sources","first","self"],"type":"object"},"customer-manager_PaginatedCustomFieldsResponse":{"properties":{"custom_fields":{"description":"List of custom fields.","items":{"$ref":"#/components/schemas/customer-manager_CustomField"},"type":"array"},"first":{"description":"The URL path to the first page.","example":"/v2/customers/custom-fields?page_number=1","type":"string"},"next":{"description":"The URL path to the next page.","example":"/v2/customers/custom-fields?page_number=2","nullable":true,"type":"string"},"prev":{"description":"The URL path to the previous page.","example":"/v2/customers/custom-fields?page_number=1","nullable":true,"type":"string"},"self":{"description":"The URL path to the current page.","example":"/v2/customers/custom-fields?page_number=1","type":"string"},"total_count":{"description":"Total number of custom fields.","example":5,"format":"int64","type":"integer"}},"required":["custom_fields","first","self","total_count"],"type":"object"},"customer-manager_PaginatedCustomerLabelsV2Response":{"properties":{"first":{"description":"The URL path to the first page.","example":"/v2/resource?page_number=1","type":"string"},"labels":{"items":{"$ref":"#/components/schemas/customer-manager_LabelV2"},"type":"array"},"next":{"description":"The URL path to the next page.","example":"/v2/resource?page_number=4","nullable":true,"type":"string"},"prev":{"description":"The URL path to the previous page.","example":"/v2/resource?page_number=2","nullable":true,"type":"string"},"self":{"description":"The URL path to the current page.","example":"/v2/resource?page_number=3","type":"string"},"total_count":{"description":"Total number of items.","example":60,"format":"int64","nullable":true,"type":"integer"}},"required":["first","labels","self"],"type":"object"},"customer-manager_PaginatedProductsV2Response":{"properties":{"first":{"description":"The URL path to the first page.","example":"/v2/resource?page_number=1","type":"string"},"next":{"description":"The URL path to the next page.","example":"/v2/resource?page_number=4","nullable":true,"type":"string"},"prev":{"description":"The URL path to the previous page.","example":"/v2/resource?page_number=2","nullable":true,"type":"string"},"products":{"items":{"$ref":"#/components/schemas/customer-manager_ProductApi"},"type":"array"},"self":{"description":"The URL path to the current page.","example":"/v2/resource?page_number=3","type":"string"},"total_count":{"description":"Total number of items.","example":60,"format":"int64","nullable":true,"type":"integer"}},"required":["first","products","self"],"type":"object"},"customer-manager_Party":{"discriminator":{"mapping":{"company":"#/components/schemas/customer-manager_Company","person":"#/components/schemas/customer-manager_Person","undefined":"#/components/schemas/customer-manager_CustomerTypeUndefined","vessel":"#/components/schemas/customer-manager_Vessel"},"propertyName":"type"},"properties":{"type":{"type":"string"}},"required":["type"],"type":"object"},"customer-manager_Person":{"allOf":[{"properties":{"address":{"items":{"$ref":"#/components/schemas/customer-manager_Address"},"type":"array"},"contact_information":{"$ref":"#/components/schemas/customer-manager_ContactInformation"},"country_of_birth":{"enum":["AF","AX","AL","AN","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","MK","RO","RU","RW","RE","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","US","UY","UZ","VU","VE","VN","VG","VI","WF","EH","XK","XT","XX","YE","ZM","ZW"],"format":"iso-3166-alpha-2","type":"string"},"custom_fields":{"items":{"$ref":"#/components/schemas/customer-manager_CustomFieldInstance"},"type":"array"},"date_of_birth":{"$ref":"#/components/schemas/customer-manager_Date"},"fathers_name":{"maxLength":50,"minLength":0,"type":"string"},"first_name":{"maxLength":50,"minLength":0,"type":"string"},"full_name":{"maxLength":256,"minLength":0,"type":"string"},"gender":{"enum":["MALE","FEMALE","NOT_KNOWN","OTHER"],"type":"string"},"industry":{"maxLength":50,"minLength":0,"type":"string"},"last_name":{"maxLength":50,"minLength":0,"type":"string"},"middle_name":{"maxLength":50,"minLength":0,"type":"string"},"mothers_name":{"maxLength":50,"minLength":0,"type":"string"},"nationality":{"format":"iso-3166-alpha-2","items":{"enum":["AF","AX","AL","AN","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","MK","RO","RU","RW","RE","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","US","UY","UZ","VU","VE","VN","VG","VI","WF","EH","XK","XT","XX","YE","ZM","ZW"],"format":"iso-3166-alpha-2","type":"string"},"type":"array"},"net_worth":{"$ref":"#/components/schemas/customer-manager_NetWorth"},"personal_identification":{"items":{"$ref":"#/components/schemas/customer-manager_PersonalIdentification"},"type":"array"},"profession":{"items":{"type":"string"},"type":"array"},"residential_information":{"items":{"$ref":"#/components/schemas/customer-manager_ResidentialInformation"},"type":"array"},"salary":{"$ref":"#/components/schemas/customer-manager_Salary"},"source_of_income":{"maxLength":50,"minLength":0,"type":"string"},"source_of_wealth":{"maxLength":50,"minLength":0,"type":"string"},"suffix":{"maxLength":50,"minLength":0,"type":"string"},"title":{"maxLength":50,"minLength":0,"type":"string"}},"type":"object"}],"required":["last_name"],"type":"object"},"customer-manager_PersonForSearch":{"properties":{"fathers_name":{"nullable":true,"type":"string"},"first_name":{"nullable":true,"type":"string"},"full_name":{"nullable":true,"type":"string"},"last_name":{"nullable":true,"type":"string"},"middle_name":{"nullable":true,"type":"string"},"mothers_name":{"nullable":true,"type":"string"},"suffix":{"nullable":true,"type":"string"}},"type":"object"},"customer-manager_PersonalIdentification":{"properties":{"date_of_expiry":{"$ref":"#/components/schemas/customer-manager_Date"},"date_of_issue":{"$ref":"#/components/schemas/customer-manager_Date"},"issuing_country":{"enum":["AF","AX","AL","AN","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","MK","RO","RU","RW","RE","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","US","UY","UZ","VU","VE","VN","VG","VI","WF","EH","XK","XT","XX","YE","ZM","ZW"],"format":"iso-3166-alpha-2","nullable":true,"type":"string"},"number":{"maxLength":50,"minLength":0,"nullable":true,"type":"string"},"type":{"enum":["SOCIAL_SECURITY_NUMBER","DRIVING_LICENCE","PASSPORT","IDENTITY_CARD","TAX_REGISTRATION","ALIEN_IDENTIFICATION","EMPLOYER_IDENTIFICATION","OTHER"],"nullable":true,"type":"string"}},"type":"object"},"customer-manager_ProblemDetailErrorResponse":{"additionalProperties":true,"properties":{"detail":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","type":"string"},"instance":{"format":"uri","nullable":true,"type":"string"},"status":{"format":"int32","nullable":true,"type":"integer"},"timestamp":{"format":"date-time","type":"string"},"title":{"nullable":true,"type":"string"},"type":{"format":"uri","nullable":true,"type":"string"}},"required":["identifier","timestamp"],"type":"object"},"customer-manager_ProductApi":{"properties":{"bank_account":{"$ref":"#/components/schemas/customer-manager_BankAccount"},"crypto_wallet":{"$ref":"#/components/schemas/customer-manager_CryptoWallet"},"currency":{"enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","XXX","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","SHP","WST","STN","SAR","RSD","SCR","SLL","SLE","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","TZS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VED","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XAU","XPD","XPT","XAG"],"format":"iso-4217","nullable":true,"type":"string"},"monthly_payment_amount":{"format":"double","nullable":true,"type":"number"},"monthly_received_amount":{"format":"double","nullable":true,"type":"number"},"monthly_transaction_count":{"format":"int64","nullable":true,"type":"integer"},"name":{"maxLength":50,"minLength":0,"nullable":true,"type":"string"},"onboarding_channel":{"$ref":"#/components/schemas/customer-manager_OnboardingChannelApi"},"purpose":{"maxLength":256,"minLength":0,"nullable":true,"type":"string"},"status":{"maxLength":50,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"customer-manager_ResidentialInformation":{"properties":{"country_of_residence":{"enum":["AF","AX","AL","AN","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","MK","RO","RU","RW","RE","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","US","UY","UZ","VU","VE","VN","VG","VI","WF","EH","XK","XT","XX","YE","ZM","ZW"],"format":"iso-3166-alpha-2","nullable":true,"type":"string"},"residential_status":{"enum":["RESIDENT","PERMANENT_RESIDENT","NON_RESIDENT","TAX_RESIDENT"],"nullable":true,"type":"string"}},"type":"object"},"customer-manager_RiskScore":{"properties":{"overall_result":{"$ref":"#/components/schemas/customer-manager_RiskScoreResult"}},"required":["overall_result"],"type":"object"},"customer-manager_RiskScoreResult":{"properties":{"level":{"enum":["UNSPECIFIED","SKIPPED","UNKNOWN","LOW","MEDIUM","HIGH","PROHIBITED"],"nullable":true,"type":"string"}},"type":"object"},"customer-manager_Salary":{"properties":{"amount":{"$ref":"#/components/schemas/customer-manager_LongRange"},"currency":{"enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","XXX","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","SHP","WST","STN","SAR","RSD","SCR","SLL","SLE","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","TZS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VED","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XAU","XPD","XPT","XAG"],"format":"iso-4217","nullable":true,"type":"string"}},"type":"object"},"customer-manager_TextValue":{"allOf":[{"$ref":"#/components/schemas/customer-manager_CustomFieldValue"},{"properties":{"text":{"description":"The text content.","example":"Text Field Value","maxLength":256,"minLength":0,"type":"string"}},"type":"object"}],"description":"Text representation of the custom field value.","required":["data_type","text"],"type":"object"},"customer-manager_UndefinedForSearch":{"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"customer-manager_Unit":{"type":"object"},"customer-manager_UpdateCustomFieldRequest":{"properties":{"display_name":{"maxLength":50,"minLength":0,"type":"string"}},"required":["display_name"],"type":"object"},"customer-manager_Vessel":{"allOf":[{"$ref":"#/components/schemas/customer-manager_Party"},{"properties":{"alias":{"items":{"type":"string"},"maxItems":5,"minItems":0,"type":"array"},"custom_fields":{"items":{"$ref":"#/components/schemas/customer-manager_CustomFieldInstance"},"type":"array"},"flags":{"$ref":"#/components/schemas/customer-manager_VesselFlags"},"identifiers":{"$ref":"#/components/schemas/customer-manager_VesselIdentifiers"},"name":{"maxLength":256,"minLength":0,"type":"string"},"tonnage":{"maxLength":256,"minLength":0,"type":"string"},"vessel_type":{"maxLength":250,"minLength":0,"type":"string"},"year_of_build":{"format":"int32","type":"integer"}},"type":"object"}],"required":["name"],"type":"object"},"customer-manager_VesselFlags":{"properties":{"current_flag":{"enum":["AF","AX","AL","AN","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","MK","RO","RU","RW","RE","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","US","UY","UZ","VU","VE","VN","VG","VI","WF","EH","XK","XT","XX","YE","ZM","ZW"],"nullable":true,"type":"string"}},"type":"object"},"customer-manager_VesselForSearch":{"properties":{"alias":{"items":{"type":"string"},"nullable":true,"type":"array"},"imo":{"nullable":true,"type":"string"},"mmsi":{"nullable":true,"type":"string"},"name":{"type":"string"}},"required":["name"],"type":"object"},"customer-manager_VesselIdentifiers":{"properties":{"call_sign":{"maxLength":25,"minLength":0,"nullable":true,"type":"string"},"imo":{"maxLength":8,"minLength":7,"nullable":true,"type":"string"},"mmsi":{"maxLength":9,"minLength":9,"nullable":true,"type":"string"}},"type":"object"},"customlist_AddressDTO":{"properties":{"address_line1":{"nullable":true,"type":"string"},"address_line2":{"nullable":true,"type":"string"},"address_type":{"enum":["RESIDENTIAL","MAILING","OPERATING","REGISTRATION","BILLING"],"nullable":true,"type":"string"},"country_code":{"description":"2 letter country code as defined by iso-3166-alpha-2","example":"FR","format":"iso-3166-alpha-2","maxLength":2,"minLength":2,"nullable":true,"type":"string"},"country_subdivision":{"nullable":true,"type":"string"},"full_address":{"nullable":true,"type":"string"},"postal_code":{"nullable":true,"type":"string"},"town_name":{"nullable":true,"type":"string"}},"type":"object"},"customlist_AuditDTO":{"properties":{"issued_at":{"format":"date-time","type":"string"},"issued_by":{"format":"uuid","type":"string"},"reason":{"type":"string"}},"required":["issued_at","issued_by","reason"],"type":"object"},"customlist_CompanyAddDTO":{"properties":{"addresses":{"items":{"$ref":"#/components/schemas/customlist_AddressDTO"},"nullable":true,"type":"array","uniqueItems":true},"legal_forms":{"items":{"type":"string"},"nullable":true,"type":"array","uniqueItems":true},"names":{"$ref":"#/components/schemas/customlist_CompanyNamesDTO"},"registration_numbers":{"items":{"type":"string"},"nullable":true,"type":"array","uniqueItems":true}},"required":["names"],"type":"object"},"customlist_CompanyDTO":{"properties":{"addresses":{"items":{"$ref":"#/components/schemas/customlist_AddressDTO"},"type":"array","uniqueItems":true},"legal_forms":{"items":{"type":"string"},"type":"array","uniqueItems":true},"names":{"$ref":"#/components/schemas/customlist_CompanyNamesDTO"},"registration_numbers":{"items":{"type":"string"},"type":"array","uniqueItems":true}},"required":["addresses","legal_forms","names","registration_numbers"],"type":"object"},"customlist_CompanyNamesDTO":{"properties":{"aliases":{"items":{"type":"string"},"nullable":true,"type":"array","uniqueItems":true},"legal":{"type":"string"},"trading":{"items":{"type":"string"},"nullable":true,"type":"array","uniqueItems":true}},"required":["legal"],"type":"object"},"customlist_CustomListAddDTO":{"properties":{"description":{"type":"string"},"name":{"type":"string"}},"required":["description","name"],"type":"object"},"customlist_CustomListDTO":{"properties":{"archived_at":{"format":"date-time","nullable":true,"type":"string"},"created":{"$ref":"#/components/schemas/customlist_AuditDTO"},"custom_list_id":{"format":"uuid","type":"string"},"description":{"type":"string"},"entities":{"$ref":"#/components/schemas/customlist_EntitiesCountDTO"},"last_updated":{"$ref":"#/components/schemas/customlist_AuditDTO"},"name":{"type":"string"}},"required":["created","custom_list_id","description","entities","last_updated","name"],"type":"object"},"customlist_CustomListPageDTO":{"properties":{"first":{"type":"string"},"lists":{"items":{"$ref":"#/components/schemas/customlist_CustomListDTO"},"type":"array"},"next":{"nullable":true,"type":"string"},"prev":{"nullable":true,"type":"string"},"self":{"type":"string"}},"required":["first","lists","self"],"type":"object"},"customlist_EntitiesCountDTO":{"properties":{"active_count":{"format":"int32","type":"integer"}},"required":["active_count"],"type":"object"},"customlist_EntityAddDTO":{"properties":{"additional_information":{"nullable":true,"type":"string"},"company":{"$ref":"#/components/schemas/customlist_CompanyAddDTO"},"id":{"type":"string"},"narrative":{"nullable":true,"type":"string"},"person":{"$ref":"#/components/schemas/customlist_PersonAddDTO"},"url":{"nullable":true,"type":"string"}},"required":["id"],"type":"object"},"customlist_EntityDTO":{"properties":{"additional_information":{"nullable":true,"type":"string"},"archived_at":{"format":"date-time","nullable":true,"type":"string"},"company":{"$ref":"#/components/schemas/customlist_CompanyDTO"},"custom_list_id":{"format":"uuid","type":"string"},"id":{"type":"string"},"last_updated":{"$ref":"#/components/schemas/customlist_AuditDTO"},"narrative":{"nullable":true,"type":"string"},"person":{"$ref":"#/components/schemas/customlist_PersonDTO"},"url":{"nullable":true,"type":"string"},"version":{"format":"int32","type":"integer"}},"required":["custom_list_id","id","last_updated","version"],"type":"object"},"customlist_IdentifierDTO":{"properties":{"type":{"enum":["PASSPORT","NATIONAL_ID"],"type":"string"},"value":{"type":"string"}},"required":["type","value"],"type":"object"},"customlist_PersonAddDTO":{"properties":{"addresses":{"items":{"$ref":"#/components/schemas/customlist_AddressDTO"},"nullable":true,"type":"array","uniqueItems":true},"date_of_birth":{"description":"Date in the format YYYY-MM-DD. Expected to be in the past and later than 1800-01-01","example":"2000-01-01T00:00:00.000Z","format":"date","nullable":true,"type":"string"},"identifiers":{"items":{"$ref":"#/components/schemas/customlist_IdentifierDTO"},"nullable":true,"type":"array","uniqueItems":true},"names":{"$ref":"#/components/schemas/customlist_PersonNamesDTO"},"nationalities":{"description":"2 letter country code as defined by iso-3166-alpha-2","format":"iso-3166-alpha-2","items":{"description":"2 letter country code as defined by iso-3166-alpha-2","format":"iso-3166-alpha-2","type":"string"},"nullable":true,"type":"array","uniqueItems":true}},"required":["names"],"type":"object"},"customlist_PersonDTO":{"properties":{"addresses":{"items":{"$ref":"#/components/schemas/customlist_AddressDTO"},"type":"array","uniqueItems":true},"date_of_birth":{"format":"date","nullable":true,"type":"string"},"identifiers":{"items":{"$ref":"#/components/schemas/customlist_IdentifierDTO"},"type":"array","uniqueItems":true},"names":{"$ref":"#/components/schemas/customlist_PersonNamesDTO"},"nationalities":{"description":"2 letter country code as defined by iso-3166-alpha-2","format":"iso-3166-alpha-2","items":{"description":"2 letter country code as defined by iso-3166-alpha-2","format":"iso-3166-alpha-2","type":"string"},"type":"array","uniqueItems":true}},"required":["addresses","identifiers","names","nationalities"],"type":"object"},"customlist_PersonNameDTO":{"description":"\nA name will be considered valid if:\n- full_name is set and the other fields are not\n- first_name, middle_names and last_name are set and full_name is not set\n- first_name and last_name are the only fields with a value\nAny other combination will be considered invalid\n    ","properties":{"first_name":{"nullable":true,"type":"string"},"full_name":{"nullable":true,"type":"string"},"last_name":{"nullable":true,"type":"string"},"middle_names":{"nullable":true,"type":"string"}},"type":"object"},"customlist_PersonNamesDTO":{"properties":{"aliases":{"items":{"$ref":"#/components/schemas/customlist_PersonNameDTO"},"nullable":true,"type":"array","uniqueItems":true},"primary_name":{"$ref":"#/components/schemas/customlist_PersonNameDTO"}},"required":["primary_name"],"type":"object"},"customlist_ProblemDetailErrorResponse":{"additionalProperties":true,"properties":{"detail":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","type":"string"},"instance":{"format":"uri","nullable":true,"type":"string"},"status":{"format":"int32","nullable":true,"type":"integer"},"timestamp":{"format":"date-time","type":"string"},"title":{"nullable":true,"type":"string"},"type":{"format":"uri","nullable":true,"type":"string"}},"required":["identifier","timestamp"],"type":"object"},"exports_CreateExportPayload":{"properties":{"data_since":{"description":"Export data since date","example":"2023-11-05T21:00:00.000Z","format":"date-time","nullable":true,"type":"string"},"end_date":{"description":"Export data end date","example":"2023-11-05T21:00:00.000Z","format":"date-time","nullable":true,"type":"string"},"export_name":{"description":"Export name, created by customer","example":"profiles-2023-q1-exports","maxLength":50,"minLength":0,"type":"string"},"export_type_key":{"description":"Export type key","example":"CUSTOMER_SCREENING","type":"string"},"start_date":{"description":"Export data start date","example":"2023-11-01T21:00:00.000Z","format":"date-time","nullable":true,"type":"string"}},"required":["export_name","export_type_key"],"type":"object"},"exports_DownloadExportResponseBody":{"properties":{"download_url":{"description":"Download url","example":"s3://export.csv","type":"string"}},"required":["download_url"],"type":"object"},"exports_ExportItem":{"properties":{"created_at":{"description":"Export creation time","example":"2023-12-11T09:30:03.975Z","format":"date-time","type":"string"},"export_name":{"description":"Export name, created by customer","example":"profiles-2023-q1-exports","type":"string"},"export_type_key":{"description":"Export type key","example":"CUSTOMER_SCREENING","type":"string"},"identifier":{"description":"Export type id","example":"550e8400-e29b-41d4-a716-446655440000","format":"uuid","type":"string"},"status":{"description":"Export status","example":"PENDING","type":"string"},"window_data_since_time":{"description":"Export data since date","example":"2023-01-01T00:00:00.000Z","format":"date-time","nullable":true,"type":"string"},"window_end_time":{"description":"Export data end date","example":"2023-04-01T00:00:00.000Z","format":"date-time","nullable":true,"type":"string"},"window_start_time":{"description":"Export data start date","example":"2023-01-01T00:00:00.000Z","format":"date-time","nullable":true,"type":"string"}},"required":["created_at","export_name","export_type_key","identifier","status"],"type":"object"},"exports_ExportTypeKeys":{"properties":{"key":{"type":"string"}},"required":["key"],"type":"object"},"exports_PaginatedResponseExportItem":{"properties":{"first":{"description":"The URL path to the first page.","example":"/v1/resource?page_number=1","type":"string"},"items":{"items":{"$ref":"#/components/schemas/exports_ExportItem"},"type":"array"},"next":{"description":"The URL path to the next page.","example":"/v1/resource?page_number=4","nullable":true,"type":"string"},"prev":{"description":"The URL path to the previous page.","example":"/v1/resource?page_number=2","nullable":true,"type":"string"},"self":{"description":"The URL path to the current page.","example":"/v1/resource?page_number=3","type":"string"},"total_count":{"description":"Total number of items.","example":60,"format":"int64","nullable":true,"type":"integer"}},"required":["first","self","items"],"type":"object"},"exports_PaginatedResponseExportTypeKeys":{"properties":{"first":{"description":"The URL path to the first page.","example":"/v1/resource?page_number=1","type":"string"},"items":{"items":{"$ref":"#/components/schemas/exports_ExportTypeKeys"},"type":"array"},"next":{"description":"The URL path to the next page.","example":"/v1/resource?page_number=4","nullable":true,"type":"string"},"prev":{"description":"The URL path to the previous page.","example":"/v1/resource?page_number=2","nullable":true,"type":"string"},"self":{"description":"The URL path to the current page.","example":"/v1/resource?page_number=3","type":"string"},"total_count":{"description":"Total number of items.","example":60,"format":"int64","nullable":true,"type":"integer"}},"required":["first","self","items"],"type":"object"},"exports_ProblemDetailErrorResponse":{"additionalProperties":true,"properties":{"detail":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","type":"string"},"instance":{"format":"uri","nullable":true,"type":"string"},"status":{"format":"int32","nullable":true,"type":"integer"},"timestamp":{"format":"date-time","type":"string"},"title":{"nullable":true,"type":"string"},"type":{"format":"uri","nullable":true,"type":"string"}},"required":["identifier","timestamp"],"type":"object"},"identity_AccountData":{"properties":{"account_type":{"description":"Type of the account","enum":["CLIENT_ACCOUNT_TYPE_UNSPECIFIED","CLIENT_ACCOUNT_TYPE_NON_PRODUCTION","CLIENT_ACCOUNT_TYPE_PRODUCTION","UNRECOGNIZED"],"example":"CLIENT_ACCOUNT_TYPE_NON_PRODUCTION","type":"string"},"active":{"description":"If the account is active or deactivated.","type":"boolean"},"client_identifier":{"description":"The unique identifier of the account's client.","example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"created_at":{"description":"Date and time the account was created.","format":"date-time","type":"string"},"deactivated_at":{"description":"Date and time the account was deactivated.","format":"date-time","type":"string"},"identifier":{"description":"The unique identifier of the account.","example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"name":{"description":"Name of the account","example":"A Bank PLC Sandbox","type":"string"},"updated_at":{"description":"Date and time the account was last updated.","format":"date-time","type":"string"}},"required":["account_type","active","client_identifier","identifier","name"],"type":"object"},"identity_AccountSwitchRequestBody":{"properties":{"account_identifier":{"description":"The unique identifier of the account.","example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"}},"required":["account_identifier"],"type":"object"},"identity_AccountUserRolesRequestBody":{"properties":{"account_identifier":{"description":"The unique identifier of the account.","example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"role_identifiers":{"description":"List of role identifiers.","example":["00000000-0000-0000-0000-000000000000"],"items":{"example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"type":"array","uniqueItems":true}},"required":["role_identifiers"],"type":"object"},"identity_AccountUserRolesResponse":{"properties":{"identifier":{"description":"The unique identifier of the user.","example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"roles":{"description":"List of roles within the account.","items":{"$ref":"#/components/schemas/identity_UserRole"},"type":"array"}},"required":["identifier","roles"],"type":"object"},"identity_AccountsResponse":{"properties":{"accounts":{"items":{"$ref":"#/components/schemas/identity_AccountData"},"type":"array"},"first":{"description":"The url with parameters of the first page","type":"string"},"next":{"description":"The url with parameters of the next page, null if there are no more pages","type":"string"},"prev":{"description":"The url with parameters of the previous page, null if current page_number is 1","type":"string"},"self":{"description":"The url with parameters of the current page","type":"string"},"total_count":{"description":"Total number of accounts.","example":60,"format":"int64","nullable":true,"type":"integer"}},"required":["accounts","first"],"type":"object"},"identity_AnyUserResponse":{"properties":{"active":{"description":"If a user is active or deactivated.","example":true,"type":"boolean"},"client_identifier":{"description":"The unique identifier of the client.","example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"created_at":{"description":"Date and time the user was created.","format":"date-time","type":"string"},"created_by":{"description":"The unique identifier of who created the user.","format":"uuid","type":"string"},"deactivated_at":{"description":"Date and time the user was deactivated.","format":"date-time","type":"string"},"email":{"description":"Email address of the user.","example":"example@mail.com","type":"string"},"enforce_mfa_after":{"description":"Date and time of when MFA will be enforced for the user.","format":"date-time","type":"string"},"identifier":{"description":"The unique identifier of the user.","example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"name":{"description":"Full name of the user.","example":"John Doe","type":"string"},"updated_at":{"description":"Date and time the user was last updated.","format":"date-time","type":"string"},"updated_by":{"description":"The unique identifier of who last updated the user.","format":"uuid","type":"string"},"user_type":{"description":"Specifies the type of the entity.","enum":["AGENT","HUMAN"],"example":"HUMAN","type":"string"}},"required":["active","client_identifier","created_at","created_by","email","identifier","name","updated_at","updated_by","user_type"],"type":"object"},"identity_BuiltInRoleResponse":{"allOf":[{"$ref":"#/components/schemas/identity_RoleResponse"},{"properties":{"description":{"description":"Description of the role.","example":"View Cases","type":"string"},"identifier":{"description":"The unique identifier of the role.","example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"name":{"description":"Name of the role.","example":"Supervisor","type":"string"},"users_assigned_count":{"description":"Number of users assigned.","example":1,"format":"int32","type":"integer"}},"type":"object"}],"required":["description","identifier","name","users_assigned_count"],"type":"object"},"identity_BulkAccountUserRoles":{"description":"List with the result of the operation on each user identifier.","properties":{"errors":{"description":"Details for in case it wasn't successful.","items":{"$ref":"#/components/schemas/identity_BulkAccountUserRolesError"},"type":"array"},"success":{"description":"The unique identifier of the user.","example":true,"type":"boolean"},"user_identifier":{"description":"The unique identifier of the user.","example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"}},"required":["success","user_identifier"],"type":"object"},"identity_BulkAccountUserRolesError":{"description":"Details for in case it wasn't successful.","properties":{"details":{"description":"Detail of the error.","example":"Failed to connect with database","type":"string"},"message":{"description":"Error message.","example":"DATABASE_ERROR","type":"string"}},"required":["details","message"],"type":"object"},"identity_BulkAccountUserRolesRequestBody":{"properties":{"account_identifier":{"description":"The unique identifier of the account.","example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"role_identifiers":{"description":"List of role identifiers.","example":["00000000-0000-0000-0000-000000000000"],"items":{"example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"type":"array","uniqueItems":true},"user_identifiers":{"description":"List of user identifiers.","example":["00000000-0000-0000-0000-000000000000"],"items":{"example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"type":"array","uniqueItems":true}},"required":["role_identifiers","user_identifiers"],"type":"object"},"identity_BulkAccountUserRolesResponse":{"properties":{"results":{"description":"List with the result of the operation on each user identifier.","items":{"$ref":"#/components/schemas/identity_BulkAccountUserRoles"},"type":"array"}},"required":["results"],"type":"object"},"identity_ClientData":{"properties":{"active":{"description":"If your client is active or deactivated.","type":"boolean"},"allow_password_login":{"description":"If password login is enabled or disabled.","type":"boolean"},"allow_sso_login":{"description":"If SSO login is enabled or disabled.","type":"boolean"},"created_at":{"description":"Date and time the client was created.","format":"date-time","type":"string"},"deactivated_at":{"description":"Date and time the client was deactivated.","format":"date-time","type":"string"},"identifier":{"description":"The unique identifier of the client.","example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"idp_identifier":{"description":"The identifier of the identity provider.","type":"string"},"name":{"description":"The client's name.","example":"Client","type":"string"},"updated_at":{"description":"Date and time the client was last updated.","format":"date-time","type":"string"}},"required":["active","allow_password_login","allow_sso_login","identifier","idp_identifier","name"],"type":"object"},"identity_CustomRoleResponse":{"allOf":[{"$ref":"#/components/schemas/identity_RoleResponse"},{"properties":{"account_identifier":{"description":"The account identifier of the role.","example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"created_at":{"description":"Date and time the role was last created.","example":"2023-01-01T10:10:10.000Z","format":"date-time","type":"string"},"created_by":{"default":"00000000-0000-0000-0000-000000000000","description":"Created by identifier","format":"uuid","type":"string"},"description":{"description":"Description of the role.","example":"View Cases","type":"string"},"identifier":{"description":"The unique identifier of the role.","example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"name":{"description":"Name of the role.","example":"Supervisor","type":"string"},"updated_at":{"description":"Date and time the role was last updated.","example":"2023-01-01T10:10:10.000Z","format":"date-time","type":"string"},"updated_by":{"default":"00000000-0000-0000-0000-000000000000","description":"Updated by identifier","format":"uuid","type":"string"},"users_assigned_count":{"description":"Number of users assigned.","example":1,"format":"int32","type":"integer"}},"type":"object"}],"required":["account_identifier","created_at","description","identifier","name","updated_at","users_assigned_count"],"type":"object"},"identity_CustomRoleWithPermissionsResponse":{"allOf":[{"$ref":"#/components/schemas/identity_RoleWithPermissionResponse"},{"properties":{"account_identifier":{"description":"The account identifier of the role.","example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"created_at":{"description":"Date and time the role was last created.","example":"2023-01-01T10:10:10.000Z","format":"date-time","type":"string"},"created_by":{"default":"00000000-0000-0000-0000-000000000000","description":"Created by identifier","format":"uuid","type":"string"},"updated_at":{"description":"Date and time the role was last updated.","example":"2023-01-01T10:10:10.000Z","format":"date-time","type":"string"},"updated_by":{"default":"00000000-0000-0000-0000-000000000000","description":"Updated by identifier","format":"uuid","type":"string"}},"type":"object"}],"required":["account_identifier","created_at","description","identifier","name","permissions","updated_at","users_assigned_count"],"type":"object"},"identity_DefaultRoleWithPermissionsResponse":{"allOf":[{"$ref":"#/components/schemas/identity_RoleWithPermissionResponse"}],"required":["description","identifier","name","permissions","users_assigned_count"],"type":"object"},"identity_ExtendedUserAccountRolesResponse":{"properties":{"accounts":{"description":"List of accounts.","items":{"$ref":"#/components/schemas/identity_ExtendedUserAccountsRoles"},"type":"array"},"first":{"description":"The url with parameters of the first page","type":"string"},"next":{"description":"The url with parameters of the next page, null if there are no more pages","type":"string"},"prev":{"description":"The url with parameters of the previous page, null if current page_number is 1","type":"string"},"self":{"description":"The url with parameters of the current page","type":"string"},"total_count":{"description":"Total number of items.","example":60,"format":"int64","nullable":true,"type":"integer"}},"required":["accounts","first"],"type":"object"},"identity_ExtendedUserAccountsRoles":{"description":"List of accounts.","properties":{"account_type":{"description":"Type of the account.","enum":["CLIENT_ACCOUNT_TYPE_UNSPECIFIED","CLIENT_ACCOUNT_TYPE_NON_PRODUCTION","CLIENT_ACCOUNT_TYPE_PRODUCTION","UNRECOGNIZED"],"type":"string"},"client_identifier":{"description":"The unique identifier of the client.","example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"identifier":{"description":"The unique identifier of the account.","example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"name":{"description":"Name of the account.","example":"A Bank Retail","type":"string"},"roles":{"description":"List of roles within the account.","items":{"$ref":"#/components/schemas/identity_ExtendedUserRole"},"type":"array"}},"required":["account_type","client_identifier","identifier","name","roles"],"type":"object"},"identity_ExtendedUserRole":{"description":"List of roles within the account.","properties":{"assigned_at":{"description":"Date and time the user was assigned the user role in the account.","example":"2023-01-01T10:10:10.000Z","format":"date-time","type":"string"},"name":{"description":"Name of the role","example":"Admin","type":"string"},"user_role_identifier":{"description":"The unique identifier of the user role.","example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"}},"required":["name"],"type":"object"},"identity_GroupWithPermissionsHttpResponse":{"properties":{"name":{"description":"Name","example":"permissions.groups.00000000-0000-0000-0000-000000000000.name","type":"string"},"permissions":{"description":"Permissions","example":[1,2,3],"items":{"description":"Permissions","format":"int32","type":"integer"},"type":"array","uniqueItems":true}},"required":["name","permissions"],"type":"object"},"identity_NoRolesUserData":{"description":"List of users.","properties":{"active":{"description":"If a user is active or deactivated.","example":true,"type":"boolean"},"client_identifier":{"description":"The unique identifier of the client.","example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"created_at":{"description":"Date and time the user was created.","format":"date-time","type":"string"},"created_by":{"description":"The unique identifier of who created the user.","format":"uuid","type":"string"},"deactivated_at":{"description":"Date and time the user was deactivated.","format":"date-time","type":"string"},"email":{"description":"Email address of the user.","example":"example@mail.com","type":"string"},"enforce_mfa_after":{"description":"Date and time of when MFA will be enforced for the user.","format":"date-time","type":"string"},"identifier":{"description":"The unique identifier of the user.","example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"name":{"description":"Full name of the user.","example":"John Doe","type":"string"},"updated_at":{"description":"Date and time the user was last updated.","format":"date-time","type":"string"},"updated_by":{"description":"The unique identifier of who last updated the user.","format":"uuid","type":"string"},"user_type":{"enum":["AGENT","HUMAN"],"type":"string"}},"required":["active","client_identifier","email","identifier","name","user_type"],"type":"object"},"identity_NoRolesUsersResponse":{"properties":{"first":{"description":"The url with parameters of the first page","type":"string"},"next":{"description":"The url with parameters of the next page, null if there are no more pages","type":"string"},"prev":{"description":"The url with parameters of the previous page, null if current page_number is 1","type":"string"},"self":{"description":"The url with parameters of the current page","type":"string"},"total_count":{"description":"Total number of users.","example":60,"format":"int64","nullable":true,"type":"integer"},"users":{"description":"List of users.","items":{"$ref":"#/components/schemas/identity_NoRolesUserData"},"type":"array"}},"required":["first","users"],"type":"object"},"identity_OwnUserResponse":{"properties":{"active":{"description":"If a user is active or deactivated.","example":true,"type":"boolean"},"client_identifier":{"description":"The unique identifier of the client.","example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"cookie_consent":{"description":"Whether the user has consented to cookies.","example":false,"type":"boolean"},"created_at":{"description":"Date and time the user was created.","format":"date-time","type":"string"},"created_by":{"description":"The unique identifier of who created the user.","format":"uuid","type":"string"},"deactivated_at":{"description":"Date and time the user was deactivated.","format":"date-time","type":"string"},"email":{"description":"Email address of the user.","example":"example@mail.com","type":"string"},"enforce_mfa_after":{"description":"Date and time of when MFA will be enforced for the user.","format":"date-time","type":"string"},"identifier":{"description":"The unique identifier of the user.","example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"is_default_locale":{"description":"Default locale is used.","type":"boolean"},"locale":{"description":"Locale of the user.","enum":["en-US","en-GB","fr-CA","fr-FR"],"type":"string"},"name":{"description":"Full name of the user.","example":"John Doe","type":"string"},"prompt_user_cookie":{"description":"Whether to prompt the user about cookie consent.","example":true,"type":"boolean"},"updated_at":{"description":"Date and time the user was last updated.","format":"date-time","type":"string"},"updated_by":{"description":"The unique identifier of who last updated the user.","format":"uuid","type":"string"}},"required":["active","client_identifier","cookie_consent","created_at","created_by","email","identifier","is_default_locale","locale","name","prompt_user_cookie","updated_at","updated_by"],"type":"object"},"identity_PaginatedResponseGroupWithPermissionsHttpResponse":{"properties":{"first":{"description":"The URL path to the first page.","example":"/v1/resource?page_number=1","type":"string"},"groups":{"items":{"$ref":"#/components/schemas/identity_GroupWithPermissionsHttpResponse"},"type":"array"},"next":{"description":"The URL path to the next page.","example":"/v1/resource?page_number=4","nullable":true,"type":"string"},"prev":{"description":"The URL path to the previous page.","example":"/v1/resource?page_number=2","nullable":true,"type":"string"},"self":{"description":"The URL path to the current page.","example":"/v1/resource?page_number=3","type":"string"},"total_count":{"description":"Total number of items.","example":60,"format":"int64","nullable":true,"type":"integer"}},"required":["first","self","groups"],"type":"object"},"identity_PaginatedResponsePermissionWithDepsResponse":{"properties":{"first":{"description":"The URL path to the first page.","example":"/v1/resource?page_number=1","type":"string"},"next":{"description":"The URL path to the next page.","example":"/v1/resource?page_number=4","nullable":true,"type":"string"},"permissions":{"items":{"$ref":"#/components/schemas/identity_PermissionWithDepsResponse"},"type":"array"},"prev":{"description":"The URL path to the previous page.","example":"/v1/resource?page_number=2","nullable":true,"type":"string"},"self":{"description":"The URL path to the current page.","example":"/v1/resource?page_number=3","type":"string"},"total_count":{"description":"Total number of items.","example":60,"format":"int64","nullable":true,"type":"integer"}},"required":["first","self","permissions"],"type":"object"},"identity_PaginatedResponseRoleResponse":{"properties":{"first":{"description":"The URL path to the first page.","example":"/v1/resource?page_number=1","type":"string"},"next":{"description":"The URL path to the next page.","example":"/v1/resource?page_number=4","nullable":true,"type":"string"},"prev":{"description":"The URL path to the previous page.","example":"/v1/resource?page_number=2","nullable":true,"type":"string"},"roles":{"items":{"oneOf":[{"$ref":"#/components/schemas/identity_BuiltInRoleResponse"},{"$ref":"#/components/schemas/identity_CustomRoleResponse"}]},"type":"array"},"self":{"description":"The URL path to the current page.","example":"/v1/resource?page_number=3","type":"string"},"total_count":{"description":"Total number of items.","example":60,"format":"int64","nullable":true,"type":"integer"}},"required":["first","roles","self"],"type":"object"},"identity_PartialUpdateRoleRequestBody":{"properties":{"description":{"description":"Description of the role.","example":"View Cases","maxLength":300,"minLength":0,"type":"string"},"name":{"description":"Name of the role.","example":"Role name","maxLength":100,"minLength":1,"type":"string"},"permissions":{"description":"An array of permissions as integers.","example":[1,2],"items":{"description":"An array of permissions as integers.","format":"int32","type":"integer"},"type":"array","uniqueItems":true}},"type":"object"},"identity_PermissionListResponse":{"properties":{"bitfield":{"type":"string"},"permissions":{"description":"List of your permissions.","items":{"$ref":"#/components/schemas/identity_PermissionResponse"},"type":"array"}},"required":["bitfield","permissions"],"type":"object"},"identity_PermissionResponse":{"properties":{"description":{"description":"Description of the permission.","example":"Accessing API, user and account management","type":"string"},"identifier":{"description":"The unique identifier of the permission.","example":1,"format":"int32","type":"integer"},"level":{"description":"Permission level type","enum":["USER","ACCOUNT"],"example":"USER","type":"string"},"name":{"description":"Name of the permission.","example":"insights","type":"string"}},"required":["description","identifier","level","name"],"type":"object"},"identity_PermissionWithDepsResponse":{"properties":{"description":{"description":"Description of the permission.","example":"Accessing API, user and account management","type":"string"},"identifier":{"description":"The unique identifier of the permission.","example":1,"format":"int32","type":"integer"},"level":{"description":"Permission level type","enum":["USER","ACCOUNT"],"example":"USER","type":"string"},"name":{"description":"Name of the permission.","example":"insights","type":"string"},"required_user_permissions":{"description":"User-level permissions required for this permission to be given to a role","items":{"description":"Permission identifier","format":"int32","type":"integer"},"type":"array","uniqueItems":true}},"required":["description","identifier","level","name","required_user_permissions"],"type":"object"},"identity_ProblemDetailErrorResponse":{"additionalProperties":true,"properties":{"detail":{"type":"string"},"identifier":{"format":"uuid","type":"string"},"instance":{"format":"uri","type":"string"},"status":{"format":"int32","type":"integer"},"timestamp":{"format":"date-time","type":"string"},"title":{"type":"string"},"type":{"format":"uri","type":"string"}},"required":["identifier","timestamp"],"type":"object"},"identity_RoleRequestBody":{"properties":{"description":{"description":"Description of the role.","example":"View Cases","maxLength":300,"minLength":0,"type":"string"},"name":{"description":"Name of the role.","example":"Role name","maxLength":100,"minLength":1,"type":"string"},"permissions":{"description":"List of user permission identifiers","example":[1,2],"items":{"description":"List of user permission identifiers","format":"int32","type":"integer"},"type":"array","uniqueItems":true}},"required":["description","name","permissions"],"type":"object"},"identity_RoleResponse":{"type":"object"},"identity_RoleWithPermissionResponse":{"properties":{"description":{"description":"Description of the role.","example":"View Cases","type":"string"},"identifier":{"description":"The unique identifier of the role.","example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"name":{"description":"Name of the role.","example":"Supervisor","type":"string"},"permissions":{"description":"Role permission identifiers","example":[1],"items":{"description":"Role permission identifiers","format":"int32","type":"integer"},"type":"array","uniqueItems":true},"users_assigned_count":{"description":"Number of users assigned.","example":1,"format":"int32","type":"integer"}},"required":["description","identifier","name","permissions","users_assigned_count"],"type":"object"},"identity_StandardUserRole":{"description":"List of roles within the account.","properties":{"assigned_at":{"description":"Date and time the user was assigned the user role in the account.","example":"2023-01-01T10:10:10.000Z","format":"date-time","type":"string"},"name":{"description":"Name of the role","example":"Admin","type":"string"}},"required":["name"],"type":"object"},"identity_UserAccountRolesResponse":{"properties":{"accounts":{"description":"List of accounts.","items":{"$ref":"#/components/schemas/identity_UserAccountsRoles"},"type":"array"},"first":{"description":"The url with parameters of the first page","type":"string"},"next":{"description":"The url with parameters of the next page, null if there are no more pages","type":"string"},"prev":{"description":"The url with parameters of the previous page, null if current page_number is 1","type":"string"},"self":{"description":"The url with parameters of the current page","type":"string"},"total_count":{"description":"Total number of items.","example":60,"format":"int64","nullable":true,"type":"integer"}},"required":["accounts","first"],"type":"object"},"identity_UserAccountsRoles":{"description":"List of accounts.","properties":{"account_type":{"description":"Type of the account.","enum":["CLIENT_ACCOUNT_TYPE_UNSPECIFIED","CLIENT_ACCOUNT_TYPE_NON_PRODUCTION","CLIENT_ACCOUNT_TYPE_PRODUCTION","UNRECOGNIZED"],"type":"string"},"client_identifier":{"description":"The unique identifier of the client.","example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"identifier":{"description":"The unique identifier of the account.","example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"name":{"description":"Name of the account.","example":"A Bank Retail","type":"string"},"roles":{"description":"List of roles within the account.","items":{"$ref":"#/components/schemas/identity_StandardUserRole"},"type":"array"}},"required":["account_type","client_identifier","identifier","name","roles"],"type":"object"},"identity_UserData":{"description":"List of users.","properties":{"active":{"description":"If a user is active or deactivated.","example":true,"type":"boolean"},"client_identifier":{"description":"The unique identifier of the client.","example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"created_at":{"description":"Date and time the user was created.","format":"date-time","type":"string"},"deactivated_at":{"description":"Date and time the user was deactivated.","format":"date-time","type":"string"},"email":{"description":"Email address of the user.","example":"example@mail.com","type":"string"},"enforce_mfa_after":{"description":"Date and time of when MFA will be enforced for the user.","format":"date-time","type":"string"},"identifier":{"description":"The unique identifier of the user.","example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"name":{"description":"Full name of the user.","example":"John Doe","type":"string"},"roles":{"description":"User roles list","items":{"$ref":"#/components/schemas/identity_StandardUserRole"},"type":"array"},"updated_at":{"description":"Date and time the user was last updated.","format":"date-time","type":"string"},"user_type":{"description":"Specifies the type of the entity.","enum":["AGENT","HUMAN"],"example":"HUMAN","type":"string"}},"required":["active","client_identifier","email","identifier","name","user_type"],"type":"object"},"identity_UserPartialUpdateRequestBody":{"properties":{"active":{"description":"If the user is active or deactivated.","example":true,"type":"boolean"},"enforce_mfa_after":{"description":"Date and time of when MFA will be enforced for the user.","example":"2024-06-01T00:00:00.000Z","format":"date-time","type":"string"},"name":{"description":"Full name of the user.","example":"John Doe","maxLength":50,"minLength":1,"type":"string"}},"type":"object"},"identity_UserRequestBody":{"properties":{"email":{"description":"Email address of the user.","example":"john@example.com","maxLength":100,"minLength":1,"type":"string"},"name":{"description":"Full name of the user.","example":"John Doe","maxLength":50,"minLength":1,"type":"string"}},"required":["email","name"],"type":"object"},"identity_UserRole":{"description":"List of roles within the account.","properties":{"assigned_at":{"description":"Date and time the user was assigned the user role in the account.","example":"2023-01-01T10:10:10.000Z","format":"date-time","type":"string"},"name":{"description":"Name of the role","example":"Admin","type":"string"},"user_role_identifier":{"description":"The unique identifier of the user role.","example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"}},"required":["name"],"type":"object"},"identity_UsersMePartialUpdateRequestBody":{"properties":{"cookie_consent":{"description":"Whether the user consents to cookies.","example":false,"type":"boolean"},"locale":{"description":"User locale.","enum":["en-US","en-GB","fr-CA","fr-FR"],"example":"en-US","type":"string"}},"type":"object"},"identity_UsersResponse":{"properties":{"first":{"description":"The url with parameters of the first page","type":"string"},"next":{"description":"The url with parameters of the next page, null if there are no more pages","type":"string"},"prev":{"description":"The url with parameters of the previous page, null if current page_number is 1","type":"string"},"self":{"description":"The url with parameters of the current page","type":"string"},"total_count":{"description":"Total number of users.","example":60,"format":"int64","nullable":true,"type":"integer"},"users":{"description":"List of users.","items":{"$ref":"#/components/schemas/identity_UserData"},"type":"array"}},"required":["first","users"],"type":"object"},"label_CreateLabelsPayload":{"properties":{"labels":{"description":"A list of unique label names to create.","items":{"description":"Label name must be between 1 and 280 characters.","maxLength":280,"minLength":1,"type":"string"},"maxItems":100,"minItems":0,"type":"array","uniqueItems":true}},"required":["labels"],"type":"object"},"label_CreateLabelsResponse":{"properties":{"labels":{"description":"List of labels","items":{"$ref":"#/components/schemas/label_Label"},"type":"array"}},"required":["labels"],"type":"object"},"label_GetLabelsPaginatedResponse":{"properties":{"first":{"description":"The URL path to the first page.","example":"/v2/labels?page_number=1","type":"string"},"labels":{"description":"List of labels","items":{"$ref":"#/components/schemas/label_Label"},"type":"array"},"next":{"description":"The URL path to the next page.","example":"/v2/labels?page_number=4","nullable":true,"type":"string"},"prev":{"description":"The URL path to the previous page.","example":"/v2/labels?page_number=2","nullable":true,"type":"string"},"self":{"description":"The URL path to the current page.","example":"/v2/labels?page_number=3","type":"string"},"total_count":{"description":"Total number of labels.","example":50,"format":"int64","type":"integer"}},"required":["first","labels","self","total_count"],"type":"object"},"label_Label":{"description":"List of labels","properties":{"created_at":{"format":"date-time","type":"string"},"created_by":{"type":"string"},"identifier":{"format":"uuid","type":"string"},"name":{"description":"Name of the label.","maxLength":280,"minLength":1,"type":"string"},"updated_at":{"format":"date-time","type":"string"},"updated_by":{"type":"string"}},"required":["created_at","created_by","identifier","name","updated_at","updated_by"],"type":"object"},"label_ProblemDetailErrorResponse":{"additionalProperties":true,"properties":{"detail":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","type":"string"},"instance":{"format":"uri","nullable":true,"type":"string"},"status":{"format":"int32","nullable":true,"type":"integer"},"timestamp":{"format":"date-time","type":"string"},"title":{"nullable":true,"type":"string"},"type":{"format":"uri","nullable":true,"type":"string"}},"required":["identifier","timestamp"],"type":"object"},"label_UpdateLabelRequest":{"properties":{"name":{"maxLength":280,"minLength":0,"type":"string"}},"required":["name"],"type":"object"},"mes_AvailableSourceFieldFromBlock":{"properties":{"description":{"type":"string"},"identifier":{"type":"string"},"name":{"type":"string"},"type":{"enum":["STRING","NUMBER"],"type":"string"}},"required":["description","identifier","name","type"],"type":"object"},"mes_AvailableSourceFieldFromPath":{"properties":{"key":{"type":"string"},"type":{"enum":["STRING","NUMBER"],"type":"string"}},"required":["key","type"],"type":"object"},"mes_AvailableSourceFieldsResponse":{"description":"List of Available Source Fields","properties":{"blocks":{"items":{"$ref":"#/components/schemas/mes_AvailableSourceFieldFromBlock"},"type":"array"},"paths":{"items":{"$ref":"#/components/schemas/mes_AvailableSourceFieldFromPath"},"type":"array"}},"required":["blocks","paths"],"type":"object"},"mes_LookupListCreateRequestBody":{"properties":{"input_schema":{"items":{"$ref":"#/components/schemas/mes_LookupListSchemaCreateRequestBody"},"maxItems":1,"minItems":1,"type":"array"},"name":{"type":"string"},"output_schema":{"items":{"$ref":"#/components/schemas/mes_LookupListSchemaCreateRequestBody"},"maxItems":1,"minItems":1,"type":"array"}},"required":["input_schema","name","output_schema"],"type":"object"},"mes_LookupListItemResponse":{"additionalProperties":{"oneOf":[{"type":"string"},{"type":"number"}]},"description":"Dynamic lookup list item with field-value pairs","example":{"field1":"string_value","field2":123,"field3":45.67},"type":"object"},"mes_LookupListMappingCreateRequestBody":{"properties":{"lookup_list_identifier":{"format":"uuid","type":"string"},"output_fields":{"items":{"$ref":"#/components/schemas/mes_OutputField"},"type":"array"},"source_fields":{"items":{"$ref":"#/components/schemas/mes_SourceField"},"type":"array"}},"required":["lookup_list_identifier","output_fields","source_fields"],"type":"object"},"mes_LookupListMappingPatchRequestBody":{"properties":{"lookup_list_identifier":{"format":"uuid","nullable":true,"type":"string"},"output_fields":{"items":{"$ref":"#/components/schemas/mes_OutputField"},"nullable":true,"type":"array"},"source_fields":{"items":{"$ref":"#/components/schemas/mes_SourceField"},"nullable":true,"type":"array"}},"type":"object"},"mes_LookupListMappingResponse":{"properties":{"created_at":{"format":"date-time","type":"string"},"created_by":{"format":"uuid","type":"string"},"identifier":{"format":"uuid","type":"string"},"lookup_list_identifier":{"format":"uuid","type":"string"},"output_fields":{"items":{"$ref":"#/components/schemas/mes_OutputField"},"type":"array"},"source_fields":{"items":{"$ref":"#/components/schemas/mes_SourceField"},"type":"array"},"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"updated_at":{"format":"date-time","nullable":true,"type":"string"},"updated_by":{"format":"uuid","nullable":true,"type":"string"}},"required":["created_at","created_by","identifier","lookup_list_identifier","output_fields","source_fields","status"],"type":"object"},"mes_LookupListNoSchemaResponse":{"properties":{"created_at":{"format":"date-time","nullable":true,"type":"string"},"created_by":{"format":"uuid","type":"string"},"identifier":{"format":"uuid","type":"string"},"items_count":{"format":"int32","type":"integer"},"name":{"type":"string"},"updated_at":{"format":"date-time","nullable":true,"type":"string"},"updated_by":{"format":"uuid","type":"string"},"version":{"$ref":"#/components/schemas/mes_VersionResponse"}},"required":["created_by","identifier","items_count","name","updated_by"],"type":"object"},"mes_LookupListSchemaCreateRequestBody":{"properties":{"name":{"type":"string"},"type":{"enum":["string","number","decimal"],"type":"string"}},"required":["name","type"],"type":"object"},"mes_LookupListUpdateRequestBody":{"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"mes_LookupListVersionResponse":{"properties":{"created_at":{"format":"date-time","nullable":true,"type":"string"},"created_by":{"format":"uuid","type":"string"},"number":{"format":"int32","type":"integer"},"status":{"enum":["DRAFT","ACTIVE","INACTIVE"],"type":"string"},"updated_at":{"format":"date-time","nullable":true,"type":"string"},"updated_by":{"format":"uuid","type":"string"}},"required":["created_by","number","status","updated_by"],"type":"object"},"mes_LookupListsResponse":{"properties":{"created_at":{"format":"date-time","nullable":true,"type":"string"},"created_by":{"format":"uuid","type":"string"},"identifier":{"format":"uuid","type":"string"},"input_schema":{"items":{"$ref":"#/components/schemas/mes_SchemaResponse"},"type":"array"},"items_count":{"format":"int32","type":"integer"},"name":{"type":"string"},"output_schema":{"items":{"$ref":"#/components/schemas/mes_SchemaResponse"},"type":"array"},"updated_at":{"format":"date-time","nullable":true,"type":"string"},"updated_by":{"format":"uuid","type":"string"},"version":{"$ref":"#/components/schemas/mes_VersionResponse"}},"required":["created_by","identifier","input_schema","items_count","name","output_schema","updated_by"],"type":"object"},"mes_OutputField":{"properties":{"field_key":{"type":"string"},"lookup_list_column_name":{"type":"string"}},"required":["field_key","lookup_list_column_name"],"type":"object"},"mes_PaginatedResponseLookupListItemResponse":{"properties":{"first":{"description":"The URL path to the first page.","example":"/v1/resource?page_number=1","type":"string"},"items":{"items":{"$ref":"#/components/schemas/mes_LookupListItemResponse"},"type":"array"},"next":{"description":"The URL path to the next page.","example":"/v1/resource?page_number=4","nullable":true,"type":"string"},"prev":{"description":"The URL path to the previous page.","example":"/v1/resource?page_number=2","nullable":true,"type":"string"},"self":{"description":"The URL path to the current page.","example":"/v1/resource?page_number=3","type":"string"},"total_count":{"description":"Total number of items.","example":60,"format":"int64","nullable":true,"type":"integer"}},"required":["first","self","items"],"type":"object"},"mes_PaginatedResponseLookupListMappingResponse":{"properties":{"first":{"description":"The URL path to the first page.","example":"/v1/resource?page_number=1","type":"string"},"lookup_list_mappings":{"items":{"$ref":"#/components/schemas/mes_LookupListMappingResponse"},"type":"array"},"next":{"description":"The URL path to the next page.","example":"/v1/resource?page_number=4","nullable":true,"type":"string"},"prev":{"description":"The URL path to the previous page.","example":"/v1/resource?page_number=2","nullable":true,"type":"string"},"self":{"description":"The URL path to the current page.","example":"/v1/resource?page_number=3","type":"string"},"total_count":{"description":"Total number of items.","example":60,"format":"int64","nullable":true,"type":"integer"}},"required":["first","self","lookup_list_mappings"],"type":"object"},"mes_PaginatedResponseLookupListNoSchemaResponse":{"properties":{"first":{"description":"The URL path to the first page.","example":"/v1/resource?page_number=1","type":"string"},"lookup_lists":{"items":{"$ref":"#/components/schemas/mes_LookupListNoSchemaResponse"},"type":"array"},"next":{"description":"The URL path to the next page.","example":"/v1/resource?page_number=4","nullable":true,"type":"string"},"prev":{"description":"The URL path to the previous page.","example":"/v1/resource?page_number=2","nullable":true,"type":"string"},"self":{"description":"The URL path to the current page.","example":"/v1/resource?page_number=3","type":"string"},"total_count":{"description":"Total number of items.","example":60,"format":"int64","nullable":true,"type":"integer"}},"required":["first","self","lookup_lists"],"type":"object"},"mes_PaginatedResponseLookupListVersionResponse":{"properties":{"first":{"description":"The URL path to the first page.","example":"/v1/resource?page_number=1","type":"string"},"items":{"items":{"$ref":"#/components/schemas/mes_LookupListVersionResponse"},"type":"array"},"next":{"description":"The URL path to the next page.","example":"/v1/resource?page_number=4","nullable":true,"type":"string"},"prev":{"description":"The URL path to the previous page.","example":"/v1/resource?page_number=2","nullable":true,"type":"string"},"self":{"description":"The URL path to the current page.","example":"/v1/resource?page_number=3","type":"string"},"total_count":{"description":"Total number of items.","example":60,"format":"int64","nullable":true,"type":"integer"}},"required":["first","self","items"],"type":"object"},"mes_ProblemDetailErrorResponse":{"additionalProperties":true,"properties":{"detail":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","type":"string"},"instance":{"format":"uri","nullable":true,"type":"string"},"status":{"format":"int32","nullable":true,"type":"integer"},"timestamp":{"format":"date-time","type":"string"},"title":{"nullable":true,"type":"string"},"type":{"format":"uri","nullable":true,"type":"string"}},"required":["identifier","timestamp"],"type":"object"},"mes_SchemaResponse":{"properties":{"name":{"type":"string"},"type":{"enum":["string","number","decimal"],"type":"string"}},"required":["name","type"],"type":"object"},"mes_SourceField":{"properties":{"field_key":{"type":"string"},"lookup_list_column_name":{"type":"string"}},"required":["field_key","lookup_list_column_name"],"type":"object"},"mes_VersionResponse":{"properties":{"number":{"format":"int32","type":"integer"},"status":{"enum":["DRAFT","ACTIVE","INACTIVE"],"type":"string"}},"required":["number","status"],"type":"object"},"ns_AlertingOutput":{"properties":{"alerts":{"items":{"$ref":"#/components/schemas/ns_WorkflowAlert"},"nullable":true,"type":"array"}},"type":"object"},"ns_AlertingStep":{"properties":{"error_message":{"nullable":true,"type":"string"},"identifier":{"example":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","nullable":true,"type":"string"},"status":{"example":"COMPLETED","type":"string"},"step_output":{"$ref":"#/components/schemas/ns_AlertingOutput"}},"required":["status","step_output"],"type":"object"},"ns_CaseAlertListUpdatedV2JsonPayload":{"properties":{"account_identifier":{"example":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","type":"string"},"alert_identifiers":{"example":["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"],"items":{"example":"[\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"]","type":"string"},"type":"array"},"api_version":{"example":"v2","type":"string"},"case_identifier":{"example":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","type":"string"},"customer":{"$ref":"#/components/schemas/ns_Customer"},"subjects":{"items":{"$ref":"#/components/schemas/ns_Subject"},"type":"array"},"webhook_type":{"example":"CASE_ALERT_LIST_UPDATED","type":"string"}},"required":["account_identifier","alert_identifiers","api_version","case_identifier","subjects","webhook_type"],"type":"object"},"ns_CaseCreatedJsonPayloadV2":{"properties":{"account_identifier":{"example":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","type":"string"},"api_version":{"example":"v2","type":"string"},"case_identifier":{"example":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","type":"string"},"case_stage":{"$ref":"#/components/schemas/ns_CaseStage"},"case_state":{"example":"ONBOARDING_NOT_STARTED","type":"string"},"case_type":{"example":"CUSTOMER_ONBOARDING","type":"string"},"customer":{"$ref":"#/components/schemas/ns_Customer"},"subjects":{"items":{"$ref":"#/components/schemas/ns_Subject"},"type":"array"},"webhook_type":{"example":"CASE_CREATED","type":"string"}},"required":["account_identifier","api_version","case_identifier","case_stage","case_state","case_type","subjects","webhook_type"],"type":"object"},"ns_CaseCreationOutput":{"properties":{"case_identifier":{"example":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","nullable":true,"type":"string"}},"type":"object"},"ns_CaseCreationStep":{"properties":{"error_message":{"nullable":true,"type":"string"},"identifier":{"example":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","nullable":true,"type":"string"},"status":{"example":"COMPLETED","type":"string"},"step_output":{"$ref":"#/components/schemas/ns_CaseCreationOutput"}},"required":["status","step_output"],"type":"object"},"ns_CaseStage":{"properties":{"decision_type":{"example":"POSITIVE","nullable":true,"type":"string"},"display_name":{"example":"Not Started","type":"string"},"display_order":{"example":1,"format":"int32","type":"integer"},"identifier":{"example":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","type":"string"},"stage_type":{"example":"INITIAL","type":"string"}},"required":["display_name","display_order","identifier","stage_type"],"type":"object"},"ns_CaseStateUpdatedV1JsonPayload":{"properties":{"account_identifier":{"example":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","type":"string"},"api_version":{"example":"v1","type":"string"},"case_identifier":{"example":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","type":"string"},"case_state":{"example":"CASE_STATE_POSITIVE_END_STATE","type":"string"},"case_type":{"example":"CUSTOMER_ONBOARDING","type":"string"}},"required":["account_identifier","api_version","case_identifier","case_state","case_type"],"type":"object"},"ns_Customer":{"properties":{"external_identifier":{"example":"your unique customer identifier","nullable":true,"type":"string"},"identifier":{"example":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","nullable":true,"type":"string"},"version":{"example":1,"format":"int32","nullable":true,"type":"integer"}},"type":"object"},"ns_CustomerCreationOutput":{"properties":{"customer_identifier":{"example":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","nullable":true,"type":"string"},"external_identifier":{"example":"your unique customer identifier","nullable":true,"type":"string"}},"type":"object"},"ns_CustomerCreationStep":{"properties":{"error_message":{"nullable":true,"type":"string"},"identifier":{"example":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","nullable":true,"type":"string"},"status":{"type":"string"},"step_output":{"$ref":"#/components/schemas/ns_CustomerCreationOutput"}},"required":["status","step_output"],"type":"object"},"ns_CustomerRiskScoreDataUpdateV3JsonPayload":{"properties":{"account_identifier":{"example":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","type":"string"},"api_version":{"example":"v3","type":"string"},"customer_external_identifier":{"example":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","type":"string"},"previous_risk_score":{"$ref":"#/components/schemas/ns_RiskScorePayload"},"risk_score":{"$ref":"#/components/schemas/ns_RiskScorePayload"},"webhook_type":{"example":"CUSTOMER_RISK_SCORE_CHANGED","type":"string"}},"required":["account_identifier","api_version","customer_external_identifier","previous_risk_score","risk_score","webhook_type"],"type":"object"},"ns_CustomerScreeningOutput":{"properties":{"aml_types":{"items":{"type":"string"},"nullable":true,"type":"array"},"screening_result":{"example":"HAS_PROFILES","nullable":true,"type":"string"}},"type":"object"},"ns_CustomerScreeningStep":{"properties":{"error_message":{"nullable":true,"type":"string"},"identifier":{"example":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","nullable":true,"type":"string"},"status":{"example":"COMPLETED","type":"string"},"step_output":{"$ref":"#/components/schemas/ns_CustomerScreeningOutput"}},"required":["status","step_output"],"type":"object"},"ns_DeletedEmailConfigurationResponse":{"properties":{"identifier":{"description":"Email configuration unique identifier","example":"6de244da-11f8-479d-aec7-c4d2126b092e","format":"uuid","type":"string"}},"required":["identifier"],"type":"object"},"ns_EmailConfigurationLog":{"properties":{"created_at":{"description":"Timestamp when the configuration was created","format":"date-time","type":"string"},"created_by":{"description":"Created by the user","format":"uuid","type":"string"},"enabled_for":{"$ref":"#/components/schemas/ns_EnabledFor"},"identifier":{"description":"Unique identifier for the configuration","format":"uuid","type":"string"},"type":{"description":"The event type that the user wants to be notified about","example":"CASE_ASSIGNED","type":"string"},"updated_at":{"description":"Timestamp when the configuration was last updated","format":"date-time","type":"string"}},"required":["created_at","created_by","enabled_for","identifier","type","updated_at"],"type":"object"},"ns_EmailConfigurationPayload":{"properties":{"enabled_for":{"$ref":"#/components/schemas/ns_EnabledFor"},"type":{"description":"The event type that the user wants to listen to","enum":["CASE_ASSIGNED"],"nullable":true,"type":"string"}},"required":["enabled_for"],"type":"object"},"ns_EmailTestPayload":{"properties":{"email":{"description":"The recipient email address to which the test email will be sent.","example":"me@complyadvantage.com","format":"email","type":"string"}},"required":["email"],"type":"object"},"ns_EnabledFor":{"description":"Lists of user and role identifiers the email will be sent to","properties":{"roles":{"description":"List of role identifiers the email will be sent to","format":"uuid","items":{"description":"List of role identifiers the email will be sent to","format":"uuid","type":"string"},"type":"array"},"users":{"description":"List of user identifiers the email will be sent to","format":"uuid","items":{"description":"List of user identifiers the email will be sent to","format":"uuid","type":"string"},"type":"array"}},"required":["roles","users"],"type":"object"},"ns_InitialRiskScoringOutput":{"properties":{"overall_level":{"example":"LOW-RISK","nullable":true,"type":"string"},"overall_value":{"example":0,"format":"double","nullable":true,"type":"number"}},"type":"object"},"ns_InitialRiskScoringStep":{"properties":{"error_message":{"nullable":true,"type":"string"},"identifier":{"example":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","nullable":true,"type":"string"},"status":{"example":"COMPLETED","type":"string"},"step_output":{"$ref":"#/components/schemas/ns_InitialRiskScoringOutput"}},"required":["status","step_output"],"type":"object"},"ns_PaginatedResponseEmailConfigurationLog":{"properties":{"email_notification_configurations":{"items":{"$ref":"#/components/schemas/ns_EmailConfigurationLog"},"type":"array"},"first":{"description":"The URL path to the first page.","example":"/v1/resource?page_number=1","type":"string"},"next":{"description":"The URL path to the next page.","example":"/v1/resource?page_number=4","nullable":true,"type":"string"},"prev":{"description":"The URL path to the previous page.","example":"/v1/resource?page_number=2","nullable":true,"type":"string"},"self":{"description":"The URL path to the current page.","example":"/v1/resource?page_number=3","type":"string"},"total_count":{"description":"Total number of items.","example":60,"format":"int64","nullable":true,"type":"integer"}},"required":["first","self","email_notification_configurations"],"type":"object"},"ns_PaginatedResponseWebhookConfigurationLog":{"properties":{"first":{"description":"The URL path to the first page.","example":"/v1/resource?page_number=1","type":"string"},"next":{"description":"The URL path to the next page.","example":"/v1/resource?page_number=4","nullable":true,"type":"string"},"prev":{"description":"The URL path to the previous page.","example":"/v1/resource?page_number=2","nullable":true,"type":"string"},"self":{"description":"The URL path to the current page.","example":"/v1/resource?page_number=3","type":"string"},"total_count":{"description":"Total number of items.","example":60,"format":"int64","nullable":true,"type":"integer"},"webhook_notification_configurations":{"items":{"$ref":"#/components/schemas/ns_WebhookConfigurationLog"},"type":"array"}},"required":["first","self","webhook_notification_configurations"],"type":"object"},"ns_ProblemDetailErrorResponse":{"additionalProperties":true,"properties":{"detail":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","type":"string"},"instance":{"format":"uri","nullable":true,"type":"string"},"status":{"format":"int32","nullable":true,"type":"integer"},"timestamp":{"format":"date-time","type":"string"},"title":{"nullable":true,"type":"string"},"type":{"format":"uri","nullable":true,"type":"string"}},"required":["identifier","timestamp"],"type":"object"},"ns_RiskAttribute":{"properties":{"name":{"example":"country_of_residence","type":"string"},"parameter":{"example":"PT","nullable":true,"type":"string"},"score":{"example":30,"format":"double","type":"number"}},"required":["name","score"],"type":"object"},"ns_RiskCategory":{"properties":{"category_type":{"enum":["BASIC_INFORMATION","AML","COUNTRY","PRODUCT","CHANNEL","NGD_RISK","CUSTOM_FIELDS"],"type":"string"},"level":{"enum":["LOW","MEDIUM","HIGH","PROHIBITED","SKIPPED"],"example":"MEDIUM","type":"string"},"risk_attributes":{"items":{"$ref":"#/components/schemas/ns_RiskAttribute"},"type":"array"},"score":{"example":30,"format":"double","type":"number"},"weight":{"example":0.5,"format":"double","type":"number"}},"required":["category_type","level","risk_attributes","score","weight"],"type":"object"},"ns_RiskScorePayload":{"properties":{"categories_scores":{"items":{"$ref":"#/components/schemas/ns_RiskCategory"},"nullable":true,"type":"array"},"level":{"enum":["LOW","MEDIUM","HIGH","PROHIBITED","SKIPPED"],"example":"HIGH","type":"string"},"manual_override":{"example":false,"type":"boolean"},"score":{"example":75,"format":"double","type":"number"}},"required":["level","manual_override","score"],"type":"object"},"ns_Subject":{"properties":{"external_identifier":{"example":"your unique subject identifier","nullable":true,"type":"string"},"identifier":{"example":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","nullable":true,"type":"string"},"type":{"example":"CUSTOMER","type":"string"},"version":{"example":"1","nullable":true,"type":"string"}},"required":["type"],"type":"object"},"ns_TestEmailResponse":{"properties":{"identifier":{"description":"Test email unique identifier","example":"6de244da-11f8-479d-aec7-c4d2126b092e","format":"uuid","type":"string"},"test_result":{"$ref":"#/components/schemas/ns_TestEmailResult"}},"required":["identifier","test_result"],"type":"object"},"ns_TestEmailResult":{"description":"Response from the SMTP email server on the attempt to send","properties":{"response_type":{"description":"Type of response","enum":["SUCCESS","SERVER_ERROR"],"example":"SUCCESS","format":"String","type":"string"},"server_response_code":{"description":"SMTP server response","example":200,"format":"int32","nullable":true,"type":"integer"}},"required":["response_type"],"type":"object"},"ns_TestResult":{"properties":{"response_type":{"description":"Server response type","enum":["SUCCESS","REDIRECTION","CLIENT_REQUEST_ERROR","SERVER_ERROR","NO_RESPONSE","OAUTH_CLIENT_REQUEST_ERROR","OAUTH_SERVER_ERROR","OAUTH_NO_RESPONSE"],"type":"string"},"server_response_code":{"description":"Server response code","format":"int32","type":"integer"}},"required":["response_type","server_response_code"],"type":"object"},"ns_TestWebhookResponse":{"properties":{"identifier":{"description":"Test webhook unique identifier","format":"uuid","type":"string"},"test_result":{"$ref":"#/components/schemas/ns_TestResult"}},"required":["identifier","test_result"],"type":"object"},"ns_TransactionReviewedV3JsonPayload":{"properties":{"account_identifier":{"example":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","type":"string"},"api_version":{"example":"v3","type":"string"},"evaluation_outcome":{"example":"HOLD","type":"string"},"review_decision":{"example":"RELEASE","type":"string"},"transaction_external_identifier":{"example":"your unique transaction identifier","type":"string"},"transaction_identifier":{"example":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","type":"string"},"webhook_type":{"example":"TRANSACTION_REVIEWED","type":"string"}},"required":["account_identifier","api_version","evaluation_outcome","review_decision","transaction_external_identifier","transaction_identifier","webhook_type"],"type":"object"},"ns_UpdateEmailConfigurationPayload":{"properties":{"enabled_for":{"$ref":"#/components/schemas/ns_EnabledFor"}},"required":["enabled_for"],"type":"object"},"ns_UpdateWebhookPayload":{"properties":{"is_active":{"description":"This flag sets whether the webhook is active or not.\nIf 'true', Mesh sends updates when the monitored events take place.\nIf 'false', Mesh will not send any updates.\n","example":false,"nullable":true,"type":"boolean"},"name":{"description":"The name of the webhook configuration.","example":"New Name","nullable":true,"type":"string"},"url":{"description":"The client side URL that webhooks should be sent to","example":"https://www.example.org/hooks","format":"url","nullable":true,"type":"string"}},"type":"object"},"ns_UpdatedWebhookConfigurationResponse":{"properties":{"identifier":{"description":"The identifier of the webhook notification configuration that has been updated","example":"70f0581a-8d09-4077-8dcc-0d78d3f687e3","format":"uuid","type":"string"}},"required":["identifier"],"type":"object"},"ns_WebhookConfigurationLog":{"properties":{"created_at":{"description":"The datetime that the webook notification configuration was created","example":"2022-01-31T14:27:24.000Z","format":"date-time","type":"string"},"created_by":{"description":"The user who created the webhook notification configuration","example":"6de244da-11f8-479d-aec7-c4d2126b092e","format":"uuid","type":"string"},"identifier":{"description":"Identifier of the webhook notification configuration object","example":"6de244da-11f8-479d-aec7-c4d2126b092e","format":"uuid","type":"string"},"is_active":{"description":"The flag to make webhooks active or inactive","example":true,"type":"boolean"},"name":{"description":"The client provided name for the webhook configration","example":"example name","type":"string"},"type":{"description":"The type of webhook notification configuration being created","enum":["CASE_CREATED","CASE_STATE_UPDATED","WORKFLOW_COMPLETED","CASE_ALERT_LIST_UPDATED","CSOM_EMULATION_MATCH_STATUS_UPDATED","CSOM_EMULATION_SEARCH_STATUS_UPDATED","CSOM_EMULATION_MONITORED_SEARCH_UPDATED","TRANSACTION_REVIEWED"],"example":"CASE_CREATED","type":"string"},"updated_at":{"description":"The datetime that the webhook notification configuration was last updated","example":"2022-01-31T14:27:24.000Z","format":"date-time","type":"string"},"url":{"description":"The client side URL to send the webhooks to","example":"https://www.example.org/hooks","format":"url","type":"string"}},"required":["created_at","created_by","identifier","is_active","name","type","updated_at","url"],"type":"object"},"ns_WebhookConfigurationPayload":{"properties":{"is_active":{"description":"This flag sets whether the webhook is in use or not. If 'true' Mesh sends updates when the monitored events take place. If 'false', Mesh will not send any updates. If unset default value will always be true.","example":true,"type":"boolean"},"name":{"description":"The name of the webhook configuration.","example":"example","type":"string"},"type":{"description":"The type of webhook notification configuration being created","enum":["CASE_CREATED","CASE_STATE_UPDATED","WORKFLOW_COMPLETED","CASE_ALERT_LIST_UPDATED","TRANSACTION_REVIEWED"],"example":"CASE_CREATED","type":"string"},"url":{"description":"The client side URL that webhooks should be sent to","example":"https://www.example.org/hooks","format":"url","type":"string"}},"required":["is_active","name","type","url"],"type":"object"},"ns_WebhookTestPayload":{"properties":{"url":{"description":"The URL you want the example payload sent to.","example":"https://example.com/webhook-receive","type":"string"}},"required":["url"],"type":"object"},"ns_WorkflowAlert":{"properties":{"identifier":{"example":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","type":"string"}},"required":["identifier"],"type":"object"},"ns_WorkflowCompletedV2JsonPayload":{"properties":{"account_identifier":{"example":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","type":"string"},"api_version":{"example":"v2","type":"string"},"status":{"example":"COMPLETED","type":"string"},"step_details":{"$ref":"#/components/schemas/ns_WorkflowStepDetails"},"steps":{"example":["customer-creation","initial-risk-scoring","customer-screening","alerting"],"items":{"example":"[\"customer-creation\",\"initial-risk-scoring\",\"customer-screening\",\"alerting\"]","type":"string"},"type":"array"},"webhook_type":{"example":"WORKFLOW_COMPLETED","type":"string"},"workflow_instance_identifier":{"example":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","type":"string"},"workflow_type":{"example":"create-and-screen","type":"string"}},"required":["account_identifier","api_version","status","step_details","steps","webhook_type","workflow_instance_identifier","workflow_type"],"type":"object"},"ns_WorkflowStepDetails":{"properties":{"alerting":{"$ref":"#/components/schemas/ns_AlertingStep"},"case-creation":{"$ref":"#/components/schemas/ns_CaseCreationStep"},"customer-creation":{"$ref":"#/components/schemas/ns_CustomerCreationStep"},"customer-screening":{"$ref":"#/components/schemas/ns_CustomerScreeningStep"},"initial-risk-scoring":{"$ref":"#/components/schemas/ns_InitialRiskScoringStep"}},"type":"object"},"ol_AccountBalanceV3":{"description":"Represents the balance of a financial account.","properties":{"current_balance":{"$ref":"#/components/schemas/ol_MonetaryValueV3"}},"required":["current_balance"],"type":"object"},"ol_AcquirerV3":{"description":"Represents the payment acquirer information.","properties":{"details":{"$ref":"#/components/schemas/ol_PartyIdentificationV3"},"identifier":{"description":"Unique acquirer identifier.","example":"acq_visa_usa","maxLength":50,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"ol_Address":{"properties":{"address_line1":{"maxLength":150,"minLength":0,"nullable":true,"type":"string"},"address_line2":{"maxLength":150,"minLength":0,"nullable":true,"type":"string"},"country":{"enum":["AF","AX","AL","AN","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","MK","RO","RU","RW","RE","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","US","UY","UZ","VU","VE","VN","VG","VI","WF","EH","XK","YE","ZM","ZW"],"format":"iso-3166-alpha-2","nullable":true,"type":"string"},"country_subdivision":{"maxLength":50,"minLength":0,"nullable":true,"type":"string"},"postal_code":{"maxLength":50,"minLength":0,"nullable":true,"type":"string"},"town_name":{"maxLength":50,"minLength":0,"nullable":true,"type":"string"},"type":{"enum":["RESIDENTIAL_ADDRESS","MAILING_ADDRESS","OPERATING_ADDRESS","REGISTRATION_ADDRESS","BILLING_ADDRESS"],"nullable":true,"type":"string"}},"type":"object"},"ol_AddressFormatV3":{"description":"Represents the format of the address used for a party.","enum":["STRUCTURED","UNSTRUCTURED"],"example":"STRUCTURED","type":"string"},"ol_AddressTypeV3":{"description":"Represents the type of address.","enum":["RESIDENTIAL","MAILING","OPERATING","REGISTRATION","BILLING"],"example":"MAILING","type":"string"},"ol_AddressV3":{"description":"The address of the party.","discriminator":{"propertyName":"format"},"properties":{"format":{"$ref":"#/components/schemas/ol_AddressFormatV3"}},"required":["format"],"type":"object"},"ol_AgentRoleV3":{"description":"The roles an agent may take within a financial transaction.","enum":["COUNTERPARTY_BANK","INTERMEDIARY"],"example":"COUNTERPARTY_BANK","type":"string"},"ol_AgentV3":{"description":"Represents an agent in a financial transaction.","properties":{"bank":{"$ref":"#/components/schemas/ol_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/ol_MoneyTransferOperatorV3"},"online_remittance_platform":{"$ref":"#/components/schemas/ol_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/ol_AgentRoleV3"}},"required":["role"],"type":"object"},"ol_AlertStep":{"properties":{"alert_skipped_code":{"enum":["ALERT_SKIPPED_CODE_UNSPECIFIED","ALERT_SKIPPED_CODE_NO_ALERT_REQUIRED","ALERT_SKIPPED_CODE_MANUAL_SUPPRESSION","ALERT_SKIPPED_CODE_FROM_SOURCE"],"nullable":true,"type":"string"},"identifier":{"format":"uuid","type":"string"}},"required":["identifier"],"type":"object"},"ol_AlertingStepOutput":{"properties":{"alerts":{"items":{"$ref":"#/components/schemas/ol_AlertStep"},"type":"array"}},"required":["alerts"],"type":"object"},"ol_AsyncWorkflowResponse":{"properties":{"workflow_instance_identifier":{"format":"uuid","nullable":true,"type":"string"}},"type":"object"},"ol_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/ol_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/ol_MonetaryValueV3"}},"type":"object"},"ol_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"},"ol_Bank":{"properties":{"bic":{"maxLength":11,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"ol_BankAccount":{"properties":{"account_number":{"maxLength":34,"minLength":0,"nullable":true,"type":"string"},"bank":{"$ref":"#/components/schemas/ol_Bank"},"bban":{"maxLength":30,"minLength":0,"nullable":true,"type":"string"},"iban":{"nullable":true,"type":"string"},"sort_code":{"maxLength":11,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"ol_BankPaymentMonetaryTransactionTypeDetailsV3":{"allOf":[{"$ref":"#/components/schemas/ol_MonetaryTransactionTypeDetailsV3"},{"properties":{"agents":{"description":"Any intermediaries involved in the transaction between the creditor and the debtor.","items":{"$ref":"#/components/schemas/ol_AgentV3"},"maxItems":10,"minItems":0,"type":"array"},"creditor":{"$ref":"#/components/schemas/ol_PartyIdentificationV3"},"debtor":{"$ref":"#/components/schemas/ol_PartyIdentificationV3"},"payment_scheme":{"$ref":"#/components/schemas/ol_PaymentSchemeV3"},"state":{"$ref":"#/components/schemas/ol_BankPaymentStateV3"},"ultimate_creditor":{"$ref":"#/components/schemas/ol_PartyIdentificationV3"},"ultimate_debtor":{"$ref":"#/components/schemas/ol_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"],"type":"object"},"ol_BankPaymentStateV3":{"description":"The possible states of a bank payment transaction.","enum":["PENDING","BOOKED"],"example":"BOOKED","type":"string"},"ol_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/ol_StructuredAddressV3"},"name":{"description":"The name of the bank.","example":"Deutsche Bank","maxLength":256,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"ol_BooleanEnrichmentValueV3":{"allOf":[{"$ref":"#/components/schemas/ol_EnrichmentValueV3"},{"properties":{"boolean":{"description":"The boolean value","example":true,"type":"boolean"}},"type":"object"}],"description":"Boolean representation of the enrichment value.","required":["boolean","data_type"],"type":"object"},"ol_CardFundingTypeV3":{"description":"Defines the funding type of a payment card.","enum":["CREDIT","DEBIT","PREPAID","OTHER"],"example":"CREDIT","type":"string"},"ol_CardHolderV3":{"description":"Represents a card holder with party identification details and onboarding information.","properties":{"details":{"$ref":"#/components/schemas/ol_PartyIdentificationV3"}},"type":"object"},"ol_CardPaymentMonetaryTransactionTypeDetailsV3":{"allOf":[{"$ref":"#/components/schemas/ol_MonetaryTransactionTypeDetailsV3"},{"properties":{"acquirer":{"$ref":"#/components/schemas/ol_AcquirerV3"},"card":{"$ref":"#/components/schemas/ol_PaymentCardV3"},"card_holder":{"$ref":"#/components/schemas/ol_CardHolderV3"},"card_payment_scope":{"$ref":"#/components/schemas/ol_CardPaymentScopeV3"},"card_payment_type":{"$ref":"#/components/schemas/ol_CardPaymentTypeV3"},"card_scheme":{"$ref":"#/components/schemas/ol_CardSchemeV3"},"card_verification_results":{"$ref":"#/components/schemas/ol_CardVerificationResultsV3"},"issuer":{"$ref":"#/components/schemas/ol_IssuerV3"},"merchant":{"$ref":"#/components/schemas/ol_MerchantV3"},"payment_stage":{"$ref":"#/components/schemas/ol_CardPaymentStageV3"},"payment_stages_info":{"$ref":"#/components/schemas/ol_PaymentStagesInfoV3"},"point_of_sale":{"$ref":"#/components/schemas/ol_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/ol_MerchantV3"}},"type":"object"}],"description":"Models a card payment transaction where funds are transferred using a payment card.","required":["type"],"type":"object"},"ol_CardPaymentScopeV3":{"description":"Defines the scope of a card payment transaction.","enum":["DOMESTIC","CROSSBORDER"],"example":"DOMESTIC","type":"string"},"ol_CardPaymentStageV3":{"description":"Defines the stage of a card payment transaction.","enum":["AUTHORIZED","SETTLED","REVERSED","PARTIALLY_SETTLED","CHARGEBACK"],"example":"SETTLED","type":"string"},"ol_CardPaymentTypeV3":{"description":"Defines the type of card payment.","enum":["REGULAR","INSTALLMENT","RECURRING","MOTO","UNSCHEDULED","TOP_UP","REFUND","OTHER","AUTH_ONLY"],"example":"REGULAR","type":"string"},"ol_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"},"ol_CardVerificationResultsV3":{"description":"Represents card verification results including CVV, AVS, and identity checks.","properties":{"avs_check":{"$ref":"#/components/schemas/ol_VerificationCheckV3"},"cvc_check":{"$ref":"#/components/schemas/ol_VerificationCheckV3"},"three_d_secure_check":{"$ref":"#/components/schemas/ol_VerificationCheckV3"}},"type":"object"},"ol_CardWalletTypeV3":{"description":"Defines the type of digital wallet.","enum":["GOOGLE_PAY","APPLE_PAY","PAYPAL","REMOTE_COMMERCE_PROGRAMS","OTHER"],"example":"APPLE_PAY","type":"string"},"ol_CaseCreationStepOutput":{"properties":{"case_identifier":{"format":"uuid","type":"string"}},"required":["case_identifier"],"type":"object"},"ol_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"},"ol_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/ol_MonetaryValueV3"}},"required":["timestamp","value"],"type":"object"},"ol_Company":{"properties":{"address":{"items":{"$ref":"#/components/schemas/ol_Address"},"nullable":true,"type":"array"},"alias":{"items":{"type":"string"},"nullable":true,"type":"array"},"company_type":{"maxLength":50,"minLength":0,"nullable":true,"type":"string"},"custom_fields":{"items":{"$ref":"#/components/schemas/ol_CustomFieldInstance"},"nullable":true,"type":"array"},"incorporation_date":{"$ref":"#/components/schemas/ol_Date"},"industry":{"maxLength":50,"minLength":0,"nullable":true,"type":"string"},"legal_name":{"maxLength":256,"minLength":0,"type":"string"},"place_of_registration":{"format":"iso-3166-2","maxLength":6,"minLength":2,"nullable":true,"type":"string"},"registration_authority_identification":{"maxLength":50,"minLength":0,"nullable":true,"type":"string"},"source_of_income":{"maxLength":50,"minLength":0,"nullable":true,"type":"string"},"status_summary":{"enum":["UNKNOWN","ACTIVE","INACTIVE"],"nullable":true,"type":"string"}},"required":["legal_name"],"type":"object"},"ol_ConfigurationDTO":{"description":"Optional array specifying sync/async processing configuration for Payment Screening and Transaction Monitoring.","properties":{"evaluation_result_delivery":{"$ref":"#/components/schemas/ol_EvaluationResultDeliveryDTO"},"identifiers":{"items":{"format":"uuid","type":"string"},"maxItems":2147483647,"minItems":1,"type":"array","uniqueItems":true},"processing_method":{"enum":["SYNCHRONOUS","ASYNCHRONOUS"],"type":"string"},"type":{"enum":["PAYMENT_SCREENING","TRANSACTION_MONITORING"],"type":"string"}},"required":["identifiers","processing_method","type"],"type":"object"},"ol_ContactInformation":{"properties":{"email_address":{"items":{"type":"string"},"nullable":true,"type":"array"},"fax_number":{"items":{"type":"string"},"nullable":true,"type":"array"},"phone_number":{"items":{"type":"string"},"nullable":true,"type":"array"},"url":{"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"},"ol_CounterpartyPartyIdentifierV3":{"allOf":[{"$ref":"#/components/schemas/ol_PartyIdentifierV3"},{"properties":{"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"],"type":"object"},"ol_CreateAndProcessTransactionDTO":{"properties":{"configurations":{"description":"Optional array specifying sync/async processing configuration for Payment Screening and Transaction Monitoring.","items":{"$ref":"#/components/schemas/ol_ConfigurationDTO"},"nullable":true,"type":"array"},"customers":{"description":"The list of customers.","items":{"$ref":"#/components/schemas/ol_CustomerApi"},"maxItems":1,"minItems":0,"nullable":true,"type":"array","uniqueItems":true},"scenario_configuration_identifiers":{"description":"The list of scenario configurations the transaction should be monitored against.","items":{"description":"The list of scenario configurations the transaction should be monitored against.","format":"uuid","type":"string"},"maxItems":1,"minItems":0,"nullable":true,"type":"array","uniqueItems":true},"screening_configuration_identifier":{"description":"The configuration identifier to be used to screening the transaction.","format":"uuid","nullable":true,"type":"string"},"transaction":{"$ref":"#/components/schemas/ol_TransactionV3"}},"required":["transaction"],"type":"object"},"ol_CreateAndScreenCustomerRequest":{"description":"Create and screen customer synchronously","properties":{"configuration":{"$ref":"#/components/schemas/ol_CustomerConfigData"},"customer":{"$ref":"#/components/schemas/ol_CustomerApi"},"monitoring":{"$ref":"#/components/schemas/ol_CustomerMonitoringData"},"product":{"description":"Represents a list of products. They can be either a bank account or a crypto wallet.","items":{"$ref":"#/components/schemas/ol_ProductApi"},"nullable":true,"type":"array"}},"required":["customer"],"type":"object"},"ol_CryptoWallet":{"properties":{"managing_exchange":{"maxLength":50,"minLength":0,"nullable":true,"type":"string"},"wallet_identifier":{"maxLength":256,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"ol_CustomFieldDataType":{"description":"The type of data stored in a custom field.","enum":["TEXT","INTEGER","DECIMAL"],"type":"string"},"ol_CustomFieldDataTypeV3":{"description":"The type of data stored in a custom field.","enum":["TEXT","DECIMAL"],"type":"string"},"ol_CustomFieldInstance":{"description":"The instance of a custom field as it relates to a specific customer.","properties":{"key":{"description":"The key of the custom field.","example":"field_key","type":"string"},"value":{"oneOf":[{"$ref":"#/components/schemas/ol_DecimalValue"},{"$ref":"#/components/schemas/ol_IntegerValue"},{"$ref":"#/components/schemas/ol_TextValue"}]}},"required":["key","value"],"type":"object"},"ol_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/ol_DecimalValueV3","TEXT":"#/components/schemas/ol_TextValueV3"},"propertyName":"data_type"},"oneOf":[{"$ref":"#/components/schemas/ol_DecimalValueV3"},{"$ref":"#/components/schemas/ol_TextValueV3"}]}},"required":["key","value"],"type":"object"},"ol_CustomFieldValue":{"description":"The value of the custom field.","discriminator":{"mapping":{"DECIMAL":"#/components/schemas/ol_DecimalValue","INTEGER":"#/components/schemas/ol_IntegerValue","TEXT":"#/components/schemas/ol_TextValue"},"propertyName":"data_type"},"properties":{"data_type":{"$ref":"#/components/schemas/ol_CustomFieldDataType"}},"required":["data_type"],"type":"object"},"ol_CustomFieldValueV3":{"description":"The value of the custom field.","discriminator":{"propertyName":"data_type"},"properties":{"data_type":{"$ref":"#/components/schemas/ol_CustomFieldDataTypeV3"}},"required":["data_type"],"type":"object"},"ol_CustomerApi":{"description":"Customer to be created and screened. It can be either a person, a company or undefined.","properties":{"acquisition_source":{"maxLength":256,"minLength":0,"nullable":true,"type":"string"},"company":{"$ref":"#/components/schemas/ol_Company"},"customer_since":{"$ref":"#/components/schemas/ol_Date"},"external_identifier":{"maxLength":256,"minLength":0,"type":"string"},"person":{"$ref":"#/components/schemas/ol_Person"},"undefined":{"$ref":"#/components/schemas/ol_CustomerTypeUndefined"}},"required":["external_identifier"],"type":"object"},"ol_CustomerConfigData":{"description":"Represents monitoring and screening configurations.","properties":{"screening_configuration_identifier":{"description":"The identifier of the screening configuration","example":"0f17930c-a4e6-4fef-b913-6a12ad5afd12","format":"uuid","nullable":true,"type":"string"}},"type":"object"},"ol_CustomerCreationStepOutput":{"properties":{"customer_identifier":{"format":"uuid","type":"string"},"external_identifier":{"type":"string"}},"required":["customer_identifier","external_identifier"],"type":"object"},"ol_CustomerEntityScreeningMonitoring":{"properties":{"configuration_identifier":{"description":"The identifier of the screening monitor configuration","example":"0f17930c-a4e6-4fef-b913-6a12ad5afd12","format":"uuid","nullable":true,"type":"string"},"enabled":{"type":"boolean"}},"required":["enabled"],"type":"object"},"ol_CustomerMonitoringData":{"description":"Represents monitoring configuration.","properties":{"entity_screening":{"$ref":"#/components/schemas/ol_CustomerEntityScreeningMonitoring"}},"type":"object"},"ol_CustomerPartyIdentifierV3":{"allOf":[{"$ref":"#/components/schemas/ol_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"],"type":"object"},"ol_CustomerScreeningStepOutput":{"properties":{"aml_types":{"items":{"enum":["UNSPECIFIED","ADVERSE_MEDIA","ADVERSE_MEDIA_GENERAL","ADVERSE_MEDIA_V2_OTHER_MINOR","ADVERSE_MEDIA_V2_EU_AML_DIRECTIVE","ADVERSE_MEDIA_V1_HIGH_RISK","ADVERSE_MEDIA_VIOLENT_CRIME","ADVERSE_MEDIA_V2_VIOLENCE_AML_CFT","ADVERSE_MEDIA_V2_VIOLENCE_NON_AML_CFT","ADVERSE_MEDIA_FINANCIAL_CRIME","WARNING","PEP","ADVERSE_MEDIA_V2_PROPERTY","PEP_CLASS_1_TO_3","ADVERSE_MEDIA_NARCOTICS","ADVERSE_MEDIA_V2_NARCOTICS_AML_CFT","FITNESS_PROBITY","ADVERSE_MEDIA_FRAUD","ADVERSE_MEDIA_V2_FRAUD_LINKED","PEP_CLASS_2","ADVERSE_MEDIA_V2_REGULATORY","PEP_CLASS_1","ADVERSE_MEDIA_V2_GENERAL_AML_CFT","ADVERSE_MEDIA_V2_OTHER_SERIOUS","ADVERSE_MEDIA_TERRORISM","ADVERSE_MEDIA_V2_FINANCIAL_AML_CFT","ADVERSE_MEDIA_V2_FINANCIAL_DIFFICULTY","PEP_CLASS_4","ADVERSE_MEDIA_V2_TERRORISM","ADVERSE_MEDIA_SEXUAL_CRIME","PEP_CLASS_3","ADVERSE_MEDIA_V2_CYBERCRIME","SANCTION","ADVERSE_MEDIA_V2_OTHER_FINANCIAL","SANCTION_RELATED","CUSTOM"],"type":"string"},"nullable":true,"type":"array"},"screening_result":{"$ref":"#/components/schemas/ol_ScreeningResult"}},"required":["screening_result"],"type":"object"},"ol_CustomerTypeUndefined":{"properties":{"birth_year":{"format":"int32","nullable":true,"type":"integer"},"country":{"format":"iso-3166-alpha-2","items":{"enum":["AF","AX","AL","AN","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","MK","RO","RU","RW","RE","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","US","UY","UZ","VU","VE","VN","VG","VI","WF","EH","XK","YE","ZM","ZW"],"format":"iso-3166-alpha-2","type":"string"},"nullable":true,"type":"array"},"name":{"maxLength":256,"minLength":0,"type":"string"}},"required":["name"],"type":"object"},"ol_CustomerUpdateStepOutput":{"properties":{"customer_identifier":{"format":"uuid","type":"string"},"customer_version":{"format":"int32","type":"integer"},"external_identifier":{"type":"string"}},"required":["customer_identifier","customer_version","external_identifier"],"type":"object"},"ol_Date":{"properties":{"day":{"format":"int32","nullable":true,"type":"integer"},"month":{"format":"int32","nullable":true,"type":"integer"},"year":{"format":"int32","nullable":true,"type":"integer"}},"type":"object"},"ol_DecimalEnrichmentValueV3":{"allOf":[{"$ref":"#/components/schemas/ol_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"],"type":"object"},"ol_DecimalValue":{"allOf":[{"$ref":"#/components/schemas/ol_CustomFieldValue"},{"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"],"type":"object"},"ol_DecimalValueV3":{"allOf":[{"$ref":"#/components/schemas/ol_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"],"type":"object"},"ol_DecisionStepOutput":{"properties":{"decision":{"enum":["UNKNOWN","PROCESS","HOLD","REJECT"],"type":"string"}},"required":["decision"],"type":"object"},"ol_EmptyStepOutput":{"type":"object"},"ol_EnrichmentDataTypeV3":{"description":"The type of data stored in an enrichment value.","enum":["TEXT","DECIMAL","BOOLEAN"],"type":"string"},"ol_EnrichmentStepOutput":{"properties":{"enrichments":{"items":{"$ref":"#/components/schemas/ol_EnrichmentV3"},"type":"array"}},"required":["enrichments"],"type":"object"},"ol_EnrichmentTypeV3":{"description":"The type of enrichment source.","enum":["LOOKUP_LIST"],"example":"LOOKUP_LIST","type":"string"},"ol_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/ol_EnrichmentTypeV3"},"value":{"discriminator":{"mapping":{"BOOLEAN":"#/components/schemas/ol_BooleanEnrichmentValueV3","DECIMAL":"#/components/schemas/ol_DecimalEnrichmentValueV3","TEXT":"#/components/schemas/ol_TextEnrichmentValueV3"},"propertyName":"data_type"},"oneOf":[{"$ref":"#/components/schemas/ol_BooleanEnrichmentValueV3"},{"$ref":"#/components/schemas/ol_DecimalEnrichmentValueV3"},{"$ref":"#/components/schemas/ol_TextEnrichmentValueV3"}]}},"required":["key","type","value"],"type":"object"},"ol_EnrichmentValueV3":{"description":"The value of the enrichment.","discriminator":{"propertyName":"data_type"},"properties":{"data_type":{"$ref":"#/components/schemas/ol_EnrichmentDataTypeV3"}},"required":["data_type"],"type":"object"},"ol_EvaluationErrorDTO":{"description":"Detail on the evaluation error of the scenario if any","example":{"detail":"Missing field value: transaction_identifier","title":"Input Validation Error"},"properties":{"detail":{"type":"string"},"title":{"type":"string"}},"required":["detail","title"],"type":"object"},"ol_EvaluationResultDTO":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ol_EvaluationErrorDTO"},"type":"array"},"outcome":{"enum":["PROCESS","ALLOW","HOLD","REJECT","UNKNOWN","ERROR","PENDING"],"type":"string"},"scenario_evaluations":{"items":{"$ref":"#/components/schemas/ol_ScenarioConfigurationEvaluationDTO"},"type":"array","uniqueItems":true},"screening_evaluation_results":{"$ref":"#/components/schemas/ol_TransactionScreeningEvaluationDTO"}},"required":["errors","outcome","scenario_evaluations"],"type":"object"},"ol_EvaluationResultDeliveryDTO":{"properties":{"method":{"enum":["WEBHOOK"],"type":"string"},"webhook_identifier":{"type":"string"}},"required":["method","webhook_identifier"],"type":"object"},"ol_EvaluationResultDeliveryResponseDTO":{"properties":{"method":{"enum":["WEBHOOK"],"type":"string"},"webhook_identifier":{"type":"string"}},"required":["method","webhook_identifier"],"type":"object"},"ol_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","type":"string"},"ol_FincenDetailsV3":{"description":"FinCEN transaction details.","properties":{"fincen_cash_transaction_subtype":{"$ref":"#/components/schemas/ol_FincenCashTransactionSubtype"}},"required":["fincen_cash_transaction_subtype"],"type":"object"},"ol_FullRiskScoringStepOutput":{"properties":{"overall_level":{"enum":["UNSPECIFIED-RISK","LOW-RISK","MEDIUM-RISK","HIGH-RISK","PROHIBITED","SKIPPED"],"type":"string"},"overall_value":{"format":"double","type":"number"}},"required":["overall_level","overall_value"],"type":"object"},"ol_InBranch":{"properties":{"branch_identifier":{"maxLength":256,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"ol_InitialRiskScoringStepOutput":{"properties":{"overall_level":{"enum":["UNSPECIFIED-RISK","LOW-RISK","MEDIUM-RISK","HIGH-RISK","PROHIBITED","SKIPPED"],"type":"string"},"overall_value":{"format":"double","type":"number"}},"required":["overall_level","overall_value"],"type":"object"},"ol_IntegerValue":{"allOf":[{"$ref":"#/components/schemas/ol_CustomFieldValue"},{"properties":{"integer":{"description":"The integer content.","example":30,"format":"int64","type":"integer"}},"type":"object"}],"description":"Integer representation of the custom field value.","required":["data_type","integer"],"type":"object"},"ol_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/ol_PartyIdentificationV3"}},"type":"object"},"ol_LongRange":{"properties":{"high":{"format":"int64","type":"integer"},"low":{"format":"int64","type":"integer"}},"required":["high","low"],"type":"object"},"ol_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/ol_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"},"ol_MonetaryTransactionClassificationDetailsV3":{"allOf":[{"$ref":"#/components/schemas/ol_TransactionClassificationDetailsV3"},{"properties":{"base_value":{"$ref":"#/components/schemas/ol_MonetaryValueV3"},"customer_account_balance":{"$ref":"#/components/schemas/ol_AccountBalanceV3"},"details":{"discriminator":{"mapping":{"BANK_PAYMENT":"#/components/schemas/ol_BankPaymentMonetaryTransactionTypeDetailsV3","CARD_PAYMENT":"#/components/schemas/ol_CardPaymentMonetaryTransactionTypeDetailsV3","REMITTANCE":"#/components/schemas/ol_RemittanceMonetaryTransactionTypeDetailsV3"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/ol_BankPaymentMonetaryTransactionTypeDetailsV3"},{"$ref":"#/components/schemas/ol_CardPaymentMonetaryTransactionTypeDetailsV3"},{"$ref":"#/components/schemas/ol_RemittanceMonetaryTransactionTypeDetailsV3"}]},"direction":{"$ref":"#/components/schemas/ol_MonetaryTransactionDirectionV3"},"payment_channel":{"$ref":"#/components/schemas/ol_PaymentChannelV3"},"product_name":{"description":"The freeform name of the product being used to perform the financial transaction.","example":"Product X, Issue 1","maxLength":256,"minLength":0,"type":"string"},"reference_text":{"description":"The reference text supplied as part of the financial transaction (if any).","example":"Invoice 1234","maxLength":512,"minLength":0,"type":"string"},"value":{"$ref":"#/components/schemas/ol_MonetaryValueV3"}},"type":"object"}],"description":"Details related to a monetary transaction.","required":["base_value","classification","details"],"type":"object"},"ol_MonetaryTransactionDirectionV3":{"description":"Defines the direction of the flow of value in the transaction in relation to the primary Customer in a Monetary Transaction.","enum":["OUTBOUND","INBOUND"],"readOnly":true,"type":"string"},"ol_MonetaryTransactionTypeDetailsV3":{"description":"Details specific to the a Monetary Transaction.","discriminator":{"propertyName":"type"},"properties":{"type":{"$ref":"#/components/schemas/ol_MonetaryTransactionTypeV3"}},"required":["type"],"type":"object"},"ol_MonetaryTransactionTypeV3":{"description":"Defines the type of a monetary transaction.","enum":["BANK_PAYMENT","CARD_PAYMENT","REMITTANCE"],"example":"BANK_PAYMENT","type":"string"},"ol_MonetaryValueV3":{"description":"Represents a combination of a decimal amount with a currency.","properties":{"amount":{"description":"The decimal amount/value.","example":10.02,"type":"number"},"currency":{"description":"3 letter currency code as defined by ISO-4217.","example":"EUR","format":"iso-4217","maxLength":3,"minLength":3,"type":"string"}},"required":["amount","currency"],"type":"object"},"ol_MoneyTransferOperatorV3":{"description":"Represents a money transfer operator's details.","properties":{"identifier":{"description":"A unique identifier for the money transfer operator, such as a SWIFT BIC or regulatory identifier.","example":"WUIBUS6S","maxLength":256,"minLength":0,"nullable":true,"type":"string"},"name":{"description":"The legal name of the money transfer operator.","example":"Western Union","maxLength":256,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"ol_NetWorth":{"properties":{"amount":{"format":"int64","nullable":true,"type":"integer"},"currency":{"enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","XXX","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","SHP","WST","STN","SAR","RSD","SCR","SLL","SLE","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","TZS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VED","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XAU","XPD","XPT","XAG"],"format":"iso-4217","nullable":true,"type":"string"}},"type":"object"},"ol_OnboardingChannelApi":{"properties":{"in_branch":{"$ref":"#/components/schemas/ol_InBranch"},"online":{"$ref":"#/components/schemas/ol_Online"}},"type":"object"},"ol_Online":{"properties":{"device_identifier":{"maxLength":256,"minLength":0,"nullable":true,"type":"string"},"device_type":{"maxLength":50,"minLength":0,"nullable":true,"type":"string"},"ip_address":{"nullable":true,"type":"string"},"ip_format":{"enum":["IPV4","IPV6"],"nullable":true,"type":"string"}},"type":"object"},"ol_OnlineRemittancePlatformV3":{"description":"Represents an online remittance platform's details.","properties":{"identifier":{"description":"A unique identifier for the online remittance platform.","example":"remittance-identifier","maxLength":256,"minLength":0,"nullable":true,"type":"string"},"name":{"description":"The brand or platform name of the online remittance service.","example":"Wise","maxLength":256,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"ol_PartyIdentificationV3":{"description":"Represents the identification details of a party. This includes not just the party's identifier, but also any other identifying information specific to the transaction such as alternate names or addresses.","properties":{"address":{"discriminator":{"mapping":{"STRUCTURED":"#/components/schemas/ol_StructuredAddressV3","UNSTRUCTURED":"#/components/schemas/ol_UnstructuredAddressV3"},"propertyName":"format"},"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ol_StructuredAddressV3"},{"$ref":"#/components/schemas/ol_UnstructuredAddressV3"}]},"identifier":{"discriminator":{"mapping":{"COUNTERPARTY":"#/components/schemas/ol_CounterpartyPartyIdentifierV3","CUSTOMER":"#/components/schemas/ol_CustomerPartyIdentifierV3"},"propertyName":"type"},"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ol_CounterpartyPartyIdentifierV3"},{"$ref":"#/components/schemas/ol_CustomerPartyIdentifierV3"}]},"name":{"description":"The name of the party.","example":"John Doe","maxLength":256,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"ol_PartyIdentifierV3":{"description":"Party identifier details","discriminator":{"propertyName":"type"},"properties":{"type":{"description":"The type of party identifier.","enum":["CUSTOMER","COUNTERPARTY"],"example":"CUSTOMER","type":"string"}},"required":["type"],"type":"object"},"ol_PaymentCardV3":{"description":"Details about a payment card used in a transaction.","properties":{"fingerprint":{"description":"Unique hashed card identifier for tracking.","example":"card_fingerprint_123456","maxLength":100,"minLength":0,"type":"string"},"funding_type":{"$ref":"#/components/schemas/ol_CardFundingTypeV3"},"wallet_identifier":{"description":"Digital wallet identifier if applicable.","example":"wallet_12345678","maxLength":50,"minLength":0,"nullable":true,"type":"string"},"wallet_type":{"$ref":"#/components/schemas/ol_CardWalletTypeV3"}},"required":["fingerprint"],"type":"object"},"ol_PaymentChannelV3":{"description":"The channel used for a payment.","enum":["OTHER","MOBILE","WEB","BRANCH","TELEPHONE","ATM"],"example":"MOBILE","type":"string"},"ol_PaymentSchemeV3":{"description":"The payment scheme that was used to initiate the financial transaction.","enum":["OTHER","SWIFT","SEPA","SEPA_INSTANT","FASTER_PAYMENTS","CHAPS","BACS","FEDNOW"],"example":"SWIFT","type":"string"},"ol_PaymentStagesInfoV3":{"description":"Payment stages information.","properties":{"authorization":{"$ref":"#/components/schemas/ol_AuthorizationInfoV3"},"chargeback":{"$ref":"#/components/schemas/ol_ChargebackInfoV3"},"refund":{"$ref":"#/components/schemas/ol_RefundInfoV3"},"reversal":{"$ref":"#/components/schemas/ol_ReversalInfoV3"},"settlement":{"$ref":"#/components/schemas/ol_SettlementInfoV3"}},"type":"object"},"ol_Person":{"properties":{"address":{"items":{"$ref":"#/components/schemas/ol_Address"},"nullable":true,"type":"array"},"contact_information":{"$ref":"#/components/schemas/ol_ContactInformation"},"country_of_birth":{"enum":["AF","AX","AL","AN","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","MK","RO","RU","RW","RE","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","US","UY","UZ","VU","VE","VN","VG","VI","WF","EH","XK","YE","ZM","ZW"],"format":"iso-3166-alpha-2","nullable":true,"type":"string"},"custom_fields":{"items":{"$ref":"#/components/schemas/ol_CustomFieldInstance"},"nullable":true,"type":"array"},"date_of_birth":{"$ref":"#/components/schemas/ol_Date"},"fathers_name":{"maxLength":50,"minLength":0,"nullable":true,"type":"string"},"first_name":{"maxLength":50,"minLength":0,"nullable":true,"type":"string"},"full_name":{"maxLength":256,"minLength":0,"nullable":true,"type":"string"},"gender":{"enum":["MALE","FEMALE","NOT_KNOWN","OTHER"],"nullable":true,"type":"string"},"industry":{"maxLength":50,"minLength":0,"nullable":true,"type":"string"},"last_name":{"maxLength":50,"minLength":0,"type":"string"},"middle_name":{"maxLength":50,"minLength":0,"nullable":true,"type":"string"},"mothers_name":{"maxLength":50,"minLength":0,"nullable":true,"type":"string"},"nationality":{"format":"iso-3166-alpha-2","items":{"enum":["AF","AX","AL","AN","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","MK","RO","RU","RW","RE","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","US","UY","UZ","VU","VE","VN","VG","VI","WF","EH","XK","YE","ZM","ZW"],"format":"iso-3166-alpha-2","type":"string"},"nullable":true,"type":"array"},"net_worth":{"$ref":"#/components/schemas/ol_NetWorth"},"personal_identification":{"items":{"$ref":"#/components/schemas/ol_PersonalIdentification"},"nullable":true,"type":"array"},"profession":{"items":{"type":"string"},"nullable":true,"type":"array"},"residential_information":{"items":{"$ref":"#/components/schemas/ol_ResidentialInformation"},"nullable":true,"type":"array"},"salary":{"$ref":"#/components/schemas/ol_Salary"},"source_of_income":{"maxLength":50,"minLength":0,"nullable":true,"type":"string"},"source_of_wealth":{"maxLength":50,"minLength":0,"nullable":true,"type":"string"},"suffix":{"maxLength":50,"minLength":0,"nullable":true,"type":"string"},"title":{"maxLength":50,"minLength":0,"nullable":true,"type":"string"}},"required":["last_name"],"type":"object"},"ol_PersonalIdentification":{"properties":{"date_of_expiry":{"$ref":"#/components/schemas/ol_Date"},"date_of_issue":{"$ref":"#/components/schemas/ol_Date"},"issuing_country":{"enum":["AF","AX","AL","AN","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","MK","RO","RU","RW","RE","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","US","UY","UZ","VU","VE","VN","VG","VI","WF","EH","XK","YE","ZM","ZW"],"format":"iso-3166-alpha-2","nullable":true,"type":"string"},"number":{"maxLength":50,"minLength":0,"nullable":true,"type":"string"},"type":{"enum":["SOCIAL_SECURITY_NUMBER","DRIVING_LICENCE","PASSPORT","IDENTITY_CARD","TAX_REGISTRATION","ALIEN_IDENTIFICATION","EMPLOYER_IDENTIFICATION","OTHER"],"nullable":true,"type":"string"}},"type":"object"},"ol_PointOfSaleConditionCodeV3":{"description":"Point of sale condition code and description","properties":{"code":{"description":"2-digit POS condition code","example":"59","nullable":true,"pattern":"^[0-9]{2}$","type":"string"},"description":{"description":"Human-readable POS condition description","example":"E-commerce transaction - card not present","maxLength":200,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"ol_PointOfSaleConditionV3":{"description":"Contains contextual information about the card payment environment.","properties":{"condition":{"$ref":"#/components/schemas/ol_PointOfSaleConditionCodeV3"},"entry_mode":{"$ref":"#/components/schemas/ol_PointOfSaleEntryModeV3"}},"type":"object"},"ol_PointOfSaleEntryModeV3":{"description":"Point of sale entry mode code and description","properties":{"code":{"description":"3-digit POS entry mode code","example":"012","nullable":true,"pattern":"^[0-9]{3}$","type":"string"},"description":{"description":"Human-readable POS entry mode description","example":"E-commerce transaction","maxLength":200,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"ol_ProblemDetailErrorResponse":{"additionalProperties":true,"properties":{"detail":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","type":"string"},"instance":{"format":"uri","nullable":true,"type":"string"},"status":{"format":"int32","nullable":true,"type":"integer"},"timestamp":{"format":"date-time","type":"string"},"title":{"nullable":true,"type":"string"},"type":{"format":"uri","nullable":true,"type":"string"}},"required":["identifier","timestamp"],"type":"object"},"ol_ProductApi":{"description":"Represents a list of products. They can be either a bank account or a crypto wallet.","properties":{"bank_account":{"$ref":"#/components/schemas/ol_BankAccount"},"crypto_wallet":{"$ref":"#/components/schemas/ol_CryptoWallet"},"currency":{"enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","XXX","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","SHP","WST","STN","SAR","RSD","SCR","SLL","SLE","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","TZS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VED","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XAU","XPD","XPT","XAG"],"format":"iso-4217","nullable":true,"type":"string"},"monthly_payment_amount":{"format":"double","nullable":true,"type":"number"},"monthly_received_amount":{"format":"double","nullable":true,"type":"number"},"monthly_transaction_count":{"format":"int64","nullable":true,"type":"integer"},"name":{"maxLength":50,"minLength":0,"nullable":true,"type":"string"},"onboarding_channel":{"$ref":"#/components/schemas/ol_OnboardingChannelApi"},"purpose":{"maxLength":256,"minLength":0,"nullable":true,"type":"string"},"status":{"maxLength":50,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"ol_RefundInfoV3":{"description":"Refund information.","properties":{"reason":{"$ref":"#/components/schemas/ol_RefundReasonV3"},"timestamp":{"description":"Refund timestamp.","format":"date-time","type":"string"}},"required":["timestamp"],"type":"object"},"ol_RefundReasonV3":{"description":"Refund reason information.","properties":{"code":{"description":"Reason code for refund.","maxLength":50,"minLength":0,"nullable":true,"type":"string"},"description":{"description":"Reason description.","maxLength":200,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"ol_RegulatoryReportDetailsV3":{"description":"Regulatory reporting transaction details.","properties":{"fincen_details":{"$ref":"#/components/schemas/ol_FincenDetailsV3"}},"type":"object"},"ol_RemittanceCreditorV3":{"description":"Represents the creditor in a remittance transaction.","properties":{"cash_pickup":{"$ref":"#/components/schemas/ol_CashPickupDetailsV3"},"details":{"$ref":"#/components/schemas/ol_PartyIdentificationV3"}},"required":["details"],"type":"object"},"ol_RemittanceMonetaryTransactionTypeDetailsV3":{"allOf":[{"$ref":"#/components/schemas/ol_MonetaryTransactionTypeDetailsV3"},{"properties":{"agents":{"description":"Any intermediaries involved in the transaction between the creditor and the debtor.","items":{"$ref":"#/components/schemas/ol_AgentV3"},"maxItems":10,"minItems":0,"type":"array"},"collection_method":{"$ref":"#/components/schemas/ol_RemittancePaymentMethodV3"},"creditor":{"$ref":"#/components/schemas/ol_RemittanceCreditorV3"},"debtor":{"$ref":"#/components/schemas/ol_PartyIdentificationV3"},"payment_scheme":{"$ref":"#/components/schemas/ol_PaymentSchemeV3"},"purpose_of_payment":{"$ref":"#/components/schemas/ol_RemittancePurposeV3"},"relationship":{"$ref":"#/components/schemas/ol_RemittanceRelationshipV3"},"service_provider":{"$ref":"#/components/schemas/ol_RemittanceServiceProviderV3"},"source_of_funds":{"$ref":"#/components/schemas/ol_RemittanceSourceOfFundsV3"},"source_payment_method":{"$ref":"#/components/schemas/ol_RemittancePaymentMethodV3"},"ultimate_creditor":{"$ref":"#/components/schemas/ol_PartyIdentificationV3"},"ultimate_debtor":{"$ref":"#/components/schemas/ol_PartyIdentificationV3"}},"type":"object"}],"description":"Models a cross-border remittance payment transaction between parties in different countries.","required":["creditor","debtor","type"],"type":"object"},"ol_RemittancePaymentMethodV3":{"description":"The payment method used for remittance transactions.","enum":["CASH","CREDIT_CARD","DEBIT_CARD","BANK_TRANSFER","MOBILE_WALLET","PREPAID_CARD","CHEQUE","CRYPTOCURRENCY","GIFT_CARD","POSTAL_ORDER","BARTER","OTHER"],"example":"CASH","type":"string"},"ol_RemittancePurposeV3":{"description":"The purpose of the remittance payment.","enum":["FAMILY_SUPPORT","EDUCATION","MEDICAL","BUSINESS","PROPERTY","EMERGENCY","SAVINGS","GIFT","TRAVEL","DEBT_REPAYMENT","PURCHASE","SALARY","RENT","OTHER"],"type":"string"},"ol_RemittanceRelationshipV3":{"description":"The relationship between the sender and receiver in a remittance transaction.","enum":["SPOUSE","FAMILY","FRIEND","BUSINESS_PARTNER","EMPLOYEE","OTHER"],"type":"string"},"ol_RemittanceServiceProviderTypeV3":{"description":"The type of service provider facilitating the remittance transaction.","enum":["TRADITIONAL_BANK","MONEY_TRANSFER_OPERATOR","DIGITAL_PLATFORM","ONLINE_PAYMENT_SERVICE","MOBILE_MONEY_SERVICE","CRYPTOCURRENCY_PLATFORM","NEOBANK","OTHER"],"example":"MONEY_TRANSFER_OPERATOR","type":"string"},"ol_RemittanceServiceProviderV3":{"description":"Represents a remittance service provider's details.","properties":{"identifier":{"description":"The unique identifier for the remittance service provider.","example":"RSP-12345","maxLength":256,"minLength":0,"nullable":true,"type":"string"},"name":{"description":"The name of the remittance service provider.","example":"Western Union","maxLength":256,"minLength":0,"nullable":true,"type":"string"},"type":{"$ref":"#/components/schemas/ol_RemittanceServiceProviderTypeV3"}},"type":"object"},"ol_RemittanceSourceOfFundsV3":{"description":"The source of funds for the remittance transaction.","enum":["SALARY","BUSINESS_INCOME","SAVINGS","INVESTMENTS","PENSION","LOAN","GIFT","INHERITANCE","ASSET_SALE","INSURANCE_PAYOUT","GOVERNMENT_BENEFITS","TRUST_DISTRIBUTION","CRYPTO_LIQUIDATION","CROWDFUNDING","GAMBLING_WINNINGS","OTHER"],"type":"string"},"ol_ResidentialInformation":{"properties":{"country_of_residence":{"enum":["AF","AX","AL","AN","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","MK","RO","RU","RW","RE","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","US","UY","UZ","VU","VE","VN","VG","VI","WF","EH","XK","YE","ZM","ZW"],"format":"iso-3166-alpha-2","nullable":true,"type":"string"},"residential_status":{"enum":["RESIDENT","PERMANENT_RESIDENT","NON_RESIDENT","TAX_RESIDENT"],"nullable":true,"type":"string"}},"type":"object"},"ol_ReversalInfoV3":{"description":"Reversal information.","properties":{"identifier":{"description":"Unique reversal identifier.","maxLength":50,"minLength":0,"nullable":true,"type":"string"},"timestamp":{"description":"Reversal timestamp.","format":"date-time","type":"string"},"value":{"$ref":"#/components/schemas/ol_MonetaryValueV3"}},"required":["timestamp","value"],"type":"object"},"ol_Salary":{"properties":{"amount":{"$ref":"#/components/schemas/ol_LongRange"},"currency":{"enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","XXX","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","SHP","WST","STN","SAR","RSD","SCR","SLL","SLE","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","TZS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VED","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XAU","XPD","XPT","XAG"],"format":"iso-4217","nullable":true,"type":"string"}},"type":"object"},"ol_ScenarioConfigurationEvaluationDTO":{"properties":{"evaluation_result_delivery":{"$ref":"#/components/schemas/ol_EvaluationResultDeliveryResponseDTO"},"outcome":{"enum":["UNSPECIFIED","ALLOW","HOLD","PROCESS","ERROR","PENDING"],"type":"string"},"processing_method":{"enum":["SYNCHRONOUS","ASYNCHRONOUS"],"type":"string"},"results":{"items":{"$ref":"#/components/schemas/ol_ScenarioEvaluationDTO"},"type":"array","uniqueItems":true},"scenario_configuration_identifier":{"format":"uuid","type":"string"}},"required":["outcome","processing_method","results","scenario_configuration_identifier"],"type":"object"},"ol_ScenarioEvaluationDTO":{"properties":{"error":{"$ref":"#/components/schemas/ol_EvaluationErrorDTO"},"outcome":{"description":"The outcome of the scenario evaluation:- **HOLD**: A case will be open and the transaction should not be released until remediation of the case- **ALLOW**: A case will be open but the transaction can be released- **PROCESS**: The scenario did not identify a risk for the transaction- **ERROR**: The scenario could not be evaluated successfully. See errorDetails for more information","enum":["UNSPECIFIED","ALLOW","HOLD","PROCESS","ERROR","PENDING"],"example":"ALLOW","type":"string"},"priority":{"description":"Priority 1 is the highest while 9 is the lowest.Note: The priority is not set if the scenario did not find a risk","format":"int32","maximum":9,"minimum":1,"nullable":true,"type":"integer"},"scenario_identifier":{"description":"Identifier of the scenario the evaluation is based on","example":"e15352e0-b707-4d0b-a526-2a1092202ad4","format":"uuid","type":"string"},"scenario_name":{"description":"The scenario name is usually populated unless it was not available in our evaluation engine","example":"Payment Limit - Outbound","nullable":true,"type":"string"}},"required":["outcome","scenario_identifier"],"type":"object"},"ol_ScreeningResult":{"oneOf":[{"enum":["HAS-HITS","NO-HITS"],"type":"string"},{"enum":["HAS_PROFILES","NO_PROFILES"],"type":"string"}],"type":"object"},"ol_SettlementInfoV3":{"description":"Settlement information.","properties":{"timestamp":{"description":"Settlement timestamp.","example":"2024-01-16T08:15:00.000Z","format":"date-time","type":"string"},"value":{"$ref":"#/components/schemas/ol_MonetaryValueV3"}},"required":["timestamp","value"],"type":"object"},"ol_StepDetails":{"properties":{"error_message":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","nullable":true,"type":"string"},"status":{"enum":["NOT-STARTED","IN-PROGRESS","COMPLETED","SKIPPED","ERRORED"],"type":"string"},"step_output":{"$ref":"#/components/schemas/ol_StepOutput"}},"required":["status"],"type":"object"},"ol_StepOutput":{"anyOf":[{"$ref":"#/components/schemas/ol_EmptyStepOutput"},{"$ref":"#/components/schemas/ol_CustomerCreationStepOutput"},{"$ref":"#/components/schemas/ol_InitialRiskScoringStepOutput"},{"$ref":"#/components/schemas/ol_CustomerScreeningStepOutput"},{"$ref":"#/components/schemas/ol_CaseCreationStepOutput"},{"$ref":"#/components/schemas/ol_AlertingStepOutput"},{"$ref":"#/components/schemas/ol_StoredActivityStepOutput"},{"$ref":"#/components/schemas/ol_DecisionStepOutput"},{"$ref":"#/components/schemas/ol_CustomerUpdateStepOutput"},{"$ref":"#/components/schemas/ol_FullRiskScoringStepOutput"},{"$ref":"#/components/schemas/ol_EnrichmentStepOutput"}],"nullable":true,"type":"object"},"ol_StoredActivityStepOutput":{"properties":{"activity_identifier":{"format":"uuid","type":"string"}},"required":["activity_identifier"],"type":"object"},"ol_StructuredAddressV3":{"allOf":[{"$ref":"#/components/schemas/ol_AddressV3"},{"properties":{"address_line1":{"description":"The first line of the address.","example":"123 Main St","maxLength":256,"minLength":0,"type":"string"},"address_line2":{"description":"The second line of the address.","example":"Apt 4B","maxLength":256,"minLength":0,"type":"string"},"address_type":{"$ref":"#/components/schemas/ol_AddressTypeV3"},"country":{"description":"2 letter country code as defined by iso-3166-alpha-2.","example":"GB","format":"iso-3166-alpha-2","maxLength":2,"minLength":2,"type":"string"},"country_subdivision":{"description":"The country subdivision (e.g., state, province).","example":"Greater London","maxLength":256,"minLength":0,"type":"string"},"postal_code":{"description":"The postal code of the address.","example":"SW1A 0AA","maxLength":256,"minLength":0,"type":"string"},"town_name":{"description":"The town or city name.","example":"London","maxLength":256,"minLength":0,"type":"string"}},"type":"object"}],"description":"Represents a structured address with detailed components.","required":["format"],"type":"object"},"ol_TextEnrichmentValueV3":{"allOf":[{"$ref":"#/components/schemas/ol_EnrichmentValueV3"},{"properties":{"text":{"description":"The text content.","example":"HIGH","maxLength":256,"minLength":0,"type":"string"}},"type":"object"}],"description":"String representation of the enrichment value.","required":["data_type","text"],"type":"object"},"ol_TextValue":{"allOf":[{"$ref":"#/components/schemas/ol_CustomFieldValue"},{"properties":{"text":{"description":"The text content.","example":"Text Field Value","maxLength":256,"minLength":0,"type":"string"}},"type":"object"}],"description":"Text representation of the custom field value.","required":["data_type","text"],"type":"object"},"ol_TextValueV3":{"allOf":[{"$ref":"#/components/schemas/ol_CustomFieldValueV3"},{"properties":{"text":{"description":"The text content.","example":"Text Field Value","maxLength":256,"minLength":0,"type":"string"}},"type":"object"}],"description":"String representation of the custom field value.","required":["data_type","text"],"type":"object"},"ol_TransactionClassificationDetailsV3":{"description":"Details specific to the Transaction classification.","discriminator":{"propertyName":"classification"},"properties":{"classification":{"$ref":"#/components/schemas/ol_TransactionClassificationV3"}},"required":["classification"],"type":"object"},"ol_TransactionClassificationV3":{"description":"Classifies a transaction as a specific high-level class of transaction.","enum":["MONETARY"],"example":"MONETARY","type":"string"},"ol_TransactionIdentifierDTO":{"properties":{"external_identifier":{"type":"string"}},"required":["external_identifier"],"type":"object"},"ol_TransactionResponseDTO":{"properties":{"evaluation_result":{"$ref":"#/components/schemas/ol_EvaluationResultDTO"},"transaction":{"$ref":"#/components/schemas/ol_TransactionIdentifierDTO"}},"required":["evaluation_result","transaction"],"type":"object"},"ol_TransactionScreeningEvaluationDTO":{"properties":{"error":{"$ref":"#/components/schemas/ol_EvaluationErrorDTO"},"outcome":{"enum":["UNKNOWN","PROCESS","HOLD","REJECT"],"type":"string"},"payment_screening_configuration_identifier":{"format":"uuid","type":"string"},"processing_method":{"enum":["SYNCHRONOUS","ASYNCHRONOUS"],"type":"string"}},"required":["outcome","payment_screening_configuration_identifier","processing_method"],"type":"object"},"ol_TransactionV3":{"description":"Represents a Transaction performed by a Customer. A Transaction can be either monetary or non-monetary.","properties":{"custom_fields":{"description":"A list of custom fields attached to the Transaction.","items":{"$ref":"#/components/schemas/ol_CustomFieldV3"},"maxItems":10,"minItems":0,"nullable":true,"type":"array"},"customer_external_identifier":{"description":"Your unique identifier for customer that the Transaction is associated with. We will populate this after mapping your customer identifier to ours as we process your Transaction.","example":"MyUniqueCustomerReference","maxLength":512,"minLength":0,"type":"string","writeOnly":true},"customer_identifier":{"description":"Our unique identifier for customer that the Transaction is associated with. 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"},"details":{"discriminator":{"mapping":{"MONETARY":"#/components/schemas/ol_MonetaryTransactionClassificationDetailsV3"},"propertyName":"classification"},"oneOf":[{"$ref":"#/components/schemas/ol_MonetaryTransactionClassificationDetailsV3"}]},"enrichments":{"description":"A list of enrichments applied to the Transaction.","items":{"$ref":"#/components/schemas/ol_EnrichmentV3"},"nullable":true,"readOnly":true,"type":"array"},"evaluation_outcome":{"description":"The combined outcome of all transaction evaluations.","enum":["PENDING","PROCESS","ALLOW","HOLD","ERROR"],"readOnly":true,"type":"string"},"external_identifier":{"description":"Your unique identifier for the Transaction. You will use this to reference the Transaction within our systems. This cannot be changed after submitting the Transaction.","example":"MyUniqueIdentifier","maxLength":512,"minLength":0,"type":"string"},"identifier":{"description":"Our unique identifier for your Transaction. We generate this when we process your Transaction and you are not able to specify it.","format":"uuid","nullable":true,"readOnly":true,"type":"string"},"occurred_at":{"description":"The timestamp of the Transaction. This is the timestamp you want us to use as this transactions position in time for the purposes of risk analysis. This timestamp can contain offset information.","example":"2025-04-03T03:32:00.000Z","format":"date-time","type":"string"},"received_at":{"description":"The timestamp the Transaction event was received by us.","example":"2025-04-03T11:32:00.000Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"regulatory_reporting_details":{"$ref":"#/components/schemas/ol_RegulatoryReportDetailsV3"},"review_decision":{"description":"Represents the states of review decision","enum":["NOT_APPLICABLE","NOT_REVIEWED","RELEASE","REJECT"],"readOnly":true,"type":"string"}},"required":["customer_external_identifier","customer_identifier","details","evaluation_outcome","external_identifier","occurred_at","review_decision"],"type":"object"},"ol_UnstructuredAddressV3":{"allOf":[{"$ref":"#/components/schemas/ol_AddressV3"},{"properties":{"country":{"description":"An unstructured text representation of a country","example":"Spain","type":"string"},"local_details":{"description":"The local details of the address.","example":"123 Main Street, London","maxLength":512,"minLength":0,"type":"string"}},"type":"object"}],"description":"Represents an unstructured address with local details and country.","required":["format"],"type":"object"},"ol_UpdateAndRescoreCustomerRequest":{"description":"Update and re-score customer synchronously","properties":{"customer":{"$ref":"#/components/schemas/ol_UpdateCustomerApi"},"products":{"description":"Represents a list of products to update if present will update the customer with this object if not present will not update the customer products. They can be either a bank account or a crypto wallet.","items":{"$ref":"#/components/schemas/ol_ProductApi"},"nullable":true,"type":"array"}},"required":["customer"],"type":"object"},"ol_UpdateCustomerApi":{"description":"Customer to be updated and re-scored. It can be either a person, a company or undefined.","properties":{"acquisition_source":{"maxLength":256,"minLength":0,"nullable":true,"type":"string"},"company":{"$ref":"#/components/schemas/ol_Company"},"customer_since":{"$ref":"#/components/schemas/ol_Date"},"person":{"$ref":"#/components/schemas/ol_Person"},"undefined":{"$ref":"#/components/schemas/ol_CustomerTypeUndefined"}},"type":"object"},"ol_VerificationCheckResultV3":{"description":"Represents the result of a verification check.","enum":["PASS","FAIL","UNAVAILABLE","UNCHECKED"],"example":"PASS","type":"string"},"ol_VerificationCheckV3":{"description":"Represents a verification check with result and optional description.","properties":{"description":{"description":"Human-readable verification check description.","example":"Address and ZIP code match","maxLength":200,"minLength":0,"nullable":true,"type":"string"},"result":{"$ref":"#/components/schemas/ol_VerificationCheckResultV3"}},"type":"object"},"ol_WorkflowState":{"properties":{"status":{"enum":["NOT-STARTED","IN-PROGRESS","COMPLETED","SKIPPED","ERRORED"],"type":"string"},"step_details":{"additionalProperties":{"$ref":"#/components/schemas/ol_StepDetails"},"type":"object"},"steps":{"items":{"enum":["customer-creation","initial-risk-scoring","customer-screening","customer-rescreening","case-creation","alerting","customer-update","risk-scoring"],"type":"string"},"type":"array"},"workflow_instance_identifier":{"format":"uuid","type":"string"},"workflow_type":{"enum":["create-and-screen","update-and-rescore","rescreen-customer"],"type":"string"}},"required":["status","step_details","steps","workflow_instance_identifier","workflow_type"],"type":"object"},"ps_BicSettings":{"properties":{"options":{"items":{"enum":["REMOVE_DELISTED_ENTITIES_SANCTION_ONLY"],"type":"string"},"nullable":true,"type":"array"},"strictness":{"description":"Choose how strict you want the BIC search to be. BANK is the least strict, returning a match for any BIC matching the first 4 digits, COUNTRY returns a match on the first 6 digits, LOCATION returns a match on the first 8 digits, and BRANCH requires a match on 11 digits. If not supplied, the default is full match on the BIC, whether length is 8 or 11 digits.","enum":["BANK","COUNTRY","LOCATION","BRANCH"],"nullable":true,"type":"string"}},"type":"object"},"ps_Configuration":{"properties":{"description":{"nullable":true,"type":"string"},"ignored_parties":{"description":"Supply CUSTOMER and your customer will not be screened.","items":{"description":"Supply CUSTOMER and your customer will not be screened.","enum":["CUSTOMER"],"type":"string"},"nullable":true,"type":"array","uniqueItems":true},"name":{"type":"string"},"source_collections":{"items":{"$ref":"#/components/schemas/ps_SourceCollection"},"maxItems":4,"minItems":1,"type":"array"}},"required":["name","source_collections"],"type":"object"},"ps_ConfigurationDetail":{"properties":{"change_reason":{"type":"string"},"configuration":{"$ref":"#/components/schemas/ps_Configuration"},"configuration_identifier":{"format":"uuid","type":"string"},"is_archived":{"type":"boolean"},"updated_at":{"format":"date-time","type":"string"},"updated_by":{"format":"uuid","type":"string"},"version":{"format":"int32","type":"integer"}},"required":["change_reason","configuration","configuration_identifier","is_archived","updated_at","updated_by","version"],"type":"object"},"ps_ConfigurationSummariesResponse":{"properties":{"configurations":{"items":{"$ref":"#/components/schemas/ps_ConfigurationSummary"},"type":"array"}},"required":["configurations"],"type":"object"},"ps_ConfigurationSummary":{"properties":{"configuration_identifier":{"format":"uuid","type":"string"},"is_archived":{"type":"boolean"},"name":{"type":"string"},"updated_at":{"format":"date-time","type":"string"},"updated_by":{"format":"uuid","type":"string"},"version":{"format":"int32","type":"integer"}},"required":["configuration_identifier","is_archived","name","updated_at","updated_by","version"],"type":"object"},"ps_ConfigurationVersion":{"properties":{"change_reason":{"type":"string"},"updated_at":{"format":"date-time","type":"string"},"updated_by":{"format":"uuid","type":"string"},"version":{"format":"int32","type":"integer"}},"required":["change_reason","updated_at","updated_by","version"],"type":"object"},"ps_ConfigurationVersions":{"properties":{"configuration_identifier":{"format":"uuid","type":"string"},"is_archived":{"type":"boolean"},"versions":{"items":{"$ref":"#/components/schemas/ps_ConfigurationVersion"},"type":"array"}},"required":["configuration_identifier","is_archived","versions"],"type":"object"},"ps_CreateConfigurationRequest":{"properties":{"configuration":{"$ref":"#/components/schemas/ps_Configuration"}},"required":["configuration"],"type":"object"},"ps_CreateConfigurationResponse":{"properties":{"configuration":{"$ref":"#/components/schemas/ps_Configuration"},"configuration_identifier":{"format":"uuid","type":"string"},"created_at":{"format":"date-time","type":"string"},"created_by":{"format":"uuid","type":"string"},"version":{"format":"int32","type":"integer"}},"required":["configuration","configuration_identifier","created_at","created_by","version"],"type":"object"},"ps_NameSettings":{"properties":{"name_fuzziness":{"description":"A search fuzziness score between 0 and 1 by 0.1 increments, where 0 is a narrow search and 1 is a broad search. If provided, this value overrides the overall source collection fuzziness.","example":0.8,"format":"float","maximum":1,"minimum":0,"nullable":true,"type":"number"},"options":{"description":"Choose one or more of these options to use them in name searches.","items":{"description":"Choose one or more of these options to use them in name searches.","enum":["ALL_WORDS_MANDATORY","ALLOW_NON_PHONETIC_FUZZY_MATCHES_SANCTION","ALLOW_ONE_NON_PHONETIC","ALLOW_ONE_NON_PHONETIC_FITNESS","ALLOW_ONE_NON_PHONETIC_SANCTION","ALLOW_ONE_NON_PHONETIC_WARNING","FIRST_WORD_OPTIONAL","LAST_WORD_OPTIONAL","MORE_ARABIC_TRANSLITERATIONS_SANCTION","REMOVE_DECEASED","REMOVE_DELISTED_ENTITIES_SANCTION_ONLY","REMOVE_EQUIVALENT_NAMES","REMOVE_HOMOPHONES","REMOVE_WEAK_ALIAS","SPANISH_ADDED_MATERNAL","WARNING_FITNESS_ENTITY_TYPE_FILTER"],"type":"string"},"nullable":true,"type":"array"}},"type":"object"},"ps_ProblemDetailErrorResponse":{"additionalProperties":true,"properties":{"detail":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","type":"string"},"instance":{"format":"uri","nullable":true,"type":"string"},"status":{"format":"int32","nullable":true,"type":"integer"},"timestamp":{"format":"date-time","type":"string"},"title":{"nullable":true,"type":"string"},"type":{"format":"uri","nullable":true,"type":"string"}},"required":["identifier","timestamp"],"type":"object"},"ps_ReferenceTextSettings":{"properties":{"options":{"description":"Choose one or more of these options to use them in reference text searches.","items":{"description":"Choose one or more of these options to use them in reference text searches.","enum":["EXCLUDE_VESSELS","REMOVE_DECEASED","REMOVE_DELISTED_ENTITIES_SANCTION_ONLY","REMOVE_EQUIVALENT_NAMES","REMOVE_HOMOPHONES","REMOVE_ONE_WORD_PERSON_ALIAS","REMOVE_WEAK_ALIAS"],"type":"string"},"nullable":true,"type":"array"},"reference_text_fuzziness":{"description":"A search fuzziness score between 0 and 1 by 0.1 increments, where 0 is a narrow search and 1 is a broad search. If provided, this value overrides the overall source collection fuzziness.","example":0.8,"format":"float","maximum":1,"minimum":0,"nullable":true,"type":"number"}},"type":"object"},"ps_SourceCollection":{"properties":{"bic_settings":{"$ref":"#/components/schemas/ps_BicSettings"},"fuzziness":{"description":"A search fuzziness score between 0 and 1 by 0.1 increments, where 0 is a narrow search and 1 is a broad search.","example":0.8,"format":"float","maximum":1,"minimum":0,"type":"number"},"name":{"type":"string"},"name_settings":{"$ref":"#/components/schemas/ps_NameSettings"},"reference_text_settings":{"$ref":"#/components/schemas/ps_ReferenceTextSettings"},"source_identifiers":{"description":"Provide the source identifiers for the lists you want to screen against.","items":{"description":"Provide the source identifiers for the lists you want to screen against.","type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["fuzziness","name","source_identifiers"],"type":"object"},"ps_UpdateConfigurationRequest":{"properties":{"change_reason":{"type":"string"},"configuration":{"$ref":"#/components/schemas/ps_Configuration"},"is_archived":{"type":"boolean"}},"required":["change_reason","configuration","is_archived"],"type":"object"},"ps_UpdateConfigurationResponse":{"properties":{"change_reason":{"type":"string"},"configuration":{"$ref":"#/components/schemas/ps_Configuration"},"configuration_identifier":{"format":"uuid","type":"string"},"is_archived":{"type":"boolean"},"updated_at":{"format":"date-time","type":"string"},"updated_by":{"format":"uuid","type":"string"},"version":{"format":"int32","type":"integer"}},"required":["change_reason","configuration","configuration_identifier","is_archived","updated_at","updated_by","version"],"type":"object"},"risk-scoring_CategoryResult":{"properties":{"attribute_results":{"items":{"oneOf":[{"$ref":"#/components/schemas/risk-scoring_ListField"},{"$ref":"#/components/schemas/risk-scoring_ValueField"}]},"type":"array"},"category":{"enum":["BASIC_INFORMATION","CHANNEL","COUNTRY","PRODUCT","SCREENING"],"type":"string"},"level":{"enum":["LOW","MEDIUM","HIGH","PROHIBITED","SKIPPED"],"type":"string"},"score":{"format":"double","type":"number"},"weight":{"format":"double","type":"number"}},"required":["attribute_results","category","level","score","weight"],"type":"object"},"risk-scoring_Field":{"discriminator":{"mapping":{"list_field":"#/components/schemas/risk-scoring_ListField","value_field":"#/components/schemas/risk-scoring_ValueField"},"propertyName":"type"},"properties":{"attribute_name":{"type":"string"},"score":{"format":"double","type":"number"},"type":{"type":"string"}},"required":["attribute_name","score","type"],"type":"object"},"risk-scoring_ListField":{"allOf":[{"$ref":"#/components/schemas/risk-scoring_Field"},{"properties":{"attribute_results":{"items":{"oneOf":[{"$ref":"#/components/schemas/risk-scoring_ListField"},{"$ref":"#/components/schemas/risk-scoring_ValueField"}]},"type":"array"}},"type":"object"}],"required":["attribute_name","attribute_results","score"],"type":"object"},"risk-scoring_OverallResult":{"properties":{"level":{"enum":["LOW","MEDIUM","HIGH","PROHIBITED","SKIPPED"],"type":"string"},"score":{"format":"double","type":"number"}},"required":["level","score"],"type":"object"},"risk-scoring_ProblemDetailErrorResponse":{"additionalProperties":true,"properties":{"detail":{"type":"string"},"identifier":{"format":"uuid","type":"string"},"instance":{"format":"uri","type":"string"},"status":{"format":"int32","type":"integer"},"timestamp":{"format":"date-time","type":"string"},"title":{"type":"string"},"type":{"format":"uri","type":"string"}},"required":["identifier","timestamp"],"type":"object"},"risk-scoring_RiskScore":{"properties":{"account_identifier":{"deprecated":true,"format":"uuid","type":"string"},"category_results":{"items":{"$ref":"#/components/schemas/risk-scoring_CategoryResult"},"type":"array"},"created_at":{"format":"date-time","type":"string"},"customer_identifier":{"format":"uuid","type":"string"},"customer_version":{"format":"int32","type":"integer"},"overall_result":{"$ref":"#/components/schemas/risk-scoring_OverallResult"},"override_reason":{"type":"string"},"risk_model_identifier":{"format":"uuid","type":"string"},"risk_model_version":{"format":"int32","type":"integer"},"score_identifier":{"format":"uuid","type":"string"},"type":{"enum":["PARTIAL","FULL","MANUAL"],"type":"string"},"updated_by":{"format":"uuid","type":"string"}},"required":["account_identifier","category_results","created_at","customer_identifier","customer_version","overall_result","risk_model_identifier","risk_model_version","score_identifier","type"],"type":"object"},"risk-scoring_ValueField":{"allOf":[{"$ref":"#/components/schemas/risk-scoring_Field"},{"properties":{"evaluated_parameter":{"type":"string"}},"type":"object"}],"required":["attribute_name","evaluated_parameter","score"],"type":"object"},"search_AccountBalanceV3":{"description":"Represents the balance of a financial account.","properties":{"current_balance":{"$ref":"#/components/schemas/search_MonetaryValueV3"}},"required":["current_balance"],"type":"object"},"search_AcquirerV3":{"description":"Represents the payment acquirer information.","properties":{"details":{"$ref":"#/components/schemas/search_PartyIdentificationV3"},"identifier":{"description":"Unique acquirer identifier.","example":"acq_visa_usa","maxLength":50,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"search_AddressFormatV3":{"description":"Represents the format of the address used for a party.","enum":["STRUCTURED","UNSTRUCTURED"],"example":"STRUCTURED","type":"string"},"search_AddressTypeV3":{"description":"Represents the type of address.","enum":["RESIDENTIAL","MAILING","OPERATING","REGISTRATION","BILLING"],"example":"MAILING","type":"string"},"search_AddressV3":{"description":"The address of the party.","discriminator":{"propertyName":"format"},"properties":{"format":{"$ref":"#/components/schemas/search_AddressFormatV3"}},"required":["format"],"type":"object"},"search_AgentRoleV3":{"description":"The roles an agent may take within a financial transaction.","enum":["COUNTERPARTY_BANK","INTERMEDIARY"],"example":"COUNTERPARTY_BANK","type":"string"},"search_AgentV3":{"description":"Represents an agent in a financial transaction.","properties":{"bank":{"$ref":"#/components/schemas/search_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/search_MoneyTransferOperatorV3"},"online_remittance_platform":{"$ref":"#/components/schemas/search_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/search_AgentRoleV3"}},"required":["role"],"type":"object"},"search_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/search_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/search_MonetaryValueV3"}},"type":"object"},"search_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"},"search_BankPaymentMonetaryTransactionTypeDetailsV3":{"allOf":[{"$ref":"#/components/schemas/search_MonetaryTransactionTypeDetailsV3"},{"properties":{"agents":{"description":"Any intermediaries involved in the transaction between the creditor and the debtor.","items":{"$ref":"#/components/schemas/search_AgentV3"},"maxItems":10,"minItems":0,"type":"array"},"creditor":{"$ref":"#/components/schemas/search_PartyIdentificationV3"},"debtor":{"$ref":"#/components/schemas/search_PartyIdentificationV3"},"payment_scheme":{"$ref":"#/components/schemas/search_PaymentSchemeV3"},"state":{"$ref":"#/components/schemas/search_BankPaymentStateV3"},"ultimate_creditor":{"$ref":"#/components/schemas/search_PartyIdentificationV3"},"ultimate_debtor":{"$ref":"#/components/schemas/search_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"],"type":"object"},"search_BankPaymentStateV3":{"description":"The possible states of a bank payment transaction.","enum":["PENDING","BOOKED"],"example":"BOOKED","type":"string"},"search_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/search_StructuredAddressV3"},"name":{"description":"The name of the bank.","example":"Deutsche Bank","maxLength":256,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"search_BooleanEnrichmentValueV3":{"allOf":[{"$ref":"#/components/schemas/search_EnrichmentValueV3"},{"properties":{"boolean":{"description":"The boolean value","example":true,"type":"boolean"}},"type":"object"}],"description":"Boolean representation of the enrichment value.","required":["boolean","data_type"],"type":"object"},"search_CardFundingTypeV3":{"description":"Defines the funding type of a payment card.","enum":["CREDIT","DEBIT","PREPAID","OTHER"],"example":"CREDIT","type":"string"},"search_CardHolderV3":{"description":"Represents a card holder with party identification details and onboarding information.","properties":{"details":{"$ref":"#/components/schemas/search_PartyIdentificationV3"}},"type":"object"},"search_CardPaymentMonetaryTransactionTypeDetailsV3":{"allOf":[{"$ref":"#/components/schemas/search_MonetaryTransactionTypeDetailsV3"},{"properties":{"acquirer":{"$ref":"#/components/schemas/search_AcquirerV3"},"card":{"$ref":"#/components/schemas/search_PaymentCardV3"},"card_holder":{"$ref":"#/components/schemas/search_CardHolderV3"},"card_payment_scope":{"$ref":"#/components/schemas/search_CardPaymentScopeV3"},"card_payment_type":{"$ref":"#/components/schemas/search_CardPaymentTypeV3"},"card_scheme":{"$ref":"#/components/schemas/search_CardSchemeV3"},"card_verification_results":{"$ref":"#/components/schemas/search_CardVerificationResultsV3"},"issuer":{"$ref":"#/components/schemas/search_IssuerV3"},"merchant":{"$ref":"#/components/schemas/search_MerchantV3"},"payment_stage":{"$ref":"#/components/schemas/search_CardPaymentStageV3"},"payment_stages_info":{"$ref":"#/components/schemas/search_PaymentStagesInfoV3"},"point_of_sale":{"$ref":"#/components/schemas/search_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/search_MerchantV3"}},"type":"object"}],"description":"Models a card payment transaction where funds are transferred using a payment card.","required":["type"],"type":"object"},"search_CardPaymentScopeV3":{"description":"Defines the scope of a card payment transaction.","enum":["DOMESTIC","CROSSBORDER"],"example":"DOMESTIC","type":"string"},"search_CardPaymentStageV3":{"description":"Defines the stage of a card payment transaction.","enum":["AUTHORIZED","SETTLED","REVERSED","PARTIALLY_SETTLED","CHARGEBACK"],"example":"SETTLED","type":"string"},"search_CardPaymentTypeV3":{"description":"Defines the type of card payment.","enum":["REGULAR","INSTALLMENT","RECURRING","MOTO","UNSCHEDULED","TOP_UP","REFUND","OTHER","AUTH_ONLY"],"example":"REGULAR","type":"string"},"search_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"},"search_CardVerificationResultsV3":{"description":"Represents card verification results including CVV, AVS, and identity checks.","properties":{"avs_check":{"$ref":"#/components/schemas/search_VerificationCheckV3"},"cvc_check":{"$ref":"#/components/schemas/search_VerificationCheckV3"},"three_d_secure_check":{"$ref":"#/components/schemas/search_VerificationCheckV3"}},"type":"object"},"search_CardWalletTypeV3":{"description":"Defines the type of digital wallet.","enum":["GOOGLE_PAY","APPLE_PAY","PAYPAL","REMOTE_COMMERCE_PROGRAMS","OTHER"],"example":"APPLE_PAY","type":"string"},"search_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"},"search_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/search_MonetaryValueV3"}},"required":["timestamp","value"],"type":"object"},"search_CounterpartyPartyIdentifierV3":{"allOf":[{"$ref":"#/components/schemas/search_PartyIdentifierV3"},{"properties":{"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"],"type":"object"},"search_CustomFieldDataTypeV3":{"description":"The type of data stored in a custom field.","enum":["TEXT","DECIMAL"],"type":"string"},"search_CustomFieldV3":{"description":"A representation of a custom field.","properties":{"key":{"description":"The key of the custom field.","example":"field_key","type":"string"},"value":{"oneOf":[{"$ref":"#/components/schemas/search_DecimalValueV3"},{"$ref":"#/components/schemas/search_TextValueV3"}]}},"required":["key","value"],"type":"object"},"search_CustomFieldValueV3":{"description":"The value of the custom field.","discriminator":{"propertyName":"data_type"},"properties":{"data_type":{"$ref":"#/components/schemas/search_CustomFieldDataTypeV3"}},"required":["data_type"],"type":"object"},"search_CustomerPartyIdentifierV3":{"allOf":[{"$ref":"#/components/schemas/search_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"],"type":"object"},"search_DecimalEnrichmentValueV3":{"allOf":[{"$ref":"#/components/schemas/search_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"],"type":"object"},"search_DecimalValueV3":{"allOf":[{"$ref":"#/components/schemas/search_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"],"type":"object"},"search_EnrichmentDataTypeV3":{"description":"The type of data stored in an enrichment value.","enum":["TEXT","DECIMAL","BOOLEAN"],"type":"string"},"search_EnrichmentTypeV3":{"description":"The type of enrichment source.","enum":["LOOKUP_LIST"],"example":"LOOKUP_LIST","type":"string"},"search_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/search_EnrichmentTypeV3"},"value":{"oneOf":[{"$ref":"#/components/schemas/search_BooleanEnrichmentValueV3"},{"$ref":"#/components/schemas/search_DecimalEnrichmentValueV3"},{"$ref":"#/components/schemas/search_TextEnrichmentValueV3"}]}},"readOnly":true,"required":["key","type","value"],"type":"object"},"search_EnrichmentValueV3":{"description":"The value of the enrichment.","discriminator":{"propertyName":"data_type"},"properties":{"data_type":{"$ref":"#/components/schemas/search_EnrichmentDataTypeV3"}},"required":["data_type"],"type":"object"},"search_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","type":"string"},"search_FincenDetailsV3":{"description":"FinCEN transaction details.","properties":{"fincen_cash_transaction_subtype":{"$ref":"#/components/schemas/search_FincenCashTransactionSubtype"}},"required":["fincen_cash_transaction_subtype"],"type":"object"},"search_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/search_PartyIdentificationV3"}},"type":"object"},"search_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/search_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"},"search_MonetaryTransactionClassificationDetailsV3":{"allOf":[{"$ref":"#/components/schemas/search_TransactionClassificationDetailsV3"},{"properties":{"base_value":{"$ref":"#/components/schemas/search_MonetaryValueV3"},"customer_account_balance":{"$ref":"#/components/schemas/search_AccountBalanceV3"},"details":{"oneOf":[{"$ref":"#/components/schemas/search_BankPaymentMonetaryTransactionTypeDetailsV3"},{"$ref":"#/components/schemas/search_CardPaymentMonetaryTransactionTypeDetailsV3"},{"$ref":"#/components/schemas/search_RemittanceMonetaryTransactionTypeDetailsV3"}]},"direction":{"$ref":"#/components/schemas/search_MonetaryTransactionDirectionV3"},"payment_channel":{"$ref":"#/components/schemas/search_PaymentChannelV3"},"product_name":{"description":"The freeform name of the product being used to perform the financial transaction.","example":"Product X, Issue 1","maxLength":256,"minLength":0,"type":"string"},"reference_text":{"description":"The reference text supplied as part of the financial transaction (if any).","example":"Invoice 1234","maxLength":512,"minLength":0,"type":"string"},"value":{"$ref":"#/components/schemas/search_MonetaryValueV3"}},"type":"object"}],"description":"Details related to a monetary transaction.","required":["base_value","classification","details"],"type":"object"},"search_MonetaryTransactionDirectionV3":{"description":"Defines the direction of the flow of value in the transaction in relation to the primary Customer in a Monetary Transaction.","enum":["OUTBOUND","INBOUND"],"readOnly":true,"type":"string"},"search_MonetaryTransactionTypeDetailsV3":{"description":"Details specific to the a Monetary Transaction.","discriminator":{"propertyName":"type"},"properties":{"type":{"$ref":"#/components/schemas/search_MonetaryTransactionTypeV3"}},"required":["type"],"type":"object"},"search_MonetaryTransactionTypeV3":{"description":"Defines the type of a monetary transaction.","enum":["BANK_PAYMENT","CARD_PAYMENT","REMITTANCE"],"example":"BANK_PAYMENT","type":"string"},"search_MonetaryValueV3":{"description":"Represents a combination of a decimal amount with a currency.","properties":{"amount":{"description":"The decimal amount/value.","example":10.02,"type":"number"},"currency":{"description":"3 letter currency code as defined by ISO-4217.","example":"EUR","format":"iso-4217","maxLength":3,"minLength":3,"type":"string"}},"required":["amount","currency"],"type":"object"},"search_MoneyTransferOperatorV3":{"description":"Represents a money transfer operator's details.","properties":{"identifier":{"description":"A unique identifier for the money transfer operator, such as a SWIFT BIC or regulatory identifier.","example":"WUIBUS6S","maxLength":256,"minLength":0,"nullable":true,"type":"string"},"name":{"description":"The legal name of the money transfer operator.","example":"Western Union","maxLength":256,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"search_OnlineRemittancePlatformV3":{"description":"Represents an online remittance platform's details.","properties":{"identifier":{"description":"A unique identifier for the online remittance platform.","example":"remittance-identifier","maxLength":256,"minLength":0,"nullable":true,"type":"string"},"name":{"description":"The brand or platform name of the online remittance service.","example":"Wise","maxLength":256,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"search_PaginatedResponseTransactionV3":{"properties":{"first":{"description":"The URL path to the first page.","example":"/v1/resource?page_number=1","type":"string"},"next":{"description":"The URL path to the next page.","example":"/v1/resource?page_number=4","nullable":true,"type":"string"},"prev":{"description":"The URL path to the previous page.","example":"/v1/resource?page_number=2","nullable":true,"type":"string"},"self":{"description":"The URL path to the current page.","example":"/v1/resource?page_number=3","type":"string"},"total_count":{"description":"Total number of items.","example":60,"format":"int64","nullable":true,"type":"integer"},"transactions":{"items":{"$ref":"#/components/schemas/search_TransactionV3"},"type":"array"}},"required":["first","self","transactions"],"type":"object"},"search_PartyIdentificationV3":{"description":"Represents the identification details of a party. This includes not just the party's identifier, but also any other identifying information specific to the transaction such as alternate names or addresses.","properties":{"address":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/search_StructuredAddressV3"},{"$ref":"#/components/schemas/search_UnstructuredAddressV3"}]},"identifier":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/search_CounterpartyPartyIdentifierV3"},{"$ref":"#/components/schemas/search_CustomerPartyIdentifierV3"}]},"name":{"description":"The name of the party.","example":"John Doe","maxLength":256,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"search_PartyIdentifierV3":{"description":"Party identifier details","discriminator":{"propertyName":"type"},"properties":{"type":{"description":"The type of party identifier.","enum":["CUSTOMER","COUNTERPARTY"],"example":"CUSTOMER","type":"string"}},"required":["type"],"type":"object"},"search_PaymentCardV3":{"description":"Details about a payment card used in a transaction.","properties":{"fingerprint":{"description":"Unique hashed card identifier for tracking.","example":"card_fingerprint_123456","maxLength":100,"minLength":0,"type":"string"},"funding_type":{"$ref":"#/components/schemas/search_CardFundingTypeV3"},"wallet_identifier":{"description":"Digital wallet identifier if applicable.","example":"wallet_12345678","maxLength":50,"minLength":0,"nullable":true,"type":"string"},"wallet_type":{"$ref":"#/components/schemas/search_CardWalletTypeV3"}},"required":["fingerprint"],"type":"object"},"search_PaymentChannelV3":{"description":"The channel used for a payment.","enum":["OTHER","MOBILE","WEB","BRANCH","TELEPHONE","ATM"],"example":"MOBILE","type":"string"},"search_PaymentSchemeV3":{"description":"The payment scheme that was used to initiate the financial transaction.","enum":["OTHER","SWIFT","SEPA","SEPA_INSTANT","FASTER_PAYMENTS","CHAPS","BACS","FEDNOW"],"example":"SWIFT","type":"string"},"search_PaymentStagesInfoV3":{"description":"Payment stages information.","properties":{"authorization":{"$ref":"#/components/schemas/search_AuthorizationInfoV3"},"chargeback":{"$ref":"#/components/schemas/search_ChargebackInfoV3"},"refund":{"$ref":"#/components/schemas/search_RefundInfoV3"},"reversal":{"$ref":"#/components/schemas/search_ReversalInfoV3"},"settlement":{"$ref":"#/components/schemas/search_SettlementInfoV3"}},"type":"object"},"search_PointOfSaleConditionCodeV3":{"description":"Point of sale condition code and description","properties":{"code":{"description":"2-digit POS condition code","example":"59","nullable":true,"pattern":"^[0-9]{2}$","type":"string"},"description":{"description":"Human-readable POS condition description","example":"E-commerce transaction - card not present","maxLength":200,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"search_PointOfSaleConditionV3":{"description":"Contains contextual information about the card payment environment.","properties":{"condition":{"$ref":"#/components/schemas/search_PointOfSaleConditionCodeV3"},"entry_mode":{"$ref":"#/components/schemas/search_PointOfSaleEntryModeV3"}},"type":"object"},"search_PointOfSaleEntryModeV3":{"description":"Point of sale entry mode code and description","properties":{"code":{"description":"3-digit POS entry mode code","example":"012","nullable":true,"pattern":"^[0-9]{3}$","type":"string"},"description":{"description":"Human-readable POS entry mode description","example":"E-commerce transaction","maxLength":200,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"search_RefundInfoV3":{"description":"Refund information.","properties":{"reason":{"$ref":"#/components/schemas/search_RefundReasonV3"},"timestamp":{"description":"Refund timestamp.","format":"date-time","type":"string"}},"required":["timestamp"],"type":"object"},"search_RefundReasonV3":{"description":"Refund reason information.","properties":{"code":{"description":"Reason code for refund.","maxLength":50,"minLength":0,"nullable":true,"type":"string"},"description":{"description":"Reason description.","maxLength":200,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"search_RegulatoryReportDetailsV3":{"description":"Regulatory reporting transaction details.","properties":{"fincen_details":{"$ref":"#/components/schemas/search_FincenDetailsV3"}},"type":"object"},"search_RemittanceCreditorV3":{"description":"Represents the creditor in a remittance transaction.","properties":{"cash_pickup":{"$ref":"#/components/schemas/search_CashPickupDetailsV3"},"details":{"$ref":"#/components/schemas/search_PartyIdentificationV3"}},"required":["details"],"type":"object"},"search_RemittanceMonetaryTransactionTypeDetailsV3":{"allOf":[{"$ref":"#/components/schemas/search_MonetaryTransactionTypeDetailsV3"},{"properties":{"agents":{"description":"Any intermediaries involved in the transaction between the creditor and the debtor.","items":{"$ref":"#/components/schemas/search_AgentV3"},"maxItems":10,"minItems":0,"type":"array"},"collection_method":{"$ref":"#/components/schemas/search_RemittancePaymentMethodV3"},"creditor":{"$ref":"#/components/schemas/search_RemittanceCreditorV3"},"debtor":{"$ref":"#/components/schemas/search_PartyIdentificationV3"},"payment_scheme":{"$ref":"#/components/schemas/search_PaymentSchemeV3"},"purpose_of_payment":{"$ref":"#/components/schemas/search_RemittancePurposeV3"},"relationship":{"$ref":"#/components/schemas/search_RemittanceRelationshipV3"},"service_provider":{"$ref":"#/components/schemas/search_RemittanceServiceProviderV3"},"source_of_funds":{"$ref":"#/components/schemas/search_RemittanceSourceOfFundsV3"},"source_payment_method":{"$ref":"#/components/schemas/search_RemittancePaymentMethodV3"},"ultimate_creditor":{"$ref":"#/components/schemas/search_PartyIdentificationV3"},"ultimate_debtor":{"$ref":"#/components/schemas/search_PartyIdentificationV3"}},"type":"object"}],"description":"Models a cross-border remittance payment transaction between parties in different countries.","required":["creditor","debtor","type"],"type":"object"},"search_RemittancePaymentMethodV3":{"description":"The payment method used for remittance transactions.","enum":["CASH","CREDIT_CARD","DEBIT_CARD","BANK_TRANSFER","MOBILE_WALLET","PREPAID_CARD","CHEQUE","CRYPTOCURRENCY","GIFT_CARD","POSTAL_ORDER","BARTER","OTHER"],"example":"CASH","type":"string"},"search_RemittancePurposeV3":{"description":"The purpose of the remittance payment.","enum":["FAMILY_SUPPORT","EDUCATION","MEDICAL","BUSINESS","PROPERTY","EMERGENCY","SAVINGS","GIFT","TRAVEL","DEBT_REPAYMENT","PURCHASE","SALARY","RENT","OTHER"],"type":"string"},"search_RemittanceRelationshipV3":{"description":"The relationship between the sender and receiver in a remittance transaction.","enum":["SPOUSE","FAMILY","FRIEND","BUSINESS_PARTNER","EMPLOYEE","OTHER"],"type":"string"},"search_RemittanceServiceProviderTypeV3":{"description":"The type of service provider facilitating the remittance transaction.","enum":["TRADITIONAL_BANK","MONEY_TRANSFER_OPERATOR","DIGITAL_PLATFORM","ONLINE_PAYMENT_SERVICE","MOBILE_MONEY_SERVICE","CRYPTOCURRENCY_PLATFORM","NEOBANK","OTHER"],"example":"MONEY_TRANSFER_OPERATOR","type":"string"},"search_RemittanceServiceProviderV3":{"description":"Represents a remittance service provider's details.","properties":{"identifier":{"description":"The unique identifier for the remittance service provider.","example":"RSP-12345","maxLength":256,"minLength":0,"nullable":true,"type":"string"},"name":{"description":"The name of the remittance service provider.","example":"Western Union","maxLength":256,"minLength":0,"nullable":true,"type":"string"},"type":{"$ref":"#/components/schemas/search_RemittanceServiceProviderTypeV3"}},"type":"object"},"search_RemittanceSourceOfFundsV3":{"description":"The source of funds for the remittance transaction.","enum":["SALARY","BUSINESS_INCOME","SAVINGS","INVESTMENTS","PENSION","LOAN","GIFT","INHERITANCE","ASSET_SALE","INSURANCE_PAYOUT","GOVERNMENT_BENEFITS","TRUST_DISTRIBUTION","CRYPTO_LIQUIDATION","CROWDFUNDING","GAMBLING_WINNINGS","OTHER"],"type":"string"},"search_ReversalInfoV3":{"description":"Reversal information.","properties":{"identifier":{"description":"Unique reversal identifier.","maxLength":50,"minLength":0,"nullable":true,"type":"string"},"timestamp":{"description":"Reversal timestamp.","format":"date-time","type":"string"},"value":{"$ref":"#/components/schemas/search_MonetaryValueV3"}},"required":["timestamp","value"],"type":"object"},"search_SettlementInfoV3":{"description":"Settlement information.","properties":{"timestamp":{"description":"Settlement timestamp.","example":"2024-01-16T08:15:00.000Z","format":"date-time","type":"string"},"value":{"$ref":"#/components/schemas/search_MonetaryValueV3"}},"required":["timestamp","value"],"type":"object"},"search_StructuredAddressV3":{"allOf":[{"$ref":"#/components/schemas/search_AddressV3"},{"properties":{"address_line1":{"description":"The first line of the address.","example":"123 Main St","maxLength":256,"minLength":0,"type":"string"},"address_line2":{"description":"The second line of the address.","example":"Apt 4B","maxLength":256,"minLength":0,"type":"string"},"address_type":{"$ref":"#/components/schemas/search_AddressTypeV3"},"country":{"description":"2 letter country code as defined by iso-3166-alpha-2.","example":"GB","format":"iso-3166-alpha-2","maxLength":2,"minLength":2,"type":"string"},"country_subdivision":{"description":"The country subdivision (e.g., state, province).","example":"Greater London","maxLength":256,"minLength":0,"type":"string"},"postal_code":{"description":"The postal code of the address.","example":"SW1A 0AA","maxLength":256,"minLength":0,"type":"string"},"town_name":{"description":"The town or city name.","example":"London","maxLength":256,"minLength":0,"type":"string"}},"type":"object"}],"description":"Represents a structured address with detailed components.","required":["format"],"type":"object"},"search_TextEnrichmentValueV3":{"allOf":[{"$ref":"#/components/schemas/search_EnrichmentValueV3"},{"properties":{"text":{"description":"The text content.","example":"HIGH","maxLength":256,"minLength":0,"type":"string"}},"type":"object"}],"description":"String representation of the enrichment value.","required":["data_type","text"],"type":"object"},"search_TextValueV3":{"allOf":[{"$ref":"#/components/schemas/search_CustomFieldValueV3"},{"properties":{"text":{"description":"The text content.","example":"Text Field Value","maxLength":256,"minLength":0,"type":"string"}},"type":"object"}],"description":"String representation of the custom field value.","required":["data_type","text"],"type":"object"},"search_TransactionClassificationDetailsV3":{"description":"Details specific to the Transaction classification.","discriminator":{"propertyName":"classification"},"properties":{"classification":{"$ref":"#/components/schemas/search_TransactionClassificationV3"}},"required":["classification"],"type":"object"},"search_TransactionClassificationV3":{"description":"Classifies a transaction as a specific high-level class of transaction.","enum":["MONETARY"],"example":"MONETARY","type":"string"},"search_TransactionV3":{"description":"Represents a Transaction performed by a Customer. A Transaction can be either monetary or non-monetary.","properties":{"custom_fields":{"description":"A list of custom fields attached to the Transaction.","items":{"$ref":"#/components/schemas/search_CustomFieldV3"},"maxItems":10,"minItems":0,"nullable":true,"type":"array"},"customer_external_identifier":{"description":"Your unique identifier for customer that the Transaction is associated with. We will populate this after mapping your customer identifier to ours as we process your Transaction.","example":"MyUniqueCustomerReference","maxLength":512,"minLength":0,"type":"string","writeOnly":true},"customer_identifier":{"description":"Our unique identifier for customer that the Transaction is associated with. 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"},"details":{"oneOf":[{"$ref":"#/components/schemas/search_MonetaryTransactionClassificationDetailsV3"}]},"enrichments":{"description":"A list of enrichments applied to the Transaction.","items":{"$ref":"#/components/schemas/search_EnrichmentV3"},"nullable":true,"readOnly":true,"type":"array"},"evaluation_outcome":{"description":"The combined outcome of all transaction evaluations.","enum":["PENDING","PROCESS","ALLOW","HOLD","ERROR"],"readOnly":true,"type":"string"},"external_identifier":{"description":"Your unique identifier for the Transaction. You will use this to reference the Transaction within our systems. This cannot be changed after submitting the Transaction.","example":"MyUniqueIdentifier","maxLength":512,"minLength":0,"type":"string"},"identifier":{"description":"Our unique identifier for your Transaction. We generate this when we process your Transaction and you are not able to specify it.","format":"uuid","nullable":true,"readOnly":true,"type":"string"},"occurred_at":{"description":"The timestamp of the Transaction. This is the timestamp you want us to use as this transactions position in time for the purposes of risk analysis. This timestamp can contain offset information.","example":"2025-04-03T03:32:00.000Z","format":"date-time","type":"string"},"received_at":{"description":"The timestamp the Transaction event was received by us.","example":"2025-04-03T11:32:00.000Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"regulatory_reporting_details":{"$ref":"#/components/schemas/search_RegulatoryReportDetailsV3"},"review_decision":{"description":"Represents the states of review decision","enum":["NOT_APPLICABLE","NOT_REVIEWED","RELEASE","REJECT"],"readOnly":true,"type":"string"}},"required":["customer_external_identifier","customer_identifier","details","evaluation_outcome","external_identifier","occurred_at","review_decision"],"type":"object"},"search_UnstructuredAddressV3":{"allOf":[{"$ref":"#/components/schemas/search_AddressV3"},{"properties":{"country":{"description":"An unstructured text representation of a country","example":"Spain","type":"string"},"local_details":{"description":"The local details of the address.","example":"123 Main Street, London","maxLength":512,"minLength":0,"type":"string"}},"type":"object"}],"description":"Represents an unstructured address with local details and country.","required":["format"],"type":"object"},"search_VerificationCheckResultV3":{"description":"Represents the result of a verification check.","enum":["PASS","FAIL","UNAVAILABLE","UNCHECKED"],"example":"PASS","type":"string"},"search_VerificationCheckV3":{"description":"Represents a verification check with result and optional description.","properties":{"description":{"description":"Human-readable verification check description.","example":"Address and ZIP code match","maxLength":200,"minLength":0,"nullable":true,"type":"string"},"result":{"$ref":"#/components/schemas/search_VerificationCheckResultV3"}},"type":"object"},"sra_AddedMentions":{"description":"Added mention for a risk","properties":{"added_aml_types":{"description":"Added AML mentions","items":{"description":"Added AML mentions","type":"string"},"nullable":true,"type":"array"},"added_listings":{"description":"Added listing mentions","items":{"description":"Added listing mentions","type":"string"},"nullable":true,"type":"array"},"added_snippets":{"description":"Added snippet mentions","items":{"description":"Added snippet mentions","type":"string"},"nullable":true,"type":"array"}},"type":"object"},"sra_Aircraft":{"description":"Identity information of the profile.","nullable":true,"properties":{"associates":{"description":"List of known associates","items":{"$ref":"#/components/schemas/sra_Associate"},"nullable":true,"type":"array"},"names":{"description":"List of known names","items":{"$ref":"#/components/schemas/sra_Name"},"nullable":true,"type":"array"}},"type":"object"},"sra_Associate":{"description":"Associate","properties":{"name":{"description":"Name of associate","nullable":true,"type":"string"},"type":{"description":"Association type","example":"father","nullable":true,"type":"string"}},"type":"object"},"sra_Collection":{"description":"Object containing the collection of screening parameters. A collection can either contain ComplyAdvantage sources or custom lists.","minLength":1,"properties":{"aml_types":{"default":[],"description":"The list of available AML types for the collection.","example":["pep-class-1","pep-class-2"],"items":{"default":"[]","description":"The list of available AML types for the collection.","example":"[\"pep-class-1\",\"pep-class-2\"]","type":"string"},"type":"array"},"custom_list_identifiers":{"default":[],"description":"The list of available custom lists for the collection.","example":["add73965-d5f1-44ea-857d-1660fb0bdd70","680ff6c0-c399-4fe5-ac6d-2cd428d836b5"],"items":{"default":"[]","description":"The list of available custom lists for the collection.","example":"[\"add73965-d5f1-44ea-857d-1660fb0bdd70\",\"680ff6c0-c399-4fe5-ac6d-2cd428d836b5\"]","type":"string"},"nullable":true,"type":"array"},"description":{"description":"The description of the collection.","example":"Collection description","type":"string"},"fuzziness":{"description":"The fuzziness of the collection.","example":0.8,"format":"float","maximum":1,"minimum":0,"type":"number"},"name":{"description":"The name and identifier of the collection.","example":"Collection Name","type":"string"},"options":{"default":[],"description":"The list of available options for the collection.","example":["sanction_option","pep_option"],"items":{"default":"[]","description":"The list of available options for the collection.","example":"[\"sanction_option\",\"pep_option\"]","type":"string"},"type":"array"},"source_identifiers":{"default":[],"description":"The list of available sources for the collection.","example":["S:ABC123","S:1A2B3C"],"items":{"default":"[]","description":"The list of available sources for the collection.","example":"[\"S:ABC123\",\"S:1A2B3C\"]","type":"string"},"type":"array"}},"required":["aml_types","description","fuzziness","name","options","source_identifiers"],"type":"object"},"sra_Company":{"description":"Identity information of the profile.","nullable":true,"properties":{"associates":{"description":"List of known associates","items":{"$ref":"#/components/schemas/sra_Associate"},"nullable":true,"type":"array"},"names":{"description":"List of known names","items":{"$ref":"#/components/schemas/sra_Name"},"nullable":true,"type":"array"}},"type":"object"},"sra_Configuration":{"description":"Object containing a screening configuration with multiple collections.","properties":{"configuration_options":{"default":[],"description":"Configurations to be used across all collections, not the same as options inside a collection","example":["media_snippet_id"],"items":{"default":"[]","description":"Configurations to be used across all collections, not the same as options inside a collection","example":"[\"media_snippet_id\"]","type":"string"},"nullable":true,"type":"array"},"country_filters":{"default":[],"description":"Country based screening results filtering","example":["GB"],"format":"ISO 3166-1 Alpha-2","items":{"default":"[]","description":"Country based screening results filtering","example":"[\"GB\"]","format":"ISO 3166-1 Alpha-2","type":"string"},"type":"array"},"description":{"description":"The description of the screening configuration.","example":"Configuration description","type":"string"},"is_archived":{"default":false,"description":"The flag to indicate if the screening configuration is archived.","type":"boolean"},"name":{"description":"The name and identifier of the screening configuration.","example":"Configuration Name","type":"string"},"results_limit":{"description":"The limit of screening results returned","enum":[10,25,50,100,500],"format":"int32","type":"integer"},"source_collections":{"description":"The list of collections.","items":{"$ref":"#/components/schemas/sra_Collection"},"minLength":1,"type":"array"}},"required":["country_filters","description","is_archived","name","results_limit","source_collections"],"type":"object"},"sra_CreateConfigurationRequest":{"description":"Create configuration request containing a change reason and a screening configuration with multiple collections.","properties":{"change_reason":{"description":"The reason for the change/creation. Defaults to \"Initial creation\"","nullable":true,"type":"string"},"configuration":{"$ref":"#/components/schemas/sra_Configuration"}},"type":"object"},"sra_DateOfBirth":{"description":"Date of birth","properties":{"source":{"description":"Source associated with the date of birth","nullable":true,"type":"string"},"value":{"description":"Date of birth","nullable":true,"type":"string"}},"type":"object"},"sra_DateOfDeath":{"description":"Date of death","properties":{"source":{"description":"Source associated with the date of death","nullable":true,"type":"string"},"value":{"description":"Date of death","nullable":true,"type":"string"}},"type":"object"},"sra_Field":{"description":"Information associated with a source.","properties":{"name":{"description":"Name of the field","nullable":true,"type":"string"},"tag":{"description":"Tag relating to the information (if applicable)","nullable":true,"type":"string"},"value":{"description":"Value","nullable":true,"type":"string"}},"type":"object"},"sra_GetNotesResponse":{"description":"A paginated collection of notes","properties":{"first":{"description":"URL to fetch the first page of items","nullable":true,"type":"string"},"next":{"description":"URL to fetch the next page of items","nullable":true,"type":"string"},"notes":{"description":"List of notes","items":{"$ref":"#/components/schemas/sra_ScreeningNoteResponse"},"nullable":true,"type":"array"},"prev":{"description":"URL to fetch the previous page of items","nullable":true,"type":"string"},"self":{"description":"URL to fetch the current page of items","nullable":true,"type":"string"},"total_count":{"description":"Total number of notes across all pages","format":"int32","nullable":true,"type":"integer"}},"type":"object"},"sra_Image":{"description":"Image","properties":{"source":{"description":"Source associated with the image","nullable":true,"type":"string"},"url":{"description":"Url of the image","nullable":true,"type":"string"}},"type":"object"},"sra_ListConfigurationVersionsResponse":{"description":"The response object containing a list of configuration versions.","properties":{"versions":{"description":"The list of configuration versions.","items":{"$ref":"#/components/schemas/sra_ScreeningConfigurationVersion"},"nullable":true,"type":"array"}},"type":"object"},"sra_ListConfigurationsResponse":{"description":"The response object containing a list of screening configurations.","properties":{"configurations":{"description":"The list of screening configurations.","items":{"$ref":"#/components/schemas/sra_ScreeningConfiguration"},"nullable":true,"type":"array"}},"type":"object"},"sra_ListRiskV1Response":{"properties":{"first":{"description":"The URL path to the first page.","example":"/v1/resource?page_number=1&size=25","nullable":true,"type":"string"},"next":{"description":"The URL path to the next page.","example":"/v1/resource?page_number=4&size=25","nullable":true,"type":"string"},"prev":{"description":"The URL path to the previous page.","example":"/v1/resource?page_number=2&size=25","nullable":true,"type":"string"},"risks":{"description":"List of Risks","items":{"$ref":"#/components/schemas/sra_Risk"},"nullable":true,"type":"array"},"self":{"description":"The URL path to the current page.","example":"/v1/resource?page_number=3&size=25","nullable":true,"type":"string"},"total_count":{"description":"Total number of items.","example":60,"format":"int64","nullable":true,"type":"integer"}},"type":"object"},"sra_Media":{"description":"Risk identified in media.","properties":{"identifier":{"description":"Unique identifier of the media (if available)","nullable":true,"type":"string"},"publishing_date":{"description":"Publishing date of the media (if available)","nullable":true,"type":"string"},"snippet":{"description":"Snippet of the media (if available)","nullable":true,"type":"string"},"title":{"description":"Title of the media (if available)","nullable":true,"type":"string"},"url":{"description":"Url of the media (if available)","nullable":true,"type":"string"}},"type":"object"},"sra_Name":{"description":"Name","properties":{"name":{"description":"Name","nullable":true,"type":"string"},"type":{"description":"Name type","enum":["AKA"],"example":"AKA","nullable":true,"type":"string"}},"type":"object"},"sra_PepSource":{"description":"Risks identified from PEP lists.","properties":{"active_end_dates":{"description":"List of dates when the PEP finished in office","items":{"description":"List of dates when the PEP finished in office","type":"string"},"nullable":true,"type":"array"},"active_start_dates":{"description":"List of dates when the PEP started in office","items":{"description":"List of dates when the PEP started in office","type":"string"},"nullable":true,"type":"array"},"aml_types":{"description":"Aml types associated with the source","items":{"description":"Aml types associated with the source","type":"string"},"nullable":true,"type":"array"},"country_codes":{"description":"Country codes associated with the source","items":{"description":"Country codes associated with the source","type":"string"},"nullable":true,"type":"array"},"fields":{"description":"List of relevant information from the source","items":{"$ref":"#/components/schemas/sra_Field"},"nullable":true,"type":"array"},"identifier":{"description":"Unique identifier of the source","nullable":true,"type":"string"},"listing_ended_utc":{"description":"Date the source was removed","nullable":true,"type":"string"},"listing_started_utc":{"description":"Date the source was first published","nullable":true,"type":"string"},"name":{"description":"Name of the source","nullable":true,"type":"string"},"political_parties":{"description":"List of political parties associated with the PEP","items":{"description":"List of political parties associated with the PEP","type":"string"},"nullable":true,"type":"array"},"political_positions":{"description":"List of political positions held by the PEP","items":{"description":"List of political positions held by the PEP","type":"string"},"nullable":true,"type":"array"},"political_regions":{"description":"List of political regions associated with the PEP","items":{"description":"List of political regions associated with the PEP","type":"string"},"nullable":true,"type":"array"},"related_urls":{"description":"List urls related to the source","items":{"description":"List urls related to the source","type":"string"},"nullable":true,"type":"array"},"url":{"description":"Url of the source","nullable":true,"type":"string"}},"type":"object"},"sra_Person":{"description":"Identity information of the profile.","nullable":true,"properties":{"associates":{"description":"List of known associates","items":{"$ref":"#/components/schemas/sra_Associate"},"nullable":true,"type":"array"},"dates_of_birth":{"description":"List of known dates of birth","items":{"$ref":"#/components/schemas/sra_DateOfBirth"},"nullable":true,"type":"array"},"dates_of_death":{"description":"List of known dates of death","items":{"$ref":"#/components/schemas/sra_DateOfDeath"},"nullable":true,"type":"array"},"images":{"description":"List of images","items":{"$ref":"#/components/schemas/sra_Image"},"nullable":true,"type":"array"},"names":{"description":"List of known names","items":{"$ref":"#/components/schemas/sra_Name"},"nullable":true,"type":"array"},"places_of_birth":{"description":"List of known places of birth","items":{"$ref":"#/components/schemas/sra_PlaceOfBirth"},"nullable":true,"type":"array"}},"type":"object"},"sra_PlaceOfBirth":{"description":"Place of birth","properties":{"source":{"description":"Source associated with the place of birth","nullable":true,"type":"string"},"value":{"description":"Place of birth","nullable":true,"type":"string"}},"type":"object"},"sra_PostNoteRequest":{"description":"Object containing new note content","properties":{"contents":{"description":"Text content of new note","type":"string"}},"required":["contents"],"type":"object"},"sra_ProblemDetailErrorResponse":{"additionalProperties":true,"properties":{"detail":{"nullable":true,"type":"string"},"identifier":{"format":"uuid","nullable":true,"type":"string"},"instance":{"format":"uri","nullable":true,"type":"string"},"status":{"format":"int32","nullable":true,"type":"integer"},"timestamp":{"format":"date-time","nullable":true,"type":"string"},"title":{"nullable":true,"type":"string"},"type":{"format":"uri","nullable":true,"type":"string"}},"type":"object"},"sra_Profile":{"description":"A list of entity screening risks associated with the alert.","properties":{"aircraft":{"$ref":"#/components/schemas/sra_Aircraft"},"company":{"$ref":"#/components/schemas/sra_Company"},"identifier":{"description":"Unique identifier of the profile","nullable":true,"type":"string"},"match_score":{"description":"Match score","format":"double","nullable":true,"type":"number"},"match_types":{"description":"List of reasons the profile matched the screen criteria","example":["name_exact"],"items":{"description":"List of reasons the profile matched the screen criteria","example":"[\"name_exact\"]","type":"string"},"nullable":true,"type":"array"},"matching_name":{"description":"Name of the profile that matched the screen criteria","nullable":true,"type":"string"},"person":{"$ref":"#/components/schemas/sra_Person"},"risk_indicators":{"$ref":"#/components/schemas/sra_RiskIndicators"},"vessel":{"$ref":"#/components/schemas/sra_Vessel"}},"type":"object"},"sra_Risk":{"description":"Object containing risk information.","properties":{"created_at":{"description":"Timestamp of when the risk was created","format":"date-time","nullable":true,"type":"string"},"decision":{"description":"Decision made on the risk.","enum":["NOT_REVIEWED","IN_REVIEW","FALSE_POSITIVE","TRUE_POSITIVE"],"nullable":true,"type":"string"},"detail":{"$ref":"#/components/schemas/sra_RiskDetail"},"identifier":{"description":"Unique identifier of the risk","format":"uuid","nullable":true,"type":"string"},"previous_decision":{"description":"Decision made on the risk.","enum":["NOT_REVIEWED","IN_REVIEW","FALSE_POSITIVE","TRUE_POSITIVE"],"nullable":true,"type":"string"},"type":{"description":"Type of risk","enum":["ENTITY_SCREENING"],"nullable":true,"type":"string"},"updated_at":{"description":"Timestamp of when the risk was updated","format":"date-time","nullable":true,"type":"string"},"updated_by":{"description":"Unique identifier of the user of last updated the risk","format":"uuid","nullable":true,"type":"string"}},"type":"object"},"sra_RiskDetail":{"description":"Detail of the risk.","properties":{"added_mentions":{"$ref":"#/components/schemas/sra_AddedMentions"},"change_type":{"description":"Type of change detected on the profile between two successive screens.","enum":["ADDED","REMOVED","UPDATED"],"nullable":true,"type":"string"},"configuration_identifier":{"description":"Unique identifier of the screening configuration used","format":"uuid","nullable":true,"type":"string"},"profile":{"$ref":"#/components/schemas/sra_Profile"}},"type":"object"},"sra_RiskIndicators":{"description":"Risks associated with the profile.","properties":{"aml_types":{"description":"List of aml types associated with the profile","items":{"description":"List of aml types associated with the profile","type":"string"},"nullable":true,"type":"array"},"lists":{"description":"List of risks identified from lists","items":{"$ref":"#/components/schemas/sra_Source"},"nullable":true,"type":"array"},"media":{"description":"List of risks identified in media","items":{"$ref":"#/components/schemas/sra_Media"},"nullable":true,"type":"array"},"peps":{"description":"List of risks identified from PEP lists","items":{"$ref":"#/components/schemas/sra_PepSource"},"nullable":true,"type":"array"},"sanctions":{"description":"List of risks identified from sanction lists","items":{"$ref":"#/components/schemas/sra_Source"},"nullable":true,"type":"array"}},"type":"object"},"sra_ScreeningConfiguration":{"description":"The response schema for a screening configuration.","properties":{"change_reason":{"description":"The reason for the change in the screening configuration.","nullable":true,"type":"string"},"configuration":{"$ref":"#/components/schemas/sra_Configuration"},"configuration_identifier":{"description":"The screening configuration identifier.","format":"uuid","nullable":true,"type":"string"},"created_at":{"description":"Timestamp of when the screening configuration was created.","format":"date-time","nullable":true,"type":"string"},"created_by":{"description":"The unique identifier of the user who created the screening configuration.","format":"uuid","nullable":true,"type":"string"},"version":{"description":"The version of the screening configuration.","format":"int32","nullable":true,"type":"integer"}},"type":"object"},"sra_ScreeningConfigurationVersion":{"description":"The list of configuration versions.","properties":{"change_reason":{"nullable":true,"type":"string"},"created_at":{"nullable":true,"type":"string"},"created_by":{"format":"uuid","nullable":true,"type":"string"},"name":{"nullable":true,"type":"string"},"version":{"format":"int32","nullable":true,"type":"integer"}},"type":"object"},"sra_ScreeningNoteResponse":{"description":"Object containing note information","properties":{"contents":{"description":"Text content of note","maximum":1000,"nullable":true,"type":"string"},"created_at":{"description":"Timestamp of when note was created","format":"date-time","nullable":true,"type":"string"},"created_by":{"description":"Unique identifier of the user who created the note","format":"uuid","nullable":true,"type":"string"},"identifier":{"description":"Unique identifier for this note","format":"uuid","nullable":true,"type":"string"},"risk_identifier":{"description":"Unique identifier of the risk that this note is associated with","format":"uuid","nullable":true,"type":"string"}},"type":"object"},"sra_Source":{"description":"Risks identified from sanction or watch lists.","properties":{"aml_types":{"description":"Aml types associated with the source","items":{"description":"Aml types associated with the source","type":"string"},"nullable":true,"type":"array"},"country_codes":{"description":"Country codes associated with the source","items":{"description":"Country codes associated with the source","type":"string"},"nullable":true,"type":"array"},"fields":{"description":"List of relevant information from the source","items":{"$ref":"#/components/schemas/sra_Field"},"nullable":true,"type":"array"},"identifier":{"description":"Unique identifier of the source","nullable":true,"type":"string"},"listing_ended_utc":{"description":"Date the source was removed","nullable":true,"type":"string"},"listing_started_utc":{"description":"Date the source was first published","nullable":true,"type":"string"},"name":{"description":"Name of the source","nullable":true,"type":"string"},"related_urls":{"description":"List urls related to the source","items":{"description":"List urls related to the source","type":"string"},"nullable":true,"type":"array"},"url":{"description":"Url of the source","nullable":true,"type":"string"}},"type":"object"},"sra_UpdateConfigurationRequest":{"description":"Update configuration request containing a change reason and a screening configuration with multiple collections.","properties":{"change_reason":{"description":"The reason for the change.","nullable":true,"type":"string"},"configuration":{"$ref":"#/components/schemas/sra_Configuration"}},"type":"object"},"sra_Vessel":{"description":"Identity information of the profile.","nullable":true,"properties":{"associates":{"description":"List of known associates","items":{"$ref":"#/components/schemas/sra_Associate"},"nullable":true,"type":"array"},"names":{"description":"List of known names","items":{"$ref":"#/components/schemas/sra_Name"},"nullable":true,"type":"array"}},"type":"object"}},"securitySchemes":{"BearerAuth":{"description":"HTTP Bearer Token Authentication","scheme":"bearer","type":"http"}}},"info":{"title":"Mesh API","version":"v2.0"},"openapi":"3.0.3","paths":{"/v2/accounts/me":{"get":{"description":"Returns details about your account.","operationId":"identity_v2_accounts_me_getMyAccount","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity_AccountData"}}},"description":"OK"}},"summary":"Get details about your account","tags":["Accounts"]},"put":{"description":"Changes the active logged in account for your user. A new token will need to be generated to authenticate subsequent requests.","operationId":"identity_v2_accounts_me_updateUserAccountMetadata","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity_AccountSwitchRequestBody"}}},"required":true},"responses":{"200":{"description":"OK"}},"summary":"Switch logged in account","tags":["Accounts"]}},"/v2/accounts/me/users":{"get":{"description":"Returns all users that belong to your account.","operationId":"identity_v2_accounts_me_users_getMyAccountsUsers","parameters":[{"deprecated":true,"description":"Filter user by name.","example":"Doe","in":"query","name":"name_contains","required":false,"schema":{"type":"string"}},{"description":"Search users.","example":"Doe","in":"query","name":"search","required":false,"schema":{"type":"string"}},{"description":"Exclude deactivated users.","example":true,"in":"query","name":"active","required":false,"schema":{"type":"boolean"}},{"description":"Filter by roles assigned after the date.","example":"2000-01-01T00:00:00.000Z","in":"query","name":"assigned_at_from","required":false,"schema":{"format":"date","type":"string"}},{"description":"Filter by roles assigned before the date.","example":"2000-01-01T00:00:00.000Z","in":"query","name":"assigned_at_to","required":false,"schema":{"format":"date","type":"string"}},{"description":"Filter roles.","example":["00000000-0000-0000-0000-000000000000"],"in":"query","name":"role","required":false,"schema":{"items":{"example":"00000000-0000-0000-0000-000000000000","type":"string"},"type":"array"}},{"description":"Do not include support users in the response.","example":false,"in":"query","name":"exclude_support_users","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Include agents in the response.","example":false,"in":"query","name":"include_agents","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"The page of results returned within the response.","example":1,"in":"query","name":"page_number","required":false,"schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"The amount of results returned within the response.","example":10,"in":"query","name":"page_size","required":false,"schema":{"default":50,"minimum":1,"type":"integer"}},{"description":"Sorting criteria in the format of: `[-]property` (`-` descending modifier).\n\n* Default sort order is ascending (without `-`).\n\n* Multiple sort criteria are supported.","example":["name"],"in":"query","name":"sort","required":false,"schema":{"default":["name"],"items":{"enum":["name","email","assigned_at"],"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity_UsersResponse"}}},"description":"OK"}},"summary":"Get list of users in your account","tags":["Accounts"]}},"/v2/alerts/mutes":{"get":{"description":"Get list of alert mutes for account or customer\n\n\nYou need the \"View alerts\" permission to use this endpoint.","operationId":"alertServiceGetAlertMutes","parameters":[{"description":"Optional UUID identifier of the customer if you want to get alert mutes for a single customer","example":"9c8b2759-607a-4c90-85bc-b0f3967c7b31","in":"query","name":"customer_identifier","required":false,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/am_GetAlertMutesResponse"}}},"description":"List of found alert mutes for customer or account"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/am_ProblemDetailErrorResponse"}}},"description":"Invalid customer identifier"}},"summary":"Get list of alert mutes for account or customer","tags":["Alerts & Risks"]},"post":{"description":"Allows muting future alerts about the same risk, currently only support for customer scoped muting is provided\n\n\nYou need the \"Create and delete mutes\" permission to use this endpoint.","operationId":"alertServiceCreateAlertMute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/am_CreateAlertMuteRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/am_AlertMuteDTO"}}},"description":"Alert mute created successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/am_ProblemDetailErrorResponse"}}},"description":"Customer identifier is not present"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/am_ProblemDetailErrorResponse"}}},"description":"Profile is already muted for this customer"}},"summary":"Create alert mutes for customer","tags":["Alerts & Risks"]}},"/v2/alerts/mutes/{alert_mute_key}/customer/{customer_identifier}":{"delete":{"description":"Delete a muted alert for a risk, currently only support for customer scoped muting is provided\n\n\nYou need the \"Create and delete mutes\" permission to use this endpoint.","operationId":"alertServiceDeleteAlertMute","parameters":[{"description":"The key of the risk item that has been muted, for example the Risk ID of a profile hit","example":"3JX8PBHOQAZN3RD","in":"path","name":"alert_mute_key","required":true,"schema":{"type":"string"}},{"description":"UUID Identifier for the Customer","example":"4aace766-d4bb-4fe5-a9ad-47ebd7687b80","in":"path","name":"customer_identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"204":{"content":{"application/json":{}},"description":"Alert mute deleted successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/am_ProblemDetailErrorResponse"}}},"description":"Invalid customer identifier"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/am_ProblemDetailErrorResponse"}}},"description":"No alert mute found to delete"}},"summary":"Delete alert mute","tags":["Alerts & Risks"]}},"/v2/alerts/{alert_identifier}/risks":{"get":{"description":"This endpoint will list all risks for a given alert.\n\n\nYou need the \"View alerts\" permission to use this endpoint.","operationId":"alertServiceGetRisks","parameters":[{"description":"UUID identifier of the alert from which to get the risks","example":"95913b76-050c-40f3-9075-25f0737ac7d3","in":"path","name":"alert_identifier","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"One-based page index (1..N)","example":1,"in":"query","name":"page_number","required":false,"schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"The size of the page to be returned","example":20,"in":"query","name":"page_size","required":false,"schema":{"default":25,"minimum":1,"type":"integer"}},{"description":"Sorting criteria in the format of: `[-]property` (`-` descending modifier).\n\n* Default sort order is ascending (without `-`).\n\n* Multiple sort criteria are supported.","example":["-timestamp"],"in":"query","name":"sort","required":false,"schema":{"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"examples":{"Screening Response":{"description":"Risks response from screening app","value":{"first":"/v2/resource?page_number=1&size=25","next":"/v2/resource?page_number=4&size=25","prev":"/v2/resource?page_number=2&size=25","risks":[{"created_at":"2024-07-18T10:29:45.453Z","decision":"NOT_REVIEWED","detail":{"change_type":"ADDED","configuration_identifier":"018bf164-3e72-7489-b36b-c1edbf15cb1e","profile":{"company":{"names":[{"name":"Company legal name","type":"AKA"}]},"identifier":"F9MA22Q9NY521Z1","match_types":["name_exact"],"matching_name":"Paul John Smith","person":{"associates":[{"name":"John Paul Smith","type":"father"},{"name":"John Paul Smith","type":"related-to"}],"dates_of_birth":[{"source":"uk-company-house-disqualified-directors-register","value":"1960-01-01T00:00:00.000Z"}],"dates_of_death":[],"images":[{"source":"string","value":"string"}],"names":[{"name":"Paul John Smith","type":"AKA"}],"places_of_birth":[]},"risk_indicators":{"aml_types":["adverse-media","adverse-media-v2-general-aml-cft","adverse-media-v2-other-minor","adverse-media-v2-property","adverse-media-v2-regulatory","sanction"],"lists":[{"aml_types":["adverse-media-v2-regulatory"],"country_codes":["GB"],"fields":[{"name":"Nationality","tag":"nationality","value":"United Kingdom"},{"name":"Date of Birth","tag":"date_of_birth","value":"1960-01-01T00:00:00.000Z"},{"name":"Related URL","tag":"related_url","value":"https://beta.companieshouse.gov.uk/register-of-disqualifications/A"}],"identifier":"S:ABC123","listing_ended_utc":"2016-02-18T00:00:00.000Z","listing_started_utc":"2016-01-29T00:00:00.000Z","name":"United Kingdom Company House Disqualified Directors Register","related_urls":["https://beta.companieshouse.gov.uk/register-of-disqualifications/A"],"url":"https://beta.companieshouse.gov.uk/register-of-disqualifications/A"}],"media":[{"identifier":null,"publishing_date":"string","snippet":"string","title":"string","url":"string"}],"peps":[{"active_end_dates":["string"],"active_start_dates":["string"],"aml_types":["pep","pep-class-2"],"country_codes":["GB"],"fields":[{"name":"Original Country Text","tag":null,"value":"EN"},{"name":"Date of Death","tag":"date_of_death","value":"2014-03-22T00:00:00.000Z"}],"identifier":"S:ABC123","listing_ended_utc":"2016-02-18T00:00:00.000Z","listing_started_utc":"2016-01-29T00:00:00.000Z","name":"ComplyAdvantage PEP Data","political_parties":[],"political_positions":["Leading figure of the military"],"political_regions":[],"related_urls":["https://beta.companieshouse.gov.uk/register-of-disqualifications/A"],"url":"https://beta.companieshouse.gov.uk/register-of-disqualifications/A"}],"sanctions":[{"aml_types":["sanction"],"country_codes":["GB"],"fields":[{"name":"Nationality","tag":null,"value":"United Kingdom"},{"name":"Place of Birth","tag":null,"value":"United Kingdom"}],"identifier":"S:ABC123","listing_ended_utc":null,"listing_started_utc":"2016-01-29T00:00:00.000Z","name":"OFAC SDN List","related_urls":[],"url":"https://beta.companieshouse.gov.uk/register-of-disqualifications/A"}]}}},"identifier":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"ENTITY_SCREENING","updated_at":"2024-07-18T10:29:45.453Z","updated_by":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}],"self":"/v2/resource?page_number=3&size=25","total_count":60}},"Transaction monitoring response":{"description":"Risks response from transaction monitoring","value":{"first":"/v2/resource?page_number=1&size=25","next":"/v2/resource?page_number=4&size=25","prev":"/v2/resource?page_number=2&size=25","risks":[{"created_at":"2025-05-13T06:52:58.075Z","detail":{"scenario":{"description":"string","identifier":"3fa85f64-5717-4562-b3fc-2c963f66afa6","name":"string","version":0},"transaction":{"external_identifier":"string","identifier":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"BANK_PAYMENT"},"triggered_segment":{"identifiers":["3fa85f64-5717-4562-b3fc-2c963f66afa6"],"name":"string","outcome":"ALLOW","priority":9}},"identifier":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"TRANSACTION_MONITORING"}],"self":"/v2/resource?page_number=3&size=25","total_count":60}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/sra_ListRiskV1Response"},{"$ref":"#/components/schemas/am_TransactionMonitoringRisksResponse"}]}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/am_ProblemDetailErrorResponse"}}},"description":"Not found"}},"summary":"Get risks within an alert","tags":["Alerts & Risks"]}},"/v2/alerts/{alert_identifier}/risks/{risk_identifier}/decision":{"post":{"description":"Given an alert identifier, risk identifier, and new risk state, updates the state of the given risk signal.\n\n**Note**: A risk signal from a `TRANSACTION_MONITORING` alert cannot be updated and will result in a 400 response code\n\n\nYou need the \"Update risks\" permission to use this endpoint.","operationId":"alertServiceChangeRiskStatus","parameters":[{"example":"f24f3832-4f1e-40fa-98d0-3d5a324de11b","in":"path","name":"alert_identifier","required":true,"schema":{"format":"uuid","type":"string"}},{"example":"b4fd0eae-a440-49a3-af6a-56189848949b","in":"path","name":"risk_identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/am_RiskStatusUpdatePayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/am_RiskStatusUpdatePayload"}}},"description":"Decision state updated"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/am_ProblemDetailErrorResponse"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/am_ProblemDetailErrorResponse"}}},"description":"Not found"}},"summary":"Update the status of a risk","tags":["Alerts & Risks"]}},"/v2/alerts/{alert_identifier}/transition":{"post":{"description":"This endpoint transitions an alert to a new state.\n\n\nYou need the \"Update alerts\" permission to use this endpoint.","operationId":"alertServiceTransitionAlertState","parameters":[{"description":"UUID identifier of the alert","example":"95915b77-050c-40f3-9075-25f0737ac7d3","in":"path","name":"alert_identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/am_TransitionStatePayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/am_TransitionStatePayload"}}},"description":"State of the alert transitioned to"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/am_ProblemDetailErrorResponse"}}},"description":"Invalid alert state"}},"summary":"Transition an alert to a state","tags":["Alerts & Risks"]}},"/v2/audit/cases/{case_identifier}":{"get":{"description":"Returns the audit log trail for a case.\n\n\nYou need the \"View cases\" permission to use this endpoint.","operationId":"auditGetCaseAuditTrailV2","parameters":[{"description":"The case identifier","example":"018d0dd4-9b7c-7537-aaac-13f2f48877af","in":"path","name":"case_identifier","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Page index","example":1,"in":"query","name":"page_number","schema":{"type":"integer"}},{"description":"The size of the page to be returned","example":50,"in":"query","name":"page_size","schema":{"default":50,"type":"integer"}},{"description":"Sorting criteria in the format (-)?[parameter]. Default sort order is ascending. for descending prefix the parameter with `-` Multiple sort criteria are supported.","example":["-occurred_at"],"in":"query","name":"sort","schema":{"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/audit_CaseAuditLogsPageV2"}}},"description":"Returns the audit log trail for the case."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/audit_ProblemDetailErrorResponse"}}},"description":"Invalid case uuid identifier."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/audit_ProblemDetailErrorResponse"}}},"description":"No logs found for case."}},"summary":"Get audit log for a case","tags":["Audit"]}},"/v2/audit/customers/{customer_identifier}":{"get":{"description":"Returns the audit log trail for a customer.\n\n\nYou need the \"View customers\" permission to use this endpoint.","operationId":"auditGetCustomerAuditTrailV2","parameters":[{"description":"The customer identifier","example":"018d0dd4-9b7c-7537-aaac-13f2f48877af","in":"path","name":"customer_identifier","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Page index","example":1,"in":"query","name":"page_number","schema":{"type":"integer"}},{"description":"The size of the page to be returned","example":50,"in":"query","name":"page_size","schema":{"default":50,"type":"integer"}},{"description":"Sorting criteria in the format (-)?[parameter]. Default sort order is ascending. for descending prefix the parameter with `-` Multiple sort criteria are supported.","example":["-occurred_at"],"in":"query","name":"sort","schema":{"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/audit_CustomerAuditLogsPageV2"}}},"description":"Returns the audit log trail for the customer."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/audit_ProblemDetailErrorResponse"}}},"description":"Invalid customer uuid identifier."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/audit_ProblemDetailErrorResponse"}}},"description":"No logs found for customer."}},"summary":"Get audit log for a customer","tags":["Audit"]}},"/v2/audit/transactions/{transaction_identifier}":{"get":{"description":"Returns the audit log trail for a transaction.\n\n\nYou need the \"View transactions\" permission to use this endpoint.","operationId":"auditGetTransactionAuditTrailV2","parameters":[{"description":"The transaction identifier","example":"018d0dd4-9b7c-7537-aaac-13f2f48877af","in":"path","name":"transaction_identifier","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Page index","example":1,"in":"query","name":"page_number","schema":{"type":"integer"}},{"description":"The size of the page to be returned","example":50,"in":"query","name":"page_size","schema":{"default":50,"type":"integer"}},{"description":"Sorting criteria in the format (-)?[parameter]. Default sort order is ascending. for descending prefix the parameter with `-` Multiple sort criteria are supported.","example":["-occurred_at"],"in":"query","name":"sort","schema":{"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/audit_TransactionAuditLogsPageV2"}}},"description":"Returns the audit log trail for the transaction."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/audit_ProblemDetailErrorResponse"}}},"description":"Invalid transaction uuid identifier."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/audit_ProblemDetailErrorResponse"}}},"description":"No logs found for transaction."}},"summary":"Get audit log for a transaction","tags":["Audit"]}},"/v2/batch-processing":{"get":{"description":"This endpoint will return a list of all batch processes that have been initiated, including their `identifiers`, status and errors.\n\n\nYou need one of the \"View customers\" or \"View transactions\" permissions to use this endpoint.","operationId":"bulkUploaderGetAllV2BatchProcessing","parameters":[{"description":"One-based page index (1..N)","example":1,"in":"query","name":"page_number","required":false,"schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"The size of the page to be returned","example":20,"in":"query","name":"page_size","required":false,"schema":{"default":25,"minimum":1,"type":"integer"}},{"description":"Sorting criteria in the format of: `[-]property` (`-` descending modifier).\n\n* Default sort order is ascending (without `-`).\n\n* Multiple sort criteria are supported.","example":["-timestamp"],"in":"query","name":"sort","required":false,"schema":{"default":[],"items":{"type":"string"},"type":"array"}},{"example":["VALIDATING"],"in":"query","name":"status","required":false,"schema":{"items":{"enum":["NOT_STARTED","VALIDATING","VALIDATING_ERROR","PROCESSING","PROCESSING_ERROR","COMPLETED","INTERNAL_ERROR"],"type":"string"},"type":"array"}},{"example":["5256d7de-702b-4669-b1ba-0ce5c99da18c"],"in":"query","name":"created_by","required":false,"schema":{"items":{"format":"uuid","type":"string"},"type":"array"}},{"description":"The workflow type for the batch process","in":"query","name":"workflow_type","required":true,"schema":{"default":"create-and-screen","description":"The workflow type for the batch process","enum":["create-and-screen","create-and-monitor","manage-lookup-list"],"type":"string"}},{"description":"Filter by target identifier","example":"164dbbc6-d255-4854-9f1d-56f8474f2835","in":"query","name":"target_identifier","required":false,"schema":{"example":"164dbbc6-d255-4854-9f1d-56f8474f2835","format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulk_PaginatedResponseBatch"}}},"description":"OK"}},"summary":"Get the states for all batch processes","tags":["Batch Processing"]},"post":{"description":"This endpoint initiates a batch process asynchronously for a given workflow type.\n\nThe response will return an `identifier` that can be used to retrieve the file processing status by polling GET /v2/batch-processing/{identifier}.\n\nThe workflow types available are:\n\n1. **Create and screen a batch of customers** - This workflow will initiate all of the steps in the ['Create and screen customer asynchronously'](https://docs.mesh.complyadvantage.com/reference/createcustomerandscreenasync) for each of the customers in your file.\n\n2. **Create and monitor a batch of transactions** - This workflow will initiate all of the steps in the 'Create and process transactions asynchronously' for each of the transactions in your file. To learn more about the format of the batch file, see [Batch transaction upload](https://support.complyadvantage.com/hc/en-gb/articles/36369611503633-Batch-transaction-upload).\n\nThe response will include an `identifier` that can be used to check the status of the batch process,as well as any validation errors that have caused the file to not be processed.\n\nTo invoke 'create-and-screen' workflow, you need \"Access to base customer screening functionality\" enabled and the \"Create and screen customers\" permission.\nTo invoke 'create-and-monitor' workflow, you need \"Access to base transaction monitoring functionality\" enabled.","operationId":"bulkUploaderPostV2BatchProcessing","requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file":{"format":"binary","type":"string"},"target_identifier":{"description":"The identifier of the existing list in Mesh where you’re uploading. Required in some workflows when uploading files to a list that already exists.","example":"164dbbc6-d255-4854-9f1d-56f8474f2835","format":"uuid","type":"string"},"workflow_type":{"default":"create-and-screen","description":"The workflow type for the batch process","enum":["create-and-screen","create-and-monitor","manage-lookup-list"],"type":"string"}},"required":["file"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulk_Batch"}}},"description":"OK"}},"summary":"Initiate a batch-process","tags":["Batch Processing"]}},"/v2/batch-processing/{identifier}":{"delete":{"description":"Given an `identifier`, this endpoint will delete a file that has failed validation. Files that were successful cannot be deleted using this endpoint.\n\n\n\nYou need \"Access to base transaction monitoring functionality\" enabled and the \"Create and screen customers\" permission to use this endpoint.","operationId":"bulkUploaderDeleteV2BatchProcessing","parameters":[{"example":"95913b76-050c-40f3-9075-25f0737ac7d3","in":"path","name":"identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulk_DeletedBatch"}}},"description":"OK"}},"summary":"Delete a batch process","tags":["Batch Processing"]},"get":{"description":"Given an `identifier`, this endpoint will return the status for a single batch process.\n\n\nYou need one of the \"View customers\" or \"View transactions\" permissions to use this endpoint.","operationId":"bulkUploaderGetV2BatchProcessing","parameters":[{"example":"95913b76-050c-40f3-9075-25f0737ac7d3","in":"path","name":"identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulk_Batch"}}},"description":"OK"}},"summary":"Get the state for a single batch process","tags":["Batch Processing"]}},"/v2/batch-processing/{identifier}/report":{"get":{"description":"This endpoint returns a URL to download a CSV report for batch upload processes where one or more customers failed to be processed.\n\n Use the batch process identifier in the request in order to access the report URL.\n\n\nYou need one of the \"View customers\" or \"View transactions\" permissions to use this endpoint.","operationId":"bulkUploaderDownloadReportV2BatchProcessing","parameters":[{"example":"95913b76-050c-40f3-9075-25f0737ac7d3","in":"path","name":"identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulk_BatchReport"}}},"description":"OK"}},"summary":"Download a summary report","tags":["Batch Processing"]}},"/v2/cases":{"get":{"description":"Returns a paginated list of cases for the user's account. Accepts filter and sort query parameters.\n\n\nYou need the \"View cases\" permission to use this endpoint.","operationId":"casesService/v2/cases.get","parameters":[{"deprecated":true,"description":"User identifier or null.","example":["01899c37-576b-7677-b41a-9c9fdbd3bde1"],"in":"query","name":"assignee","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"description":"Provide an array of user identifiers or blank with which to filter the case list.\n\n* Includes all cases assigned to user matching user identifiers.\n\n* If array includes blank, also includes cases without an assignee (i.e. unassigned).","example":["01899c37-576b-7677-b41a-9c9fdbd3bde1"],"in":"query","name":"assignee_identifier","required":false,"schema":{"items":{"format":"uuid","type":"string"},"type":"array"}},{"description":"Filter cases by specific case types","example":["CUSTOMER_ONBOARDING"],"in":"query","name":"type","required":false,"schema":{"items":{"enum":["CUSTOMER_ONBOARDING","CUSTOMER_MONITORING","PAYMENT_SCREENING","TRANSACTION_MONITORING"],"type":"string"},"type":"array"}},{"description":"Filter cases created on or after this date and time.","example":"2024-01-22T15:54:27.265Z","in":"query","name":"created_at_from","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Filter cases created on or before this date and time.","example":"2024-01-22T15:54:27.265Z","in":"query","name":"created_at_to","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Filter cases by a list of customer identifiers","example":["01899c37-576b-7677-b41a-9c9fdbd3bde1"],"in":"query","name":"customer.identifier","required":false,"schema":{"items":{"format":"uuid","type":"string"},"type":"array"}},{"description":"Filter cases by a list of customer risk levels.","example":["HIGH"],"in":"query","name":"customer.risk_level","required":false,"schema":{"items":{"enum":["LOW","MEDIUM","HIGH","PROHIBITED","SKIPPED"],"type":"string"},"type":"array"}},{"description":"Provide an array of customer label identifiers or blank with which to filter the case list.\n\n* Includes all cases matching at least one customer label.\n\n* If array includes blank, also includes cases without a customer label.","example":["01899c37-576b-7677-b41a-9c9fdbd3bde1"],"in":"query","name":"customer.label","required":false,"schema":{"items":{"format":"uuid","type":"string"},"type":"array"}},{"description":"Provide an array of customer acquisition sources or blank with which to filter the case list.\n\n* Includes all cases matching at least one customer acquisition source.\n\n* If array includes blank, also includes cases without a customer acquisition source.","example":["Business Co."],"in":"query","name":"customer.acquisition_source","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"description":"Search for cases by customer name, customer external identifier, counterparty name, counterparty external identifier, or external activity identifier (for payment screening cases only). Supports wildcard search.","example":"Boris Johnson","in":"query","name":"search","required":false,"schema":{"type":"string"}},{"deprecated":true,"description":"The current state of the case.\n\nFor those using the deprecated case_state, if any new case stages are added the case state response for these will be returned as USER_DEFINED","example":["ONBOARDING_IN_PROGRESS"],"in":"query","name":"state","required":false,"schema":{"items":{"enum":["ONBOARDING_NOT_STARTED","ONBOARDING_IN_PROGRESS","ONBOARDING_ESCALATED","ONBOARDING_BLOCKED","ONBOARDING_POSITIVE_END_STATE","ONBOARDING_MANAGEABLE_RISK_POSITIVE_END_STATE","ONBOARDING_NEGATIVE_END_STATE","MONITORING_NOT_STARTED","MONITORING_IN_PROGRESS","MONITORING_ESCALATED","MONITORING_BLOCKED","MONITORING_NO_RISK_DETECTED_POSITIVE_END_STATE","MONITORING_RISK_DETECTED_POSITIVE_END_STATE","MONITORING_RISK_DETECTED_NEGATIVE_END_STATE","PAYMENT_SCREENING_NOT_STARTED","PAYMENT_SCREENING_IN_PROGRESS","PAYMENT_SCREENING_ESCALATED","PAYMENT_SCREENING_BLOCKED","PAYMENT_SCREENING_AWAITING_INFORMATION","PAYMENT_SCREENING_PROCESS_PAYMENT_END_STATE","PAYMENT_SCREENING_REJECT_PAYMENT_END_STATE","TRANSACTION_MONITORING_NOT_STARTED","TRANSACTION_MONITORING_IN_PROGRESS","TRANSACTION_MONITORING_ESCALATED","TRANSACTION_MONITORING_BLOCKED","TRANSACTION_MONITORING_ACCEPTED_POSITIVE_END_STATE","TRANSACTION_MONITORING_ESCALATED_NEGATIVE_END_STATE","USER_DEFINED"],"type":"string"},"type":"array"}},{"description":"Provide an array of stage identifiers with which to filter the case list.","example":["01899c37-576b-7677-b41a-9c9fdbd3bde1"],"in":"query","name":"stage.identifier","required":false,"schema":{"items":{"format":"uuid","type":"string"},"type":"array"}},{"description":"Filter cases by a list of risk types. You can retrieve the full list of available risk types from the `/v2/risk-types` endpoint.","example":["PEP_CLASS_1"],"in":"query","name":"risk_type","required":false,"schema":{"items":{"enum":["ADVERSE_MEDIA_CYBERCRIME","ADVERSE_MEDIA_EU_AML_DIRECTIVE","ADVERSE_MEDIA_FINANCIAL_AML_CFT","ADVERSE_MEDIA_FINANCIAL_CRIME","ADVERSE_MEDIA_FINANCIAL_DIFFICULTY","ADVERSE_MEDIA_FRAUD_LINKED","ADVERSE_MEDIA_FRAUD","ADVERSE_MEDIA_GENERAL_AML_CFT","ADVERSE_MEDIA_GENERAL","ADVERSE_MEDIA_HIGH_RISK","ADVERSE_MEDIA_NARCOTICS_AML_CFT","ADVERSE_MEDIA_NARCOTICS","ADVERSE_MEDIA_OTHER_FINANCIAL","ADVERSE_MEDIA_OTHER_MINOR","ADVERSE_MEDIA_OTHER_SERIOUS","ADVERSE_MEDIA_PROPERTY","ADVERSE_MEDIA_REGULATORY","ADVERSE_MEDIA_SEXUAL_CRIME","ADVERSE_MEDIA_TERRORISM","ADVERSE_MEDIA_VIOLENCE_AML_CFT","ADVERSE_MEDIA_VIOLENCE_NON_AML_CFT","ADVERSE_MEDIA_VIOLENT_CRIME","ADVERSE_MEDIA","FITNESS_PROBITY","PEP_CLASS_1_TO_3","PEP_CLASS_1","PEP_CLASS_2","PEP_CLASS_3","PEP_CLASS_4","PEP","SANCTION_RELATED","SANCTION","WARNING"],"type":"string"},"type":"array"}},{"description":"Filter cases by alert title(s).\n\nAllows filtering for cases with alerts matching any of the provided titles.","example":["Customer screening","Payment screening"],"in":"query","name":"alerts.title","required":false,"schema":{"items":{"type":"string"},"minLength":1,"type":"array"}},{"description":"Filter cases by the highest priority alert (1-9).\n\nAllows filtering for cases where the highest priority alert matches the provided value.","example":[1,2],"in":"query","name":"alerts.highest_priority","required":false,"schema":{"items":{"format":"int32","type":"integer"},"maximum":9,"minimum":1,"type":"array"}},{"description":"Filter cases by risk catalog risk type keys.\n\nAllows filtering for cases with risk types matching any of the provided keys.","example":["r_sanctions_exposure","r_political_exposure"],"in":"query","name":"risk_catalog_risk_types.key","required":false,"schema":{"items":{"type":"string"},"minLength":1,"type":"array"}},{"description":"One-based page index (1..N)","example":1,"in":"query","name":"page_number","required":false,"schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"The size of the page to be returned","example":20,"in":"query","name":"page_size","required":false,"schema":{"default":25,"minimum":1,"type":"integer"}},{"description":"Sorting criteria in the format of: `[-]property` (`-` descending modifier).\n\n* Default sort order is ascending (without `-`).\n\n* Multiple sort criteria are supported.","example":["-timestamp"],"in":"query","name":"sort","required":false,"schema":{"default":["-CREATED_AT"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/case-management_PaginatedResponseCaseResultResponse"}}},"description":"OK"}},"summary":"Get list of cases","tags":["Cases"]}},"/v2/cases/assign/bulk":{"post":{"description":"This endpoint synchronously updates assignee for up to 100 cases.\n\n\nYou need the \"Update cases\" permission to use this endpoint.","operationId":"casesService/v2/cases/assign/bulk.post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/case-management_AssignCasesRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/case-management_BulkActionResponse"}}},"description":"Multi-Status"},"400":{"content":{"application/problem+json":{"examples":{"Too many cases":{"description":"Request exceeds the maximum number of cases that can be updated.","value":{"detail":"The maximum allowed number of cases to update is 100","identifier":"3fa85f64-5717-4562-b3fc-2c963f66afa6","timestamp":"2023-12-19T09:27:17.835Z","title":"TOO_MANY_CASES"}}},"schema":{"$ref":"#/components/schemas/case-management_ProblemDetailErrorResponse"}}},"description":"Bad Request"}},"summary":"Assign cases in bulk","tags":["Cases"]}},"/v2/cases/notes/bulk":{"post":{"description":"This endpoint creates a note for multiple cases. Up to 100 cases.","operationId":"casesService/v2/cases/notes/bulk.post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/case-management_CreateCasesNoteRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/case-management_BulkActionResponse"}}},"description":"Multi-Status"},"400":{"content":{"application/problem+json":{"examples":{"Too many cases":{"description":"Request exceeds the maximum number of cases that can be updated.","value":{"detail":"The maximum allowed number of cases to update is 100","identifier":"3fa85f64-5717-4562-b3fc-2c963f66afa6","timestamp":"2023-12-19T09:27:17.835Z","title":"TOO_MANY_CASES"}}},"schema":{"$ref":"#/components/schemas/case-management_ProblemDetailErrorResponse"}}},"description":"Bad Request"}},"summary":"Leave a note on multiple cases in bulk","tags":["Cases"]}},"/v2/cases/states":{"get":{"deprecated":true,"description":"This endpoint returns all possible states to which a case can be transitioned.","operationId":"casesService/v2/cases/states.get","parameters":[{"description":"One-based page index (1..N)","example":1,"in":"query","name":"page_number","required":false,"schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"The size of the page to be returned","example":20,"in":"query","name":"page_size","required":false,"schema":{"default":25,"minimum":1,"type":"integer"}},{"description":"Sorting criteria in the format of: `[-]property` (`-` descending modifier).\n\n* Default sort order is ascending (without `-`).\n\n* Multiple sort criteria are supported.","example":["-timestamp"],"in":"query","name":"sort","required":false,"schema":{"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/case-management_PaginatedResponseCaseStatesResponse"}}},"description":"OK"}},"summary":"Get a list of available case states","tags":["Cases"]}},"/v2/cases/transition/bulk":{"post":{"description":"This endpoint synchronously updates state (or stage) for up to 100 cases.\n\n\nYou need the \"Update cases\" permission to use this endpoint.","operationId":"casesService/v2/cases/transition/bulk.post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/case-management_TransitionCasesRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/case-management_BulkActionResponse"}}},"description":"Multi-Status"},"400":{"content":{"application/problem+json":{"examples":{"Too many cases":{"description":"Request exceeds the maximum number of cases that can be updated.","value":{"detail":"The maximum allowed number of cases to update is 100","identifier":"3fa85f64-5717-4562-b3fc-2c963f66afa6","timestamp":"2023-12-19T09:27:17.835Z","title":"TOO_MANY_CASES"}}},"schema":{"$ref":"#/components/schemas/case-management_ProblemDetailErrorResponse"}}},"description":"Bad Request"}},"summary":"Transition cases in bulk","tags":["Cases"]}},"/v2/cases/workflows":{"get":{"description":"This endpoint returns a page of workflows.","operationId":"casesService/v2/cases/workflows.get","parameters":[{"description":"One-based page index (1..N)","example":1,"in":"query","name":"page_number","required":false,"schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"The size of the page to be returned","example":20,"in":"query","name":"page_size","required":false,"schema":{"default":25,"minimum":1,"type":"integer"}},{"description":"Sorting criteria in the format of: `[-]property` (`-` descending modifier).\n\n* Default sort order is ascending (without `-`).\n\n* Multiple sort criteria are supported.","example":["-timestamp"],"in":"query","name":"sort","required":false,"schema":{"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/case-management_PaginatedResponseWorkflowResponse"}}},"description":"OK"}},"summary":"Get list of case workflows","tags":["Case Workflows"]}},"/v2/cases/workflows/{workflow_identifier}":{"get":{"description":"This endpoint returns the latest version of a single workflow by ID.","operationId":"casesService/v2/cases/workflows/workflow_identifier.get","parameters":[{"description":"The unique identifier of the workflow.","example":"01899c37-576b-7677-b41a-9c9fdbd3bde1","in":"path","name":"workflow_identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/case-management_WorkflowResponse"}}},"description":"OK"}},"summary":"Get a specific case workflow","tags":["Case Workflows"]},"put":{"description":"This endpoint updates a single workflow by ID.\n\nSupported Operations:\n- Rename Stages:\n   - You can change the name of existing stages\n   - Any change in name will apply to all cases, including closed cases. Ensure the new stage name preserves the original meaning to maintain integrity in audit logs, insights, and reports\n   - Renaming decisions does not change their decision type\n- Reorder Stages:\n   - Stages of types Reviews and Decision can be reordered across the new display order\n   - Stages can only be reordered within their types\n\n- Add Stages:\n   - Review stage:\n      - a minimum of 1 review stage is needed\n      - a maximum of 8 review stages are allowed\n   - Decisions:\n      - a minimum of 2 decisions are needed and this should include one of each:\n         - positive\n         - negative\n      - a maximum of 8 decisions are allowed\n- Change Alert Grouping:\n   - Alert Grouping can be set to true or false\n   - If the property is not set no change will be made\n\n\n\n\nYou need the \"Update case workflows\" permission to use this endpoint.","operationId":"casesService/v2/cases/workflows/workflow_identifier.put","parameters":[{"description":"The unique identifier of the workflow.","example":"01899c37-576b-7677-b41a-9c9fdbd3bde1","in":"path","name":"workflow_identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"stages":[{"display_name":"The initial stage","display_order":1,"identifier":"018f348d-e9a1-7641-ab3f-371d3d7e314d","stage_type":"INITIAL"},{"display_name":"A review stage","display_order":2,"identifier":"018f348d-e9a1-7af5-a843-f743f3eb4846","stage_type":"REVIEW"},{"decision_type":"POSITIVE","display_name":"An existing decision stage","display_order":3,"identifier":"3fa85f64-5717-4562-b3fc-2c963f66afa6","stage_type":"DECISION"},{"decision_type":"NEGATIVE","display_name":"A new decision stage","display_order":4,"stage_type":"DECISION"}]},"schema":{"$ref":"#/components/schemas/case-management_UpdateWorkflowRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"case_type":"CUSTOMER_ONBOARDING","created_at":"2025-02-13T10:18:10.324Z","created_by":"3fa85f64-5717-4562-b3fc-2c963f66afd6","identifier":"3fa85f64-5717-4562-b3fc-2c963f66afe6","stages":[{"display_name":"The initial stage","display_order":1,"identifier":"018f348d-e9a1-7641-ab3f-371d3d7e314d","stage_type":"INITIAL"},{"display_name":"A review stage","display_order":2,"identifier":"018f348d-e9a1-7af5-a843-f743f3eb4846","stage_type":"REVIEW"},{"decision_type":"POSITIVE","display_name":"An existing decision stage","display_order":3,"identifier":"3fa85f64-5717-4562-b3fc-2c963f66afa6","stage_type":"DECISION"},{"decision_type":"NEGATIVE","display_name":"A new decision stage","display_order":4,"identifier":"3fa85f64-5717-4562-b3fc-2c963f66afc6","stage_type":"DECISION"}],"version":3},"schema":{"$ref":"#/components/schemas/case-management_WorkflowResponse"}}},"description":"OK"}},"summary":"Update a specific case workflow","tags":["Case Workflows"]}},"/v2/cases/workflows/{workflow_identifier}/versions/{version}":{"get":{"description":"This endpoint returns a specific version of a single workflow by ID.","operationId":"casesService/v2/cases/workflows/workflow_identifier/versions/version.get","parameters":[{"description":"The unique identifier of the workflow.","example":"01899c37-576b-7677-b41a-9c9fdbd3bde1","in":"path","name":"workflow_identifier","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The version of the workflow.","example":1,"in":"path","name":"version","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/case-management_WorkflowResponse"}}},"description":"OK"}},"summary":"Get a specific version of a case workflow","tags":["Case Workflows"]}},"/v2/cases/{case_identifier}":{"get":{"description":"This endpoint returns a single case by ID.\n\n\nYou need the \"View cases\" permission to use this endpoint.","operationId":"casesService/v2/cases/case_identifier.get","parameters":[{"description":"The unique identifier of the case.","example":"01899c37-576b-7677-b41a-9c9fdbd3bde1","in":"path","name":"case_identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/case-management_CaseResponse"}}},"description":"OK"}},"summary":"Get a specific case","tags":["Cases"]}},"/v2/cases/{case_identifier}/alerts":{"get":{"description":"Returns a paginated list of alerts associated with a case.\n\n\nYou need the \"View cases\" permission to use this endpoint.","operationId":"casesService/v2/cases/case_identifier/alerts.get","parameters":[{"description":"The unique identifier of the case.","example":"01899c37-576b-7677-b41a-9c9fdbd3bde1","in":"path","name":"case_identifier","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Filter alerts by alert identifier","in":"query","name":"identifier","required":false,"schema":{"format":"uuid","type":"string"}},{"description":"Filter alerts by states","in":"query","name":"states","required":false,"schema":{"items":{"enum":["NOT_STARTED","IN_PROGRESS","POSITIVE_END_STATE","NEGATIVE_END_STATE"],"type":"string"},"type":"array"}},{"description":"One-based page index (1..N)","example":1,"in":"query","name":"page_number","required":false,"schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"The size of the page to be returned","example":20,"in":"query","name":"page_size","required":false,"schema":{"default":25,"minimum":1,"type":"integer"}},{"description":"Sorting criteria in the format of: `[-]property` (`-` descending modifier).\n\n* Default sort order is ascending (without `-`).\n\n* Multiple sort criteria are supported.","example":["-timestamp"],"in":"query","name":"sort","required":false,"schema":{"default":["-CREATED_AT"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/case-management_PaginatedResponseCaseAlertResponseV2"}}},"description":"OK"}},"summary":"Retrieve the alerts for a case","tags":["Cases"]}},"/v2/cases/{case_identifier}/assign":{"post":{"description":"This endpoint updates the assignee for a single case (to a new value or to null).\n\n\nYou need the \"Update cases\" permission to use this endpoint.","operationId":"casesService/v2/cases/case_identifier/assign.post","parameters":[{"description":"The unique identifier of the case.","example":"01899c37-576b-7677-b41a-9c9fdbd3bde1","in":"path","name":"case_identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/case-management_CaseAssignment"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/case-management_AssignedCaseResponse"}}},"description":"OK"}},"summary":"Assign a case to a user","tags":["Cases"]}},"/v2/cases/{case_identifier}/notes":{"get":{"description":"Returns a paginated list of notes associated with a case.\n\n\nYou need the \"View cases\" permission to use this endpoint.","operationId":"casesService/v2/cases/case_identifier/notes.get","parameters":[{"description":"The unique identifier of the case.","example":"01899c37-576b-7677-b41a-9c9fdbd3bde1","in":"path","name":"case_identifier","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"One-based page index (1..N)","example":1,"in":"query","name":"page_number","required":false,"schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"The size of the page to be returned","example":20,"in":"query","name":"page_size","required":false,"schema":{"default":25,"minimum":1,"type":"integer"}},{"description":"Sorting criteria in the format of: `[-]property` (`-` descending modifier).\n\n* Default sort order is ascending (without `-`).\n\n* Multiple sort criteria are supported.","example":["-timestamp"],"in":"query","name":"sort","required":false,"schema":{"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/case-management_PaginatedResponseNoteResponse"}}},"description":"OK"}},"summary":"Get the notes on a case","tags":["Cases"]},"post":{"description":"Creates a note linked to a specific case.","operationId":"casesService/v2/cases/case_identifier/notes.post","parameters":[{"description":"The unique identifier of the case.","example":"01899c37-576b-7677-b41a-9c9fdbd3bde1","in":"path","name":"case_identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/case-management_CreateCaseNoteRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/case-management_NoteResponse"}}},"description":"Created"}},"summary":"Leave a note on a case","tags":["Cases"]}},"/v2/cases/{case_identifier}/transition":{"post":{"description":"This endpoint transitions a case to a new stage.\n\nNote: \n\n - case_state is deprecated. Please use case_stage instead.\n\n - For those already integrated using case_state, if any new case stages are added the case state response for these will be returned as USER_DEFINED\n\n\nYou need the \"Update cases\" permission to use this endpoint.","operationId":"casesService/v2/cases/case_identifier/transition.post","parameters":[{"description":"The unique identifier of the case.","example":"01899c37-576b-7677-b41a-9c9fdbd3bde1","in":"path","name":"case_identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/case-management_CaseTransitionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/case-management_CaseTransitionResponse"}}},"description":"OK"},"400":{"content":{"application/problem+json":{"examples":{"Invalid state for case type":{"description":"The target case state is not valid for this type of case.","value":{"detail":"State MONITORING_BLOCKED is not a valid state for case type CUSTOMER_ONBOARDING","identifier":"3fa85f64-5717-4562-b3fc-2c963f66afa6","timestamp":"2023-12-19T09:27:17.835Z","title":"INVALID_STATE_FOR_CASE_TYPE"}},"Target state is not an end state":{"description":"The target state must be a valid end state.","value":{"detail":"State ONBOARDING_NOT_STARTED is not a valid end state","identifier":"3fa85f64-5717-4562-b3fc-2c963f66afa6","timestamp":"2023-12-19T09:27:17.835Z","title":"INVALID_END_STATE"}},"Unable to update state for a payment screening case in end state":{"description":"Once a payment screening case is in an end state, its state cannot be updated again.","value":{"detail":"Case 3fa85f64-5717-4562-b3fc-2c963f66afa6 is a payment screening case and is already in an end state, so its state cannot be changed.","identifier":"3fa85f64-5717-4562-b3fc-2c963f66afa6","timestamp":"2023-12-19T09:27:17.835Z","title":"CANNOT_TRANSITION_PAYMENT_SCREENING_CASES_FROM_END_STATE"}}},"schema":{"$ref":"#/components/schemas/case-management_ProblemDetailErrorResponse"}}},"description":"Bad request"}},"summary":"Transition a case to a stage","tags":["Cases"]}},"/v2/clients/me":{"get":{"description":"Returns your client details.","operationId":"identity_v2_clients_me_getMyClient","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity_ClientData"}}},"description":"OK"}},"summary":"Get your client details","tags":["Clients"]}},"/v2/clients/me/accounts":{"get":{"description":"Returns a list of accounts within your client.\n\n\nYou need the \"View all accounts\" permission to use this endpoint.","operationId":"identity_v2_clients_me_accounts_getMyClientsAccounts","parameters":[{"description":"Filter the resource by name.","example":"ad","in":"query","name":"name_contains","required":false,"schema":{"type":"string"}},{"description":"The page of results returned within the response.","example":1,"in":"query","name":"page_number","required":false,"schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"The amount of results returned within the response.","example":10,"in":"query","name":"page_size","required":false,"schema":{"default":10,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity_AccountsResponse"}}},"description":"OK"}},"summary":"Get list of accounts within your client","tags":["Clients"]}},"/v2/clients/me/users":{"get":{"description":"Retrieve list of users in the client.\n\nYou need the \"View users\" permission to use this endpoint if no value is passed for the `identifier` query param.","operationId":"identity_v2_clients_me_users_getClientUsers","parameters":[{"deprecated":true,"description":"Search users by name.","example":"Doe","in":"query","name":"name_contains","required":false,"schema":{"type":"string"}},{"description":"Search users.","example":"Doe","in":"query","name":"search","required":false,"schema":{"type":"string"}},{"description":"Exclude you current account from the listing.","example":false,"in":"query","name":"exclude_my_account","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Do not include support users in the response.","example":false,"in":"query","name":"exclude_support_users","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Identifiers of users requested within the client.","example":["00000000-0000-0000-0000-000000000000"],"in":"query","name":"identifier","required":false,"schema":{"items":{"example":"00000000-0000-0000-0000-000000000000","type":"string"},"maxItems":40,"minItems":0,"type":"array"}},{"description":"The page of results returned within the response.","example":1,"in":"query","name":"page_number","required":false,"schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"The amount of results returned within the response.","example":10,"in":"query","name":"page_size","required":false,"schema":{"default":10,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity_NoRolesUsersResponse"}}},"description":"Users list retrieved"}},"summary":"Retrieve list of users in the client","tags":["Clients"]}},"/v2/custom-lists":{"get":{"description":"Retrieve all custom lists regardless of their status\n\n\nYou need \"Access to custom lists for customer screening\" enabled to use this endpoint.","operationId":"customListAPIAllCustomLists","parameters":[{"description":"One-based page index (1..N)","example":1,"in":"query","name":"page_number","required":false,"schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"The size of the page to be returned","example":20,"in":"query","name":"page_size","required":false,"schema":{"default":50,"minimum":1,"type":"integer"}},{"description":"Sorting criteria in the format of: `[-]property` (`-` descending modifier).\n\n* Default sort order is ascending (without `-`).\n\n* Multiple sort criteria are supported.","example":["-timestamp"],"in":"query","name":"sort","required":false,"schema":{"default":[],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customlist_CustomListPageDTO"}}},"description":"OK"}},"summary":"Retrieve all custom lists","tags":["Custom Lists"]},"post":{"description":"Create a new empty custom list ready to be populated\n\n\nYou need \"Access to custom lists for customer screening\" enabled and the \"Create, update, and delete custom lists and their entities, and download entities\" permission to use this endpoint.","operationId":"customListAPINewCustomList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customlist_CustomListAddDTO"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customlist_CustomListDTO"}}},"description":"Created"},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/customlist_ProblemDetailErrorResponse"}}},"description":"The request body required fields are invalid or missing"}},"summary":"Create a new custom list","tags":["Custom Lists"]}},"/v2/custom-lists/{custom_list_id}/entity":{"post":{"description":"Register the operation to add a new entity to an existing and active custom list.\n            The entity will be effectively added asynchronously and will be searchable later.\n            \n\n\nYou need \"Access to custom lists for customer screening\" enabled and the \"Create, update, and delete custom lists and their entities, and download entities\" permission to use this endpoint.","operationId":"customListAPINewEntityAddedToList","parameters":[{"description":"The identifier of the custom list to which the entity will be added.","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"custom_list_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customlist_EntityAddDTO"}}},"required":true},"responses":{"202":{"description":"The requested entity has been registered and will be searchable as soon as possible"},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/customlist_ProblemDetailErrorResponse"}}},"description":"The custom list id is expected to be a UUID"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/customlist_ProblemDetailErrorResponse"}}},"description":"The custom list has exceeded the number of entities that can be added (1,000,000)"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/customlist_ProblemDetailErrorResponse"}}},"description":"An entity with the same id already exists therefore the request has been denied.\n                    If you need to update a entity, please refer to [PATCH] /{custom_list_id}/entity/{entity_id}\n                     "}},"summary":"Add a specific entity to a list","tags":["Custom Lists"]},"put":{"description":"Register the operation to add or update a new entity to an existing and active custom list.\n            The entity will be effectively added or updated asynchronously and will be searchable later.\n            \n\n\nYou need \"Access to custom lists for customer screening\" enabled and the \"Create, update, and delete custom lists and their entities, and download entities\" permission to use this endpoint.","operationId":"customListAPINewEntityAddedOrUpdatedToList","parameters":[{"description":"The identifier of the custom list containing the entity to be added/updated.","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"custom_list_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customlist_EntityAddDTO"}}},"required":true},"responses":{"202":{"description":"The requested entity has been registered and will be searchable as soon as possible"},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/customlist_ProblemDetailErrorResponse"}}},"description":"The custom list id is expected to be a UUID"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/customlist_ProblemDetailErrorResponse"}}},"description":"The custom list has exceeded the number of entities that can be added (1,000,000)"}},"summary":"Add or update a specific entity to a list","tags":["Custom Lists"]}},"/v2/custom-lists/{custom_list_id}/entity/{id}":{"delete":{"description":"Register the operation to archive an existing entity to an existing custom list.\n            The entity will be archived asynchronously and will be removed from search later.\n            \n\n\nYou need \"Access to custom lists for customer screening\" enabled and the \"Create, update, and delete custom lists and their entities, and download entities\" permission to use this endpoint.","operationId":"customListAPIEntityArchivedFromList","parameters":[{"description":"The identifier of the custom list containing the entity to be deleted.","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"custom_list_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The identifier of the entity to delete","example":"my-entity-id","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"The requested entity will be archived and removed from search as soon as possible"},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/customlist_ProblemDetailErrorResponse"}}},"description":"The custom list id is expected to be a UUID"}},"summary":"Archive an entity from a list","tags":["Custom Lists"]},"get":{"description":"Retrieve the latest version of an entity by id within a list\n\n\nYou need \"Access to custom lists for customer screening\" enabled and the \"Create, update, and delete custom lists and their entities, and download entities\" permission to use this endpoint.","operationId":"customListAPIFetchLatestEntityById","parameters":[{"description":"The identifier of the custom list containing the entity to be retrieved.","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"custom_list_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The identifier of the entity to retrieve","example":"my-entity-id","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customlist_EntityDTO"}}},"description":"The requested entity has been found and returned"},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/customlist_ProblemDetailErrorResponse"}}},"description":"The custom list id is expected to be a UUID"},"404":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/customlist_ProblemDetailErrorResponse"}}},"description":"The requested entity could not be found."}},"summary":"Fetch a specific entity from a list","tags":["Custom Lists"]}},"/v2/custom-lists/{id}":{"delete":{"description":"Deletes a custom list if it's not being used by a Screening Configuration\n\n\nYou need \"Access to custom lists for customer screening\" enabled and the \"Create, update, and delete custom lists and their entities, and download entities\" permission to use this endpoint.","operationId":"customListAPIDeleteCustomListById","parameters":[{"description":"The identifier of the custom list you wish to delete.","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"202":{"description":"The custom list is deleted"},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/customlist_ProblemDetailErrorResponse"}}},"description":"The custom list id is expected to be a UUID"},"404":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/customlist_ProblemDetailErrorResponse"}}},"description":"The custom list could not be found"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/customlist_ProblemDetailErrorResponse"}}},"description":"The custom list being used by the Screening Configuration"}},"summary":"Delete a custom list by its identifier","tags":["Custom Lists"]},"get":{"description":"Retrieve the custom list details by identifier\n\n\nYou need \"Access to custom lists for customer screening\" enabled and the \"Create, update, and delete custom lists and their entities, and download entities\" permission to use this endpoint.","operationId":"customListAPIFetchCustomListById","parameters":[{"description":"The identifier of the custom list you wish to retrieve.","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The HTTP Accept header.","example":"text/csv","in":"header","name":"accept","required":false,"schema":{"type":"string"}},{"description":"Filter by entity status.","examples":{"Multiple statuses":{"description":"Multiple statuses","value":["ACTIVE","ARCHIVED"]}},"in":"query","name":"status","required":false,"schema":{"default":["ACTIVE"],"items":{"enum":["ACTIVE","ARCHIVED"],"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customlist_CustomListDTO"}},"text/csv":{"examples":{"CSV representation of a custom list":{"description":"CSV representation of a custom list","value":"\"name\",\"Demo\"\n\"custom_list_id\",\"01979de6-bbd0-7a82-a70d-4129d910a8d5\"\n\"created_date\",\"2025-06-23T17:47:13.744007Z\"\n\"last_updated_date\",\"2025-06-23T17:47:13.744007Z\"\n\"distinct_entities\",\"0\""}},"schema":{"type":"string"}}},"description":"OK"},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/customlist_ProblemDetailErrorResponse"}}},"description":"The custom list id is expected to be a UUID"},"404":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/customlist_ProblemDetailErrorResponse"}}},"description":"The custom list could not be found"}},"summary":"Retrieve a custom list from its identifier","tags":["Custom Lists"]}},"/v2/customers":{"get":{"description":"This endpoint returns a list of customers that match the specified search criteria.\n\nThe response includes partial information for each customer, including essential fields from the customer profile, risk level, and status objects.\n\nComplete details for each customer can be retrieved by calling the relevant endpoint with a specific customer identifier.\n\nThis endpoint can return up to 10,000 customers. For larger datasets, use the 'exports' endpoint, which is designed for exporting large volumes of data.\n\n\nYou need the \"View customers\" permission to use this endpoint.","operationId":"customerGetCustomersList","parameters":[{"description":"Search customers by name or external identifier","example":"john doe","in":"query","name":"search","required":false,"schema":{"type":"string"}},{"in":"query","name":"created_at_from","required":false,"schema":{"format":"date-time","type":"string"}},{"in":"query","name":"created_at_to","required":false,"schema":{"format":"date-time","type":"string"}},{"in":"query","name":"updated_at_from","required":false,"schema":{"format":"date-time","type":"string"}},{"in":"query","name":"updated_at_to","required":false,"schema":{"format":"date-time","type":"string"}},{"in":"query","name":"type","required":false,"schema":{"type":"string"}},{"in":"query","name":"risk_level","required":false,"schema":{"type":"string"}},{"in":"query","name":"status","required":false,"schema":{"type":"string"}},{"in":"query","name":"monitoring_enabled","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"acquisition_source","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"in":"query","name":"segments","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"in":"query","name":"labels","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"in":"query","name":"sort","required":false,"schema":{"type":"string"}},{"description":"One-based page index (1..N)","example":1,"in":"query","name":"page_number","required":false,"schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"The size of the page to be returned","example":20,"in":"query","name":"page_size","required":false,"schema":{"default":50,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_CustomersList"}}},"description":"Get the list of customers"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_ProblemDetailErrorResponse"}}},"description":"Bad Request"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_ProblemDetailErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_ProblemDetailErrorResponse"}}},"description":"Not Found"}},"summary":"Get a list of customers \n\n","tags":["Customers"]}},"/v2/customers/acquisition-sources":{"get":{"description":"\n\nYou need the \"View customers\" permission to use this endpoint.","operationId":"customerGetAcquisitionSources","parameters":[{"in":"query","name":"search","required":false,"schema":{"type":"string"}},{"description":"One-based page index (1..N)","example":1,"in":"query","name":"page_number","required":false,"schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"The size of the page to be returned","example":20,"in":"query","name":"page_size","required":false,"schema":{"default":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_PaginatedAcquisitionSourcesV2Response"}}},"description":"Get a list of acquisition sources matching the search parameter."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_ProblemDetailErrorResponse"}}},"description":"Bad Request"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_ProblemDetailErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_ProblemDetailErrorResponse"}}},"description":"Not Found"}},"summary":"Get a list of acquisition sources matching the search parameter.","tags":["Customers"]}},"/v2/customers/custom-fields":{"get":{"description":"This endpoint returns a paginated list of custom fields which can be optionally filtered by customer type.\n\n\nYou need the \"View customers\" permission to use this endpoint.","operationId":"customerGetCustomFields","parameters":[{"in":"query","name":"customer_type","required":false,"schema":{"enum":["PERSON","COMPANY","VESSEL"],"type":"string"}},{"description":"One-based page index (1..N)","example":1,"in":"query","name":"page_number","required":false,"schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"The size of the page to be returned","example":20,"in":"query","name":"page_size","required":false,"schema":{"default":50,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_PaginatedCustomFieldsResponse"}}},"description":"Successfully retrieved custom fields."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_ProblemDetailErrorResponse"}}},"description":"Bad Request"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_ProblemDetailErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_ProblemDetailErrorResponse"}}},"description":"Not Found"}},"summary":"Get a list of custom fields","tags":["Custom Fields"]},"post":{"description":"Create a new custom field to be used in the customer schema.\n\n\nYou need the \"Manage customer custom fields\" permission to use this endpoint.","operationId":"customerCreateCustomField","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_CreateCustomFieldRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_CustomField"}}},"description":"Custom field created successfully."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_ProblemDetailErrorResponse"}}},"description":"Bad Request."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_ProblemDetailErrorResponse"}}},"description":"Forbidden."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_ProblemDetailErrorResponse"}}},"description":"Not Found"}},"summary":"Create a custom field for customers","tags":["Custom Fields"]}},"/v2/customers/custom-fields/{custom_field_identifier}":{"patch":{"description":"Update the display name for a custom field.\n\n\nYou need the \"Manage customer custom fields\" permission to use this endpoint.","operationId":"customerUpdateCustomerCustomField","parameters":[{"description":"The unique identifier we provided when you created the customer custom field.","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"custom_field_identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_UpdateCustomFieldRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_CustomField"}}},"description":"Success. The custom field is updated."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_ProblemDetailErrorResponse"}}},"description":"Incorrect input parameters."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_ProblemDetailErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_ProblemDetailErrorResponse"}}},"description":"The custom field doesn't exist."}},"summary":"Update customer custom fields","tags":["Custom Fields"]}},"/v2/customers/external/{external_identifier}":{"get":{"description":"This endpoint returns a 308 Permanent Redirect response, directing you to the get [customer](https://docs.mesh.complyadvantage.com/reference/customergetcustomerv2) endpoint based on the provided external identifier.\nMany API libraries follow the automatic redirect but, in some programming languages it may requires an additional API call.\n\n\nYou need the \"View customers\" permission to use this endpoint.","operationId":"customerGetCustomerV2WithExternalIdentifier","parameters":[{"description":"The unique identifier for your customer that you set when creating the customer.","example":"external_identifier","in":"path","name":"external_identifier","required":true,"schema":{"type":"string"}}],"responses":{"308":{"description":"Permanent Redirect"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_ProblemDetailErrorResponse"}}},"description":"Bad Request"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_ProblemDetailErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_ProblemDetailErrorResponse"}}},"description":"Not Found"}},"summary":"Get customer using your identifier","tags":["Customers"]}},"/v2/customers/{customer_identifier}":{"get":{"description":"Once the workflow status returns as COMPLETED, it is possible to collect the latest customer record.\n\nThe response contains all the information submitted during the POST `/v2/customer` request.\n\nThe customer-identifier can be found within the GET `/v2/workflows/` response from within the `step_output` within the `customer-creation` step.\n\nThere is a number of customer statuses that can be returned from this endpoint:\n\n| Status name | Description |\n| ------ | ------ |\n|Processing| The customer has been created successfully but there are parts of the create-and-screen workflow that are still in progress|\n|Active|The customer is active - the initial risk level is not prohibited and there are no onboarding screening results, or these results were returned and their case status is accepted|\n|Closed|The customer is closed - the initial risk level is prohibited, or there are screening results and the case status is rejected, or maybe the client closed this customer for another reason.|\n\n\nYou need the \"View customers\" permission to use this endpoint.","operationId":"customerGetCustomerV2","parameters":[{"description":"The unique identifier we provided when you created the customer.","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"customer_identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_CustomerV2"}}},"description":"Get a customer."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_ProblemDetailErrorResponse"}}},"description":"Bad Request"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_ProblemDetailErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_ProblemDetailErrorResponse"}}},"description":"The customer doesn't exist."}},"summary":"Get customer details","tags":["Customers"]}},"/v2/customers/{customer_identifier}/cases":{"get":{"description":"Returns a paginated list of cases associated with a customer.","operationId":"casesService/v2/customers/customer_identifier/cases.get","parameters":[{"description":"The unique identifier of the customer.","example":"01899c37-576b-7677-b41a-9c9fdbd3bde1","in":"path","name":"customer_identifier","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"One-based page index (1..N)","example":1,"in":"query","name":"page_number","required":false,"schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"The size of the page to be returned","example":20,"in":"query","name":"page_size","required":false,"schema":{"default":25,"minimum":1,"type":"integer"}},{"description":"Sorting criteria in the format of: `[-]property` (`-` descending modifier).\n\n* Default sort order is ascending (without `-`).\n\n* Multiple sort criteria are supported.","example":["-timestamp"],"in":"query","name":"sort","required":false,"schema":{"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/case-management_PaginatedResponseCaseResponse"}}},"description":"OK"}},"summary":"Retrieve cases for a customer","tags":["Customers"]}},"/v2/customers/{customer_identifier}/labels":{"get":{"description":"Provides the labels that have been set for the specified customer.\n\n\nYou need the \"View customers\" permission to use this endpoint.","operationId":"customerGetLabelsV2","parameters":[{"description":"The unique identifier we provided when you created the customer.","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"customer_identifier","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"One-based page index (1..N)","example":1,"in":"query","name":"page_number","required":false,"schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"The size of the page to be returned","example":20,"in":"query","name":"page_size","required":false,"schema":{"default":50,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"examples":{"Page 1":{"description":"Page 1 of the customer labels available for this account.","value":{"first":"/v2/customers/{customer-identifier}/labels?page_number=1&page_size=1","labels":[{"identifier":"3fa85f64-5717-4562-b3fc-2c963f66afa6","name":"string-1"}],"next":"/v2/customers/{customer-identifier}/labels?page_number=2&page_size=1","prev":"null","self":"/v2/customers/{customer-identifier}/labels?page_number=1&page_size=1","total_count":3}},"Page 2":{"description":"Page 2 of the customer labels available for this account.","value":{"first":"/v2/customers/{customer-identifier}/labels?page_number=1&page_size=1","labels":[{"identifier":"3fa85f64-5717-4562-b3fc-2c963f77aba9","name":"string-2"}],"next":"/v2/customers/{customer-identifier}/labels?page_number=3&page_size=1","prev":"/v2/customers/{customer-identifier}/labels?page_number=1&page_size=1","self":"/v2/customers/{customer-identifier}/labels?page_number=2&page_size=1","total_count":3}}},"schema":{"$ref":"#/components/schemas/customer-manager_PaginatedCustomerLabelsV2Response"}}},"description":"Label list"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_ProblemDetailErrorResponse"}}},"description":"Bad Request"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_ProblemDetailErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_ProblemDetailErrorResponse"}}},"description":"Not Found"}},"summary":"Retrieve the labels for a customer","tags":["Labels"]},"put":{"description":"Sets the labels for a customer. The labels you specify replace what was there before.\n\nThe payload you send is a JSON array of the label UUIDs you want to set for this customer. \n\n\n\nYou need the \"Update customers\" permission to use this endpoint.","operationId":"customerUpdateLabels","parameters":[{"description":"The unique identifier we provided when you created the customer.","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"customer_identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"format":"uuid","type":"string"},"type":"array"}}},"required":true},"responses":{"204":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_Unit"}}},"description":"Success. The labels have been set for the customer."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_ProblemDetailErrorResponse"}}},"description":"Incorrect input parameters."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_ProblemDetailErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_ProblemDetailErrorResponse"}}},"description":"The customer doesn't exist."}},"summary":"Set labels for a customer","tags":["Labels"]}},"/v2/customers/{customer_identifier}/monitor":{"get":{"description":"This endpoint returns the monitor status for a single customer.\n\n\nYou need the \"View customer monitoring status\" permission to use this endpoint.","operationId":"customerGetMonitoringConfig","parameters":[{"description":"The unique identifier we provided when you created the customer.","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"customer_identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_CustomerMonitoringData"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_ProblemDetailErrorResponse"}}},"description":"Bad Request"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_ProblemDetailErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_ProblemDetailErrorResponse"}}},"description":"Not Found"}},"summary":"Get monitoring configuration of a customer","tags":["Customers"]},"patch":{"description":"This endpoint allows you to set the monitoring configuration for a single customer.\n\n\nYou need \"Access to base customer monitoring functionality\" enabled and the \"Monitor and unmonitor customers\" permission to use this endpoint.","operationId":"customerUpdateCustomerMonitorConfiguration","parameters":[{"description":"The unique identifier we provided when you created the customer.","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"customer_identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_CustomerMonitoringDataApi"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_CustomerMonitoringData"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_ProblemDetailErrorResponse"}}},"description":"Bad Request"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_ProblemDetailErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_ProblemDetailErrorResponse"}}},"description":"Not Found"}},"summary":"Update monitoring configuration for an existing customer","tags":["Customers"]}},"/v2/customers/{customer_identifier}/products":{"get":{"description":"This endpoint returns a list of the latest product information for a single customer.\n\n\nYou need the \"View customers\" permission to use this endpoint.","operationId":"customerGetProductsV2","parameters":[{"description":"The unique identifier we provided when you created the customer.","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"customer_identifier","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"One-based page index (1..N)","example":1,"in":"query","name":"page_number","required":false,"schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"The size of the page to be returned","example":20,"in":"query","name":"page_size","required":false,"schema":{"default":50,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_PaginatedProductsV2Response"}}},"description":"Get a customers products."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_ProblemDetailErrorResponse"}}},"description":"Bad Request"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_ProblemDetailErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer-manager_ProblemDetailErrorResponse"}}},"description":"The customer doesn't exist."}},"summary":"Get customer's products","tags":["Customers"]}},"/v2/customers/{customer_identifier}/reports":{"post":{"description":"Calling this endpoint will return a download URL to a screening certificate for a specific customer. When the response is 201, it means the screening certificate is generated successfully, and can be downloaded from the link returned. When the response is 200, it indicates that the data for the certificate is not yet available and you should try again shortly.\n\n\nYou need the \"View customers\" permission to use this endpoint.","operationId":"screeningCertificatesServiceAPIPostReportsV2","parameters":[{"description":"The unique identifier we provided when you created the customer.","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"customer_identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/cert_ReportsRequest"},"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"first":"/v2/customers/44444444-4444-4444-4444-444444444444/reports?page_number=1","next":null,"prev":null,"reports":[{"created_at":"1970-01-01T00:00:00.012Z","created_by":"55555555-5555-5555-5555-555555555555","expires_at":"1970-01-01T00:00:00.012Z","report_type":"SCREENING_REPORT","status":"NOT_READY"}],"self":"/v2/customers/44444444-4444-4444-4444-444444444444/reports","total_count":1}}},"description":"The customer report is not ready, please try again later."},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cert_PaginatedResponseReport"}}},"description":"The customer report has been generated successfully."},"400":{"content":{"application/json":{"example":{"detail":"There were validation errors with your request","identifier":"018e1971-1c6f-761f-a510-43540727ff48","instance":"https://v2/customers/56fb9e63-de1b-4cbc-9e7e-c5e15391eb09/reports","properties":{"errors":[{"field":"report_type","reasons":[{"key":"report_type","message":"SOME_OTHER_REPORT is not a valid report type","parameters":null}],"rejected":"SOME_OTHER_REPORT"}]},"status":400,"timestamp":"2024-03-07T15:03:47.055Z","title":"Invalid JSON Request","type":"about:blank"},"schema":{"$ref":"#/components/schemas/cert_ProblemDetailErrorResponse"}}},"description":"Bad request."},"403":{"content":{"application/json":{"example":{"detail":"You do not have the permissions needed to access the resource.","identifier":"018d3157-0ec8-73ba-a684-865e5e2ff1ed","instance":"https://v2/customers/56fb9e63-de1b-4cbc-9e7e-c5e15391eb09/reports","properties":{},"status":403,"timestamp":"2024-01-22T13:23:25.512Z","title":"Forbidden","type":"about:blank"},"schema":{"$ref":"#/components/schemas/cert_ProblemDetailErrorResponse"}}},"description":"Invalid permissions."},"404":{"content":{"application/json":{"example":{"detail":"Customer for account 0190b67d-df91-79ac-a60f-2c985e85630e with identifier 0190b67d-a943-79e0-a520-fdb6dbcf93bb not found","identifier":"018d3157-0ec8-73ba-a684-865e5e2ff1ed","instance":"https://v2/customers/0190b67d-a943-79e0-a520-fdb6dbcf93bb/reports","properties":{},"status":404,"timestamp":"2024-01-22T13:23:25.512Z","title":"Customer not found","type":"about:blank"},"schema":{"$ref":"#/components/schemas/cert_ProblemDetailErrorResponse"}}},"description":"The customer doesn't exist."}},"summary":"Generate a screening certificate for a specific customer","tags":["Customers"]}},"/v2/customers/{customer_identifier}/scores":{"get":{"description":"This endpoint returns the latest risk score for a customer. It includes the overall score and level as well as a breakdown of the score by category.\n\n\nYou need the \"View customers\" permission to use this endpoint.","operationId":"riskScoringManagerServiceAPIGetRiskScore","parameters":[{"description":"The unique identifier we provided when you created the customer.","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"customer_identifier","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Optional field to sort risk models by.","example":"created_at","in":"query","name":"sort","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/risk-scoring_RiskScore"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/risk-scoring_ProblemDetailErrorResponse"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/risk-scoring_ProblemDetailErrorResponse"}}},"description":"Not Found"}},"summary":"Get customer's risk score","tags":["Customers"]}},"/v2/customers/{customer_identifier}/workflows/sync/update-and-rescore":{"post":{"description":"This endpoint initiates the synchronous 'update and re-score' workflow for your customer in synchronous mode. The workflow consists of two steps:\n1. **Customer Record Update:** The customer record, and associated view of products, is updated.\n2. **Risk Scoring:** The risk score is re-calculated for the updated customer. The workflow executes synchronously returning the workflow status. This end-point is currently idempotent: in case of downstream error you can re-send the exact same request, and the workflow will be retried.\n\nIn using this endpoint:\n- **The Customer profile is mandatory and must be provided in full:**\n  * This endpoint overwrites the previous version of the customer record, any missing fields are treated as removed data and this data will be deleted from the customer view.\n- **The associated Product information is optional** and behaves in one of two ways:\n  * If the `products` tag is not provided, the current list of products will stay as is\n  * If the `products` tag is provided, it will overwrite the previous version of products. As such, all products - new, changed, and unchanged should be provided.\n\n\nYou need the \"Update customers\" permission to use this endpoint.","operationId":"updateCustomer","parameters":[{"description":"Customer identifier of the customer to update","example":"b30a02b7-eb74-445a-b678-b778ab3f091e","in":"path","name":"customer_identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ol_UpdateAndRescoreCustomerRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"WORKFLOW COMPLETED":{"description":"Once all step workflows are marked as COMPLETED then the workflow status will be marked as COMPLETED. ","value":{"status":"COMPLETED","step_details":{"customer-update":{"identifier":"018c3ff3-7275-7dc2-94a5-fe30315240b1","status":"COMPLETED","step_output":{"customer_identifier":"018c3ff3-746b-70de-9eb5-033634ec07eb","customer_version":2,"external_identifier":"abcd-1234"}},"risk-scoring":{"identifier":"018c3ff3-74c5-7645-b0fd-a2e24754067f","status":"COMPLETED","step_output":{"overall_level":"LOW-RISK","overall_value":0}}},"steps":["customer-update","risk-scoring"],"workflow_instance_identifier":"018c3ff3-7099-7090-a15b-8daee4cb81df","workflow_type":"update-and-rescore"}},"WORKFLOW ERRORED":{"description":"If any of the step workflows returns an ERRORED state then it will be required to contact support to resolve the issue.","value":{"status":"ERRORED","step_details":{"customer-update":{"error_message":"Something wrong","identifier":"018c4014-1de6-7d9d-ae92-eeacf245a259","status":"ERRORED","step_output":{}},"risk-scoring":{"identifier":null,"status":"SKIPPED","step_output":{}}},"steps":["customer-update","risk-scoring"],"workflow_instance_identifier":"018c4014-1c51-7b7d-a97c-044b5b624916","workflow_type":"update-and-rescore"}},"WORKFLOW IN PROGRESS":{"description":"If any step workflow is still IN PROGRESS then the following response will be provided. Further checks will be required to receive the latest status.","value":{"status":"IN-PROGRESS","step_details":{"customer-update":{"identifier":"018c3ff4-7ad2-7bd3-bd5e-c31abc2f691c","status":"IN-PROGRESS","step_output":{}},"risk-scoring":{"identifier":"018c3ff4-7d34-7017-a2fb-d39975d453fd","status":"NOT-STARTED","step_output":{}}},"steps":["customer-update","risk-scoring"],"workflow_instance_identifier":"018c3ff4-7979-7f95-98be-886116e3315c","workflow_type":"update-and-rescore"}}},"schema":{"$ref":"#/components/schemas/ol_WorkflowState"}}},"description":"Sync update and re-score workflow executed"},"400":{"content":{"application/json":{"examples":{"Validation error":{"description":"Validation error","value":{"detail":"There were validation errors with your request","identifier":"018e1971-1c6f-761f-a510-43540727ff48","instance":"https://example/v2/customers/56fb9e63-de1b-4cbc-9e7e-c5e15391eb09/workflows/sync/update-and-rescore","properties":{"errors":[{"field":"full_name","reasons":[{"key":"full_name","message":"full_name size must be between 0 and 50","parameters":null}],"rejected":"somenamesomenamesomenamesomenamesomenamesomenamesomenamesomenamesomename"}]},"status":400,"timestamp":"2024-03-07T15:03:47.055Z","title":"Invalid JSON Request","type":"about:blank"}}},"schema":{"$ref":"#/components/schemas/ol_ProblemDetailErrorResponse"}}},"description":"Bad request"},"403":{"content":{"application/json":{"examples":{"Invalid Permissions":{"description":"Invalid Permissions","value":{"detail":"You do not have the permissions needed to access the resource.","identifier":"018d3157-0ec8-73ba-a684-865e5e2ff1ed","instance":"https://example/v2/customers/56fb9e63-de1b-4cbc-9e7e-c5e15391eb09/workflows/sync/update-and-rescore","properties":{},"status":403,"timestamp":"2024-01-22T13:23:25.512Z","title":"Forbidden","type":"about:blank"}}},"schema":{"$ref":"#/components/schemas/ol_ProblemDetailErrorResponse"}}},"description":"Forbidden"}},"summary":"Update and re-score a customer synchronously","tags":["Customers"]}},"/v2/entity-screening/configurations":{"get":{"description":"This endpoint returns a list of configurations with its metadata","operationId":"entityScreeningGetConfigurations","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sra_ListConfigurationsResponse"}}},"description":"Configurations successfully retrieved"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sra_ProblemDetailErrorResponse"}}},"description":"No configurations found"}},"summary":"Get screening configurations","tags":["Screening Configurations"]},"post":{"description":"This endpoint creates a new screening configuration\n\n\nYou need \"Access to base customer screening functionality\" enabled and the \"Create and update customer screening configurations\" permission to use this endpoint.","operationId":"entityScreeningCreateConfiguration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sra_CreateConfigurationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sra_ScreeningConfiguration"}}},"description":"Configuration successfully created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sra_ProblemDetailErrorResponse"}}},"description":"Bad Request"}},"summary":"Create screening configuration","tags":["Screening Configurations"]}},"/v2/entity-screening/configurations/{configuration_identifier}":{"put":{"description":"This endpoint updates a screening configuration details\n\n\nYou need \"Access to base customer screening functionality\" enabled and the \"Create and update customer screening configurations\" permission to use this endpoint.","operationId":"entityScreeningUpdateConfiguration","parameters":[{"description":"The unique configuration identifier","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"configuration_identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sra_UpdateConfigurationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sra_ScreeningConfiguration"}}},"description":"Configuration successfully updated"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sra_ProblemDetailErrorResponse"}}},"description":"Bad Request"}},"summary":"Update screening configuration","tags":["Screening Configurations"]}},"/v2/entity-screening/configurations/{configuration_identifier}/versions":{"get":{"description":"This endpoint returns all versions of a screening configuration","operationId":"entityScreeningGetConfigurationVersions","parameters":[{"description":"The unique configuration identifier","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"configuration_identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sra_ListConfigurationVersionsResponse"}}},"description":"Configuration versions successfully retrieved"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sra_ProblemDetailErrorResponse"}}},"description":"No configuration versions found"}},"summary":"Get screening configuration versions","tags":["Screening Configurations"]}},"/v2/entity-screening/configurations/{configuration_identifier}/versions/{version_identifier}":{"get":{"description":"This endpoint returns a version of a configuration with its metadata","operationId":"entityScreeningGetConfigurationVersion","parameters":[{"description":"The unique configuration identifier","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"configuration_identifier","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Configuration version identifier. Setting configuration version to 0 returns the latest version","example":1,"in":"path","name":"version_identifier","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sra_ScreeningConfiguration"}}},"description":"Configuration successfully retrieved"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sra_ProblemDetailErrorResponse"}}},"description":"No configuration version found"}},"summary":"Get a screening configuration version","tags":["Screening Configurations"]}},"/v2/entity-screening/risks/{risk_identifier}/notes":{"get":{"description":"Get the notes for a screening risk","operationId":"entityScreeningGetRiskNotes","parameters":[{"description":"The unique risk identifier","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"risk_identifier","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"If true, retrieves all notes attached to the profile associated with the requested risk","example":true,"in":"query","name":"related_notes","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"One-based page index (1..N)","example":1,"in":"query","name":"page_number","required":false,"schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"The size of the page to be returned","example":20,"in":"query","name":"page_size","required":false,"schema":{"default":50,"minimum":1,"type":"integer"}},{"description":"Sort notes by created_at. Prefix with '-' for descending order (e.g. -created_at), or omit the prefix for ascending order (e.g. created_at).","example":"-created_at","in":"query","name":"sort","required":false,"schema":{"default":[],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sra_GetNotesResponse"}}},"description":"OK"},"404":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/sra_ProblemDetailErrorResponse"}}},"description":"Risk not found."}},"summary":"Get the notes for a screening risk","tags":["Alerts & Risks"]},"post":{"description":"Create a new note on a screening risk","operationId":"entityScreeningCreateNote","parameters":[{"description":"The unique risk identifier","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"risk_identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sra_PostNoteRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sra_ScreeningNoteResponse"}}},"description":"Success."},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/sra_ProblemDetailErrorResponse"}}},"description":"Bad request."},"404":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/sra_ProblemDetailErrorResponse"}}},"description":"Risk not found."}},"summary":"Create a new note on a screening risk","tags":["Alerts & Risks"]}},"/v2/exports":{"get":{"description":"Calling this endpoint will return a list of all the exports that the requesting user attempted to create. It will return exports that are pending, successful and failed.\n\n\nYou need the \"View and download insights\" permission to use this endpoint.","operationId":"exportsServiceListExports","parameters":[{"description":"One-based page index (1..N)","example":1,"in":"query","name":"page_number","required":false,"schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"The size of the page to be returned","example":20,"in":"query","name":"page_size","required":false,"schema":{"default":25,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/exports_PaginatedResponseExportItem"}}},"description":"List of exports successfully returned"},"400":{"content":{"application/problem+json":{"examples":{"Page number too large":{"description":"Page number too large","value":{"detail":"Page number of 55 is greater than max page number of 41","identifier":"018d5563-3da8-794b-8dca-388804d4331f","instance":"https://docs.mesh.complyadvantage.com/reference/errors","status":400,"timestamp":"2024-01-29T13:24:35.998Z","title":"Page number too large","type":"about:blank"}},"Page size too large":{"description":"Page size too large","value":{"detail":"Page size of $(MAX_PAGE_SIZE + 1) is greater than max page size of 100","identifier":"018d5563-3da8-794b-8dca-388804d4331f","instance":"https://docs.mesh.complyadvantage.com/reference/errors","status":400,"timestamp":"2024-01-29T13:24:35.998Z","title":"Page size too large","type":"about:blank"}}},"schema":{"$ref":"#/components/schemas/exports_ProblemDetailErrorResponse"}}},"description":"Bad request"}},"summary":"Get a list of all exports that the requesting user attempted to create","tags":["Exports"]},"post":{"description":"Create a new export by selecting an export type and a start and end date. The available export names are CUSTOMER_SCREENING, CUSTOMER, SCREENING_AND_MONITORING_CASES, PROFILES, PAYMENT_SCREENING_CASES, TRANSACTION_MONITORING_CASES_AND_ALERTS, TRANSACTIONS.\n\n\nYou need the \"View and download insights\" permission to use this endpoint.","operationId":"exportsServiceCreateExport","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/exports_CreateExportPayload"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/exports_ExportItem"}}},"description":"Export successfully created"},"400":{"content":{"application/json":{"examples":{"Invalid export_type_key":{"description":"Invalid export_type_key","value":{"errors":[{"field":"export_type_key","reasons":[{"key":"EXPORT_TYPE_INVALID","message":"export_type_key must be one of the following: CUSTOMER_SCREENING, CUSTOMER, SCREENING_AND_MONITORING_CASES, PROFILES, PAYMENT_SCREENING_CASES, TRANSACTION_MONITORING_CASES_AND_ALERTS, TRANSACTIONS.","parameters":null}],"rejected":"invalid-export-type-key"}],"identifier":"dc9f5c1a-915e-4860-ba57-bed23494a6ee","instance":"https://docs.mesh.complyadvantage.com/reference/errors","status":400,"timestamp":"2024-01-30T14:26:25.998Z","title":"Invalid input","type":"about:blank"}},"export_name cannot be blank":{"description":"export_name cannot be blank","value":{"errors":[{"field":"export_name","reasons":[{"key":"EXPORT_NAME_BLANK","message":"export_name field must not be blank.","parameters":null}],"rejected":""}],"identifier":"dc9f5c1a-915e-4860-ba57-bed23494a6ee","instance":"https://docs.mesh.complyadvantage.com/reference/errors","status":400,"timestamp":"2024-01-30T14:26:25.998Z","title":"Invalid input","type":"about:blank"}},"export_name cannot be over character limit":{"description":"export_name cannot be over character limit","value":{"errors":[{"field":"export_name","reasons":[{"key":"EXPORT_NAME_LENGTH","message":"export_name field must be a maximum of 50 characters.","parameters":null}],"rejected":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}],"identifier":"dc9f5c1a-915e-4860-ba57-bed23494a6ee","instance":"https://docs.mesh.complyadvantage.com/reference/errors","status":400,"timestamp":"2024-01-30T14:26:25.998Z","title":"Invalid input","type":"about:blank"}},"start_date and end_date must be in ISO 8601 format":{"description":"start_date and end_date must be in ISO 8601 format","value":{"errors":[{"field":"start_date","reasons":[{"key":"DATE_INVALID","message":"Invalid date format, the date format must be ISO 8601.","parameters":null}],"rejected":"01-11-2023"}],"identifier":"dc9f5c1a-915e-4860-ba57-bed23494a6ee","instance":"https://docs.mesh.complyadvantage.com/reference/errors","status":400,"timestamp":"2024-01-30T14:26:25.998Z","title":"Invalid input","type":"about:blank"}},"start_date cannot be after end_date":{"description":"start_date cannot be after end_date","value":{"errors":[{"field":"start_date","reasons":[{"key":"START_DATE_AFTER_END_DATE","message":"start_date must be before end_date.","parameters":null}],"rejected":""}],"identifier":"dc9f5c1a-915e-4860-ba57-bed23494a6ee","instance":"https://docs.mesh.complyadvantage.com/reference/errors","status":400,"timestamp":"2024-01-30T14:26:25.998Z","title":"Invalid input","type":"about:blank"}},"start_date cannot be in the future":{"description":"start_date cannot be in the future","value":{"errors":[{"field":"start_date","reasons":[{"key":"START_DATE_IN_THE_FUTURE","message":"start_date cannot be in the future.","parameters":null}],"rejected":"2030-01-01T00:00:00.000Z"}],"identifier":"dc9f5c1a-915e-4860-ba57-bed23494a6ee","instance":"https://docs.mesh.complyadvantage.com/reference/errors","status":400,"timestamp":"2030-01-30T14:26:25.998Z","title":"Invalid input","type":"about:blank"}},"start_date cannot be over a year ago":{"description":"start_date cannot be over a year ago","value":{"errors":[{"field":"start_date","reasons":[{"key":"START_DATE_MORE_THAN_ONE_YEAR_AGO","message":"start_date cannot be more than one year ago.","parameters":null}],"rejected":"2021-01-01T00:00:00.000Z"}],"identifier":"dc9f5c1a-915e-4860-ba57-bed23494a6ee","instance":"https://docs.mesh.complyadvantage.com/reference/errors","status":400,"timestamp":"2024-01-30T14:26:25.998Z","title":"Invalid input","type":"about:blank"}}},"schema":{"$ref":"#/components/schemas/exports_ProblemDetailErrorResponse"}}},"description":"Bad request"}},"summary":"Create a new export","tags":["Exports"]}},"/v2/exports/export-types":{"get":{"description":"This endpoint will return a paginated list of available exports, along with details about the data contained within each and how it can be used for analytical and reporting purposes.\n\n\nYou need the \"View and download insights\" permission to use this endpoint.","operationId":"exportsServiceGetExportTypes","parameters":[{"description":"One-based page index (1..N)","example":1,"in":"query","name":"page_number","required":false,"schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"The size of the page to be returned","example":20,"in":"query","name":"page_size","required":false,"schema":{"default":25,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/exports_PaginatedResponseExportTypeKeys"}}},"description":"List of exports successfully returned"}},"summary":"Get a list of export types","tags":["Exports"]}},"/v2/exports/{export_identifier}/download":{"get":{"description":"This endpoint will return the download url for the requested export.\n\n\nYou need the \"View and download insights\" permission to use this endpoint.","operationId":"exportsServiceGetExportDownloadUrl","parameters":[{"description":"The `uuid` of the `Export`.","example":"01566c37-576b-7677-b41a-9c6fdbd3abc9","in":"path","name":"export_identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/exports_DownloadExportResponseBody"}}},"description":"Download url for the export successfully returned."},"404":{"content":{"application/json":{"examples":{"Export generation has failed":{"description":"Export generation has failed","value":{"detail":"Export with ID of 550e8400-e29b-41d4-a716-446655440000 generation has failed.","identifier":"018d5563-3da8-794b-8dca-388804d4331f","instance":"https://docs.mesh.complyadvantage.com/reference/errors","status":404,"timestamp":"2024-01-29T13:24:35.998Z","title":"Export generation has failed.","type":"about:blank"}},"Export generation is still pending":{"description":"Export generation is still pending","value":{"detail":"Export with ID of 550e8400-e29b-41d4-a716-446655440000 generation is still pending.","identifier":"018d5563-3da8-794b-8dca-388804d4331f","instance":"https://docs.mesh.complyadvantage.com/reference/errors","status":404,"timestamp":"2024-01-29T13:24:35.998Z","title":"Export generation is still pending.","type":"about:blank"}},"Export object does not exist":{"description":"Export object does not exist","value":{"detail":"Export with ID of 550e8400-e29b-41d4-a716-446655440000 identifier does not exist.","identifier":"018d5563-3da8-794b-8dca-388804d4331f","instance":"https://docs.mesh.complyadvantage.com/reference/errors","status":404,"timestamp":"2024-01-29T13:24:35.998Z","title":"Export object does not exist.","type":"about:blank"}}},"schema":{"$ref":"#/components/schemas/exports_ProblemDetailErrorResponse"}}},"description":"Export not found."},"503":{"content":{"application/json":{"examples":{"Generating presigned url failed":{"description":"Generating presigned url failed","value":{"detail":"Generating presigned url for Export with ID of 450e8400-e29b-41d4-a716-446655440000 failed.","identifier":"dc9f5c1a-915e-4860-ba57-bed23494a6ee","instance":"https://docs.mesh.complyadvantage.com/reference/errors/503","status":503,"timestamp":"2024-01-30T14:26:25.998Z","title":"Generating presigned url failed.","type":"about:blank"}}},"schema":{"$ref":"#/components/schemas/exports_ProblemDetailErrorResponse"}}},"description":"Service unavailable due to problems encountered while generating the presigned url."}},"summary":"Get a download url for a given export","tags":["Exports"]}},"/v2/iam/permissions":{"get":{"description":"List permissions","operationId":"identity_v2_iam_permissions_listPermissions","parameters":[{"description":"Permission level.","example":"ACCOUNT","in":"query","name":"level","required":false,"schema":{"enum":["USER","ACCOUNT"],"type":"string"}},{"description":"Include only permissions that are valid given the requesting user's account permissions.","example":true,"in":"query","name":"valid_for_account","required":false,"schema":{"type":"boolean"}},{"description":"One-based page index (1..N)","example":1,"in":"query","name":"page_number","required":false,"schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"The size of the page to be returned","example":20,"in":"query","name":"page_size","required":false,"schema":{"default":10,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity_PaginatedResponsePermissionWithDepsResponse"}}},"description":"OK"}},"summary":"List permissions","tags":["IAM"]}},"/v2/iam/permissions/groups":{"get":{"description":"List permission groups","operationId":"identity_v2_iam_permissions_groups_listPermissionGroups","parameters":[{"description":"Permission level.","example":"ACCOUNT","in":"query","name":"level","required":false,"schema":{"enum":["USER","ACCOUNT"],"type":"string"}},{"description":"Include only permissions that are valid given the requesting user's account permissions.","example":true,"in":"query","name":"valid_for_account","required":false,"schema":{"type":"boolean"}},{"description":"One-based page index (1..N)","example":1,"in":"query","name":"page_number","required":false,"schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"The size of the page to be returned","example":20,"in":"query","name":"page_size","required":false,"schema":{"default":25,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity_PaginatedResponseGroupWithPermissionsHttpResponse"}}},"description":"OK"}},"summary":"List permission groups with permissions","tags":["IAM"]}},"/v2/iam/roles":{"get":{"description":"Returns a list of roles. You need the View roles in organization permission to use the account_identifier parameter.\n\n\nYou need the \"View roles in account\" permission to use this endpoint.","operationId":"identity_v2_iam_roles_getRoles","parameters":[{"description":"Filter roles by name.","example":"Admin","in":"query","name":"name_contains","required":false,"schema":{"type":"string"}},{"description":"Filter only roles that have all of at least one set of permissions.","example":["1","2"],"in":"query","name":"permissions","required":false,"schema":{"items":{"example":"1+2+5","type":"string"},"type":"array"}},{"description":"The identifier of the account whose roles you'd like to retrieve.","example":"00000000-0000-0000-0000-000000000000","in":"query","name":"account_identifier","required":false,"schema":{"format":"uuid","type":"string"}},{"description":"The page of results returned within the response.","example":1,"in":"query","name":"page_number","required":false,"schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"The amount of results returned within the response.","example":10,"in":"query","name":"page_size","required":false,"schema":{"default":50,"minimum":1,"type":"integer"}},{"description":"Sorting criteria in the format of: `[-]property` (`-` descending modifier).\n\n* Default sort order is ascending (without `-`).\n\n* Multiple sort criteria are supported.","example":["name"],"in":"query","name":"sort","required":false,"schema":{"default":["name"],"items":{"enum":["name","created_at","updated_at"],"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity_PaginatedResponseRoleResponse"}}},"description":"OK"}},"summary":"Get list of roles","tags":["IAM"]},"post":{"description":"\n\nYou need the \"Create, update, and delete roles in account\" permission to use this endpoint.","operationId":"identity_v2_iam_roles_createRole","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity_RoleRequestBody"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/identity_CustomRoleWithPermissionsResponse"},{"$ref":"#/components/schemas/identity_DefaultRoleWithPermissionsResponse"}]}}},"description":"CREATED"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity_ProblemDetailErrorResponse"}}},"description":"Invalid input"}},"summary":"Create a new role","tags":["IAM"]}},"/v2/iam/roles/{role_identifier}":{"delete":{"description":"\n\nYou need the \"Create, update, and delete roles in account\" permission to use this endpoint.","operationId":"identity_v2_iam_roles_role_identifier_deleteSpecificRole","parameters":[{"description":"The identifier of the Role that you want to delete.","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"role_identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"204":{"description":"Role deleted"}},"summary":"Delete a role","tags":["IAM"]},"get":{"description":"Returns details for a given role.\n\n\nYou need the \"View roles in account\" permission to use this endpoint.","operationId":"identity_v2_iam_roles_role_identifier_getSpecificRole","parameters":[{"description":"The identifier of the role that you want to retrieve.","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"role_identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/identity_CustomRoleWithPermissionsResponse"},{"$ref":"#/components/schemas/identity_DefaultRoleWithPermissionsResponse"}]}}},"description":"OK"}},"summary":"Get details about a role","tags":["IAM"]},"patch":{"description":"\n\nYou need the \"Create, update, and delete roles in account\" permission to use this endpoint.","operationId":"identity_v2_iam_roles_role_identifier_updateAccountRole","parameters":[{"description":"The identifier of the role that you want to update.","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"role_identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity_PartialUpdateRoleRequestBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/identity_CustomRoleWithPermissionsResponse"},{"$ref":"#/components/schemas/identity_DefaultRoleWithPermissionsResponse"}]}}},"description":"UPDATED"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity_ProblemDetailErrorResponse"}}},"description":"Invalid input"}},"summary":"Partial update an existing role","tags":["IAM"]}},"/v2/labels":{"get":{"description":"This endpoint allows you to retrieve all the labels in an account. It can also be used to perform a direct search on a label identifier or name, and can be sorted by name or created at of the labels.\n\n\nYou need the \"View customers\" permission to use this endpoint.","operationId":"labelManagerGetLabelsList","parameters":[{"description":"The unique name you provided when you created the label.","example":["label_one"],"in":"query","name":"name","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"description":"The unique identifier we provided when you created the label.","example":["00000000-0000-0000-0000-000000000000"],"in":"query","name":"identifier","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"in":"query","name":"search","required":false,"schema":{"type":"string"}},{"description":"One-based page index (1..N)","example":1,"in":"query","name":"page_number","required":false,"schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"The size of the page to be returned","example":20,"in":"query","name":"page_size","required":false,"schema":{"default":50,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/label_GetLabelsPaginatedResponse"}}},"description":"Get a list of labels"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/label_ProblemDetailErrorResponse"}}},"description":"Bad Request"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/label_ProblemDetailErrorResponse"}}},"description":"You do not have the permissions needed to access the resource."}},"summary":"Get a list of labels","tags":["Labels"]},"post":{"description":"This endpoint allows you to create labels by submitting an array of label names.\n\n\nYou need the \"Create and update labels\" permission to use this endpoint.","operationId":"labelManagerCreateLabels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/label_CreateLabelsPayload"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/label_CreateLabelsResponse"}}},"description":"New labels created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/label_ProblemDetailErrorResponse"}}},"description":"Bad Request"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/label_ProblemDetailErrorResponse"}}},"description":"You do not have the permissions needed to access the resource."}},"summary":"Create new labels","tags":["Labels"]}},"/v2/labels/{label_identifier}":{"patch":{"description":"This endpoint allows you to rename a label\n\n\nYou need the \"Create and update labels\" permission to use this endpoint.","operationId":"labelManagerRenameLabel","parameters":[{"description":"The unique identifier we provided when you created the label.","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"label_identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/label_UpdateLabelRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/label_Label"}}},"description":"Rename label"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/label_ProblemDetailErrorResponse"}}},"description":"Bad Request"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/label_ProblemDetailErrorResponse"}}},"description":"You do not have the permissions needed to access the resource."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/label_ProblemDetailErrorResponse"}}},"description":"Label Not Found"}},"summary":"Rename label","tags":["Labels"]}},"/v2/notifications/configurations/email":{"get":{"description":"Returns all the email notification configurations created for this account. Allows to filter by email notification type.\n\n\nYou need the \"View email notification configurations\" permission to use this endpoint.","operationId":"notificationGetEmailConfigurations","parameters":[{"example":"CASE_ASSIGNED","in":"query","name":"type","required":false,"schema":{"enum":["CASE_ASSIGNED"],"type":"string"}},{"description":"One-based page index (1..N)","example":1,"in":"query","name":"page_number","required":false,"schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"The size of the page to be returned","example":20,"in":"query","name":"page_size","required":false,"schema":{"default":25,"minimum":1,"type":"integer"}},{"description":"Sorting criteria in the format of: `[-]property` (`-` descending modifier).\n\n* Default sort order is ascending (without `-`).\n\n* Multiple sort criteria are supported.","example":["-timestamp"],"in":"query","name":"sort","required":false,"schema":{"default":[],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ns_PaginatedResponseEmailConfigurationLog"}}},"description":"OK"}},"summary":"Get a list of all email notification configurations","tags":["Email Configurations"]},"post":{"description":"This endpoint enables you to create an email notification, by selecting a type of notification that should trigger the sending of this email and specify who the email should be sent to, when the conditions are met.\n\nAt least one recipient should be specified.\n\nThere is one event type which can trigger an email to be sent:\n\n### CASE_ASSIGNED\n\nSends an email to the assignee, whenever a new case is assigned to that user.\nIf that user is configured in the list of recipients and the person assigning the email is not the same user (so only sending an email notification when someone else assigns a case to this user).\n\nExample:\n```\nHi Sophie,\n\nA case has been assigned to you by Julian\nType: Customer Onboarding\nCreated at: February 10, 2025 at 10:00am\nStage: In Review\nAssignee: Sophie\nNote: Assigned to you because you are specialized on these scenarios\nClick here to view this case\n\nPlease contact support@complyadvantage.com if you have any questions.\n\n```\n\n\n\nYou need the \"Create and update email notification configurations\" permission to use this endpoint.","operationId":"notificationCreateEmailConfiguration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ns_EmailConfigurationPayload"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ns_EmailConfigurationLog"}}},"description":"Email configuration created successfully"},"400":{"content":{"application/problem+json":{"examples":{"invalid email":{"description":"invalid email","value":{"detail":"Email configuration requires at least one valid UUID for user or role","identifier":"0193ab2b-1be8-7eed-8c20-dae093618aea","instance":"https://example/v2/notifications/configurations/email/01938f3e-1286-752c-9b52-9210e4b95a14","status":400,"timestamp":"2024-12-09T11:25:49.416Z","title":"Validation Error","type":"about:blank"}}},"schema":{"$ref":"#/components/schemas/ns_ProblemDetailErrorResponse"}}},"description":"Bad request. Request cannot be processed due to input Email configuration payload error."}},"summary":"Create a new email notification configuration","tags":["Email Configurations"]}},"/v2/notifications/configurations/email/test":{"post":{"description":"This is an optional test that will send an example email to the email address you specify.\n\nTest Email content: \n\n```\"This is a test email from ComplyAdvantage with identifier=2032e328-c48b-4674-8229-576955df1a79 \"```\n\n\nYou need the \"Create and update email notification configurations\" permission to use this endpoint.","operationId":"notificationTestEmailConfiguration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ns_EmailTestPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ns_TestEmailResponse"}}},"description":"success"},"400":{"content":{"application/problem+json":{"examples":{"missing email":{"description":"missing email","value":{"detail":"There were validation errors with your request","errors":[{"field":"email","reasons":[{"key":"email incorrect type OR required","message":"email validation error","parameters":null}],"rejected":"0"}],"identifier":"0193ac84-8eec-70dc-9747-e3e894095734","instance":"https://example/v2/notifications/configurations/email/test","status":400,"timestamp":"2024-12-09T17:43:08.780Z","title":"Validation Error","type":"about:blank"}}},"schema":{"$ref":"#/components/schemas/ns_ProblemDetailErrorResponse"}}},"description":"Bad request. Request cannot be processed due to input error."}},"summary":"Test an email","tags":["Email Configurations"]}},"/v2/notifications/configurations/email/{identifier}":{"delete":{"description":"This endpoint allows deleting an email notification configuration.\n\n\nYou need the \"Create and update email notification configurations\" permission to use this endpoint.","operationId":"notificationDeleteEmailConfiguration","parameters":[{"description":"When you create an email config or run “Get list of email configs”, you’ll receive a unique configuration identifier for each email config. Supply that here for the email you wish to delete.","example":"95913b76-050c-40f3-9075-25f0737ac7d3","in":"path","name":"identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ns_DeletedEmailConfigurationResponse"}}},"description":"Email configuration deleted successfully"},"400":{"content":{"application/problem+json":{"examples":{"Requires at least one valid UUID for user or role":{"description":"Requires at least one valid UUID for user or role","value":{"detail":"Email configuration with the provided identifier=0193b5a8-eb33-7af3-a5f1-37d9ec1a14fd does not exist","identifier":"0193b5aa-2d94-7cfa-a4d8-2a637ec5d619","instance":"https://example/v2/notifications/configurations/email/0193b5a8-eb33-7af3-a5f1-37d9ec1a14fd","status":404,"timestamp":"2024-12-09T18:06:22.711Z","title":"Configuration does not exist","type":"about:blank"}}},"schema":{"$ref":"#/components/schemas/ns_ProblemDetailErrorResponse"}}},"description":"Bad request. Request cannot be processed due to input error."}},"summary":"Delete an email notification configuration","tags":["Email Configurations"]},"patch":{"description":"This endpoint allows updating who the email notification is configured to be sent to.\n\n\nYou need the \"Create and update email notification configurations\" permission to use this endpoint.","operationId":"notificationPatchEmailConfiguration","parameters":[{"description":"The identifier of the email configuration","example":"95913b76-050c-40f3-9075-25f0737ac7d3","in":"path","name":"identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ns_UpdateEmailConfigurationPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ns_EmailConfigurationLog"}}},"description":"Email configuration updated successfully"},"400":{"content":{"application/problem+json":{"examples":{"Requires at least one valid UUID for user or role":{"description":"Requires at least one valid UUID for user or role","value":{"detail":"Email configuration requires at least one valid UUID for user or role","identifier":"0193ac99-d3f7-70e5-b8d1-2cd66e6bdf36","instance":"https://example/v2/notifications/configurations/email/01938f3c-9e8b-7537-b55e-538663b866ca","status":400,"timestamp":"2024-12-09T18:06:22.711Z","title":"Validation Error","type":"about:blank"}}},"schema":{"$ref":"#/components/schemas/ns_ProblemDetailErrorResponse"}}},"description":"Bad request. Request cannot be processed due to input error."}},"summary":"Update an email notification configuration","tags":["Email Configurations"]}},"/v2/notifications/configurations/webhook":{"get":{"description":"Use this endpoint to get back a list of all webhook notification configurations that the account has set up.\n\n\nYou need the \"View webhooks\" permission to use this endpoint.","operationId":"notificationGetWebhookConfigurations","parameters":[{"description":"Filter webhook notification configurations by type","example":"CASE_CREATED","in":"query","name":"type","required":false,"schema":{"enum":["CASE_CREATED","CASE_STATE_UPDATED","WORKFLOW_COMPLETED","CASE_ALERT_LIST_UPDATED","TRANSACTION_REVIEWED"],"type":"string"}},{"description":"One-based page index (1..N)","example":1,"in":"query","name":"page_number","required":false,"schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"The size of the page to be returned","example":20,"in":"query","name":"page_size","required":false,"schema":{"default":25,"minimum":1,"type":"integer"}},{"description":"Sorting criteria in the format of: `[-]property` (`-` descending modifier).\n\n* Default sort order is ascending (without `-`).\n\n* Multiple sort criteria are supported.","example":["-timestamp"],"in":"query","name":"sort","required":false,"schema":{"default":[],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ns_PaginatedResponseWebhookConfigurationLog"}}},"description":"OK"}},"summary":"Get a list of all webhook notification configurations.","tags":["Webhooks"]},"post":{"callbacks":{"onCaseAlertListUpdated":{"$request.body.url":{"post":{"description":"Receive an update whenever the alert list associated with a case is updated, such as when new alerts are added to the case.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ns_CaseAlertListUpdatedV2JsonPayload"}}}},"responses":{"200":{"description":"The downstream service should respond with 200 OK to acknowledge receipt of the  webhook."}},"summary":"CASE_ALERT_LIST_UPDATED"}}},"onCaseCreated":{"$request.body.url":{"post":{"description":"Receive an update whenever a new case is created.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ns_CaseCreatedJsonPayloadV2"}}}},"responses":{"200":{"description":"The downstream service should respond with 200 OK to acknowledge receipt of the  webhook."}},"summary":"CASE_CREATED"}}},"onCaseStageUpdated":{"$request.body.url":{"post":{"description":"Receive an update whenever a case changes its stage, e.g. from \"Not Started\" to \"In Progress\".","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ns_CaseStateUpdatedV1JsonPayload"}}}},"responses":{"200":{"description":"The downstream service should respond with 200 OK to acknowledge receipt of the  webhook."}},"summary":"CASE_STAGE_UPDATED"}}},"onCustomerRiskLevelDecreased":{"$request.body.url":{"post":{"description":"Receive an update when a customer's risk level decreases.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ns_CustomerRiskScoreDataUpdateV3JsonPayload"}}}},"responses":{"200":{"description":"The downstream service should respond with 200 OK to acknowledge receipt of the  webhook."}},"summary":"CUSTOMER_RISK_LEVEL_DECREASED"}}},"onCustomerRiskLevelIncreased":{"$request.body.url":{"post":{"description":"Receive an update when a customer's risk level increases.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ns_CustomerRiskScoreDataUpdateV3JsonPayload"}}}},"responses":{"200":{"description":"The downstream service should respond with 200 OK to acknowledge receipt of the  webhook."}},"summary":"CUSTOMER_RISK_LEVEL_INCREASED"}}},"onCustomerRiskScoreChanged":{"$request.body.url":{"post":{"description":"Receive an update when a customer's risk score changes.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ns_CustomerRiskScoreDataUpdateV3JsonPayload"}}}},"responses":{"200":{"description":"The downstream service should respond with 200 OK to acknowledge receipt of the  webhook."}},"summary":"CUSTOMER_RISK_SCORE_CHANGED"}}},"onTransactionReviewed":{"$request.body.url":{"post":{"description":"Receive an update when an onboarding workflow completes.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ns_TransactionReviewedV3JsonPayload"}}}},"responses":{"200":{"description":"The downstream service should respond with 200 OK to acknowledge receipt of the  webhook."}},"summary":"TRANSACTION_REVIEWED"}}},"onWorkflowCompleted":{"$request.body.url":{"post":{"description":"Receive an update when an onboarding workflow completes.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ns_WorkflowCompletedV2JsonPayload"}}}},"responses":{"200":{"description":"The downstream service should respond with 200 OK to acknowledge receipt of the  webhook."}},"summary":"WORKFLOW_COMPLETED"}}}},"description":"\nThis endpoint enables you to create a webhook configuration that will monitor an event type and send updates to the URL you specify.\n\nThere are several event types you can listen to:\n\n### CASE_CREATED\n\nReceive an update whenever a new case is created.\n\nNote:\n - case_state is deprecated. Please use case_stage instead.\n - This webhook produces two responses v1 and v2 - please use v2 as it contains case_stage and also the customer external_identifier\n\nExample:\n```json\n{\n \"api_version\": \"v2\",\n \"webhook_type\": \"CASE_CREATED\",\n \"case_identifier\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"case_state\": \"ONBOARDING_NOT_STARTED\",\n \"case_type\": \"CUSTOMER_ONBOARDING\",\n \"customer\": {\n  \"identifier\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n  \"external_identifier\": \"your unique customer identifier\",\n  \"version\": 1\n },\n \"case_stage\": {\n   \"identifier\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n   \"display_name\": \"Not Started\",\n   \"display_order\": 1,\n   \"stage_type\": \"INITIAL\",\n   \"decision_type\": null\n },\n \"subjects\": [\n   {\n     \"type\": \"CUSTOMER\",\n     \"identifier\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n     \"external_identifier\": \"your unique customer identifier\",\n     \"version\": \"1\"\n   },\n   {\n     \"type\": \"TRANSACTION\",\n     \"identifier\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n     \"external_identifier\": \"your unique transaction identifier\"\n   },\n   {\n     \"type\": \"COUNTERPARTY\",\n     \"external_identifier\": \"your unique counterparty identifier\"\n   }\n ]\n}\n```\n### CASE_STAGE_UPDATED\n\nReceive an update whenever a case changes its stage, e.g. from \"Not Started\" to \"In Progress\".\n\nNote:\n - case_state is deprecated. Please use case_stage instead.\n - This webhook produces two responses v1 and v2 - please use v2 as it contains case_stage and also the customer external_identifier\n\nExample:\n```json\n{\n \"api_version\": \"v2\",\n \"webhook_type\": \"CASE_STAGE_UPDATED\",\n \"case_identifier\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"case_state\": \"CASE_STATE_POSITIVE_END_STATE\",\n \"case_type\": \"CUSTOMER_ONBOARDING\",\n \"customer\": {\n  \"identifier\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n  \"external_identifier\": \"your unique customer identifier\",\n  \"version\": 1\n },\n \"note\": {\n  \"contents\": \"note left at the time the case state was updated\"\n },\n \"case_stage\": {\n   \"identifier\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n   \"display_name\": \"False Positive\",\n   \"display_order\": 4,\n   \"stage_type\": \"DECISION\",\n   \"decision_type\": \"POSITIVE\"\n },\n \"subjects\": [\n   {\n     \"type\": \"CUSTOMER\",\n     \"identifier\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n     \"external_identifier\": \"your unique customer identifier\",\n     \"version\": \"1\"\n   },\n   {\n     \"type\": \"TRANSACTION\",\n     \"identifier\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n     \"external_identifier\": \"your unique transaction identifier\"\n   },\n   {\n     \"type\": \"COUNTERPARTY\",\n     \"external_identifier\": \"your unique counterparty identifier\"\n   }\n ]\n}\n\n```\n### CASE_ALERT_LIST_UPDATED\n\nReceive an update whenever the alert list associated with a case is updated, such as when new alerts are added to the case.\n\nExample:\n```json\n{\n \"api_version\": \"v2\",\n \"account_identifier\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n \"webhook_type\": \"CASE_ALERT_LIST_UPDATED\",\n \"case_identifier\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"customer\": {\n  \"identifier\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n  \"external_identifier\": \"your unique customer identifier\",\n  \"version\": 1\n },\n \"alert_identifiers\": [\n   \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n   \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"subjects\": [\n   {\n     \"type\": \"CUSTOMER\",\n     \"identifier\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n     \"external_identifier\": \"your unique customer identifier\",\n     \"version\": \"1\"\n   },\n   {\n     \"type\": \"TRANSACTION\",\n     \"identifier\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n     \"external_identifier\": \"your unique transaction identifier\"\n   },\n   {\n     \"type\": \"COUNTERPARTY\",\n     \"external_identifier\": \"your unique counterparty identifier\"\n   }\n ]\n}\n```\n### WORKFLOW_COMPLETED\n\nReceive an update when an onboarding workflow completes.\n\nExample:\n```json\n{\n  \"api_version\": \"v2\",\n  \"webhook_type\": \"WORKFLOW_COMPLETED\",\n  \"workflow_instance_identifier\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n  \"status\": \"COMPLETED\",\n  \"step_details\": {\n    \"alerting\": {\n      \"identifier\": null,\n      \"status\": \"COMPLETED\",\n      \"step_output\": {\n      \"alerts\": [\n          {\n            \"identifier\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n          }\n        ]\n      }\n    },\n    \"customer-creation\": {\n        \"identifier\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n        \"status\": \"COMPLETED\",\n        \"step_output\": {\n        \"customer_identifier\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n      }\n    },\n    \"customer-screening\": {\n      \"identifier\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n      \"status\": \"COMPLETED\",\n      \"step_output\": {\n        \"screening_result\": \"HAS_PROFILES\",\n        \"aml_types\": [\n          \"SANCTION\",\n          \"ADVERSE_MEDIA\",\n          \"ADVERSE_MEDIA_V2_CYBERCRIME\",\n          \"PEP_CLASS_1\",\n          \"PEP_CLASS_2\",\n          \"WARNING\"\n        ]\n      }\n    },\n    \"initial-risk-scoring\": {\n        \"identifier\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n        \"status\": \"COMPLETED\",\n        \"step_output\": {\n        \"overall_level\": \"LOW-RISK\",\n        \"overall_value\": 0\n      }\n    }\n  },\n  \"steps\": [\n    \"customer-creation\",\n    \"initial-risk-scoring\",\n    \"customer-screening\",\n    \"alerting\"\n  ],\n  \"workflow_type\": \"create-and-screen\"\n}\n```\n### TRANSACTION_REVIEWED\n\nReceive an update when an onboarding workflow completes.\n\nExample:\n```json\n{\n  \"api_version\": \"v3\",\n  \"account_identifier\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n  \"webhook_type\": \"TRANSACTION_REVIEWED\",\n  \"transaction_identifier\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n  \"transaction_external_identifier\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n  \"evaluation_outcome\": \"HOLD\",\n  \"review_decision\": \"RELEASE\"\n}\n```\n     \n\n\nYou need the \"Create and update webhooks\" permission to use this endpoint.","operationId":"notificationCreateWebhookConfiguration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ns_WebhookConfigurationPayload"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ns_WebhookConfigurationLog"}}},"description":"Webhook configuration created successfully"},"400":{"content":{"application/problem+json":{"examples":{"invalid url":{"description":"invalid url","value":{"identifier":"018dc10d-4ef6-794e-a21b-04de02024aa5","instance":"https://example/v2/webhooks","properties":{"errors":[{"field":"url","reasons":[],"rejected":"URL not properly formatted"}]},"status":400,"timestamp":"2024-02-19T11:08:11.382Z","title":"validation failed"}}},"schema":{"$ref":"#/components/schemas/ns_ProblemDetailErrorResponse"}}},"description":"Bad request. Request cannot be processed due to input webhook configuration payload error."}},"summary":"Create a new webhook configuration","tags":["Webhooks"]}},"/v2/notifications/configurations/webhook/test":{"post":{"description":"This is an optional test that will send an example payload to the URL you specify.\n\nTest webhook payload: \n\n```json \n{\n    \"message\": \"This is a test webhook from ComplyAdvantage\"\n}\n ```\n\n\nYou need the \"Create and update webhooks\" permission to use this endpoint.","operationId":"notificationTestWebhookConfiguration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ns_WebhookTestPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ns_TestWebhookResponse"}}},"description":"success"},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ns_ProblemDetailErrorResponse"}}},"description":"Bad request. Request cannot be processed due to input error."}},"summary":"Test a webhook","tags":["Webhooks"]}},"/v2/notifications/configurations/webhook/{identifier}":{"patch":{"description":"This endpoint will update the webhook configuration\n\n\nYou need the \"Create and update webhooks\" permission to use this endpoint.","operationId":"notificationPatchWebhookConfiguration","parameters":[{"description":"Identifier of the webhook notification configuration object","example":"95913b76-050c-40f3-9075-25f0737ac7d3","in":"path","name":"identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ns_UpdateWebhookPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ns_UpdatedWebhookConfigurationResponse"}}},"description":"Webhook configuration updated successfully"},"400":{"content":{"application/json":{"examples":{"Invalid URL format":{"description":"URL validation failed due to invalid format","value":{"detail":"There were validation errors with your request","errors":[{"field":"url","reasons":[{"key":"error.validation.ValidWebhookUrl","message":"Invalid webhook URL"}],"rejected":"invalid-url-format"}],"identifier":"018e1971-1c6f-761f-a510-43540727ff48","instance":"/v2/notifications/configurations/webhook/95913b76-050c-40f3-9075-25f0737ac7d3","status":400,"timestamp":"2024-03-07T15:03:47.055Z","title":"Validation Error","type":"about:blank"}},"Private IP address":{"description":"URL validation failed because it resolves to a private IP address","value":{"detail":"There were validation errors with your request","errors":[{"field":"url","reasons":[{"key":"error.validation.ValidWebhookUrl","message":"Invalid webhook URL"}],"rejected":"http://172.16.0.1/webhook"}],"identifier":"018e1971-1c6f-761f-a510-43540727ff48","instance":"/v2/notifications/configurations/webhook/95913b76-050c-40f3-9075-25f0737ac7d3","status":400,"timestamp":"2024-03-07T15:03:47.055Z","title":"Validation Error","type":"about:blank"}}},"schema":{"$ref":"#/components/schemas/ns_ProblemDetailErrorResponse"}}},"description":"Bad request. Validation errors with the request payload."},"403":{"content":{"application/json":{"example":{"detail":"You do not have the permissions needed to access the resource.","identifier":"018d3157-0ec8-73ba-a684-865e5e2ff1ed","instance":"/v2/notifications/configurations/webhook/95913b76-050c-40f3-9075-25f0737ac7d3","properties":{},"status":403,"timestamp":"2024-01-22T13:23:25.512Z","title":"Forbidden","type":"about:blank"},"schema":{"$ref":"#/components/schemas/ns_ProblemDetailErrorResponse"}}},"description":"Forbidden. User does not have the required permissions."},"404":{"content":{"application/problem+json":{"examples":{"Configuration not found":{"description":"The webhook configuration identifier does not exist for this account","value":{"detail":"Webhook configuration with the provided identifier=95913b76-050c-40f3-9075-25f0737ac7d3 does not exist","identifier":"018e1971-1c6f-761f-a510-43540727ff48","instance":"/v2/notifications/configurations/webhook/95913b76-050c-40f3-9075-25f0737ac7d3","properties":{},"status":404,"timestamp":"2024-03-07T15:03:47.055Z","title":"Configuration does not exist","type":"about:blank"}}},"schema":{"$ref":"#/components/schemas/ns_ProblemDetailErrorResponse"}}},"description":"Not Found. The webhook configuration with the specified identifier does not exist."}},"summary":"Update a webhook notification configuration.","tags":["Webhooks"]}},"/v2/payment-screening/configurations":{"get":{"description":"\nThis endpoint returns a list of all payment screening configurations with their metadata\n\nPayment screening configurations define which lists a transaction will be screened against and the fuzziness that should be applied to the search. You can create multiple configurations in your account. Each payment screening configuration can have multiple versions.\n        \n\n\nYou need \"Access to base payment screening functionality\" enabled to use this endpoint.","operationId":"paymentScreeningFetchConfigurationSummaries","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ps_ConfigurationSummariesResponse"}}},"description":"OK"}},"summary":"Get payment screening configurations","tags":["Payment Screening Configurations"]},"post":{"description":"\nThis endpoint allows you to create a new payment screening configuration.\n\nPayment screening configurations define which lists a transaction will be screened against and the settings to apply to the search. You can create multiple configurations in your account and each configuration can have multiple versions.\n\nWithin the configuration are one or more source collections. A source collection contains:\n\n* The sanctions lists you wish to screen against \n* A global fuzziness score (a spectrum with 0 as exact search, 100 as very broad search) \n* Name search options:\n    * Name fuzziness score that, if present, overrides the global fuzziness\n    * Search options\n* Reference text search options:\n    * Reference text fuzziness score that, if present, overrides the global fuzziness\n    * Search options\n* BIC search strictness    \n    \nIn addition, you can choose to omit your customer from the screening.\n        \n\n\nYou need \"Access to base payment screening functionality\" enabled to use this endpoint.","operationId":"paymentScreeningCreateConfiguration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ps_CreateConfigurationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ps_CreateConfigurationResponse"}}},"description":"Created"}},"summary":"Create payment screening configuration","tags":["Payment Screening Configurations"]}},"/v2/payment-screening/configurations/{configuration_identifier}":{"get":{"description":"\nThis endpoint provides full details of the latest version of the payment screening configuration specified by the configuration ID.\n\nPayment screening configurations define which lists a transaction will be screened against, and the fuzziness that should be applied to the search. You can create multiple of these in your account. Each payment screening configuration can have multiple versions.\n        \n\n\nYou need \"Access to base payment screening functionality\" enabled to use this endpoint.","operationId":"paymentScreeningFetchLatestConfiguration","parameters":[{"description":"configuration ID","example":"91b47e18-7b4b-46e7-8e9b-7311bedc1115","in":"path","name":"configuration_identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ps_ConfigurationDetail"}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ps_ProblemDetailErrorResponse"}}},"description":"Not found"}},"summary":"Retrieve latest payment screening configuration by id","tags":["Payment Screening Configurations"]},"put":{"description":"\nThis endpoint creates a new version of a payment screening configuration.\n\nSpecify the details of the new version, as you would when creating a new configuration. The new version will be created with an incremented version number.\n\nPayment screening configurations define which lists a transaction will be screened against and the settings to apply to the search. You can create multiple configurations in your account and each configuration can have multiple versions.\n\nWithin the configuration are one or more source collections. A source collection contains:\n\n* The sanctions lists you wish to screen against\n* A global fuzziness score (a spectrum with 0 as exact search, 100 as very broad search) \n* Name search options:\n    * Name fuzziness score that, if present, overrides the global fuzziness\n    * Search options\n* Reference text search options:\n    * Reference text fuzziness score that, if present, overrides the global fuzziness\n    * Search options\n* BIC search strictness\n\nIn addition, you can choose to omit your customer from the screening.\n        \n\n\nYou need \"Access to base payment screening functionality\" enabled to use this endpoint.","operationId":"paymentScreeningUpdateConfiguration","parameters":[{"description":"configuration ID","example":"91b47e18-7b4b-46e7-8e9b-7311bedc1115","in":"path","name":"configuration_identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ps_UpdateConfigurationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ps_UpdateConfigurationResponse"}}},"description":"Created"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ps_ProblemDetailErrorResponse"}}},"description":"Not found"}},"summary":"Create a new version of a configuration","tags":["Payment Screening Configurations"]}},"/v2/payment-screening/configurations/{configuration_identifier}/versions":{"get":{"description":"\nThis endpoint returns all versions of a screening configuration.\n\nPayment screening configurations define which lists a transaction will be screened against, and the fuzziness that should be applied to the search. You can create multiple of these in your account. Each payment screening configuration can have multiple versions.\n        \n\n\nYou need \"Access to base payment screening functionality\" enabled to use this endpoint.","operationId":"paymentScreeningFetchConfigurationVersions","parameters":[{"description":"configuration ID","example":"91b47e18-7b4b-46e7-8e9b-7311bedc1115","in":"path","name":"configuration_identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ps_ConfigurationVersions"}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ps_ProblemDetailErrorResponse"}}},"description":"Not found"}},"summary":"Get payment screening configuration versions","tags":["Payment Screening Configurations"]}},"/v2/payment-screening/configurations/{configuration_identifier}/versions/{version_identifier}":{"get":{"description":"\nThis endpoint returns a version of a payment screening configuration with its metadata.\n\nPayment screening configurations define which lists a transaction will be screened against, and the fuzziness that should be applied to the search. You can create multiple of these in your account. Each payment screening configuration can have multiple versions.\n        \n\n\nYou need \"Access to base payment screening functionality\" enabled to use this endpoint.","operationId":"paymentScreeningFetchConfigurationByVersion","parameters":[{"description":"configuration ID","example":"91b47e18-7b4b-46e7-8e9b-7311bedc1115","in":"path","name":"configuration_identifier","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"configuration version","example":4,"in":"path","name":"version_identifier","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ps_ConfigurationDetail"}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ps_ProblemDetailErrorResponse"}}},"description":"Not found"}},"summary":"Get a payment screening configuration version","tags":["Payment Screening Configurations"]}},"/v2/token":{"post":{"description":"Mesh is authenticated via OAuth2.  An initial request must be made to collect the token. This token can then be used to authenticate all requests for the following 24 hours, after which the token must be refreshed.\n\nThe username and password should be one of the users already created in your account. We recommend creating a dedicated API user for your integration.  The value `realm` is provided by ComplyAdvantage.\n\nThe access token returned by the initial request can then be used within the authorization header.\n\n```\n\"Authorization\":\"Bearer {access_token}\"\n```\n\nThe bearer token has a validity period of 24 hours (86,400 seconds), after which any authentication attempts will fail.  To refresh a token, use the same method as that used to generate it.","operationId":"createToken","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenCreateRequestBody"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/TokenCreateResponseData"}}},"description":"OK"},"400":{"content":{"*/*":{"schema":{"properties":{"error":{"type":"string"},"error_description":{"type":"string"}},"type":"object"}}},"description":"Bad Request"}},"security":[{}],"summary":"Create an access token","tags":["Authentication"]}},"/v2/users":{"post":{"description":"Creates a new user.\n\nTo enable the user to access an account, they must be assigned at least one role. A user will not be sent an email invite until assigned at least one role.\n\nFollow these steps to create and configure a user: \n\n1. **Create user:** Create the user by calling  `POST /users`.\n\n2. **Get role(s):** Use `GET /roles` to fetch the role_identifier(s) you wish to assign to the user.\n\n3. **(Optional) Get account**: If you need to assign roles for an account you're not currently logged into but within the same organization, retrieve the relevant `account_identifier` using `GET clients/me/accounts`.\n\n4. **Assign user role**: Use `POST /users/{user_identifier}/roles` to assign the user to an account with a list of `role_identifier(s)` and optionally the `account_identifier` if applicable.\n\n\nYou need the \"Create and update users\" permission to use this endpoint.","operationId":"identity_v2_users_createUser","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity_UserRequestBody"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity_AnyUserResponse"}}},"description":"CREATED"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity_ProblemDetailErrorResponse"}}},"description":"Invalid input"}},"summary":"Create a new user","tags":["Users"]}},"/v2/users/me":{"get":{"description":"Returns details about your user.","operationId":"identity_v2_users_me_getMyUser","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity_OwnUserResponse"}}},"description":"OK"}},"summary":"Get details about your user","tags":["Users"]},"patch":{"description":"Update details for your user.","operationId":"identity_v2_users_me_patchMyUser","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity_UsersMePartialUpdateRequestBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity_OwnUserResponse"}}},"description":"OK"}},"summary":"Update your user","tags":["Users"]}},"/v2/users/me/accounts":{"get":{"description":"Returns a list of accounts for your user.","operationId":"identity_v2_users_me_accounts_getMyAccounts","parameters":[{"description":"Filter accounts by name.","example":"Doe","in":"query","name":"name_contains","required":false,"schema":{"type":"string"}},{"description":"The page of results returned within the response.","example":1,"in":"query","name":"page_number","required":false,"schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"The amount of results returned within the response.","example":10,"in":"query","name":"page_size","required":false,"schema":{"default":10,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity_UserAccountRolesResponse"}}},"description":"OK"}},"summary":"Get accounts for your user","tags":["Users"]}},"/v2/users/me/permissions":{"get":{"description":"Returns your permissions.","operationId":"identity_v2_users_me_permissions_getMyPermissions","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity_PermissionListResponse"}}},"description":"OK"}},"summary":"Get permissions for your user","tags":["Users"]}},"/v2/users/roles/bulk":{"put":{"description":"Set the roles for a list of users in an account.\n\n\nYou need the \"Assign roles in account\" permission to use this endpoint.","operationId":"identity_v2_users_roles_bulk_bulkUpdateUserAccountRoles","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity_BulkAccountUserRolesRequestBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity_BulkAccountUserRolesResponse"}}},"description":"OK"}},"summary":"Bulk assign user roles","tags":["Users"]}},"/v2/users/{user_identifier}":{"get":{"description":"Returns details for a given user.","operationId":"identity_v2_users_user_identifier_getSpecificUser","parameters":[{"description":"The identifier of the user that you want to retrieve.","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"user_identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity_AnyUserResponse"}}},"description":"OK"}},"summary":"Get details about a user","tags":["Users"]},"patch":{"description":"Updates details for a given user.\n\n\nYou need the \"Create and update users\" permission to use this endpoint.","operationId":"identity_v2_users_user_identifier_partialUpdateUser","parameters":[{"description":"The identifier of the user that you want to update.","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"user_identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity_UserPartialUpdateRequestBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity_AnyUserResponse"}}},"description":"OK"}},"summary":"Update an existing user","tags":["Users"]}},"/v2/users/{user_identifier}/accounts":{"get":{"description":"Returns a list of accounts for a given user.\n\n\nYou need the \"View users\" permission to use this endpoint.","operationId":"identity_v2_users_user_identifier_accounts_getSpecificUsersAccounts","parameters":[{"description":"The identifier of the user whose accounts you'd like to retrieve.","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"user_identifier","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Filter user by name.","example":"Doe","in":"query","name":"name_contains","required":false,"schema":{"type":"string"}},{"description":"The identifier of the client whose accounts you'd like to retrieve.","example":"00000000-0000-0000-0000-000000000000","in":"query","name":"client_identifier","required":false,"schema":{"format":"uuid","type":"string"}},{"description":"The page of results returned within the response.","example":1,"in":"query","name":"page_number","required":false,"schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"The amount of results returned within the response.","example":10,"in":"query","name":"page_size","required":false,"schema":{"default":10,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity_ExtendedUserAccountRolesResponse"}}},"description":"OK"}},"summary":"Get accounts for a user","tags":["Users"]}},"/v2/users/{user_identifier}/roles":{"put":{"description":"Set the roles of a user in an account.\n\n\nYou need the \"Assign roles in account\" permission to use this endpoint.","operationId":"identity_v2_users_user_identifier_roles_updateUserAccountRoles","parameters":[{"description":"The identifier of the user who the roles will be assigned to.","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"user_identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity_AccountUserRolesRequestBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity_AccountUserRolesResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity_ProblemDetailErrorResponse"}}},"description":"Invalid input"}},"summary":"Assign user roles","tags":["Users"]}},"/v2/workflows/create-and-screen":{"post":{"description":"This endpoint initiates the 'create and screen' workflow for your customer in **asynchronous mode**. The workflow consists of five steps:\n1. **Customer Record Creation:** The Customer Record is created in Mesh.\n2. **Risk Scoring:** An initial Risk Score is calculated for the Customer.\n3. **Customer Screening:** The Customer is screened using settings based on the Calculated Risk Score.\n4. **Alerts:** Alerts associated with the screened customer are generated based on the risk analysis.\n5. **Case Creation:** Create cases based on the result of customer screening and alerts, for an analyst to review.\n\nEach customer must have a unique customer external identifier specified as part of the request. This identifier is used to find the customer within Mesh and link back to your own internal systems.\n\nThe customer can be one of: `PERSON`, `COMPANY` or `UNDEFINED` and can optionally have multiple `products`.\n\nFollowing risk scoring, the customer will be screened using ComplyAdvantage's AML database.  You can specify the screening profile used for initial screening and subsequent ongoing monitoring within the `configuration` object.  The value for `screening_profile_identifier` can be found in the settings section of the Mesh application.\n\nThe workflow will execute asynchronously. The initial POST returns a 'workflow-instance-identifier' and you can be notified of completion by:\n\n* either polling the GET `/workflows/` endpoint with the `workflow_identifier` returned when starting the workflow\n\n* or, setting up a `WORKFLOW_COMPLETED` webhook that will fire when your workflow completes.\n\n\n\nYou need \"Access to base customer screening functionality\" enabled and the \"Create and screen customers\" permission to use this endpoint.","operationId":"createCustomerAndScreenAsync","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ol_CreateAndScreenCustomerRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"Async workflow created":{"description":"Async workflow created, workflow instance identified returned.","value":{"workflow_instance_identifier":"018d30ec-9485-7146-9444-e52486fae1bb"}}},"schema":{"$ref":"#/components/schemas/ol_AsyncWorkflowResponse"}}},"description":"Workflow executed"},"400":{"content":{"application/json":{"examples":{"Validation error":{"description":"Validation error","value":{"detail":"Customer object is missing from request","identifier":"018e1971-1c6f-761f-a510-43540727ff48","instance":"https://example/v2/workflows/create-and-screen","properties":{"errors":[]},"status":400,"timestamp":"2024-03-07T15:03:47.055Z","title":"Invalid JSON Request","type":"about:blank"}}},"schema":{"$ref":"#/components/schemas/ol_ProblemDetailErrorResponse"}}},"description":"Bad request"}},"summary":"Create and Screen a Customer asynchronously","tags":["Onboarding"]}},"/v2/workflows/sync/create-and-screen":{"post":{"description":"This endpoint initiates the 'create and screen' workflow for your customer in **synchronous mode**. The workflow consists of five steps:\n1. **Customer Record Creation:** The Customer Record is created in Mesh.\n2. **Risk Scoring:** An initial Risk Score is calculated for the Customer.\n3. **Customer Screening:** The Customer is screened using settings based on the Calculated Risk Score.\n4. **Alerts:** Alerts associated with the screened customer are generated based on the risk analysis.\n5. **Case Creation:** Create cases based on the result of customer screening and alerts, for an analyst to review.\n\nEach customer must have a unique customer external identifier specified as part of the request. This identifier is used to find the customer within Mesh and link back to your own internal systems.\n\nThe customer can be one of: `PERSON`, `COMPANY` or `UNDEFINED` and can optionally have multiple `products`.\n\nFollowing risk scoring, the customer will be screened using ComplyAdvantage's AML database.  You can specify the screening profile used for initial screening and subsequent ongoing monitoring within the `configuration` object.  The value for `screening_profile_identifier` can be found in the settings section of the Mesh application.\n\nThe workflow executes synchronously up to customer screening, returning the workflow status. This end-point is currently idempotent: in case of downstream error you can re-send the exact same request, and the workflow will be retried.\n\n\n\nYou need \"Access to base customer screening functionality\" enabled and the \"Create and screen customers\" permission to use this endpoint.","operationId":"createCustomerAndScreenSync","parameters":[{"description":"Optional stage until which the sync workflow should continue before switching to async","example":"ALERTING","in":"query","name":"last_sync_step","required":false,"schema":{"default":"SCREENING","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ol_CreateAndScreenCustomerRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"WORKFLOW COMPLETED":{"description":"Once all step workflows are marked as COMPLETED then the workflow status will be marked as COMPLETED. If the screening result is returned as HAS_PROFILES then remediation is required on the ComplyAdvantage application. If the screening results return NO_PROFILES then no remediation is required.The full customer record can be retrieved by calling GET /v1/customer/ using the identifier from customer-creation step with step_details.","value":{"status":"COMPLETED","step_details":{"alerting":{"identifier":null,"status":"COMPLETED","step_output":{"alerts":[{"identifier":"018c3ff3-7d0c-7254-8096-e6d81fece3b7"}]}},"case-creation":{"identifier":"018cd4d3-2f7f-7351-9432-606a88d54adc","status":"COMPLETED","step_output":{"case_identifier":"018cd4d3-2f7f-7351-9432-606a88d54adc"}},"customer-creation":{"identifier":"018c3ff3-7275-7dc2-94a5-fe30315240b1","status":"COMPLETED","step_output":{"customer_identifier":"018c3ff3-746b-70de-9eb5-033634ec07eb","external_identifier":"abcd-1234"}},"customer-screening":{"identifier":"018c3ff3-7881-7860-9dfb-a9bd964d372d","status":"COMPLETED","step_output":{"aml_types":["SANCTION","ADVERSE_MEDIA","ADVERSE_MEDIA_V2_CYBERCRIME","PEP_CLASS_1","PEP_CLASS_2","WARNING"],"screening_result":"HAS_PROFILES"}},"initial-risk-scoring":{"identifier":"018c3ff3-74c5-7645-b0fd-a2e24754066f","status":"COMPLETED","step_output":{"overall_level":"LOW-RISK","overall_value":0}}},"steps":["customer-creation","initial-risk-scoring","customer-screening","alerting","case-creation"],"workflow_instance_identifier":"018c3ff3-7099-7090-a15b-8daee4cb81df","workflow_type":"create-and-screen"}},"WORKFLOW COMPLETED (NO PROFILES FOUND)":{"description":"Once all step workflows are marked as COMPLETED then the workflow status will be marked as COMPLETED. If the screening results return NO_PROFILES then no remediation is required. The full customer record can be retrieved by calling GET /v1/customer/ using the identifier from customer-creation step with step_details.","value":{"status":"COMPLETED","step_details":{"alerting":{"identifier":null,"status":"COMPLETED","step_output":{"alerts":[]}},"case-creation":{"identifier":null,"status":"SKIPPED","step_output":{}},"customer-creation":{"identifier":"019a1655-7740-73d9-95b9-ff5bdb8a2560","status":"COMPLETED","step_output":{"customer_identifier":"019a1655-79b2-718c-b762-8ba568d8e733","external_identifier":"f2ca0b1f-c0b6-480e-8ee6-dc5e61e03ed2"}},"customer-screening":{"identifier":"019a1655-7e6d-7bd7-91f1-dbe1801cd7d1","status":"COMPLETED","step_output":{"screening_result":"NO_PROFILES"}},"initial-risk-scoring":{"identifier":"019a1655-81aa-70c4-a04e-ef2d2e27a155","status":"COMPLETED","step_output":{"overall_level":"LOW-RISK","overall_value":0}}},"steps":["customer-creation","initial-risk-scoring","customer-screening","alerting","case-creation"],"workflow_instance_identifier":"019a1655-760f-74e6-a431-d49c9f913d15","workflow_type":"create-and-screen"}},"WORKFLOW COMPLETED(WITH SKIPPED STEPS)":{"description":"It is possible for the workflow to be marked as COMPLETED when initial-risk-scoring returns a PROHIBITED status and customer-screening as SKIPPED depending on the search configuration that has been set. In this scenario there will be no further updates to the risk score after this step.","value":{"status":"COMPLETED","step_details":{"alerting":{"identifier":null,"status":"COMPLETED","step_output":{"alerts":[{"identifier":"018c3ff3-7d0c-7254-8096-e6d81fece3b7"}]}},"case-creation":{"identifier":"018cd4d3-2f7f-7351-9432-606a88d54adc","status":"COMPLETED","step_output":{"case_identifier":"018cd4d3-2f7f-7351-9432-606a88d54adc"}},"customer-creation":{"identifier":"018c3ff3-7275-7dc2-94a5-fe30315240b1","status":"SKIPPED"},"customer-screening":{"identifier":"018c3ff3-7881-7860-9dfb-a9bd964d372d","status":"COMPLETED","step_output":{"aml_types":["SANCTION","ADVERSE_MEDIA","ADVERSE_MEDIA_V2_CYBERCRIME","PEP_CLASS_1","PEP_CLASS_2","WARNING"],"screening_result":"HAS_PROFILES"}},"initial-risk-scoring":{"identifier":"018c3ff3-74c5-7645-b0fd-a2e24754066f","status":"COMPLETED"}},"steps":["customer-creation","initial-risk-scoring","customer-screening","alerting","case-creation"],"workflow_instance_identifier":"018c3ff3-7099-7090-a15b-8daee4cb81df","workflow_type":"create-and-screen"}},"WORKFLOW ERRORED":{"description":"If any of the step workflows returns an ERRORED state then it will be required to contact support to resolve the issue.","value":{"status":"ERRORED","step_details":{"alerting":{"identifier":null,"status":"SKIPPED","step_output":{}},"case-creation":{"identifier":null,"status":"SKIPPED","step_output":{}},"customer-creation":{"error_message":"external identifier 018c3ff4-7979-7f95-98be-886116e3315c in use and belongs to the customer identifier 018c4013-fc8e-7db1-a30e-590fb36c4870","identifier":"018c4014-1de6-7d9d-ae92-eeacf245a259","status":"ERRORED","step_output":{"customer_identifier":"018c4013-fc8e-7db1-a30e-590fb36c4870","external_identifier":"abcd-1234"}},"customer-screening":{"identifier":null,"status":"SKIPPED","step_output":{}},"initial-risk-scoring":{"identifier":null,"status":"SKIPPED","step_output":{}}},"steps":["customer-creation","initial-risk-scoring","customer-screening","alerting","case-creation"],"workflow_instance_identifier":"018c4014-1c51-7b7d-a97c-044b5b624916","workflow_type":"create-and-screen"}},"WORKFLOW IN PROGRESS":{"description":"If any step workflow is still IN PROGRESS then the following response will be provided. Further checks will be required to receive the latest status.","value":{"status":"IN-PROGRESS","step_details":{"alerting":{"identifier":null,"status":"NOT-STARTED","step_output":{}},"case-creation":{"identifier":null,"status":"NOT-STARTED","step_output":{}},"customer-creation":{"identifier":"018c3ff4-7ad2-7bd3-bd5e-c31abc2f691c","status":"COMPLETED","step_output":{"customer_identifier":"018c3ff4-7cc3-7aa5-b256-1387eb0f0e2b","external_identifier":"abcd-1234"}},"customer-screening":{"identifier":null,"status":"NOT-STARTED","step_output":{}},"initial-risk-scoring":{"identifier":"018c3ff4-7d34-7017-a2fb-d39975d453fd","status":"IN-PROGRESS","step_output":{}}},"steps":["customer-creation","initial-risk-scoring","customer-screening","alerting","case-creation"],"workflow_instance_identifier":"018c3ff4-7979-7f95-98be-886116e3315c","workflow_type":"create-and-screen"}}},"schema":{"$ref":"#/components/schemas/ol_WorkflowState"}}},"description":"Sync workflow executed"},"400":{"content":{"application/json":{"examples":{"Invalid workflow_type":{"description":"Invalid workflow_type","value":{"identifier":"018c3ff3-7099-7090-a15b-8daee4cb81df","status":400,"timestamp":"2023-12-11T09:30:03.975Z","title":"Invalid workflow_type: Invalid"}},"Validation error":{"description":"Validation error","value":{"identifier":"018c3ff3-7099-7090-a15b-8daee4cb81df","status":400,"timestamp":"2023-12-11T09:30:03.975Z","title":"Validation error"}}},"schema":{"$ref":"#/components/schemas/ol_ProblemDetailErrorResponse"}}},"description":"Bad request"},"409":{"content":{"application/json":{"examples":{"Conflict error":{"description":"Conflict error","value":{"detail":"A workflow with id 018d3157-0ec8-73ba-a684-865e5e2ff1ed already exists for this customer.","identifier":"018e1971-1c6f-761f-a510-43540727ff48","instance":"https://example/v2/workflows/sync/create-and-screen","properties":{},"status":409,"timestamp":"2024-01-22T13:23:25.512Z","title":"Conflict","type":"about:blank"}}},"schema":{"$ref":"#/components/schemas/ol_ProblemDetailErrorResponse"}}},"description":"Conflict"}},"summary":"Create and Screen a Customer synchronously","tags":["Onboarding"]}},"/v2/workflows/{workflow_instance_identifier}":{"get":{"description":"## Overall workflow status\n\nThis endpoint will return the status and eventual end result of the specified workflow.  Once a workflow has been initiated, it can be periodically polled to receive the status using the workflow-instance-identifier provided in the response of the POST `v2/workflows/create-and-screen`  \n\nThe response comprises the status of the overall workflow.  One of\n- `NOT-STARTED` - The workflow is queued but has not yet begun\n- `IN-PROGRESS` - The workflow is executing but not yet completed.  The step details should be checked to ascertain progress\n- `COMPLETED` - The workflow has completed execution without errors.  The step details should be checked to ascertain the end results\n- `ERRORED` - The workflow has completed with errors.\n\nIn addition to the status, the workflow endpoint returns:\n\n- `steps` - an array of the step keys within the workflow\n- `step_details` - an object containing the status and return values for each of steps within the workflow (see following section)\n\n## Workflow steps\n\nThe workflow response contains a `step_details` object, which contains the status and returned values from each step in the workflow. Each step object within the step_details contains a status field that can be one of the following values:\n\n- `NOT-STARTED` - The step has not yet been executed\n- `IN-PROGRESS` - The step is executing\n- `COMPLETED` - The step has completed and the step_output object can be checked for output\n- `SKIPPED` - The step has been skipped because it did not meet the criteria for execution.  In the case of the “create and screen\" workflow, this applies to the screening step when the customer risk is prohibited\n- `ERRORED` - The step has completed but returned errors\n\nIn addition to the status, the step detail contains:\n\n- `identifier` - a unique identifier for the step\n- `step_output` - an object containing the return values for the step\n","operationId":"getWorkflowState","parameters":[{"example":"95913b76-050c-40f3-9075-25f0737ac7d3","in":"path","name":"workflow_instance_identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"WORKFLOW COMPLETED":{"description":"Once all step workflows are marked as COMPLETED then the workflow status will be marked as COMPLETED. If the screening result is returned as HAS_PROFILES then remediation is required on the ComplyAdvantage application. If the screening results return NO_PROFILES then no remediation is required. The full customer record can be retrieved by calling GET /v1/customer/ using the identifier from customer-creation step with step_details.","value":{"status":"COMPLETED","step_details":{"alerting":{"identifier":null,"status":"COMPLETED","step_output":{"alerts":[{"identifier":"018c3ff3-7d0c-7254-8096-e6d81fece3b7"}]}},"case-creation":{"identifier":"018cd4d3-2f7f-7351-9432-606a88d54adc","status":"COMPLETED","step_output":{"case_identifier":"018cd4d3-2f7f-7351-9432-606a88d54adc"}},"customer-creation":{"identifier":"018c3ff3-7275-7dc2-94a5-fe30315240b1","status":"COMPLETED","step_output":{"customer_identifier":"018c3ff3-746b-70de-9eb5-033634ec07eb","external_identifier":"abcd-1234"}},"customer-screening":{"identifier":"018c3ff3-7881-7860-9dfb-a9bd964d372d","status":"COMPLETED","step_output":{"aml_types":["SANCTION","ADVERSE_MEDIA","ADVERSE_MEDIA_V2_CYBERCRIME","PEP_CLASS_1","PEP_CLASS_2","WARNING"],"screening_result":"HAS_PROFILES"}},"initial-risk-scoring":{"identifier":"018c3ff3-74c5-7645-b0fd-a2e24754066f","status":"COMPLETED","step_output":{"overall_level":"LOW-RISK","overall_value":0}}},"steps":["customer-creation","initial-risk-scoring","customer-screening","alerting","case-creation"],"workflow_instance_identifier":"018c3ff3-7099-7090-a15b-8daee4cb81df","workflow_type":"create-and-screen"}},"WORKFLOW COMPLETED(WITH SKIPPED STEPS)":{"description":"It is possible for the workflow to be marked as COMPLETED when initial-risk-scoring returns a PROHIBITED status and customer-screening as SKIPPED depending on the search configuration that has been set. In this scenario there will be no further updates to the risk score after this step.","value":{"status":"COMPLETED","step_details":{"alerting":{"identifier":null,"status":"COMPLETED","step_output":{"alerts":[{"identifier":"018c3ff3-7d0c-7254-8096-e6d81fece3b7"}]}},"case-creation":{"identifier":"018cd4d3-2f7f-7351-9432-606a88d54adc","status":"COMPLETED","step_output":{"case_identifier":"018cd4d3-2f7f-7351-9432-606a88d54adc"}},"customer-creation":{"identifier":"018c3ff3-7275-7dc2-94a5-fe30315240b1","status":"SKIPPED"},"customer-screening":{"identifier":"018c3ff3-7881-7860-9dfb-a9bd964d372d","status":"COMPLETED","step_output":{"aml_types":["SANCTION","ADVERSE_MEDIA","ADVERSE_MEDIA_V2_CYBERCRIME","PEP_CLASS_1","PEP_CLASS_2","WARNING"],"screening_result":"HAS_PROFILES"}},"initial-risk-scoring":{"identifier":"018c3ff3-74c5-7645-b0fd-a2e24754066f","status":"COMPLETED"}},"steps":["customer-creation","initial-risk-scoring","customer-screening","alerting","case-creation"],"workflow_instance_identifier":"018c3ff3-7099-7090-a15b-8daee4cb81df","workflow_type":"create-and-screen"}},"WORKFLOW ERRORED":{"description":"If any of the step workflows returns an ERRORED state then it will be required to contact support to resolve the issue.","value":{"status":"ERRORED","step_details":{"alerting":{"identifier":null,"status":"SKIPPED","step_output":{}},"case-creation":{"identifier":null,"status":"SKIPPED","step_output":{}},"customer-creation":{"error_message":"external identifier 018c3ff4-7979-7f95-98be-886116e3315c in use and belongs to the customer identifier 018c4013-fc8e-7db1-a30e-590fb36c4870","identifier":"018c4014-1de6-7d9d-ae92-eeacf245a259","status":"ERRORED","step_output":{"customer_identifier":"018c4013-fc8e-7db1-a30e-590fb36c4870","external_identifier":"abcd-1234"}},"customer-screening":{"identifier":null,"status":"SKIPPED","step_output":{}},"initial-risk-scoring":{"identifier":null,"status":"SKIPPED","step_output":{}}},"steps":["customer-creation","initial-risk-scoring","customer-screening","alerting","case-creation"],"workflow_instance_identifier":"018c4014-1c51-7b7d-a97c-044b5b624916","workflow_type":"create-and-screen"}},"WORKFLOW IN PROGRESS":{"description":"If any step workflow is still IN PROGRESS then the following response will be provided. Further checks will be required to receive the latest status.","value":{"status":"IN-PROGRESS","step_details":{"alerting":{"identifier":null,"status":"NOT-STARTED","step_output":{}},"case-creation":{"identifier":null,"status":"NOT-STARTED","step_output":{}},"customer-creation":{"identifier":"018c3ff4-7ad2-7bd3-bd5e-c31abc2f691c","status":"COMPLETED","step_output":{"customer_identifier":"018c3ff4-7cc3-7aa5-b256-1387eb0f0e2b","external_identifier":"abcd-1234"}},"customer-screening":{"identifier":null,"status":"NOT-STARTED","step_output":{}},"initial-risk-scoring":{"identifier":"018c3ff4-7d34-7017-a2fb-d39975d453fd","status":"IN-PROGRESS","step_output":{}}},"steps":["customer-creation","initial-risk-scoring","customer-screening","alerting","case-creation"],"workflow_instance_identifier":"018c3ff4-7979-7f95-98be-886116e3315c","workflow_type":"create-and-screen"}}},"schema":{"$ref":"#/components/schemas/ol_WorkflowState"}}},"description":"Workflow state"},"404":{"content":{"application/json":{"examples":{"Not Found":{"description":"Not Found","value":{"identifier":"018c3ff3-7099-7090-a15b-8daee4cb81df","status":404,"timestamp":"2023-12-11T09:30:03.975Z","title":"Not found"}}},"schema":{"$ref":"#/components/schemas/ol_ProblemDetailErrorResponse"}}},"description":"Not found"}},"summary":"Get status and result of onboarding","tags":["Onboarding"]}},"/v3/enrichment/lookup-lists":{"get":{"description":"Lists all Lookup Lists for an account, returning the latest version of each.\n\n\nYou need the \"View lookup lists\" permission to use this endpoint.","operationId":"meshEnrichmentServiceListLookupLists","parameters":[{"description":"Sorting criteria. Allowed fields: `name`, `status`, `updated_at`, `updated_by`, `created_at`, `created_by`. Each criterion should be a string in the format: `property_name` for ascending order, or `-property_name` for descending order. For example, to sort by name descending: `-name`. Multiple sort criteria are supported. Provide each as a separate 'sort' query parameter (e.g., `?sort=-name&sort=status`).","example":["-timestamp"],"in":"query","name":"sort","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"description":"One-based page index (1..N)","example":1,"in":"query","name":"page_number","required":false,"schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"The size of the page to be returned","example":20,"in":"query","name":"page_size","required":false,"schema":{"default":50,"minimum":1,"type":"integer"}},{"description":"Search term to filter lookup lists by name","example":"example_list","in":"query","name":"search","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mes_PaginatedResponseLookupListNoSchemaResponse"}}},"description":"Lookup Lists found"}},"summary":"List Lookup Lists for an account","tags":["Enrichment"]},"post":{"description":"Creates a new Lookup List with a schema.\n\n\nYou need the \"Create and update lookup lists\" permission to use this endpoint.","operationId":"meshEnrichmentServiceCreateLookupList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mes_LookupListCreateRequestBody"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mes_LookupListsResponse"}}},"description":"Lookup List created"},"400":{"content":{"application/problem+json":{"examples":{"Blank lookup list name":{"description":"Blank lookup list name","value":{"detail":"Validation failed for object='lookupListCreateRequestBody'. Error count: 1","errors":{"name":"Name cannot be blank"},"identifier":"019a6ffb-f7f1-7025-8ad7-f65076ccdbe5","instance":"https://api.example.com/v3/lookup-lists","status":400,"timestamp":"2025-11-27T13:00:00.000Z","title":"Validation Error","type":"about:blank"}},"Blank schema field name":{"description":"Blank schema field name","value":{"detail":"Validation failed for object='lookupListCreateRequestBody'. Error count: 1","errors":{"inputSchema[0].name":"Schema name cannot be blank"},"identifier":"019a6ffb-f7f1-7025-8ad7-f65076ccdbe6","instance":"https://api.example.com/v3/lookup-lists","status":400,"timestamp":"2025-11-27T13:00:00.000Z","title":"Validation Error","type":"about:blank"}},"Invalid number of input schemas":{"description":"Invalid number of input schemas","value":{"detail":"Validation failed for object='lookupListCreateRequestBody'. Error count: 1","errors":{"inputSchema":"Exactly one input schema is required"},"identifier":"019a6ffb-f7f1-7025-8ad7-f65076ccdbe3","instance":"https://api.example.com/v3/lookup-lists","status":400,"timestamp":"2025-11-27T13:00:00.000Z","title":"Validation Error","type":"about:blank"}},"Invalid number of output schemas":{"description":"Invalid number of output schemas","value":{"detail":"Validation failed for object='lookupListCreateRequestBody'. Error count: 1","errors":{"outputSchema":"Exactly one output schema is required"},"identifier":"019a6ffb-f7f1-7025-8ad7-f65076ccdbe4","instance":"https://api.example.com/v3/lookup-lists","status":400,"timestamp":"2025-11-27T13:00:00.000Z","title":"Validation Error","type":"about:blank"}},"Invalid schema type":{"description":"Invalid schema type","value":{"detail":"JSON parse error: Cannot deserialize value of type com.complyadvantage.meshenrichmentservice.lookuplist.models.requests.SchemaType from String \"invalid_type\": not one of the values accepted for Enum class: [STRING, NUMBER, DECIMAL]","identifier":"019a6ffb-f7f1-7025-8ad7-f65076ccdbe7","instance":"https://api.example.com/v3/lookup-lists","status":400,"timestamp":"2025-11-27T13:00:00.000Z","title":"Bad Request","type":"about:blank"}},"Multiple validation errors":{"description":"Multiple validation errors","value":{"detail":"Validation failed for object='lookupListCreateRequestBody'. Error count: 3","errors":{"inputSchema":"Exactly one input schema is required","name":"Name cannot be blank","outputSchema":"Exactly one output schema is required"},"identifier":"019a6ffb-f7f1-7025-8ad7-f65076ccdbe8","instance":"https://api.example.com/v3/lookup-lists","status":400,"timestamp":"2025-11-27T13:00:00.000Z","title":"Validation Error","type":"about:blank"}}},"schema":{"$ref":"#/components/schemas/mes_ProblemDetailErrorResponse"}}},"description":"Bad Request - Validation errors"}},"summary":"Create a new Lookup List","tags":["Enrichment"]}},"/v3/enrichment/lookup-lists/{identifier}":{"get":{"description":"Gets the latest version of a Lookup List by identifier.\n\n\nYou need the \"View lookup lists\" permission to use this endpoint.","operationId":"meshEnrichmentServiceGetLookupList","parameters":[{"description":"The identifier of the lookup list that you want to retrieve.","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mes_LookupListsResponse"}}},"description":"Lookup List found"}},"summary":"Get a Lookup List by identifier","tags":["Enrichment"]},"patch":{"description":"Updates a Lookup List name.\n\n\nYou need the \"Create and update lookup lists\" permission to use this endpoint.","operationId":"meshEnrichmentServiceUpdateLookupList","parameters":[{"description":"The identifier of the lookup list that you want to update.","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mes_LookupListUpdateRequestBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mes_LookupListsResponse"}}},"description":"Lookup List updated"}},"summary":"Update lookup list name","tags":["Enrichment"]}},"/v3/enrichment/lookup-lists/{identifier}/draft":{"delete":{"description":"Deletes the latest version of a Lookup List if its status is draft.\n\n\nYou need the \"Create and update lookup lists\" permission to use this endpoint.","operationId":"meshEnrichmentServiceDeleteLookupListVersion","parameters":[{"description":"The identifier of the lookup list that you want to delete a DRAFT version.","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"204":{"description":"Lookup List draft version deleted"}},"summary":"Delete a lookup list draft version by identifier","tags":["Enrichment"]}},"/v3/enrichment/lookup-lists/{identifier}/promote-draft":{"post":{"description":"Promotes a version that is in DRAFT, changing it to ACTIVE.\n\n\nYou need the \"Create and update lookup lists\" permission to use this endpoint.","operationId":"meshEnrichmentServicePostPromoteDraft","parameters":[{"description":"The identifier of the lookup list that you want to promote the version.","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mes_LookupListsResponse"}}},"description":"Version promoted"}},"summary":"Promote a DRAFT version to ACTIVE","tags":["Enrichment"]}},"/v3/enrichment/lookup-lists/{identifier}/versions":{"get":{"description":"Returns all versions of a Lookup List in an account, sorted by created date.\n\n\nYou need the \"View lookup lists\" permission to use this endpoint.","operationId":"meshEnrichmentServiceListLookupListVersions","parameters":[{"description":"The identifier of the lookup list that you want to retrieve versions.","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"identifier","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"One-based page index (1..N)","example":1,"in":"query","name":"page_number","required":false,"schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"The size of the page to be returned","example":20,"in":"query","name":"page_size","required":false,"schema":{"default":50,"minimum":1,"type":"integer"}},{"description":"Sorting criteria in the format of: `[-]property` (`-` descending modifier).\n\n* Default sort order is ascending (without `-`).\n\n* Multiple sort criteria are supported.","example":["-timestamp"],"in":"query","name":"sort","required":false,"schema":{"default":[],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mes_PaginatedResponseLookupListVersionResponse"}}},"description":"Lookup List versions found"}},"summary":"List all versions for a Lookup List","tags":["Enrichment"]},"post":{"description":"Creates a new Lookup List version.\n\n\nYou need the \"Create and update lookup lists\" permission to use this endpoint.","operationId":"meshEnrichmentServiceCreateLookupListVersion","parameters":[{"description":"The identifier of the lookup list that you want to create a new version.","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mes_LookupListVersionResponse"}}},"description":"Lookup List version created"}},"summary":"Creates a new lookup list version","tags":["Enrichment"]}},"/v3/enrichment/lookup-lists/{identifier}/versions/{version_identifier}/download":{"get":{"description":"Returns a CSV file containing all items from a lookup list version.\n\n\nYou need the \"View lookup lists\" permission to use this endpoint.","operationId":"meshEnrichmentServiceListLookupListVersionItemsDownload","parameters":[{"description":"The identifier of the lookup list that you want to retrieve items.","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"identifier","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The version number of the lookup list that you want to retrieve items.","example":1,"in":"path","name":"version_identifier","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"text/csv":{"schema":{"type":"string"}}},"description":"Lookup List Items found"}},"summary":"Download a CSV file containing all items for a Lookup List Version","tags":["Enrichment"]}},"/v3/enrichment/lookup-lists/{identifier}/versions/{version_identifier}/items":{"get":{"description":"Returns all items from a Lookup List version.\n\n\nYou need the \"View lookup lists\" permission to use this endpoint.","operationId":"meshEnrichmentServiceListLookupListVersionItems","parameters":[{"description":"The identifier of the lookup list that you want to retrieve items.","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"identifier","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The version number of the lookup list that you want to retrieve items.","example":1,"in":"path","name":"version_identifier","required":true,"schema":{"format":"int32","type":"integer"}},{"description":"One-based page index (1..N)","example":1,"in":"query","name":"page_number","required":false,"schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"The size of the page to be returned","example":20,"in":"query","name":"page_size","required":false,"schema":{"default":50,"minimum":1,"type":"integer"}},{"description":"Sorting criteria in the format of: `[-]property` (`-` descending modifier).\n\n* Default sort order is ascending (without `-`).\n\n* Multiple sort criteria are supported.","example":["-timestamp"],"in":"query","name":"sort","required":false,"schema":{"default":[],"items":{"type":"string"},"type":"array"}},{"description":"Search term to filter items","example":"example_item","in":"query","name":"search","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mes_PaginatedResponseLookupListItemResponse"}}},"description":"Lookup List Items found"}},"summary":"List all items for a Lookup List Version","tags":["Enrichment"]}},"/v3/enrichment/transaction/lookup-list-mappings":{"get":{"description":"Returns all Lookup List Mappings for the account, optionally filtered by status and/or lookup list identifier, sorted by created date.\n\n\nYou need the \"View lookup lists\" permission to use this endpoint.","operationId":"meshEnrichmentServiceListLookupListMappings","parameters":[{"description":"Optional filter by the status property, to only get ACTIVE or INACTIVE","example":"ACTIVE","in":"query","name":"status","required":false,"schema":{"type":"string"}},{"description":"Optional filter by lookup list identifier. If provided, only returns mappings associated with this lookup list.","example":"00000000-0000-0000-0000-000000000000","in":"query","name":"lookup_list_identifier","required":false,"schema":{"type":"string"}},{"description":"One-based page index (1..N)","example":1,"in":"query","name":"page_number","required":false,"schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"The size of the page to be returned","example":20,"in":"query","name":"page_size","required":false,"schema":{"default":50,"minimum":1,"type":"integer"}},{"description":"Sorting criteria in the format of: `[-]property` (`-` descending modifier).\n\n* Default sort order is ascending (without `-`).\n\n* Multiple sort criteria are supported.","example":["-timestamp"],"in":"query","name":"sort","required":false,"schema":{"default":[],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mes_PaginatedResponseLookupListMappingResponse"}}},"description":"Lookup List Mappings found"},"400":{"content":{"application/problem+json":{"examples":{"Invalid UUID format":{"description":"Invalid UUID format","value":{"detail":"Invalid UUID format for lookup_list_identifier parameter","identifier":"019a6ffb-f7f1-7025-8ad7-f65076ccdbe3","instance":"https://api.example.com/v3/enrichment/transaction/lookup-list-mappings","status":400,"timestamp":"2025-11-10T22:56:15.345Z","title":"Invalid Request Parameter","type":"about:blank"}}},"schema":{"$ref":"#/components/schemas/mes_ProblemDetailErrorResponse"}}},"description":"Bad Request - Invalid status or lookup_list_identifier parameter"}},"summary":"List all Lookup List Mappings","tags":["Enrichment"]},"post":{"description":"Create a new Lookup List Mapping record associated with a specific Lookup List.\n\n\nYou need the \"View lookup lists\" and \"Create and update lookup lists\" permissions to use this endpoint.","operationId":"meshEnrichmentServiceCreateLookupListMapping","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mes_LookupListMappingCreateRequestBody"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mes_LookupListMappingResponse"}}},"description":"Lookup List Mapping created"},"400":{"content":{"application/problem+json":{"examples":{"Invalid number of output fields":{"description":"Invalid number of output fields","value":{"detail":"Output fields array must contain exactly 1 element","identifier":"019a6ffb-f7f1-7025-8ad7-f65076ccdbe6","instance":"https://api.example.com/v3/enrichment/transaction/lookup-list-mappings","status":400,"timestamp":"2025-11-10T22:56:15.345Z","title":"MIN_1_AND_MAX_1_OUTPUT_FIELDS","type":"about:blank"}},"Invalid number of source fields":{"description":"Invalid number of source fields","value":{"detail":"Source fields array must contain exactly 1 element","identifier":"019a6ffb-f7f1-7025-8ad7-f65076ccdbe5","instance":"https://api.example.com/v3/enrichment/transaction/lookup-list-mappings","status":400,"timestamp":"2025-11-10T22:56:15.345Z","title":"MIN_1_AND_MAX_1_SOURCE_FIELDS","type":"about:blank"}},"Invalid source field":{"description":"Invalid source field","value":{"detail":"Source field key is not a valid block ID or transaction path","identifier":"019a6ffb-f7f1-7025-8ad7-f65076ccdbe4","instance":"https://api.example.com/v3/enrichment/transaction/lookup-list-mappings","status":400,"timestamp":"2025-11-10T22:56:15.345Z","title":"SOURCE_FIELD_DOESNT_BELONG_TO_AVAILABLE_SOURCE_FIELDS","type":"about:blank"}},"Invalid transaction_output_field_key format":{"description":"Invalid transaction_output_field_key format","value":{"detail":"Output field key has invalid format","identifier":"019a6ffb-f7f1-7025-8ad7-f65076ccdbe3","instance":"https://api.example.com/v3/enrichment/transaction/lookup-list-mappings","status":400,"timestamp":"2025-11-10T22:56:15.345Z","title":"TRANSACTION_OUTPUT_FIELD_KEY_INVALID_FORMAT","type":"about:blank"}},"Lookup list identifier not found":{"description":"Lookup list identifier not found","value":{"detail":"A lookup list with the identifier could not be found.","identifier":"019a6ffb-f7f1-7025-8ad7-f65076ccdbe7","instance":"https://api.example.com/v3/enrichment/transaction/lookup-list-mappings","status":400,"timestamp":"2025-11-10T22:56:15.345Z","title":"LOOKUP_LIST_IDENTIFIER_MUST_EXIST","type":"about:blank"}},"Output field schema mismatch":{"description":"Output field schema mismatch","value":{"detail":"Output field does not match output schema","identifier":"019a6ffb-f7f1-7025-8ad7-f65076ccdbe9","instance":"https://api.example.com/v3/enrichment/transaction/lookup-list-mappings","status":400,"timestamp":"2025-11-10T22:56:15.345Z","title":"OUTPUT_FIELD_LOOKUP_LIST_COLUMN_NAME_MUST_MATCH_OUTPUT_FROM_SCHEMA","type":"about:blank"}},"Source field schema mismatch":{"description":"Source field schema mismatch","value":{"detail":"Source field does not match input schema","identifier":"019a6ffb-f7f1-7025-8ad7-f65076ccdbe8","instance":"https://api.example.com/v3/enrichment/transaction/lookup-list-mappings","status":400,"timestamp":"2025-11-10T22:56:15.345Z","title":"SOURCE_FIELD_LOOKUP_LIST_COLUMN_NAME_MUST_MATCH_INPUT_FROM_SCHEMA","type":"about:blank"}},"Source field type mismatch":{"description":"Source field type mismatch","value":{"detail":"Source field type does not match the schema type","identifier":"019a6ffb-f7f1-7025-8ad7-f65076ccdbe0","instance":"https://api.example.com/v3/enrichment/transaction/lookup-list-mappings","status":400,"timestamp":"2025-11-10T22:56:15.345Z","title":"EXISTING_SOURCE_FIELD_MUST_MATCH_SCHEMA_TYPE","type":"about:blank"}}},"schema":{"$ref":"#/components/schemas/mes_ProblemDetailErrorResponse"}}},"description":"Bad Request - Validation errors"},"409":{"content":{"application/problem+json":{"examples":{"Maximum mappings reached":{"description":"Maximum mappings reached","value":{"detail":"Maximum number of mappings (20) reached for this account","identifier":"019a6ffb-f7f1-7025-8ad7-f65076ccdbf2","instance":"https://api.example.com/v3/enrichment/transaction/lookup-list-mappings","status":409,"timestamp":"2025-11-10T22:56:15.345Z","title":"MAXIMUM_NUMBER_OF_MAPPINGS_REACHED","type":"about:blank"}},"Output field already in use":{"description":"Output field already in use","value":{"detail":"Output field is already in use by another mapping for this account","identifier":"019a6ffb-f7f1-7025-8ad7-f65076ccdbf1","instance":"https://api.example.com/v3/enrichment/transaction/lookup-list-mappings","status":409,"timestamp":"2025-11-10T22:56:15.345Z","title":"OUTPUT_FIELD_LOOKUP_ALREADY_IN_USE","type":"about:blank"}}},"schema":{"$ref":"#/components/schemas/mes_ProblemDetailErrorResponse"}}},"description":"Conflict - Resource already exists or limit reached"}},"summary":"Create a new Lookup List Mapping","tags":["Enrichment"]}},"/v3/enrichment/transaction/lookup-list-mappings/available-source-fields":{"get":{"description":"Lists all available Source Fields for Lookup List Mappings, allowing filtering by type. Deliberately not paginated.\n\n\nYou need the \"View lookup lists\" permission to use this endpoint.","operationId":"meshEnrichmentServiceListAllAvailableSourceFields","parameters":[{"description":"Type of available source fields to filter by","example":"string","in":"query","name":"type","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mes_AvailableSourceFieldsResponse"}}},"description":"Available Source Fields for Lookup List Mappings found."},"400":{"content":{"application/problem+json":{"examples":{"Invalid type parameter":{"description":"Invalid type parameter","value":{"detail":"Unexpected value type has been provided as request parameter","identifier":"019a6ffb-f7f1-7025-8ad7-f65076ccdbe3","instance":"https://api.example.com/v3/enrichment/transaction/lookup-list-mappings/available-source-fields","status":400,"timestamp":"2025-11-10T22:56:15.345Z","title":"Invalid Request Parameter","type":"about:blank"}}},"schema":{"$ref":"#/components/schemas/mes_ProblemDetailErrorResponse"}}},"description":"Bad Request - Invalid type parameter"}},"summary":"Lists all available Source Fields for Lookup List Mappings","tags":["Enrichment"]}},"/v3/enrichment/transaction/lookup-list-mappings/{identifier}":{"delete":{"description":"This deletion will maintain the lookup list mapping record but setting its status to INACTIVE.\n\n\nYou need the \"View lookup lists\" and \"Create and update lookup lists\" permissions to use this endpoint.","operationId":"meshEnrichmentServiceDeleteLookupListMapping","parameters":[{"description":"The identifier of the lookup list mapping that you want to delete.","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"204":{"description":"Lookup List Mapping version deleted"}},"summary":"Delete a Lookup List mapping by identifier","tags":["Enrichment"]},"get":{"description":"Returns a single Lookup List Mapping by its identifier.\n\n\nYou need the \"View lookup lists\" permission to use this endpoint.","operationId":"meshEnrichmentServiceGetLookupListMapping","parameters":[{"description":"The identifier of the lookup list mapping to retrieve.","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mes_LookupListMappingResponse"}}},"description":"Lookup List Mapping found"},"404":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/mes_ProblemDetailErrorResponse"}}},"description":"Not Found - Mapping not found"}},"summary":"Get a single Lookup List Mapping by identifier","tags":["Enrichment"]},"patch":{"description":"Updates a Lookup List Mapping by creating a new record with the updated values, and marking the old one as INACTIVE, so that it is not used anymore, but it's kept for audit purposes.\n\n\nYou need the \"View lookup lists\" and \"Create and update lookup lists\" permissions to use this endpoint.","operationId":"meshEnrichmentServiceUpdateLookupListMapping","parameters":[{"description":"The identifier of the lookup list mapping to update.","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"identifier","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mes_LookupListMappingPatchRequestBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mes_LookupListMappingResponse"}}},"description":"Lookup List Mapping updated"},"400":{"content":{"application/problem+json":{"examples":{"Invalid number of output fields":{"description":"Invalid number of output fields","value":{"detail":"Output fields array must contain exactly 1 element","identifier":"019a6ffb-f7f1-7025-8ad7-f65076ccdbe6","instance":"https://api.example.com/v3/enrichment/transaction/lookup-list-mappings","status":400,"timestamp":"2025-11-10T22:56:15.345Z","title":"MIN_1_AND_MAX_1_OUTPUT_FIELDS","type":"about:blank"}},"Invalid number of source fields":{"description":"Invalid number of source fields","value":{"detail":"Source fields array must contain exactly 1 element","identifier":"019a6ffb-f7f1-7025-8ad7-f65076ccdbe5","instance":"https://api.example.com/v3/enrichment/transaction/lookup-list-mappings","status":400,"timestamp":"2025-11-10T22:56:15.345Z","title":"MIN_1_AND_MAX_1_SOURCE_FIELDS","type":"about:blank"}},"Invalid source field":{"description":"Invalid source field","value":{"detail":"Source field key is not a valid block ID or transaction path","identifier":"019a6ffb-f7f1-7025-8ad7-f65076ccdbe4","instance":"https://api.example.com/v3/enrichment/transaction/lookup-list-mappings","status":400,"timestamp":"2025-11-10T22:56:15.345Z","title":"SOURCE_FIELD_DOESNT_BELONG_TO_AVAILABLE_SOURCE_FIELDS","type":"about:blank"}},"Invalid transaction_output_field_key format":{"description":"Invalid transaction_output_field_key format","value":{"detail":"Output field key has invalid format","identifier":"019a6ffb-f7f1-7025-8ad7-f65076ccdbe3","instance":"https://api.example.com/v3/enrichment/transaction/lookup-list-mappings","status":400,"timestamp":"2025-11-10T22:56:15.345Z","title":"TRANSACTION_OUTPUT_FIELD_KEY_INVALID_FORMAT","type":"about:blank"}},"Lookup list identifier cannot be changed":{"description":"Lookup list identifier cannot be changed","value":{"detail":"Lookup list identifier cannot be changed in an update operation","identifier":"019a6ffb-f7f1-7025-8ad7-f65076ccdbea","instance":"https://api.example.com/v3/enrichment/transaction/lookup-list-mappings/00000000-0000-0000-0000-000000000000","status":400,"timestamp":"2025-11-10T22:56:15.345Z","title":"LOOKUP_LIST_IDENTIFIER_CANNOT_BE_CHANGED","type":"about:blank"}},"Lookup list identifier not found":{"description":"Lookup list identifier not found","value":{"detail":"A lookup list with the identifier could not be found.","identifier":"019a6ffb-f7f1-7025-8ad7-f65076ccdbe7","instance":"https://api.example.com/v3/enrichment/transaction/lookup-list-mappings","status":400,"timestamp":"2025-11-10T22:56:15.345Z","title":"LOOKUP_LIST_IDENTIFIER_MUST_EXIST","type":"about:blank"}},"No changes detected":{"description":"No changes detected","value":{"detail":"No changes detected. At least one field must be modified.","identifier":"019a6ffb-f7f1-7025-8ad7-f65076ccdbe1","instance":"https://api.example.com/v3/enrichment/transaction/lookup-list-mappings/00000000-0000-0000-0000-000000000000","status":400,"timestamp":"2025-11-10T22:56:15.345Z","title":"NOTHING_TO_UPDATE","type":"about:blank"}},"Output field schema mismatch":{"description":"Output field schema mismatch","value":{"detail":"Output field does not match output schema","identifier":"019a6ffb-f7f1-7025-8ad7-f65076ccdbe9","instance":"https://api.example.com/v3/enrichment/transaction/lookup-list-mappings","status":400,"timestamp":"2025-11-10T22:56:15.345Z","title":"OUTPUT_FIELD_LOOKUP_LIST_COLUMN_NAME_MUST_MATCH_OUTPUT_FROM_SCHEMA","type":"about:blank"}},"Source field schema mismatch":{"description":"Source field schema mismatch","value":{"detail":"Source field does not match input schema","identifier":"019a6ffb-f7f1-7025-8ad7-f65076ccdbe8","instance":"https://api.example.com/v3/enrichment/transaction/lookup-list-mappings","status":400,"timestamp":"2025-11-10T22:56:15.345Z","title":"SOURCE_FIELD_LOOKUP_LIST_COLUMN_NAME_MUST_MATCH_INPUT_FROM_SCHEMA","type":"about:blank"}},"Source field type mismatch":{"description":"Source field type mismatch","value":{"detail":"Source field type does not match the schema type","identifier":"019a6ffb-f7f1-7025-8ad7-f65076ccdbe0","instance":"https://api.example.com/v3/enrichment/transaction/lookup-list-mappings","status":400,"timestamp":"2025-11-10T22:56:15.345Z","title":"EXISTING_SOURCE_FIELD_MUST_MATCH_SCHEMA_TYPE","type":"about:blank"}}},"schema":{"$ref":"#/components/schemas/mes_ProblemDetailErrorResponse"}}},"description":"Bad Request - Validation errors or no changes detected"},"404":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/mes_ProblemDetailErrorResponse"}}},"description":"Not Found - Mapping not found"},"409":{"content":{"application/problem+json":{"examples":{"Output field already in use":{"description":"Output field already in use","value":{"detail":"Output field is already in use by another mapping for this account","identifier":"019a6ffb-f7f1-7025-8ad7-f65076ccdbf1","instance":"https://api.example.com/v3/enrichment/transaction/lookup-list-mappings","status":409,"timestamp":"2025-11-10T22:56:15.345Z","title":"OUTPUT_FIELD_LOOKUP_ALREADY_IN_USE","type":"about:blank"}}},"schema":{"$ref":"#/components/schemas/mes_ProblemDetailErrorResponse"}}},"description":"Conflict - Output field already in use"}},"summary":"Update a Lookup List Mapping","tags":["Enrichment"]}},"/v3/transactions":{"get":{"description":"Returns all transactions in an account with the ability to search, sort and filter.\nYou need the \"View Transactions\" permission to use this endpoint.\nAdditionally, you need either \"Access to base transaction monitoring functionality\" and/or \"Access to base payment screening functionality\" to use this endpoint. ","operationId":"meshSearchServiceGetTransactions","parameters":[{"description":"Sorting criteria. Allowed fields: `occurred_at`, `received_at` (default), `base_value.amount`, `base_value.currency`, `direction`. Each criterion should be a string in the format: `property_name` for ascending order, or `-property_name` for descending order. For example, to sort by occurred date descending: `-occurred_at`. Multiple sort criteria are supported. Provide each as a separate 'sort' query parameter (e.g., `?sort=-occurred_at&sort=base_value.amount`).","example":["-occurred_at","base_value.amount"],"in":"query","name":"sort","required":false,"schema":{"items":{"example":"-direction","type":"string"},"type":"array"}},{"description":"Search for a transaction using your transaction identifier. Partial Match.","example":"00000000-0000-0000-0000-000000000000","in":"query","name":"search","required":false,"schema":{"type":"string"}},{"description":"Search for a full match using the identifier of the customer associated with the transaction.","example":"00000000-0000-0000-0000-000000000000","in":"query","name":"customer.identifier","required":false,"schema":{"format":"uuid","type":"string"}},{"description":"Filter by specific transaction identifiers. Returns transactions matching any of the provided IDs (OR logic). Can be combined with other filters.","example":["00000000-0000-0000-0000-000000000000","11111111-1111-1111-1111-111111111111"],"in":"query","name":"identifier","required":false,"schema":{"items":{"format":"uuid","type":"string"},"type":"array"}},{"description":"Filter by minimum received date/time (inclusive). ISO 8601 format.","example":"2023-10-26T11:00:00.000Z","in":"query","name":"received_at_from","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Filter by maximum received date/time (inclusive). ISO 8601 format.","example":"2023-10-27T11:00:00.000Z","in":"query","name":"received_at_to","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Filter by minimum occurred date/time (inclusive). ISO 8601 format.","example":"2023-10-26T10:00:00.000Z","in":"query","name":"occurred_at_from","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Filter by maximum occurred date/time (inclusive). ISO 8601 format.","example":"2023-10-27T10:00:00.000Z","in":"query","name":"occurred_at_to","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Filter by transaction direction.","example":["INBOUND"],"in":"query","name":"direction","required":false,"schema":{"items":{"enum":["INBOUND","OUTBOUND"],"type":"string"},"type":"array"}},{"description":"Filter by currency code (ISO 4217).","example":["USD","EUR"],"in":"query","name":"base_value.currency","required":false,"schema":{"items":{"enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPF","XSU","XUA","YER","ZAR","ZMW","ZWL"],"type":"string"},"type":"array"}},{"description":"Filter by minimum base amount (inclusive).","example":100,"in":"query","name":"base_value.amount_from","required":false,"schema":{"format":"double","type":"number"}},{"description":"Filter by maximum base amount (inclusive).","example":5000,"in":"query","name":"base_value.amount_to","required":false,"schema":{"format":"double","type":"number"}},{"description":"One-based page index (1..N)","example":1,"in":"query","name":"page_number","required":false,"schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"The size of the page to be returned","example":20,"in":"query","name":"page_size","required":false,"schema":{"default":50,"minimum":1,"type":"integer"}},{"description":"Filter by transaction evaluation outcome.","example":["HOLD","PENDING"],"in":"query","name":"evaluation_outcome","required":false,"schema":{"items":{"enum":["PENDING","PROCESS","ALLOW","HOLD","ERROR"],"type":"string"},"type":"array"}},{"description":"Filter by transaction type.","example":["BANK_PAYMENT","CARD_PAYMENT","REMITTANCE"],"in":"query","name":"type","required":false,"schema":{"items":{"enum":["BANK_PAYMENT","CARD_PAYMENT","REMITTANCE"],"type":"string"},"type":"array"}},{"description":"Filter by transaction review decision.","example":["RELEASE","REJECT"],"in":"query","name":"review_decision","required":false,"schema":{"items":{"enum":["NOT_APPLICABLE","NOT_REVIEWED","RELEASE","REJECT"],"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/search_PaginatedResponseTransactionV3"}}},"description":"OK"}},"summary":"Get a list of transactions","tags":["Transactions"]}},"/v3/transactions/external/{identifier}":{"get":{"description":"When you submit a Transaction to us, you provide us with your identifier for the Transaction. This API allows you to retrieve a Transaction using this identifier you supplied to us.","operationId":"activityStoreGetTransactionUsingExternalIdentifier","parameters":[{"description":"Your identifier for the transaction.","example":"YourUniqueTransactionIdentifier","in":"path","name":"identifier","required":true,"schema":{"description":"Your identifier for the transaction.","example":"YourUniqueTransactionIdentifier","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/activity_TransactionV3"}}},"description":"Stored Transaction Information"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/activity_ProblemDetailErrorResponse"}}},"description":"Transaction not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/activity_ProblemDetailErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Retrieve a Transaction using your identifier as a reference","tags":["Transactions"]}},"/v3/transactions/process":{"post":{"description":"Creates a transaction and executes our payment screening and transaction monitoring processes.\n\nThe response will indicate whether the transaction should be held or processed.\n\nThis endpoint requires PAYMENT_SCREENING_BASE and/or TRANSACTION_MONITORING_BASE account permission depending on the configuration identifies supplied with the payload.","operationId":"orchestrationLayerAPIPostV3TransactionProcess","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ol_CreateAndProcessTransactionDTO"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"Transaction with configurations array (ASYNC TM with PENDING outcome)":{"description":"Transaction with configurations array (ASYNC TM with PENDING outcome)","value":{"evaluation_result":{"errors":[],"outcome":"PROCESS","scenario_evaluations":[{"evaluation_result_delivery":{"method":"WEBHOOK","webhook_identifier":"webhook-abc-123"},"outcome":"PENDING","processing_method":"ASYNCHRONOUS","results":[],"scenario_configuration_identifier":"01973ffe-b3db-76b4-a114-9c2f1746f6d5"}],"screening_evaluation_results":{"outcome":"PROCESS","payment_screening_configuration_identifier":"01974000-0e58-79c3-b4c8-755c1a00daea","processing_method":"SYNCHRONOUS"}},"transaction":{"external_identifier":"TXN-004-2023-22222"}}},"Transaction with monitoring only (ALLOW outcome)":{"description":"Transaction with monitoring only (ALLOW outcome)","value":{"evaluation_result":{"errors":[],"outcome":"ALLOW","scenario_evaluations":[{"outcome":"ALLOW","processing_method":"SYNCHRONOUS","results":[{"outcome":"ALLOW","priority":2,"scenario_identifier":"01973ffe-9792-7666-aaa7-2f84aa243eac","scenario_name":"Velocity Check"}],"scenario_configuration_identifier":"01973ffe-b3db-76b4-a114-9c2f1746f6d5"}]},"transaction":{"external_identifier":"TXN-003-2023-11111"}}},"Transaction with screening and monitoring (HOLD outcome)":{"description":"Transaction with screening and monitoring (HOLD outcome)","value":{"evaluation_result":{"errors":[],"outcome":"HOLD","scenario_evaluations":[{"outcome":"HOLD","processing_method":"SYNCHRONOUS","results":[{"outcome":"HOLD","priority":1,"scenario_identifier":"01973fff-adc2-738f-bb92-0ccf9848ddd8","scenario_name":"High Value Transaction Monitoring"},{"outcome":"ALLOW","priority":3,"scenario_identifier":"01973ffe-f268-7460-bf21-24ce26389d23","scenario_name":"Unusual Pattern Detection"}],"scenario_configuration_identifier":"01973fff-c779-7b50-b72d-f703cfad96b8"}],"screening_evaluation_results":{"outcome":"PROCESS","payment_screening_configuration_identifier":"01973fff-de4e-795c-9265-a00596f88cbf","processing_method":"SYNCHRONOUS"}},"transaction":{"external_identifier":"TXN-002-2023-67890"}}},"Transaction with screening only (PROCESS outcome)":{"description":"Transaction with screening only (PROCESS outcome)","value":{"evaluation_result":{"errors":[],"outcome":"PROCESS","scenario_evaluations":[],"screening_evaluation_results":{"outcome":"PROCESS","payment_screening_configuration_identifier":"01974000-0e58-79c3-b4c8-755c1a00daea","processing_method":"SYNCHRONOUS"}},"transaction":{"external_identifier":"TXN-001-2023-12345"}}}},"schema":{"$ref":"#/components/schemas/ol_TransactionResponseDTO"}}},"description":"Transaction successfully processed"},"400":{"content":{"application/json":{"examples":{"Invalid configurations array - Missing webhook for ASYNC":{"description":"Invalid configurations array - Missing webhook for ASYNC","value":{"detail":"Configuration validation failed","errors":[{"field":"configurations","reasons":[{"message":"Asynchronous processing requires evaluation_result_delivery configuration","reason":"invalid"}],"value":null}],"identifier":"01974025-5d6b-732c-ba71-a7cb6e98907f","status":400,"timestamp":"2025-05-14T09:30:04.201Z","title":"Validation Error"}},"Invalid configurations array - PS cannot be ASYNCHRONOUS":{"description":"Invalid configurations array - PS cannot be ASYNCHRONOUS","value":{"detail":"Configuration validation failed","errors":[{"field":"configurations","reasons":[{"message":"Asynchronous payment screening is not supported","reason":"invalid"}],"value":null}],"identifier":"01974025-5d6b-732c-ba71-a7cb6e98907f","status":400,"timestamp":"2025-05-14T09:30:04.201Z","title":"Validation Error"}},"Invalid screening configuration":{"description":"Invalid screening configuration","value":{"detail":"Invalid Screening Configuration Identifier","errors":[{"field":"screening_configuration_identifier","reasons":[{"message":"Missing or archived screening configuration identifier provided","reason":"missing_or_invalid"}],"value":"01974025-3d4b-7980-849b-470fa8fd096a"}],"identifier":"01974025-5d6b-732c-ba71-a7cb6e98907f","status":400,"timestamp":"2025-05-14T09:30:04.201Z","title":"Validation Error"}},"Transaction external identifier too long":{"description":"Transaction external identifier too long","value":{"detail":"There were validation errors with your request","errors":[{"field":"transaction.external_identifier","reasons":[{"message":"size must be between 0 and 512","reason":"reason"}],"value":"very_long_transaction_identifier_that_exceeds_maximum_length..."}],"identifier":"01974025-94a5-788c-b4a3-513127210fd0","status":400,"timestamp":"2023-12-11T09:30:05.975Z","title":"Validation Error"}},"Unknown customer":{"description":"Unknown customer","value":{"errors":[{"field":"customer_external_identifier","reasons":[{"message":"The provided customer could not be found: unknown-customer-id-12345","reason":"missing"}],"value":"unknown-customer-id-12345"}],"identifier":"01974027-9600-7b78-a07f-798f1a211073","status":400,"timestamp":"2024-12-11T09:35:06.677Z","title":"Customer not found in our system"}}},"schema":{"$ref":"#/components/schemas/ol_ProblemDetailErrorResponse"}}},"description":"Validation Error"},"409":{"content":{"application/json":{"examples":{"Duplicate Transaction":{"description":"Duplicate Transaction","value":{"detail":"Transaction with external identifier 'TXN-DUPLICATE-123' already exists","errors":[{"field":"transaction.external_identifier","reasons":[{"message":"A transaction with this external identifier already exists","reason":"duplicate"}],"value":"TXN-DUPLICATE-123"}],"identifier":"01974024-d616-758c-aded-3c07eaa32c3b","status":409,"timestamp":"2023-12-11T09:30:10.975Z","title":"Duplicate Transaction"}}},"schema":{"$ref":"#/components/schemas/ol_ProblemDetailErrorResponse"}}},"description":"Duplicate Transaction"}},"summary":"Create and process a transaction","tags":["Transactions"]}},"/v3/transactions/{identifier}":{"get":{"description":"When you submit a transaction to us we allocate an internal identifier for the Transaction. This API allows you to retrieve a Transaction using the identifier we set when we received your transaction.","operationId":"activityStoreGetTransactionUsingInternalIdentifier","parameters":[{"description":"Our identifier for the transaction.","example":"01966d5b-e4fa-7b60-a2d7-5b5225fbd39a","in":"path","name":"identifier","required":true,"schema":{"description":"Our identifier for the transaction.","example":"01966d5b-e4fa-7b60-a2d7-5b5225fbd39a","format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/activity_TransactionV3"}}},"description":"Stored Transaction Information"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/activity_ProblemDetailErrorResponse"}}},"description":"Transaction not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/activity_ProblemDetailErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Retrieve a Transaction using our identifier","tags":["Transactions"]}},"/v3/transactions/{identifier}/review":{"post":{"description":"When a transaction is held (evaluation_outcome=HOLD), a decision can be made to either release or reject the transaction. This decision will be recorded in the review_decision field and sent as a webhook, if configured. This endpoint cannot be used for transactions that are not held.","operationId":"activityStorePostTransactionReviewDecision","parameters":[{"description":"Our identifier for the transaction.","example":"01966d5b-e4fa-7b60-a2d7-5b5225fbd39a","in":"path","name":"identifier","required":true,"schema":{"description":"Our identifier for the transaction.","example":"01966d5b-e4fa-7b60-a2d7-5b5225fbd39a","format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/activity_ReviewDecisionRequestBody"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/activity_ReviewDecisionResponse"}}},"description":"Review decision created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/activity_ProblemDetailErrorResponse"}}},"description":"Review decision can only be applied to HOLD outcome"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/activity_ProblemDetailErrorResponse"}}},"description":"Transaction not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/activity_ProblemDetailErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Make a decision on a held transaction","tags":["Transactions"]}},"/v3/transactions/{identifier}/risk_types":{"put":{"description":"This endpoint allows you to set the risk types for a transaction. Currently supports setting the risk to 'r_fraud' or removing all risks by passing an empty list.","operationId":"activityStoreSetTransactionRiskTypes","parameters":[{"description":"Internal identifier for the transaction.","example":"01966d5b-e4fa-7b60-a2d7-5b5225fbd39a","in":"path","name":"identifier","required":true,"schema":{"description":"Internal identifier for the transaction.","example":"01966d5b-e4fa-7b60-a2d7-5b5225fbd39a","format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/activity_TransactionRiskTypesRequestBody"}}},"required":true},"responses":{"204":{"description":"Transaction risks set successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/activity_ProblemDetailErrorResponse"}}},"description":"Invalid risk type value - must be one of the allowed values [r_fraud]"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/activity_ProblemDetailErrorResponse"}}},"description":"Transaction not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/activity_ProblemDetailErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Set or clear risk types for a transaction","tags":["Transactions"]}}},"security":[{"BearerAuth":[]}],"servers":[{"description":"ComplyAdvantage Mesh API","url":"https://api.mesh.complyadvantage.com"}],"tags":[{"name":"Authentication"},{"name":"Onboarding"},{"name":"Customers"},{"name":"Cases"},{"name":"Alerts & Risks"},{"name":"Webhooks"},{"name":"Exports"},{"name":"Email Configurations"},{"name":"Lookup Lists"},{"name":"Audit"}]}