ComplyAdvantage Mesh Platform API
ComplyAdvantage's newer Mesh platform API, authenticated with OAuth2 bearer tokens (24-hour validity). Covers the full customer lifecycle - customer creation and screening (sync or async), risk scoring, cases and alerts with stage transitions and assignments, transaction screening and monitoring for payments fraud, custom and lookup lists, webhook and email notifications, data exports, user and role administration, and regulatory reporting (CTR/SAR prefill). Documented separately at docs.mesh.complyadvantage.com with its own OpenAPI schema for customers.
ComplyAdvantage Mesh Platform API is one of 5 APIs that ComplyAdvantage publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Customer Screening, Transaction Monitoring, Fraud Detection, and Cases. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, an API reference, and a getting-started guide.
This API exposes 163 operations across 123 paths, organized into 23 resource areas, and defines 945 schemas. It is described by OpenAPI 3.0.3, at version v2.0.
Requests are made against a single base URL, https://api.mesh.complyadvantage.com.
163 operations
123 paths
945 schemas
10 DELETE82 GET14 PATCH47 POST10 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
ComplyAdvantage Mesh Platform API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (BearerAuth).
By default, every request must be authenticated.
BearerAuth— HTTP Bearer Token Authentication
Paths & Operations 163
Across 123 paths, the API surfaces 163 operations — 10 DELETE, 82 GET, 14 PATCH, 47 POST, 10 PUT. They span 23 resource areas, including Accounts, Alerts & Risks, Audit, Batch Processing, Cases, Case Workflows, Clients, Custom Lists, and 15 more. Each is listed below with its method, path, parameters, and response codes.
Accounts 3
GET
/v2/accounts/me
Get details about your account
PUT
/v2/accounts/me
Switch logged in account
GET
/v2/accounts/me/users
Get list of users in your account
Alerts & Risks 11
GET
/v2/alerts/mutesdeprecated
Get list of alert mutes for account or customer
POST
/v2/alerts/mutesdeprecated
Create alert mutes for customer
DELETE
/v2/alerts/mutes/{alert_mute_key}/customer/{customer_identifier}deprecated
Delete alert mute
GET
/v2/alerts/{alert_identifier}/risks
Get risks within an alert
POST
/v2/alerts/{alert_identifier}/risks/{risk_identifier}/decision
Update the status of a risk
POST
/v2/alerts/{alert_identifier}/transition
Transition an alert to a state
GET
/v2/entity-screening/risks/{risk_identifier}/notes
Get the notes for a screening risk
POST
/v2/entity-screening/risks/{risk_identifier}/notes
Create a new note on a screening risk
GET
/v3/alerts/mutes
Get list of alert mutes for account or entity
POST
/v3/alerts/mutes
Create an alert mute
DELETE
/v3/alerts/mutes/{identifier}
Delete an alert mute
Audit 6
GET
/v2/audit/accounts/me
Get audit log for your account
GET
/v2/audit/cases/{case_identifier}
Get audit log for a case
GET
/v2/audit/customers/{customer_identifier}
Get audit log for a customer
GET
/v2/audit/roles/{role_identifier}
Get audit log for a role
GET
/v2/audit/transactions/{transaction_identifier}
Get audit log for a transaction
GET
/v2/audit/users/{user_identifier}
Get audit log for a user
Batch Processing 5
GET
/v2/batch-processing
Get the states for all batch processes
POST
/v2/batch-processing
Initiate a batch-process
DELETE
/v2/batch-processing/{identifier}
Delete a batch process
GET
/v2/batch-processing/{identifier}
Get the state for a single batch process
GET
/v2/batch-processing/{identifier}/report
Download a summary report
Cases 14
GET
/v2/cases
Get list of cases
POST
/v2/cases/assign/bulk
Assign cases in bulk
POST
/v2/cases/notes/bulk
Leave a note on multiple cases in bulk
GET
/v2/cases/statesdeprecated
Get a list of available case states
POST
/v2/cases/transition/bulk
Transition cases in bulk
GET
/v2/cases/{case_identifier}
Get a specific case
GET
/v2/cases/{case_identifier}/alerts
Retrieve the alerts for a case
GET
/v2/cases/{case_identifier}/alerts/{alert_identifier}/notes
Get the notes on an alert
POST
/v2/cases/{case_identifier}/alerts/{alert_identifier}/notes
Leave a note on an alert
POST
/v2/cases/{case_identifier}/assign
Assign a case to a user
GET
/v2/cases/{case_identifier}/notes
Get the notes on a case
POST
/v2/cases/{case_identifier}/notes
Leave a note on a case
GET
/v2/cases/{case_identifier}/subjects
Retrieve the subjects for a case
POST
/v2/cases/{case_identifier}/transition
Transition a case to a stage
Case Workflows 4
GET
/v2/cases/workflows
Get list of case workflows
GET
/v2/cases/workflows/{workflow_identifier}
Get a specific case workflow
PUT
/v2/cases/workflows/{workflow_identifier}
Update a specific case workflow
GET
/v2/cases/workflows/{workflow_identifier}/versions/{version}
Get a specific version of a case workflow
Clients 3
GET
/v2/clients/me
Get your client details
GET
/v2/clients/me/accounts
Get list of accounts within your client
GET
/v2/clients/me/users
Retrieve list of users in the client
Custom Lists 12
GET
/v2/custom-lists
Retrieve all custom lists
POST
/v2/custom-lists
Create a new custom list
POST
/v2/custom-lists/{custom_list_id}/entity
Add a specific entity to a list
PUT
/v2/custom-lists/{custom_list_id}/entity
Add or update a specific entity to a list
DELETE
/v2/custom-lists/{custom_list_id}/entity/{id}
Archive an entity from a list
GET
/v2/custom-lists/{custom_list_id}/entity/{id}
Fetch a specific entity from a list
POST
/v2/custom-lists/{custom_list_id}/risk-word
Add a risk word
PUT
/v2/custom-lists/{custom_list_id}/risk-word
Add or update a risk word
DELETE
/v2/custom-lists/{custom_list_id}/risk-word/{id}
Delete a risk word
GET
/v2/custom-lists/{custom_list_id}/risk-word/{id}
Retrieve a risk word
DELETE
/v2/custom-lists/{id}
Delete a custom list by its identifier
GET
/v2/custom-lists/{id}
Retrieve a custom list from its identifier
Customers 16
GET
/v2/customers
Get a list of customers
GET
/v2/customers/acquisition-sources
Get a list of acquisition sources matching the search parameter.
GET
/v2/customers/external/{external_identifier}
Get customer using your identifier
GET
/v2/customers/{customer_identifier}
Get customer details
GET
/v2/customers/{customer_identifier}/cases
Retrieve cases for a customer
GET
/v2/customers/{customer_identifier}/monitor
Get monitoring configuration of a customer
PATCH
/v2/customers/{customer_identifier}/monitor
Update monitoring configuration for an existing customer
GET
/v2/customers/{customer_identifier}/notes
Get a list of notes on a customer.
POST
/v2/customers/{customer_identifier}/notes
Create note on a customer.
GET
/v2/customers/{customer_identifier}/products
Get customer's products
POST
/v2/customers/{customer_identifier}/reports
Generate a screening certificate for a specific customer
GET
/v2/customers/{customer_identifier}/scores
Get customer's risk score
PATCH
/v2/customers/{customer_identifier}/scores
Override customer's risk score level
POST
/v2/customers/{customer_identifier}/transition
Transition a customer's status
POST
/v2/customers/{customer_identifier}/workflows/sync/rescreen
Rescreen a customer synchronously
POST
/v2/customers/{customer_identifier}/workflows/sync/update-and-rescore
Update and re-score a customer synchronously
Custom Fields 3
GET
/v2/customers/custom-fields
Get a list of custom fields
POST
/v2/customers/custom-fields
Create a custom field for customers
PATCH
/v2/customers/custom-fields/{custom_field_identifier}
Update customer custom fields
Labels 5
GET
/v2/customers/{customer_identifier}/labels
Retrieve the labels for a customer
PUT
/v2/customers/{customer_identifier}/labels
Set labels for a customer
GET
/v2/labels
Get a list of labels
POST
/v2/labels
Create new labels
PATCH
/v2/labels/{label_identifier}
Rename label
Screening Configurations 5
GET
/v2/entity-screening/configurations
Get screening configurations
POST
/v2/entity-screening/configurations
Create screening configuration
PUT
/v2/entity-screening/configurations/{configuration_identifier}
Update screening configuration
GET
/v2/entity-screening/configurations/{configuration_identifier}/versions
Get screening configuration versions
GET
/v2/entity-screening/configurations/{configuration_identifier}/versions/{version_identifier}
Get a screening configuration version
Exports 4
GET
/v2/exports
Get a list of all exports that the requesting user attempted to create
POST
/v2/exports
Create a new export
GET
/v2/exports/export-types
Get a list of export types
GET
/v2/exports/{export_identifier}/download
Get a download url for a given export
IAM 8
GET
/v2/iam/permissionsdeprecated
List permissions
GET
/v2/iam/permissions/groups
List permission groups with permissions
GET
/v2/iam/roles
Get list of roles
POST
/v2/iam/roles
Create a new role
DELETE
/v2/iam/roles/{role_identifier}
Archive a role
GET
/v2/iam/roles/{role_identifier}
Get details about a role
PATCH
/v2/iam/roles/{role_identifier}
Partial update an existing role
GET
/v3/iam/permissions
List permissions
Email Configurations 5
GET
/v2/notifications/configurations/email
Get a list of all email notification configurations
POST
/v2/notifications/configurations/email
Create a new email notification configuration
POST
/v2/notifications/configurations/email/test
Test an email
DELETE
/v2/notifications/configurations/email/{identifier}
Delete an email notification configuration
PATCH
/v2/notifications/configurations/email/{identifier}
Update an email notification configuration
Webhooks 4
GET
/v2/notifications/configurations/webhook
Get a list of all webhook notification configurations.
POST
/v2/notifications/configurations/webhook
Create a new webhook configuration
POST
/v2/notifications/configurations/webhook/test
Test a webhook
PATCH
/v2/notifications/configurations/webhook/{identifier}
Update a webhook notification configuration.
Payment Screening 9
GET
/v2/payment-screening/configurations
Get payment screening configurations
POST
/v2/payment-screening/configurations
Create payment screening configuration
GET
/v2/payment-screening/configurations/{configuration_identifier}
Retrieve latest payment screening configuration by id
PUT
/v2/payment-screening/configurations/{configuration_identifier}
Create a new version of a configuration
GET
/v2/payment-screening/configurations/{configuration_identifier}/versions
Get payment screening configuration versions
GET
/v2/payment-screening/configurations/{configuration_identifier}/versions/{version_identifier}
Get a payment screening configuration version
GET
/v2/payment-screening/risks
Retrieve risks for a transaction
PATCH
/v2/payment-screening/risks/bulk
Bulk risk status update
PATCH
/v2/payment-screening/risks/{risk_identifier}
Update a single risk status
Regulatory Reporting 4
POST
/v2/regulatory-reports/prefill-information/fincen/ctr/transaction-locations/bulk
Bulk create or update CTR transaction locations
POST
/v2/regulatory-reports/prefill-information/fincen/ctr/transaction-locations/bulk-delete
Bulk delete CTR transaction locations
POST
/v2/regulatory-reports/prefill-information/fincen/sar/financial-institutions/bulk
Bulk create or update SAR financial institutions
POST
/v2/regulatory-reports/prefill-information/fincen/sar/financial-institutions/bulk-delete
Bulk delete SAR financial institutions
Authentication 2
POST
/v2/token
Create an access token with username/password (deprecated)
POST
/v3/token
Create an API access token
Users 10
POST
/v2/users
Create a new user
GET
/v2/users/me
Get details about your user
PATCH
/v2/users/me
Update your user
GET
/v2/users/me/accounts
Get accounts for your user
GET
/v2/users/me/permissions
Get permissions for your user
PUT
/v2/users/roles/bulk
Bulk assign user roles
GET
/v2/users/{user_identifier}
Get details about a user
PATCH
/v2/users/{user_identifier}
Update an existing user
GET
/v2/users/{user_identifier}/accounts
Get accounts for a user
PUT
/v2/users/{user_identifier}/roles
Assign user roles
Onboarding 3
POST
/v2/workflows/create-and-screen
Create and Screen a Customer asynchronously
POST
/v2/workflows/sync/create-and-screen
Create and Screen a Customer synchronously
GET
/v2/workflows/{workflow_instance_identifier}
Get status and result of onboarding
Enrichment 16
GET
/v3/enrichment/lookup-lists
List Lookup Lists for an account
POST
/v3/enrichment/lookup-lists
Create a new Lookup List
GET
/v3/enrichment/lookup-lists/{identifier}
Get a Lookup List by identifier
PATCH
/v3/enrichment/lookup-lists/{identifier}
Update lookup list name
DELETE
/v3/enrichment/lookup-lists/{identifier}/draft
Delete a lookup list draft version by identifier
POST
/v3/enrichment/lookup-lists/{identifier}/promote-draft
Promote a DRAFT version to ACTIVE
GET
/v3/enrichment/lookup-lists/{identifier}/versions
List all versions for a Lookup List
POST
/v3/enrichment/lookup-lists/{identifier}/versions
Creates a new lookup list version
GET
/v3/enrichment/lookup-lists/{identifier}/versions/{version_identifier}/download
Download a CSV file containing all items for a Lookup List Version
GET
/v3/enrichment/lookup-lists/{identifier}/versions/{version_identifier}/items
List all items for a Lookup List Version
GET
/v3/enrichment/transaction/lookup-list-mappings
List all Lookup List Mappings
POST
/v3/enrichment/transaction/lookup-list-mappings
Create a new Lookup List Mapping
GET
/v3/enrichment/transaction/lookup-list-mappings/available-source-fields
Lists all available Source Fields for Lookup List Mappings
DELETE
/v3/enrichment/transaction/lookup-list-mappings/{identifier}
Delete a Lookup List mapping by identifier
GET
/v3/enrichment/transaction/lookup-list-mappings/{identifier}
Get a single Lookup List Mapping by identifier
PATCH
/v3/enrichment/transaction/lookup-list-mappings/{identifier}
Update a Lookup List Mapping
Transactions 11
GET
/v3/transactions
Get a list of transactions
GET
/v3/transactions/custom-fields
List custom fields for the account
POST
/v3/transactions/custom-fields
Create a new custom field
PATCH
/v3/transactions/custom-fields/{custom_field_identifier}
Update an existing custom field
GET
/v3/transactions/external/{identifier}
Retrieve a Transaction using your identifier as a reference
POST
/v3/transactions/process
Create and process a transaction
GET
/v3/transactions/{identifier}
Retrieve a Transaction using our identifier
POST
/v3/transactions/{identifier}/review
Make a decision on a held transaction
PUT
/v3/transactions/{identifier}/risk_types
Set or clear risk types for a transaction
GET
/v3/transactions/{identifier}/versions
Retrieve all versions of a Transaction
GET
/v3/transactions/{identifier}/versions/{version}
Retrieve a specific version of a Transaction using our identifier
Schemas 945
The contract defines 945 schemas that model the data the API accepts and returns. The most detailed are ol_Person (23 properties), case-management_CaseResultResponse (18 properties), case-management_CaseResponse (17 properties), search_TransactionV3 (15 properties). Each schema is shown below with its type and property counts.
TokenCreateRequestBody
object
3 properties
3 required
TokenCreateRequestBodyV3
object
2 properties
2 required
TokenCreateResponseData
object
4 properties
activity_AccountBalanceV3
object
Represents the balance of a financial account.
2 properties
1 required
activity_AcquirerV3
object
Represents the payment acquirer information.
2 properties
activity_AddressFormatV3
string
Represents the format of the address used for a party.
activity_AddressTypeV3
string
Represents the type of address.
activity_AddressV3
object
Address of the ATM.
1 property
1 required
activity_AgentRoleV3
string
The roles an agent may take within a financial transaction.
activity_AgentV3
object
Represents an agent in a financial transaction.
7 properties
1 required
activity_AtmChannelV3
object
Represents an ATM channel used for transaction processing.
2 required
activity_AuthorizationInfoV3
object
Authorization information.
6 properties
activity_AuthorizationResponseV3
object
Authorization response information.
2 properties
activity_BankAccountV3
object
Represent bank account details
3 properties
1 required
activity_BankPaymentMonetaryTransactionTypeDetailsV3
object
Models a transfer of funds from one bank account to another in a different financial institution.
5 required
activity_BankPaymentStateV3
string
The possible states of a bank payment transaction.
activity_BankV3
object
Represents a bank's details.
3 properties
activity_BlockchainNetworkTypeV3
string
Type of the blockchain network used in the transaction.
activity_BlockchainV3
object
Represents a blockchain network used for cryptocurrency transactions.
3 properties
2 required
activity_BooleanEnrichmentValueV3
object
Boolean representation of the enrichment value.
2 required
activity_Caip19IdentifierV3
object
The industry standard CAIP-19 Asset Identifier (http://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-19.md)
2 properties
2 required
activity_Caip2IdentifierV3
object
The industry standard CAIP-2 Identifier for the blockchain (https://chainagnostic.org/CAIPs/caip-2)
2 properties
2 required
activity_CardFundingTypeV3
string
Defines the funding type of a payment card.
activity_CardHolderV3
object
Represents a card holder with party identification details and onboarding information.
1 property
activity_CardPaymentMonetaryTransactionTypeDetailsV3
object
Models a card payment transaction where funds are transferred using a payment card.
1 required
activity_CardPaymentScopeV3
string
Defines the scope of a card payment transaction.
activity_CardPaymentStageV3
string
Defines the stage of a card payment transaction.
activity_CardPaymentTypeV3
string
Defines the type of card payment.
activity_CardSchemeV3
string
Represents the card scheme/network that issued the card.
activity_CardVerificationResultsV3
object
Represents card verification results including CVV, AVS, and identity checks.
3 properties
activity_CardWalletTypeV3
string
Defines the type of digital wallet.
activity_CashPickupDetailsV3
object
Represents cash pickup details for remittance transactions.
3 properties
activity_ChannelNetworkDetailsV3
object
Contains network-related information for a payment channel.
2 properties
activity_ChannelV3
object
Represents the channel that initiated the transaction.
2 properties
2 required
activity_ChargebackInfoV3
object
Chargeback information.
5 properties
2 required
activity_ClearingIdentifierV3
object
ClearingIdentifier pairs a routing system with its specific value.
2 properties
2 required
activity_CounterpartyPartyIdentifierV3
object
Represents the identification details of a counterparty.
1 required
activity_CreateCustomFieldRequest
object
4 properties
4 required
activity_CryptoAssetV3
object
The asset that was transacted.
2 properties
1 required
activity_CryptoMonetaryTransactionTypeDetailsV3
object
Crypto-specific transaction details.
7 required
activity_CryptoPartyV3
object
Crypto specific Party data structure. Could be counterparty or customer. Follows the model of PartyIdentification type but with additional information.
2 properties
2 required
activity_CryptoWalletV3
object
Represents a cryptocurrency wallet involved in a transaction.
3 properties
2 required
activity_CustomField
object
5 properties
5 required
activity_CustomFieldDataTypeV3
string
The type of data stored in a custom field.
activity_CustomFieldV3
object
A representation of a custom field.
2 properties
2 required
activity_CustomFieldValueV3
object
The value of the custom field.
1 property
1 required
activity_CustomerPartyIdentifierV3
object
Represents the identification details of a customer party.
1 required
activity_DecimalEnrichmentValueV3
object
Decimal representation of the enrichment value.
2 required
activity_DecimalValueV3
object
Decimal representation of the custom field value.
2 required
activity_DeviceChannelV3
object
Represents the device channel used to initiate a transaction.
3 required
activity_EnrichmentDataTypeV3
string
The type of data stored in an enrichment value.
activity_EnrichmentTypeV3
string
The type of enrichment source.
activity_EnrichmentV3
object
A representation of a transaction enrichment.
3 properties
3 required
activity_EnrichmentValueV3
object
The value of the enrichment.
1 property
1 required
activity_FincenCashTransactionSubtype
string
Defines the subtype of FinCEN transactions.
activity_FincenDetailsV3
object
FinCEN transaction details.
2 properties
activity_GeographicCoordinatesV3
object
Geographic location represented by the latitude and longitude.
2 properties
2 required
activity_InternetProtocolAddressV3
object
Represents an Internet Protocol (IP) address with its associated type information.
2 properties
2 required
activity_InternetProtocolInformationV3
string
Enumeration for available IP format values.
activity_IssuerV3
object
Represents the card issuer information.
2 properties
activity_LoanProductV3
object
Represents a loan product.
4 required
activity_LoanTypeV3
string
Defines the type of loan.
activity_LocalAccountDetailsV3
object
Represents banking information for 'domestic rail' transactions where a global standard like IBAN is not used.
3 properties
2 required
activity_MerchantV3
object
Represents merchant information.
4 properties
activity_MonetaryTransactionClassificationDetailsV3
object
Details related to a monetary transaction.
3 required
activity_MonetaryTransactionDirectionV3
string
Defines the direction of the flow of value in the transaction in relation to the primary Customer in a Monetary Transaction.
activity_MonetaryTransactionTypeDetailsV3
object
Details specific to the a Monetary Transaction.
1 property
1 required
activity_MonetaryTransactionTypeV3
string
Defines the type of a monetary transaction.
activity_MonetaryValueV3
object
Represents a combination of a decimal amount with a currency.
3 properties
1 required
activity_MoneyTransferOperatorV3
object
Represents a money transfer operator's details.
2 properties
activity_OnlineRemittancePlatformV3
object
Represents an online remittance platform's details.
2 properties
activity_PaginatedResponseCustomField
object
6 properties
3 required
activity_PaginatedResponseTransactionV3
object
6 properties
3 required
activity_PartyIdentificationV3
object
Represents the identification details of a party. This includes not just the party's identifier, but also any other identifying information specific to the tra…
3 properties
activity_PartyIdentifierV3
object
Party identifier details
1 property
1 required
activity_PaymentCardV3
object
Details about a payment card used in a transaction.
4 properties
1 required
activity_PaymentChannelV3
string
The channel used for a payment.
activity_PaymentSchemeV3
string
The payment scheme that was used to initiate the financial transaction.
activity_PaymentStagesInfoV3
object
Payment stages information.
5 properties
activity_PointOfSaleConditionCodeV3
object
Point of sale condition code and description
2 properties
activity_PointOfSaleConditionV3
object
Contains contextual information about the card payment environment.
2 properties
activity_PointOfSaleEntryModeV3
object
Point of sale entry mode code and description
2 properties
activity_ProblemDetailErrorResponse
object
7 properties
2 required
activity_ProductTypeV3
string
Defines the type of product payload.
activity_ProductV3
object
Represents product details associated with a transaction.
7 properties
3 required
activity_RefundInfoV3
object
Refund information.
2 properties
1 required
activity_RefundReasonV3
object
Refund reason information.
2 properties
activity_RegulatoryReportDetailsV3
object
Regulatory reporting transaction details.
1 property
activity_RemittanceCreditorV3
object
Represents the creditor in a remittance transaction.
2 properties
1 required
activity_RemittanceMonetaryTransactionTypeDetailsV3
object
Models a cross-border remittance payment transaction between parties in different countries.
3 required
activity_RemittancePaymentMethodV3
string
The payment method used for remittance transactions.
activity_RemittancePurposeV3
string
The purpose of the remittance payment.
activity_RemittanceRelationshipV3
string
The relationship between the sender and receiver in a remittance transaction.
activity_RemittanceServiceProviderTypeV3
string
The type of service provider facilitating the remittance transaction.
activity_RemittanceServiceProviderV3
object
Represents a remittance service provider's details.
3 properties
activity_RemittanceSourceOfFundsV3
string
The source of funds for the remittance transaction.
activity_ReversalInfoV3
object
Reversal information.
3 properties
2 required
activity_ReviewDecisionRequestBody
object
1 property
1 required
activity_ReviewDecisionResponse
object
5 properties
4 required
activity_SettlementInfoV3
object
Settlement information.
2 properties
2 required
activity_StructuredAddressV3
object
Represents a structured address with detailed components.
1 required
activity_TextEnrichmentValueV3
object
String representation of the enrichment value.
2 required
activity_TextValueV3
object
String representation of the custom field value.
2 required
activity_TransactionClassificationDetailsV3
object
Details specific to the Transaction classification.
1 property
1 required
activity_TransactionClassificationV3
string
Classifies a transaction as a specific high-level class of transaction.
activity_TransactionRiskTypesRequestBody
object
Request body for setting transaction risk types.
1 property
1 required
activity_TransactionV3
object
Represents a Transaction performed by a Customer. A Transaction can be either monetary or non-monetary.
15 properties
8 required
activity_UnstructuredAddressV3
object
Represents an unstructured address with local details and country.
1 required
activity_UpdateCustomFieldRequest
object
2 properties
activity_VerificationCheckResultV3
string
Represents the result of a verification check.
activity_VerificationCheckV3
object
Represents a verification check with result and optional description.
2 properties
activity_VirtualAssetServiceProviderV3
object
Type for storing VASP details.
1 property
1 required
am_AlertMuteDTO
object
5 properties
4 required
am_AlertMuteEntityRequest
object
Entity scope for the mute. CUSTOMER identifiers must be valid UUIDs.
2 properties
2 required
am_AlertMuteEntityResponse
object
Entity scope the alert mute applies to.
2 properties
2 required
am_AlertMuteV3Response
object
6 properties
4 required
am_CreateAlertMuteRequest
object
3 properties
1 required
am_CreateAlertMuteV3Request
object
4 properties
3 required
am_GetAlertMutesResponse
object
6 properties
3 required
am_PaginatedResponseAlertMuteV3Response
object
6 properties
3 required
am_ProblemDetailErrorResponse
object
7 properties
2 required
am_RiskStatusUpdatePayload
object
1 property
1 required
am_Scenario
object
4 properties
4 required
am_Segment
object
4 properties
4 required
am_Transaction
object
3 properties
3 required
am_TransactionMonitoringRisk
object
4 properties
4 required
am_TransactionMonitoringRiskDetail
object
3 properties
3 required
am_TransactionMonitoringRisksResponse
object
6 properties
3 required
am_TransitionStatePayload
object
1 property
1 required
audit_AccountActivatedDetailV2
object
1 property
1 required
audit_AccountActivatedLogV2
object
6 properties
5 required
audit_AccountAuditLogsPageV2
object
6 properties
3 required
audit_AccountCreatedDetailV2
object
2 properties
2 required
audit_AccountCreatedLogV2
object
6 properties
5 required
audit_AccountDeactivatedDetailV2
object
1 property
1 required
audit_AccountDeactivatedLogV2
object
6 properties
5 required
audit_AccountIpRestrictionsUpdatedDetailV2
object
3 properties
3 required
audit_AccountIpRestrictionsUpdatedLogV2
object
6 properties
5 required
audit_AccountNameUpdatedDetailV2
object
3 properties
3 required
audit_AccountNameUpdatedLogV2
object
6 properties
5 required
audit_AccountPermissionsUpdatedDetailV2
object
3 properties
3 required
audit_AccountPermissionsUpdatedLogV2
object
6 properties
5 required
audit_AccountRateLimitsUpdatedDetailV2
object
3 properties
3 required
audit_AccountRateLimitsUpdatedLogV2
object
6 properties
5 required
audit_AccountReference
object
1 property
1 required
audit_AccountTypeUpdatedDetailV2
object
3 properties
3 required
audit_AccountTypeUpdatedLogV2
object
6 properties
5 required
audit_AccountWithRolesInfo
object
3 properties
3 required
audit_ActionedBy
object
2 properties
1 required
audit_Alert
object
1 property
1 required
audit_AlertAddedToCaseDetailV2
object
2 properties
2 required
audit_AlertAddedToCaseLogV2
object
6 properties
5 required
audit_AlertMuteForRiskDetailV2
object
4 properties
3 required
audit_AlertMutedForRiskLogV2
object
6 properties
5 required
audit_AlertStateUpdatedDetailV2
object
3 properties
1 required
audit_AlertStateUpdatedLogV2
object
6 properties
5 required
audit_AlertUnmutedForRiskLogV2
object
6 properties
5 required
audit_Assignee
object
1 property
1 required
audit_Case
object
1 property
1 required
audit_CaseAssignedDetailV2
object
4 properties
2 required
audit_CaseAssignedLogV2
object
6 properties
5 required
audit_CaseAuditLogsPageV2
object
6 properties
3 required
audit_CaseCreatedDetailV2
object
3 properties
2 required
audit_CaseCreatedLogV2
object
6 properties
5 required
audit_CaseInfoV2
object
3 properties
3 required
audit_CaseSubjectInfo
object
2 properties
2 required
audit_CaseTransitionedDetailV2
object
4 properties
4 required
audit_CaseTransitionedLogV2
object
6 properties
5 required
audit_ClientReference
object
1 property
1 required
audit_Customer
object
1 property
1 required
audit_CustomerAuditLogsPageV2
object
6 properties
3 required
audit_CustomerConfigurationUpdatedDetailV2
object
3 properties
3 required
audit_CustomerCreatedDetailV2
object
1 property
1 required
audit_CustomerCreatedLogV2
object
6 properties
5 required
audit_CustomerDeletedDetailV2
object
1 property
1 required
audit_CustomerDeletedLogV2
object
6 properties
5 required
audit_CustomerInfoUpdatedDetailV2
object
2 properties
1 required
audit_CustomerInfoUpdatedLogV2
object
6 properties
5 required
audit_CustomerLabelsUpdatedDetailV2
object
3 properties
3 required
audit_CustomerLabelsUpdatedLogV2
object
6 properties
5 required
audit_CustomerMigratedDetailV2
object
2 properties
2 required
audit_CustomerMigratedLogV2
object
6 properties
5 required
audit_CustomerMonitoring
object
2 properties
1 required
audit_CustomerMonitoringConfigurationUpdatedLogV2
object
6 properties
5 required
audit_CustomerProductUpdatedDetailV2
object
3 properties
3 required
audit_CustomerProductUpdatedLogV2
object
6 properties
5 required
audit_CustomerReference
object
2 properties
2 required
audit_CustomerScreenedDetailV2
object
6 properties
4 required
audit_CustomerScreenedLogV2
object
6 properties
5 required
audit_CustomerSegmentsUpdatedDetailV2
object
3 properties
3 required
audit_CustomerSegmentsUpdatedLogV2
object
6 properties
5 required
audit_CustomerStatusUpdatedDetailV2
object
1 property
1 required
audit_CustomerStatusUpdatedLogV2
object
6 properties
5 required
audit_CustomerWithStatus
object
4 properties
3 required
audit_MutedEntity
object
2 properties
2 required
audit_Note
object
4 properties
4 required
audit_NoteCreatedToCaseActionLogV2
object
6 properties
5 required
audit_NoteToCaseActionDetailV2
object
2 properties
2 required
audit_NoteToCaseAlertDetailV2
object
3 properties
3 required
audit_NoteToCaseAlertLogV2
object
6 properties
5 required
audit_NoteToCaseObjectDetailV2
object
2 properties
2 required
audit_NoteToCaseObjectLogV2
object
6 properties
5 required
audit_NoteToCustomerDetailV2
object
2 properties
2 required
audit_NoteToCustomerLogV2
object
6 properties
5 required
audit_NoteToRiskDetailV2
object
3 properties
3 required
audit_NoteToRiskLogV2
object
6 properties
5 required
audit_PaymentScreenedDetailV2
object
3 properties
2 required
audit_PaymentScreenedLogV2
object
6 properties
5 required
audit_ProblemDetailErrorResponse
object
7 properties
2 required
audit_ProductDetail
object
2 properties
2 required
audit_RateLimitOverride
object
2 properties
2 required
audit_RateLimitOverrideSnapshot
object
1 property
1 required
audit_Risk
object
1 property
1 required
audit_RiskCodeMutedForEntityDetailV2
object
3 properties
2 required
audit_RiskCodeUnmutedForEntityLogV2
object
6 properties
5 required
audit_RiskModelReference
object
2 properties
2 required
audit_RiskScore
object
5 properties
2 required
audit_RiskScoreAssignedToCustomerDetailV2
object
5 properties
2 required
audit_RiskScoreAssignedToCustomerLogV2
object
6 properties
5 required
audit_RiskSignalTransitionedDetailV2
object
5 properties
5 required
audit_RiskSignalTransitionedLogV2
object
6 properties
5 required
audit_RiskWithSource
object
2 properties
1 required
audit_RiskWithSourceAndCode
object
3 properties
2 required
audit_RiskWithType
object
2 properties
1 required
audit_RoleArchivedDetail
object
audit_RoleAuditLog
object
6 properties
5 required
audit_RoleAuditLogDetail
object
audit_RoleAuditLogsPage
object
6 properties
3 required
audit_RoleCreatedDetail
object
1 required
audit_RoleDescriptionUpdatedDetail
object
audit_RoleNameUpdatedDetail
object
2 required
audit_RolePermissionsUpdatedDetail
object
2 required
audit_RoleReference
object
1 property
1 required
audit_ScenarioConfiguration
object
2 properties
2 required
audit_ScenarioEvaluations
object
2 properties
2 required
audit_Screening
object
3 properties
1 required
audit_SegmentIdentifier
object
2 properties
2 required
audit_Stage
object
2 properties
2 required
audit_SubjectAddedToCaseDetailV2
object
3 properties
3 required
audit_SubjectAddedToCaseLogV2
object
6 properties
5 required
audit_TransactionAddedToCaseDetailV2
object
2 properties
2 required
audit_TransactionAddedToCaseLogV2
object
6 properties
5 required
audit_TransactionAuditLogsPageV2
object
6 properties
3 required
audit_TransactionMonitoredDetailV2
object
4 properties
4 required
audit_TransactionMonitoredLogV2
object
6 properties
5 required
audit_TransactionReceivedDetailV2
object
1 property
1 required
audit_TransactionReceivedLogV2
object
6 properties
5 required
audit_TransactionReleaseDecisionDetailV2
object
2 properties
2 required
audit_TransactionReleaseDecisionLogV2
object
6 properties
5 required
audit_TransactionWithType
object
2 properties
2 required
audit_UserAccountAssignedDetailV2
object
2 properties
2 required
audit_UserAccountAssignedLogV2
object
6 properties
5 required
audit_UserAccountRemovedDetailV2
object
2 properties
2 required
audit_UserAccountRemovedLogV2
object
6 properties
5 required
audit_UserActivatedDetailV2
object
1 property
1 required
audit_UserActivatedLogV2
object
6 properties
5 required
audit_UserAuditLogsPageV2
object
6 properties
3 required
audit_UserCreatedDetailV2
object
2 properties
2 required
audit_UserCreatedLogV2
object
6 properties
5 required
audit_UserDeactivatedDetailV2
object
1 property
1 required
audit_UserDeactivatedLogV2
object
6 properties
5 required
audit_UserNameUpdatedDetailV2
object
1 property
1 required
audit_UserNameUpdatedLogV2
object
6 properties
5 required
audit_UserReference
object
1 property
1 required
audit_UserRolesUpdatedDetailV2
object
2 properties
2 required
audit_UserRolesUpdatedLogV2
object
6 properties
5 required
audit_UserWithNameInfo
object
3 properties
3 required
audit_VersionedTransaction
object
2 properties
2 required
audit_VersionedTransactionWithType
object
3 properties
3 required
audit_VersionedTransactionWithTypeAndReceivedAt
object
4 properties
4 required
bulk_Batch
object
9 properties
6 required
bulk_BatchErrors
object
3 properties
2 required
bulk_BatchReport
object
1 property
bulk_BatchRequest
object
3 properties
3 required
bulk_BatchStatistics
object
5 properties
5 required
bulk_DeletedBatch
object
1 property
1 required
bulk_ErrorAttributes
object
8 properties
7 required
bulk_FileError
object
2 properties
1 required
bulk_PaginatedResponseBatch
object
6 properties
3 required
bulk_RowError
object
2 properties
2 required
bulk_RowErrorMessage
object
2 properties
1 required
case-management_AlertNoteResponse
object
Note associated to a specific alert.
5 properties
5 required
case-management_AlertsSummary
object
Summary of alerts information, including the highest priority.
2 properties
2 required
case-management_AssignCaseBulkActionPayload
object
2 properties
1 required
case-management_AssignCasesRequest
object
Assign multiple cases (bulk action).
2 properties
2 required
case-management_AssignedCaseResponse
object
Assignee case information.
3 properties
1 required
case-management_BankPaymentSubject
object
Transaction subject as a bank payment.
4 properties
4 required
case-management_BankPaymentSubjectDetail
object
Bank payment subject detail.
1 property
1 required
case-management_BankPaymentSummaryResponse
object
Summary of a Bank Payment.
3 properties
3 required
case-management_BulkActionError
object
An error in a bulk action.
2 properties
2 required
case-management_BulkActionPayloadNote
object
Bulk action for adding a note to Cases.
1 property
1 required
case-management_BulkActionQuery
object
The case to be updated will be those that match the properties in this object.
1 property
1 required
case-management_BulkActionResponse
object
Contains all the results of a bulk action.
1 property
1 required
case-management_BulkActionResult
object
A single result of a bulk action.
3 properties
2 required
case-management_CardPaymentSubject
object
Transaction subject as a card payment.
4 properties
4 required
case-management_CardPaymentSubjectDetail
object
Card payment subject detail.
1 property
1 required
case-management_CardPaymentSummaryResponse
object
Summary of a Card Payment.
3 properties
3 required
case-management_CaseAlertResponseV2
object
Case alert response.
8 properties
7 required
case-management_CaseAssignment
object
Case assignment update request.
1 property
case-management_CaseAssignmentNoteResponse
object
Note associated to a case assignment action.
7 properties
5 required
case-management_CaseCustomerSummaryResponse
object
Customer summary that is associated to a case.
7 properties
5 required
case-management_CaseNoteResponse
object
Note associated to a case.
5 properties
5 required
case-management_CaseResponse
object
Case result detail.
17 properties
11 required
case-management_CaseResultResponse
object
Case result detail for list endpoint.
18 properties
14 required
case-management_CaseStageTransitionRequest
object
Case stage update request.
2 properties
1 required
case-management_CaseStateTransitionRequest
object
Case state update request.
2 properties
1 required
case-management_CaseStatesResponse
object
Case state & type.
2 properties
2 required
case-management_CaseTransitionNoteResponse
object
Note associated to a case state transition action.
7 properties
7 required
case-management_CaseTransitionRequest
object
case-management_CaseTransitionResponse
object
Case transition response.
6 properties
3 required
case-management_CompanySubject
object
Company customer subject.
7 properties
5 required
case-management_CompanySubjectDetail
object
Company customer subject detail.
1 property
1 required
case-management_CounterpartySubject
object
Counterparty subject.
3 properties
2 required
case-management_CreateCaseNoteRequest
object
Create case note request.
1 property
1 required
case-management_CreateCasesNoteRequest
object
Add note to multiple cases (bulk action).
2 properties
2 required
case-management_CryptoPaymentSubject
object
Transaction subject as a crypto payment.
4 properties
4 required
case-management_CryptoPaymentSubjectDetail
object
Crypto payment subject detail.
1 property
1 required
case-management_CryptoPaymentSummaryResponse
object
Summary of a Crypto Payment.
3 properties
3 required
case-management_CustomerSubject
object
Customer subject.
case-management_ExistingStage
object
The existing Stage to be updated or remain unchanged
5 properties
4 required
case-management_NewStage
object
The stage to be created
4 properties
3 required
case-management_NoteResponse
object
Base note model.
5 properties
5 required
case-management_PaginatedResponseAlertNoteResponse
object
6 properties
3 required
case-management_PaginatedResponseCaseAlertResponseV2
object
6 properties
3 required
case-management_PaginatedResponseCaseResponse
object
6 properties
3 required
case-management_PaginatedResponseCaseResultResponse
object
6 properties
3 required
case-management_PaginatedResponseCaseStatesResponse
object
6 properties
3 required
case-management_PaginatedResponseNoteResponse
object
6 properties
3 required
case-management_PaginatedResponseSubjectApi
object
6 properties
3 required
case-management_PaginatedResponseWorkflowResponse
object
6 properties
3 required
case-management_PaymentSummaryResponse
object
Summary of payment information.
case-management_PersonSubject
object
Person customer subject.
7 properties
5 required
case-management_PersonSubjectDetail
object
Person customer subject detail.
1 property
1 required
case-management_ProblemDetailErrorResponse
object
7 properties
2 required
case-management_RemittancePaymentSubject
object
Transaction subject as a remittance payment.
4 properties
4 required
case-management_RemittancePaymentSubjectDetail
object
Remittance payment subject detail.
1 property
1 required
case-management_RemittancePaymentSummaryResponse
object
Summary of a Remittance Payment.
3 properties
3 required
case-management_RiskCatalogResponse
object
Risk catalog response containing catalog key and associated risk types.
2 properties
2 required
case-management_RiskCatalogRiskTypesResponse
object
Risk type.
1 property
1 required
case-management_RiskTypesChildResponse
object
Risk child.
1 property
1 required
case-management_RiskTypesResponse
object
Risk reference.
3 properties
3 required
case-management_Stage
object
Stage
5 properties
4 required
case-management_StageData
object
case-management_Subject
object
Case subject.
1 property
1 required
case-management_SubjectsSummary
object
Summary information about the subjects associated with a case.
1 property
1 required
case-management_TransactionSubject
object
Transaction subject.
case-management_TransitionCaseBulkActionPayload
object
case-management_TransitionCaseStageBulkActionPayload
object
2 properties
1 required
case-management_TransitionCaseStateBulkActionPayload
object
2 properties
1 required
case-management_TransitionCasesRequest
object
Bulk action for case state transition.
2 properties
2 required
case-management_UndefinedSubject
object
Undefined customer subject.
7 properties
5 required
case-management_UndefinedSubjectDetail
object
Undefined customer subject detail.
1 property
1 required
case-management_UpdateWorkflowRequest
object
2 properties
1 required
case-management_VesselSubject
object
Vessel customer subject.
7 properties
5 required
case-management_VesselSubjectDetail
object
Vessel customer subject detail.
1 property
1 required
case-management_WorkflowResponse
object
Workflow
7 properties
6 required
cert_PaginatedResponseReport
object
6 properties
2 required
cert_ProblemDetailErrorResponse
object
7 properties
2 required
cert_Report
object
6 properties
5 required
cert_ReportsRequest
object
1 property
1 required
customer-manager_Address
object
7 properties
customer-manager_Bank
object
1 property
customer-manager_BankAccount
object
customer-manager_Company
object
1 required
customer-manager_CompanyForSearch
object
2 properties
1 required
customer-manager_ContactInformation
object
4 properties
customer-manager_CreateCustomFieldRequest
object
4 properties
4 required
customer-manager_CreateCustomerNoteRequest
object
1 property
1 required
customer-manager_CreateCustomerNoteResponse
object
5 properties
5 required
customer-manager_CryptoWallet
object
customer-manager_CustomField
object
List of custom fields.
5 properties
5 required
customer-manager_CustomFieldDataType
string
The type of data stored in a custom field.
customer-manager_CustomFieldInstance
object
The instance of a custom field as it relates to a specific customer.
2 properties
2 required
customer-manager_CustomFieldValue
object
The value of the custom field.
1 property
1 required
customer-manager_CustomerEntityScreeningMonitoring
object
2 properties
1 required
customer-manager_CustomerEntityScreeningMonitoringApi
object
2 properties
customer-manager_CustomerForSearch
object
11 properties
1 required
customer-manager_CustomerMonitoringData
object
1 property
customer-manager_CustomerMonitoringDataApi
object
1 property
1 required
customer-manager_CustomerTypeUndefined
object
1 required
customer-manager_CustomerV2
object
11 properties
6 required
customer-manager_CustomersList
object
4 properties
4 required
customer-manager_Date
object
3 properties
customer-manager_DateValue
object
Date representation of the custom field value.
2 required
customer-manager_DatetimeValue
object
Datetime representation of the custom field value.
2 required
customer-manager_DecimalValue
object
Decimal representation of the custom field value.
2 required
customer-manager_EntityScreeningStatus
object
1 property
customer-manager_InBranch
object
customer-manager_IndustryCode
object
4 properties
3 required
customer-manager_IndustryCodeForSearch
object
2 properties
1 required
customer-manager_IntegerValue
object
Integer representation of the custom field value.
2 required
customer-manager_LabelV2
object
2 properties
2 required
customer-manager_LongRange
object
2 properties
2 required
customer-manager_MonitorStatus
object
1 property
1 required
customer-manager_NetWorth
object
2 properties
customer-manager_NoteDetails
object
List of customer notes.
9 properties
7 required
customer-manager_OnboardingChannelApi
object
2 properties
customer-manager_Online
object
customer-manager_PaginatedAcquisitionSourcesV2Response
object
6 properties
3 required
customer-manager_PaginatedCustomFieldsResponse
object
6 properties
4 required
customer-manager_PaginatedCustomerLabelsV2Response
object
6 properties
3 required
customer-manager_PaginatedCustomerNotesResponse
object
6 properties
4 required
customer-manager_PaginatedProductsV2Response
object
6 properties
3 required
customer-manager_Person
object
1 required
customer-manager_PersonForSearch
object
7 properties
customer-manager_PersonalIdentification
object
5 properties
customer-manager_ProblemDetailErrorResponse
object
7 properties
2 required
customer-manager_ProductApi
object
10 properties
customer-manager_ResidentialInformation
object
2 properties
customer-manager_RiskScore
object
1 property
1 required
customer-manager_RiskScoreResult
object
1 property
customer-manager_Salary
object
2 properties
customer-manager_TextValue
object
Text representation of the custom field value.
2 required
customer-manager_TransitionCustomerStatusData
object
1 property
1 required
customer-manager_TransitionCustomerStatusRequestBody
object
2 properties
2 required
customer-manager_UndefinedForSearch
object
1 property
1 required
customer-manager_Unit
object
customer-manager_UpdateCustomFieldRequest
object
1 property
1 required
customlist_AddressDTO
object
8 properties
customlist_AuditDTO
object
3 properties
3 required
customlist_CompanyAddDTO
object
4 properties
1 required
customlist_CompanyDTO
object
4 properties
4 required
customlist_CompanyNamesDTO
object
3 properties
1 required
customlist_CustomListAddDTO
object
3 properties
3 required
customlist_CustomListDTO
object
8 properties
7 required
customlist_CustomListPageDTO
object
5 properties
3 required
customlist_EntitiesCountDTO
object
1 property
1 required
customlist_EntityAddDTO
object
6 properties
1 required
customlist_EntityDTO
object
10 properties
4 required
customlist_IdentifierDTO
object
2 properties
2 required
customlist_PersonAddDTO
object
5 properties
1 required
customlist_PersonDTO
object
5 properties
4 required
customlist_PersonNameDTO
object
A name will be considered valid if: - fullname is set and the other fields are not - firstname, middlenames and lastname are set and fullname is not set - firs…
4 properties
customlist_PersonNamesDTO
object
2 properties
1 required
customlist_ProblemDetailErrorResponse
object
7 properties
2 required
customlist_RiskWordAddDTO
object
2 properties
2 required
customlist_RiskWordDTO
object
6 properties
5 required
exports_CreateExportPayload
object
4 properties
2 required
exports_DownloadExportResponseBody
object
1 property
1 required
exports_ExportItem
object
7 properties
5 required
exports_ExportTypeKeys
object
1 property
1 required
exports_PaginatedResponseExportItem
object
6 properties
3 required
exports_PaginatedResponseExportTypeKeys
object
6 properties
3 required
exports_ProblemDetailErrorResponse
object
7 properties
2 required
identity_AccountData
object
8 properties
5 required
identity_AccountSwitchRequestBody
object
1 property
1 required
identity_AccountUserRolesRequestBody
object
2 properties
1 required
identity_AccountUserRolesResponse
object
2 properties
2 required
identity_AccountsResponse
object
6 properties
2 required
identity_AndPermissionDependencyNode
object
An AND compound node — all children must be satisfied.
2 properties
2 required
identity_AnyUserResponse
object
12 properties
10 required
identity_BuiltInRoleResponse
object
4 required
identity_BulkAccountUserRoles
object
List with the result of the operation on each user identifier.
3 properties
2 required
identity_BulkAccountUserRolesError
object
Details for in case it wasn't successful.
2 properties
2 required
identity_BulkAccountUserRolesRequestBody
object
3 properties
2 required
identity_BulkAccountUserRolesResponse
object
1 property
1 required
identity_ClientData
object
10 properties
7 required
identity_CustomRoleResponse
object
9 required
identity_CustomRoleWithPermissionsResponse
object
10 required
identity_DefaultRoleWithPermissionsResponse
object
5 required
identity_ExtendedUserAccountRolesResponse
object
6 properties
2 required
identity_ExtendedUserAccountsRoles
object
List of accounts.
5 properties
5 required
identity_ExtendedUserRole
object
List of roles within the account.
3 properties
1 required
identity_GroupWithPermissionsHttpResponse
object
2 properties
2 required
identity_IdPermissionDependencyNode
object
A leaf node referencing a permission by its identifier.
2 properties
2 required
identity_ListPermissionsResponseItem
object
5 properties
5 required
identity_NoRolesUserData
object
List of users.
12 properties
6 required
identity_NoRolesUsersResponse
object
6 properties
2 required
identity_OrPermissionDependencyNode
object
An OR compound node — at least one child must be satisfied.
2 properties
2 required
identity_OwnUserResponse
object
15 properties
13 required
identity_PaginatedResponseGroupWithPermissionsHttpResponse
object
6 properties
3 required
identity_PaginatedResponseListPermissionsResponseItem
object
6 properties
3 required
identity_PaginatedResponsePermissionWithDepsResponse
object
6 properties
3 required
identity_PaginatedResponseRoleResponse
object
6 properties
3 required
identity_PartialUpdateRoleRequestBody
object
3 properties
identity_PermissionDependencyNode
object
A node in the permission dependency tree.
1 property
1 required
identity_PermissionListResponse
object
2 properties
2 required
identity_PermissionResponse
object
4 properties
4 required
identity_PermissionWithDepsResponse
object
5 properties
5 required
identity_ProblemDetailErrorResponse
object
7 properties
2 required
identity_RoleRequestBody
object
3 properties
3 required
identity_RoleResponse
object
identity_RoleWithPermissionResponse
object
5 properties
5 required
identity_StandardUserRole
object
List of roles within the account.
2 properties
1 required
identity_UserAccountRolesResponse
object
6 properties
2 required
identity_UserAccountsRoles
object
List of accounts.
5 properties
5 required
identity_UserData
object
List of users.
11 properties
6 required
identity_UserPartialUpdateRequestBody
object
3 properties
identity_UserRequestBody
object
2 properties
2 required
identity_UserRole
object
List of roles within the account.
3 properties
1 required
identity_UsersMePartialUpdateRequestBody
object
2 properties
identity_UsersResponse
object
6 properties
2 required
label_CreateLabelsPayload
object
1 property
1 required
label_CreateLabelsResponse
object
1 property
1 required
label_GetLabelsPaginatedResponse
object
6 properties
4 required
label_Label
object
List of labels
6 properties
6 required
label_ProblemDetailErrorResponse
object
7 properties
2 required
label_UpdateLabelRequest
object
1 property
1 required
mes_AvailableSourceFieldFromBlock
object
4 properties
4 required
mes_AvailableSourceFieldFromPath
object
2 properties
2 required
mes_AvailableSourceFieldsResponse
object
List of Available Source Fields
2 properties
2 required
mes_LookupListCreateRequestBody
object
3 properties
3 required
mes_LookupListItemResponse
object
Dynamic lookup list item with field-value pairs
mes_LookupListMappingCreateRequestBody
object
3 properties
3 required
mes_LookupListMappingPatchRequestBody
object
3 properties
mes_LookupListMappingResponse
object
9 properties
7 required
mes_LookupListNoSchemaResponse
object
8 properties
5 required
mes_LookupListSchemaCreateRequestBody
object
2 properties
2 required
mes_LookupListUpdateRequestBody
object
1 property
1 required
mes_LookupListVersionResponse
object
6 properties
4 required
mes_LookupListsResponse
object
10 properties
7 required
mes_OutputField
object
2 properties
2 required
mes_PaginatedResponseLookupListItemResponse
object
6 properties
3 required
mes_PaginatedResponseLookupListMappingResponse
object
6 properties
3 required
mes_PaginatedResponseLookupListNoSchemaResponse
object
6 properties
3 required
mes_PaginatedResponseLookupListVersionResponse
object
6 properties
3 required
mes_ProblemDetailErrorResponse
object
7 properties
2 required
mes_SchemaResponse
object
2 properties
2 required
mes_SourceField
object
2 properties
2 required
mes_VersionResponse
object
2 properties
2 required
ns_AlertingOutput
object
1 property
ns_AlertingStep
object
4 properties
2 required
ns_CaseAlertListUpdatedV2JsonPayload
object
7 properties
6 required
ns_CaseCreatedJsonPayloadV2
object
9 properties
8 required
ns_CaseCreationOutput
object
1 property
ns_CaseCreationStep
object
4 properties
2 required
ns_CaseNote
object
1 property
1 required
ns_CaseStage
object
5 properties
4 required
ns_CaseTransitionedV2JsonPayload
object
10 properties
8 required
ns_Customer
object
3 properties
ns_CustomerCreationOutput
object
2 properties
ns_CustomerCreationStep
object
4 properties
2 required
ns_CustomerRiskScoreDataUpdateV3JsonPayload
object
6 properties
5 required
ns_CustomerScreeningOutput
object
2 properties
ns_CustomerScreeningStep
object
4 properties
2 required
ns_DeletedEmailConfigurationResponse
object
1 property
1 required
ns_EmailConfigurationLog
object
7 properties
6 required
ns_EmailConfigurationPayload
object
2 properties
1 required
ns_EmailTestPayload
object
1 property
1 required
ns_EnabledFor
object
Lists of user and role identifiers the email will be sent to
2 properties
2 required
ns_EvaluationResultV2JsonPayload
object
4 properties
2 required
ns_InitialRiskScoringOutput
object
2 properties
ns_InitialRiskScoringStep
object
4 properties
2 required
ns_PaginatedResponseEmailConfigurationLog
object
6 properties
3 required
ns_PaginatedResponseWebhookConfigurationLog
object
6 properties
3 required
ns_ProblemDetailErrorResponse
object
7 properties
2 required
ns_RiskAttribute
object
4 properties
2 required
ns_RiskCategory
object
5 properties
5 required
ns_RiskScorePayload
object
4 properties
3 required
ns_ScenarioEvaluationV2JsonPayload
object
2 properties
2 required
ns_ScenarioIdentifierV2JsonPayload
object
2 properties
2 required
ns_Subject
object
4 properties
1 required
ns_TestEmailResponse
object
2 properties
2 required
ns_TestEmailResult
object
Response from the SMTP email server on the attempt to send
2 properties
1 required
ns_TestResult
object
2 properties
2 required
ns_TestWebhookResponse
object
2 properties
2 required
ns_TransactionMonitoredV2JsonPayload
object
8 properties
6 required
ns_TransactionReviewedV3JsonPayload
object
7 properties
7 required
ns_UpdateEmailConfigurationPayload
object
1 property
1 required
ns_UpdateWebhookPayload
object
3 properties
ns_UpdatedWebhookConfigurationResponse
object
1 property
1 required
ns_WebhookConfigurationLog
object
8 properties
8 required
ns_WebhookConfigurationPayload
object
4 properties
4 required
ns_WebhookTestPayload
object
1 property
1 required
ns_WorkflowAlert
object
1 property
1 required
ns_WorkflowCompletedV2JsonPayload
object
8 properties
8 required
ns_WorkflowStepDetails
object
5 properties
ol_AccountBalanceV3
object
Represents the balance of a financial account.
2 properties
1 required
ol_AcquirerV3
object
Represents the payment acquirer information.
2 properties
ol_Address
object
7 properties
ol_AddressFormatV3
string
Represents the format of the address used for a party.
ol_AddressTypeV3
string
Represents the type of address.
ol_AddressV3
object
Address of the ATM.
1 property
1 required
ol_AgentRoleV3
string
The roles an agent may take within a financial transaction.
ol_AgentV3
object
Represents an agent in a financial transaction.
7 properties
1 required
ol_AlertStep
object
2 properties
1 required
ol_AlertingStepOutput
object
1 property
1 required
ol_AsyncWorkflowResponse
object
1 property
ol_AtmChannelV3
object
Represents an ATM channel used for transaction processing.
2 required
ol_AuthorizationInfoV3
object
Authorization information.
6 properties
ol_AuthorizationResponseV3
object
Authorization response information.
2 properties
ol_Bank
object
1 property
ol_BankAccount
object
5 properties
ol_BankAccountV3
object
Represent bank account details
3 properties
1 required
ol_BankPaymentMonetaryTransactionTypeDetailsV3
object
Models a transfer of funds from one bank account to another in a different financial institution.
5 required
ol_BankPaymentStateV3
string
The possible states of a bank payment transaction.
ol_BankV3
object
Represents a bank's details.
3 properties
ol_BlockchainNetworkTypeV3
string
Type of the blockchain network used in the transaction.
ol_BlockchainV3
object
Represents a blockchain network used for cryptocurrency transactions.
3 properties
2 required
ol_BooleanEnrichmentValueV3
object
Boolean representation of the enrichment value.
2 required
ol_Caip19IdentifierV3
object
The industry standard CAIP-19 Asset Identifier (http://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-19.md)
2 properties
2 required
ol_Caip2IdentifierV3
object
The industry standard CAIP-2 Identifier for the blockchain (https://chainagnostic.org/CAIPs/caip-2)
2 properties
2 required
ol_CardFundingTypeV3
string
Defines the funding type of a payment card.
ol_CardHolderV3
object
Represents a card holder with party identification details and onboarding information.
1 property
ol_CardPaymentMonetaryTransactionTypeDetailsV3
object
Models a card payment transaction where funds are transferred using a payment card.
1 required
ol_CardPaymentScopeV3
string
Defines the scope of a card payment transaction.
ol_CardPaymentStageV3
string
Defines the stage of a card payment transaction.
ol_CardPaymentTypeV3
string
Defines the type of card payment.
ol_CardSchemeV3
string
Represents the card scheme/network that issued the card.
ol_CardVerificationResultsV3
object
Represents card verification results including CVV, AVS, and identity checks.
3 properties
ol_CardWalletTypeV3
string
Defines the type of digital wallet.
ol_CaseCreationStepOutput
object
1 property
1 required
ol_CashPickupDetailsV3
object
Represents cash pickup details for remittance transactions.
3 properties
ol_ChannelNetworkDetailsV3
object
Contains network-related information for a payment channel.
2 properties
ol_ChannelV3
object
Represents the channel that initiated the transaction.
2 properties
2 required
ol_ChargebackInfoV3
object
Chargeback information.
5 properties
2 required
ol_ClearingIdentifierV3
object
ClearingIdentifier pairs a routing system with its specific value.
2 properties
2 required
ol_Company
object
12 properties
1 required
ol_ConfigurationDTO
object
Optional array specifying sync/async processing configuration for Payment Screening and Transaction Monitoring.
4 properties
3 required
ol_ContactInformation
object
4 properties
ol_CounterpartyPartyIdentifierV3
object
Represents the identification details of a counterparty.
1 required
ol_CreateAndProcessTransactionDTO
object
5 properties
1 required
ol_CreateAndScreenCustomerRequest
object
Create and screen
4 properties
1 required
ol_CryptoAssetV3
object
The asset that was transacted.
2 properties
1 required
ol_CryptoMonetaryTransactionTypeDetailsV3
object
Crypto-specific transaction details.
7 required
ol_CryptoPartyV3
object
Crypto specific Party data structure. Could be counterparty or customer. Follows the model of PartyIdentification type but with additional information.
2 properties
2 required
ol_CryptoWallet
object
2 properties
ol_CryptoWalletV3
object
Represents a cryptocurrency wallet involved in a transaction.
3 properties
2 required
ol_CustomFieldDataType
string
The type of data stored in a custom field.
ol_CustomFieldDataTypeV3
string
The type of data stored in a custom field.
ol_CustomFieldInstance
object
The instance of a custom field as it relates to a specific customer.
2 properties
2 required
ol_CustomFieldV3
object
A representation of a custom field.
2 properties
2 required
ol_CustomFieldValue
object
The value of the custom field.
1 property
1 required
ol_CustomFieldValueV3
object
The value of the custom field.
1 property
1 required
ol_CustomerApi
object
Customer to be created and screened. It can be either a person, a company, a vessel or undefined.
6 properties
ol_CustomerConfigData
object
Represents monitoring and screening configurations.
1 property
ol_CustomerCreationStepOutput
object
2 properties
2 required
ol_CustomerEntityScreeningMonitoring
object
2 properties
1 required
ol_CustomerMonitoringData
object
Represents monitoring configuration.
1 property
ol_CustomerPartyIdentifierV3
object
Represents the identification details of a customer party.
1 required
ol_CustomerScreeningStepOutput
object
2 properties
1 required
ol_CustomerTypeUndefined
object
4 properties
1 required
ol_CustomerUpdateStepOutput
object
3 properties
3 required
ol_Date
object
3 properties
ol_DateValue
object
Date representation of the custom field value.
2 required
ol_DatetimeValue
object
Datetime representation of the custom field value.
2 required
ol_DecimalEnrichmentValueV3
object
Decimal representation of the enrichment value.
2 required
ol_DecimalValue
object
Decimal representation of the custom field value.
2 required
ol_DecimalValueV3
object
Decimal representation of the custom field value.
2 required
ol_DecisionStepOutput
object
1 property
1 required
ol_DeviceChannelV3
object
Represents the device channel used to initiate a transaction.
3 required
ol_EmptyStepOutput
object
ol_EnrichmentDataTypeV3
string
The type of data stored in an enrichment value.
ol_EnrichmentStepOutput
object
1 property
1 required
ol_EnrichmentTypeV3
string
The type of enrichment source.
ol_EnrichmentV3
object
A representation of a transaction enrichment.
3 properties
3 required
ol_EnrichmentValueV3
object
The value of the enrichment.
1 property
1 required
ol_EvaluationErrorDTO
object
Detail on the evaluation error of the scenario if any
2 properties
2 required
ol_EvaluationResultDTO
object
4 properties
3 required
ol_EvaluationResultDeliveryDTO
object
Optional. Specifies how to deliver async evaluation results. Only valid when processingmethod is ASYNCHRONOUS and type is TRANSACTIONMONITORING.
2 properties
2 required
ol_EvaluationResultDeliveryResponseDTO
object
2 properties
2 required
ol_FincenCashTransactionSubtype
string
Defines the subtype of FinCEN transactions.
ol_FincenDetailsV3
object
FinCEN transaction details.
2 properties
ol_FullRiskScoringStepOutput
object
2 properties
2 required
ol_GeographicCoordinatesV3
object
Geographic location represented by the latitude and longitude.
2 properties
2 required
ol_InBranch
object
1 property
ol_IndustryCode
object
4 properties
3 required
ol_InitialRiskScoringStepOutput
object
2 properties
2 required
ol_IntegerValue
object
Integer representation of the custom field value.
2 required
ol_InternetProtocolAddressV3
object
Represents an Internet Protocol (IP) address with its associated type information.
2 properties
2 required
ol_InternetProtocolInformationV3
string
Enumeration for available IP format values.
ol_IssuerV3
object
Represents the card issuer information.
2 properties
ol_LoanProductV3
object
Represents a loan product.
4 required
ol_LoanTypeV3
string
Defines the type of loan.
ol_LocalAccountDetailsV3
object
Represents banking information for 'domestic rail' transactions where a global standard like IBAN is not used.
3 properties
2 required
ol_LongRange
object
2 properties
2 required
ol_MerchantV3
object
Represents merchant information.
4 properties
ol_MonetaryTransactionClassificationDetailsV3
object
Details related to a monetary transaction.
3 required
ol_MonetaryTransactionDirectionV3
string
Defines the direction of the flow of value in the transaction in relation to the primary Customer in a Monetary Transaction.
ol_MonetaryTransactionTypeDetailsV3
object
Details specific to the a Monetary Transaction.
1 property
1 required
ol_MonetaryTransactionTypeV3
string
Defines the type of a monetary transaction.
ol_MonetaryValueV3
object
Represents a combination of a decimal amount with a currency.
3 properties
1 required
ol_MoneyTransferOperatorV3
object
Represents a money transfer operator's details.
2 properties
ol_NetWorth
object
2 properties
ol_OnboardingChannelApi
object
2 properties
ol_Online
object
4 properties
ol_OnlineRemittancePlatformV3
object
Represents an online remittance platform's details.
2 properties
ol_PartyIdentificationV3
object
Represents the identification details of a party. This includes not just the party's identifier, but also any other identifying information specific to the tra…
3 properties
ol_PartyIdentifierV3
object
Party identifier details
1 property
1 required
ol_PaymentCardV3
object
Details about a payment card used in a transaction.
4 properties
1 required
ol_PaymentChannelV3
string
The channel used for a payment.
ol_PaymentSchemeV3
string
The payment scheme that was used to initiate the financial transaction.
ol_PaymentStagesInfoV3
object
Payment stages information.
5 properties
ol_Person
object
23 properties
1 required
ol_PersonalIdentification
object
5 properties
ol_PointOfSaleConditionCodeV3
object
Point of sale condition code and description
2 properties
ol_PointOfSaleConditionV3
object
Contains contextual information about the card payment environment.
2 properties
ol_PointOfSaleEntryModeV3
object
Point of sale entry mode code and description
2 properties
ol_ProblemDetailErrorResponse
object
7 properties
2 required
ol_ProductApi
object
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…
10 properties
ol_ProductTypeV3
string
Defines the type of product payload.
ol_ProductV3
object
Represents product details associated with a transaction.
7 properties
3 required
ol_RefundInfoV3
object
Refund information.
2 properties
1 required
ol_RefundReasonV3
object
Refund reason information.
2 properties
ol_RegulatoryReportDetailsV3
object
Regulatory reporting transaction details.
2 properties
ol_RemittanceCreditorV3
object
Represents the creditor in a remittance transaction.
2 properties
1 required
ol_RemittanceMonetaryTransactionTypeDetailsV3
object
Models a cross-border remittance payment transaction between parties in different countries.
3 required
ol_RemittancePaymentMethodV3
string
The payment method used for remittance transactions.
ol_RemittancePurposeV3
string
The purpose of the remittance payment.
ol_RemittanceRelationshipV3
string
The relationship between the sender and receiver in a remittance transaction.
ol_RemittanceServiceProviderTypeV3
string
The type of service provider facilitating the remittance transaction.
ol_RemittanceServiceProviderV3
object
Represents a remittance service provider's details.
3 properties
ol_RemittanceSourceOfFundsV3
string
The source of funds for the remittance transaction.
ol_ResidentialInformation
object
2 properties
ol_ReversalInfoV3
object
Reversal information.
3 properties
2 required
ol_Salary
object
2 properties
ol_ScenarioConfigurationEvaluationDTO
object
5 properties
4 required
ol_ScenarioEvaluationDTO
object
5 properties
2 required
ol_ScreeningResult
object
ol_SettlementInfoV3
object
Settlement information.
2 properties
2 required
ol_StepDetails
object
4 properties
1 required
ol_StepOutput
object
ol_StoredActivityStepOutput
object
1 property
1 required
ol_StructuredAddressV3
object
Represents a structured address with detailed components.
1 required
ol_TextEnrichmentValueV3
object
String representation of the enrichment value.
2 required
ol_TextValue
object
Text representation of the custom field value.
2 required
ol_TextValueV3
object
String representation of the custom field value.
2 required
ol_TransactionClassificationDetailsV3
object
Details specific to the Transaction classification.
1 property
1 required
ol_TransactionClassificationV3
string
Classifies a transaction as a specific high-level class of transaction.
ol_TransactionIdentifierDTO
object
1 property
1 required
ol_TransactionResponseDTO
object
2 properties
2 required
ol_TransactionScreeningEvaluationDTO
object
4 properties
3 required
ol_TransactionV3
object
Represents a Transaction performed by a Customer. A Transaction can be either monetary or non-monetary.
15 properties
8 required
ol_UnstructuredAddressV3
object
Represents an unstructured address with local details and country.
1 required
ol_UpdateAndRescoreCustomerRequest
object
Update and re-score customer synchronously
2 properties
1 required
ol_UpdateCustomerApi
object
Customer to be updated and re-scored. It can be either a person, a company, a vessel or undefined.
5 properties
ol_VerificationCheckResultV3
string
Represents the result of a verification check.
ol_VerificationCheckV3
object
Represents a verification check with result and optional description.
2 properties
ol_VirtualAssetServiceProviderV3
object
Type for storing VASP details.
1 property
1 required
ol_WorkflowState
object
5 properties
5 required
ps_Associate
object
Associated party linked to the matched profile.
2 properties
2 required
ps_AttributeValue
object
Single structured attribute value derived from a provider field.
2 properties
1 required
ps_BicMatch
object
Detailed BIC match information returned by the provider.
3 properties
3 required
ps_BicSettings
object
2 properties
ps_BulkRiskStatusUpdateRequest
object
2 properties
2 required
ps_BulkRiskStatusUpdateResponse
object
1 property
1 required
ps_Configuration
object
3 properties
2 required
ps_ConfigurationDetail
object
7 properties
7 required
ps_ConfigurationSummariesResponse
object
1 property
1 required
ps_ConfigurationSummary
object
6 properties
6 required
ps_ConfigurationVersion
object
4 properties
4 required
ps_ConfigurationVersions
object
3 properties
3 required
ps_CreateConfigurationRequest
object
1 property
1 required
ps_CreateConfigurationResponse
object
5 properties
5 required
ps_ItemError
object
Describes a single reason why a risk status update failed.
2 properties
2 required
ps_Match
object
Transparency information about the provider match.
4 properties
ps_MatchDetail
object
Detailed match explanation for a single provider hit.
7 properties
ps_MatchTerm
object
Matched term returned for name screening transparency.
2 properties
2 required
ps_MatcherDetail
object
Matcher-specific detail payload for a risk.
2 properties
2 required
ps_NameSettings
object
3 properties
ps_ProblemDetailErrorResponse
object
7 properties
2 required
ps_Profile
object
Matched profile returned by the screening provider.
11 properties
10 required
ps_ProfileAttributes
object
Structured attributes derived from provider profile fields.
5 properties
5 required
ps_ProfileField
object
Raw provider field preserved for transparency.
4 properties
1 required
ps_ProviderDetail
object
Provider-specific detail payload for a risk.
ps_ReferenceTextSettings
object
2 properties
ps_Risk
object
Single payment screening risk entry.
7 properties
6 required
ps_RiskDetail
object
Provider-agnostic detail for a payment screening risk.
6 properties
5 required
ps_RiskResponse
object
Paginated response envelope for transaction risk results.
6 properties
3 required
ps_RiskStatusUpdateResult
object
One entry per distinct requested identifier, in request order
3 properties
2 required
ps_ScreenedEntityInfo
object
Information about the screened entity that produced the risk.
2 properties
1 required
ps_ScreeningContext
object
Context surrounding the screening operation that produced the risk.
4 properties
4 required
ps_SingleStatusUpdateRequest
object
1 property
1 required
ps_SingleStatusUpdateResponse
object
3 properties
3 required
ps_SourceCollection
object
6 properties
3 required
ps_SourceNote
object
Per-source note attached to the matched profile.
8 properties
4 required
ps_TextMatchTerm
object
Matched text fragment for text screening results.
5 properties
4 required
ps_UpdateConfigurationRequest
object
3 properties
3 required
ps_UpdateConfigurationResponse
object
7 properties
7 required
reg_AddressWithUnknowns
object
Address with unknown flags. When an unknown flag is true, the corresponding field must be null.
10 properties
reg_AlternateName
object
An alternate name entry.
2 properties
reg_BranchAddress
object
Branch address.
5 properties
1 required
reg_BranchItem
object
A single branch item.
3 properties
3 required
reg_BulkCreateFinancialInstitutionRequest
object
Bulk create/update request for SAR financial institutions and branches.
2 properties
reg_BulkCreateResponse
object
Response for a bulk create/update operation.
2 properties
2 required
reg_BulkCreateResult
object
Result for a single item in the bulk operation.
5 properties
2 required
reg_BulkCreateSummary
object
Aggregated counts for the bulk operation.
3 properties
3 required
reg_BulkCreateTransactionLocationRequest
object
Bulk create/update request for CTR transaction locations.
1 property
1 required
reg_BulkDeleteRequest
object
Bulk delete request for CTR transaction locations.
1 property
1 required
reg_BulkDeleteResponse
object
Response for a bulk delete operation.
2 properties
2 required
reg_BulkDeleteResult
object
Result for a single item in the bulk delete operation.
4 properties
2 required
reg_BulkDeleteSummary
object
Aggregated counts for the bulk delete operation.
3 properties
3 required
reg_CasinoCardClubSubType
object
Casino or card club sub-type.
2 properties
reg_Classification
object
Institution classification. subtype is required when type is CASINOORCARDCLUB. othertype is required when type is OTHERCLASSIFICATION.
3 properties
1 required
reg_Ein
object
Employer Identification Number. Provide value (9-digit numeric string) or set isunknown to true.
2 properties
reg_FinancialInstitutionClassification
object
SAR financial institution classification. subtype is required when type is CASINOORCARDCLUB. subtypes is required when type is SECURITIESORFUTURES. othertype i…
4 properties
1 required
reg_FinancialInstitutionItem
object
A single financial institution or agent item.
3 properties
2 required
reg_InstitutionAddress
object
Institution address.
5 properties
5 required
reg_InstitutionIdentification
object
Optional institution identification. When type is provided, value is required.
2 properties
reg_PrefillFinancialInstitution
object
FinCEN SAR financial institution prefill data.
7 properties
5 required
reg_PrefillFinancialInstitutionBranch
object
SAR financial institution branch data.
2 properties
1 required
reg_PrefillTransactionLocation
object
FinCEN CTR transaction location prefill data.
7 properties
5 required
reg_SarBulkDeleteItemResult
object
Result for a single item in a SAR bulk delete operation.
4 properties
2 required
reg_SarBulkDeleteResults
object
Per-item results for a SAR bulk delete operation, split by record type.
2 properties
2 required
reg_SarBulkDeleteSummary
object
Aggregated counts for a SAR bulk delete operation.
3 properties
3 required
reg_SarFinancialInstitutionBulkDeleteRequest
object
Bulk delete request for SAR financial institutions, agents, and branches.
2 properties
2 required
reg_SarFinancialInstitutionBulkDeleteResponse
object
Response for a SAR financial institution bulk delete operation.
2 properties
2 required
reg_SarInstitutionIdentification
object
Optional institution identification. When type is provided, value is required.
2 properties
reg_SecuritiesFuturesSubTypes
object
Securities or futures sub-types. Required when classification type is SECURITIESORFUTURES.
1 property
reg_TinWithUnknown
object
Taxpayer Identification Number with type.
2 properties
1 required
reg_TransactionLocationItem
object
A single transaction location item in a bulk request.
2 properties
2 required
reg_ValidationError
object
Validation error for a specific field.
3 properties
2 required
reg_ValidationErrorReason
object
Reason for a validation failure.
3 properties
3 required
risk-scoring_CategoryResult
object
5 properties
5 required
risk-scoring_Field
object
3 properties
3 required
risk-scoring_ListField
object
3 required
risk-scoring_OverallResult
object
2 properties
2 required
risk-scoring_OverallResultRequest
object
1 property
1 required
risk-scoring_ProblemDetailErrorResponse
object
7 properties
2 required
risk-scoring_RiskScore
object
12 properties
10 required
risk-scoring_RiskScoreOverrideRequest
object
3 properties
1 required
risk-scoring_ValueField
object
3 required
search_AccountBalanceV3
object
Represents the balance of a financial account.
2 properties
1 required
search_AcquirerV3
object
Represents the payment acquirer information.
2 properties
search_AddressFormatV3
string
Represents the format of the address used for a party.
search_AddressTypeV3
string
Represents the type of address.
search_AddressV3
object
Address of the ATM.
1 property
1 required
search_AgentRoleV3
string
The roles an agent may take within a financial transaction.
search_AgentV3
object
Represents an agent in a financial transaction.
7 properties
1 required
search_AtmChannelV3
object
Represents an ATM channel used for transaction processing.
2 required
search_AuthorizationInfoV3
object
Authorization information.
6 properties
search_AuthorizationResponseV3
object
Authorization response information.
2 properties
search_BankAccountV3
object
Represent bank account details
3 properties
1 required
search_BankPaymentMonetaryTransactionTypeDetailsV3
object
Models a transfer of funds from one bank account to another in a different financial institution.
5 required
search_BankPaymentStateV3
string
The possible states of a bank payment transaction.
search_BankV3
object
Represents a bank's details.
3 properties
search_BlockchainNetworkTypeV3
string
Type of the blockchain network used in the transaction.
search_BlockchainV3
object
Represents a blockchain network used for cryptocurrency transactions.
3 properties
2 required
search_BooleanEnrichmentValueV3
object
Boolean representation of the enrichment value.
2 required
search_Caip19IdentifierV3
object
The industry standard CAIP-19 Asset Identifier (http://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-19.md)
2 properties
2 required
search_Caip2IdentifierV3
object
The industry standard CAIP-2 Identifier for the blockchain (https://chainagnostic.org/CAIPs/caip-2)
2 properties
2 required
search_CardFundingTypeV3
string
Defines the funding type of a payment card.
search_CardHolderV3
object
Represents a card holder with party identification details and onboarding information.
1 property
search_CardPaymentMonetaryTransactionTypeDetailsV3
object
Models a card payment transaction where funds are transferred using a payment card.
1 required
search_CardPaymentScopeV3
string
Defines the scope of a card payment transaction.
search_CardPaymentStageV3
string
Defines the stage of a card payment transaction.
search_CardPaymentTypeV3
string
Defines the type of card payment.
search_CardSchemeV3
string
Represents the card scheme/network that issued the card.
search_CardVerificationResultsV3
object
Represents card verification results including CVV, AVS, and identity checks.
3 properties
search_CardWalletTypeV3
string
Defines the type of digital wallet.
search_CashPickupDetailsV3
object
Represents cash pickup details for remittance transactions.
3 properties
search_ChannelNetworkDetailsV3
object
Contains network-related information for a payment channel.
2 properties
search_ChannelV3
object
Represents the channel that initiated the transaction.
2 properties
2 required
search_ChargebackInfoV3
object
Chargeback information.
5 properties
2 required
search_ClearingIdentifierV3
object
ClearingIdentifier pairs a routing system with its specific value.
2 properties
2 required
search_CounterpartyPartyIdentifierV3
object
Represents the identification details of a counterparty.
1 required
search_CryptoAssetV3
object
The asset that was transacted.
2 properties
1 required
search_CryptoMonetaryTransactionTypeDetailsV3
object
Crypto-specific transaction details.
7 required
search_CryptoPartyV3
object
Crypto specific Party data structure. Could be counterparty or customer. Follows the model of PartyIdentification type but with additional information.
2 properties
2 required
search_CryptoWalletV3
object
Represents a cryptocurrency wallet involved in a transaction.
3 properties
2 required
search_CustomFieldDataTypeV3
string
The type of data stored in a custom field.
search_CustomFieldV3
object
A representation of a custom field.
2 properties
2 required
search_CustomFieldValueV3
object
The value of the custom field.
1 property
1 required
search_CustomerPartyIdentifierV3
object
Represents the identification details of a customer party.
1 required
search_DecimalEnrichmentValueV3
object
Decimal representation of the enrichment value.
2 required
search_DecimalValueV3
object
Decimal representation of the custom field value.
2 required
search_DeviceChannelV3
object
Represents the device channel used to initiate a transaction.
3 required
search_EnrichmentDataTypeV3
string
The type of data stored in an enrichment value.
search_EnrichmentTypeV3
string
The type of enrichment source.
search_EnrichmentV3
object
A representation of a transaction enrichment.
3 properties
3 required
search_EnrichmentValueV3
object
The value of the enrichment.
1 property
1 required
search_FincenCashTransactionSubtype
string
Defines the subtype of FinCEN transactions.
search_FincenDetailsV3
object
FinCEN transaction details.
2 properties
search_GeographicCoordinatesV3
object
Geographic location represented by the latitude and longitude.
2 properties
2 required
search_InternetProtocolAddressV3
object
Represents an Internet Protocol (IP) address with its associated type information.
2 properties
2 required
search_InternetProtocolInformationV3
string
Enumeration for available IP format values.
search_IssuerV3
object
Represents the card issuer information.
2 properties
search_LoanProductV3
object
Represents a loan product.
4 required
search_LoanTypeV3
string
Defines the type of loan.
search_LocalAccountDetailsV3
object
Represents banking information for 'domestic rail' transactions where a global standard like IBAN is not used.
3 properties
2 required
search_MerchantV3
object
Represents merchant information.
4 properties
search_MonetaryTransactionClassificationDetailsV3
object
Details related to a monetary transaction.
3 required
search_MonetaryTransactionDirectionV3
string
Defines the direction of the flow of value in the transaction in relation to the primary Customer in a Monetary Transaction.
search_MonetaryTransactionTypeDetailsV3
object
Details specific to the a Monetary Transaction.
1 property
1 required
search_MonetaryTransactionTypeV3
string
Defines the type of a monetary transaction.
search_MonetaryValueV3
object
Represents a combination of a decimal amount with a currency.
3 properties
1 required
search_MoneyTransferOperatorV3
object
Represents a money transfer operator's details.
2 properties
search_OnlineRemittancePlatformV3
object
Represents an online remittance platform's details.
2 properties
search_PaginatedResponseTransactionV3
object
6 properties
3 required
search_PartyIdentificationV3
object
Represents the identification details of a party. This includes not just the party's identifier, but also any other identifying information specific to the tra…
3 properties
search_PartyIdentifierV3
object
Party identifier details
1 property
1 required
search_PaymentCardV3
object
Details about a payment card used in a transaction.
4 properties
1 required
search_PaymentChannelV3
string
The channel used for a payment.
search_PaymentSchemeV3
string
The payment scheme that was used to initiate the financial transaction.
search_PaymentStagesInfoV3
object
Payment stages information.
5 properties
search_PointOfSaleConditionCodeV3
object
Point of sale condition code and description
2 properties
search_PointOfSaleConditionV3
object
Contains contextual information about the card payment environment.
2 properties
search_PointOfSaleEntryModeV3
object
Point of sale entry mode code and description
2 properties
search_ProductTypeV3
string
Defines the type of product payload.
search_ProductV3
object
Represents product details associated with a transaction.
7 properties
3 required
search_RefundInfoV3
object
Refund information.
2 properties
1 required
search_RefundReasonV3
object
Refund reason information.
2 properties
search_RegulatoryReportDetailsV3
object
Regulatory reporting transaction details.
1 property
search_RemittanceCreditorV3
object
Represents the creditor in a remittance transaction.
2 properties
1 required
search_RemittanceMonetaryTransactionTypeDetailsV3
object
Models a cross-border remittance payment transaction between parties in different countries.
3 required
search_RemittancePaymentMethodV3
string
The payment method used for remittance transactions.
search_RemittancePurposeV3
string
The purpose of the remittance payment.
search_RemittanceRelationshipV3
string
The relationship between the sender and receiver in a remittance transaction.
search_RemittanceServiceProviderTypeV3
string
The type of service provider facilitating the remittance transaction.
search_RemittanceServiceProviderV3
object
Represents a remittance service provider's details.
3 properties
search_RemittanceSourceOfFundsV3
string
The source of funds for the remittance transaction.
search_ReversalInfoV3
object
Reversal information.
3 properties
2 required
search_SettlementInfoV3
object
Settlement information.
2 properties
2 required
search_StructuredAddressV3
object
Represents a structured address with detailed components.
1 required
search_TextEnrichmentValueV3
object
String representation of the enrichment value.
2 required
search_TextValueV3
object
String representation of the custom field value.
2 required
search_TransactionClassificationDetailsV3
object
Details specific to the Transaction classification.
1 property
1 required
search_TransactionClassificationV3
string
Classifies a transaction as a specific high-level class of transaction.
search_TransactionV3
object
Represents a Transaction performed by a Customer. A Transaction can be either monetary or non-monetary.
15 properties
8 required
search_UnstructuredAddressV3
object
Represents an unstructured address with local details and country.
1 required
search_VerificationCheckResultV3
string
Represents the result of a verification check.
search_VerificationCheckV3
object
Represents a verification check with result and optional description.
2 properties
search_VirtualAssetServiceProviderV3
object
Type for storing VASP details.
1 property
1 required
sra_AddedMentions
object
Added mention for a risk
3 properties
sra_Aircraft
object
Identity information of the profile.
2 properties
sra_Associate
object
Associate
2 properties
sra_Collection
object
Object containing the collection of screening parameters. A collection can either contain ComplyAdvantage sources or custom lists.
7 properties
6 required
sra_Company
object
Identity information of the profile.
3 properties
sra_Configuration
object
Object containing a screening configuration with multiple collections.
7 properties
6 required
sra_CreateConfigurationRequest
object
Create configuration request containing a change reason and a screening configuration with multiple collections.
2 properties
sra_DateOfBirth
object
Date of birth
2 properties
sra_DateOfDeath
object
Date of death
2 properties
sra_Field
object
Information associated with a source.
3 properties
sra_GetNotesResponse
object
A paginated collection of notes
6 properties
sra_Image
object
Image
2 properties
sra_ListConfigurationVersionsResponse
object
The response object containing a list of configuration versions.
1 property
sra_ListConfigurationsResponse
object
The response object containing a list of screening configurations.
1 property
sra_ListRiskV1Response
object
6 properties
sra_Media
object
Risk identified in media.
5 properties
sra_Name
object
Name
2 properties
sra_PepSource
object
Risks identified from PEP lists.
14 properties
sra_Person
object
Identity information of the profile.
7 properties
sra_PlaceOfBirth
object
Place of birth
2 properties
sra_PostNoteRequest
object
Object containing new note content
1 property
1 required
sra_ProblemDetailErrorResponse
object
7 properties
sra_Profile
object
A list of entity screening risks associated with the alert.
9 properties
sra_Risk
object
Object containing risk information.
8 properties
sra_RiskDetail
object
Detail of the risk.
4 properties
sra_RiskIndicators
object
Risks associated with the profile.
5 properties
sra_ScreeningConfiguration
object
The response schema for a screening configuration.
6 properties
sra_ScreeningConfigurationVersion
object
The list of configuration versions.
5 properties
sra_ScreeningNoteResponse
object
Object containing note information
5 properties
sra_Source
object
Risks identified from sanction or watch lists.
9 properties
sra_UpdateConfigurationRequest
object
Update configuration request containing a change reason and a screening configuration with multiple collections.
2 properties
sra_Vessel
object
Identity information of the profile.
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from ComplyAdvantage 4
Other APIs ComplyAdvantage publishes across the network.
ComplyAdvantage Case Management API
ComplyAdvantage Monitored Searches API
ComplyAdvantage Searches API
ComplyAdvantage Users API
#Customer Screening#Transaction Monitoring#Fraud Detection#Cases
Where this information came from
This is an independent, third-party profile of ComplyAdvantage Mesh Platform API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.