example-1

Rule - List

name

Rule - Get

Rule Instance - List

Rule Instance - Create

Rule Instance - Update

Rule Instance - Delete

Rule Filters Schema - Get

Case - List

Case - Create

Case - Get

Case - Update

Case - Update Status

Alert - Create

Alert - Get

Alert - Update

Retrieve Alert Comments

Create an Alert Comment

Retrieve an Alert Comment

Delete an Alert Comment

Alert - Update Status

File size should be less than 100000000 bytes

Get a pre-signed URL

Retrieve User Comments

Create a User Comment

Retrieve a User Comment

Delete a User Comment

ACHDetails

Additional information that can be added via tags

ACHPaymentMethod

AcquisitionChannel

ActionReason

Address

Address lines of the user's residence address

Post code of the user's residence address

Alert

AlertBase

AlertClosedDetails

AlertCreationRequestEntityDetails

AlertDerived

AlertEntityDetails

AlertOpenedDetails

AlertRuleDetails

AlertUpdatableEntityDetails

Amount

ApiErrorResponse

Assignment

BooleanString

Business

Shareholders (beneficiaries) of the company that hold at least 25% ownership. Can be another company or an individual

Director(s) of the company. Must be at least one

BusinessBase

Model for a business user - optional fields

BusinessOptional

BusinessOptionalSavedPaymentDetailsItem

BusinessSavedPaymentDetailsItem

BusinessUserEvent

Model for business user risk score response

BusinessUserMonitoringResult

BusinessUserSegment

BusinessWithRulesResult

BusinessWithRulesResultSavedPaymentDetailsItem

CardBrand

CardDetails

Unique card fingerprint that helps identify a specific card without having to use explicit card number. This is likely available at your card payment scheme provider

Whether 3ds was successfully enforced for the transaction

Risk score of the card from your network provider

CardExpiry

CardFunding

CardMerchantDetails

CardPaymentMethod

CardStatus

CardType

Case

CaseBase

CaseClosedDetails

CaseCreationRequestEntityDetails

CaseDerived

CaseEntityDetails

CaseManagementEvent

Case status reason. E.g. Closed & False Positive, Closed & Investigation Completed etc.

CaseManagementEventCaseStatus

CaseManagementEventCaseStatusReason

CaseOpenedDetails

CaseReasons

CaseUpdateableEntityDetails

CasesListResponse

CheckDeliveryStatus

CheckDetails

CheckPaymentMethod

CommentRequest

CommentResponse

Model for business user company financial details

CompanyFinancialDetails

Model for business user company general details

CompanyGeneralDetails

The industry in which the business operates for a business customer

The key products and services provided by the company

Model for business user company registration details

CompanyRegistrationDetails

Commercial registry registration number for the company in its registration country

Type of legal entity, e.g., Limited Liability

ConsumerName

ConsumerUserEvent

Model for consumer user risk score response

ConsumerUserMonitoringResult

ConsumerUserSegment

Model for business user contact information details

ContactDetails

Email addresses of the contacts for a given business customer

Phone numbers to contact a given business customer

Fax numbers to contact a business customer

CountryCode

CurrencyCode

Date

DeviceData

Battery level of the device used for a transaction or event at a given timestamp

Device latitude at a give timestamp for an event or transaction

Device longitude at a give timestamp for an event or transaction

IP address of the device at a given timestamp for an event or transaction

Whether VPN was used at a given timestamp for an event or transaction

Operating system of the device at a given timestamp for an event or transaction

The maker of the device at a given timestamp for an event or transaction

The model of the device at a given timestamp for an event or transaction

The year the device was manufactured at a given timestamp for an event or transaction

The version of the app your user is using on their device at a given timestamp for an event or transaction

EmailId

EmploymentStatus

ErrorMessage

ExecutedRuleVars

ExecutedRulesResult

ExpectedIncome

ExternalRequestCaseStatus

Model for list of rules failed execution. It means rules could not be run

FailedRulesResult

FalsePositiveDetails

Gender of the individual - Male, Female or Non-Binary

Gender

GeneralBankAccountPaymentMethod

GenericBankAccountDetails

Bank account type. E.g. Checking, Savings etc.

Unique identifier of the bank. In some countries, this can be the same as the bank's SWIFT code

Special instructions to be specified if any

GetCasesRequestFilterCaseSourceItem

GetCasesRequestSortBy

GetCasesRequestSortOrder

HitRulesDetails

IBANDetails

Identifier for the bank. Can be routing number, BIK number, SWIFT code, BIC number etc.

Account number of the user. Can be account number, IBAN number etc.

Branch code of the bank. In some countries, this can be the same as the bank's SWIFT code

IBANPaymentMethod

KYCStatus

KYCStatusDetails

KycStatusDetailsInternal

LegalDocument model generalizes User's identity document type (ex: Passport)

LegalDocument

User's identity document type such as passport, national ID etc.

User's unique identity document number such as passport number

User's identity document issuance date (UNIX timestamp in milliseconds)

User's identity document expiration date (UNIX timestamp in milliseconds)

Model for business user legal entity details

LegalEntity

ListData

ListExisted

ListHeader

ListItem

ListKeyMetadata

ListMetadata

ListSubtype

ListType

MCCDetails

MpesaDetails

MpesaPaymentMethod

MpesaTransactionType

PEPStatus

POSDetails

POSEntryMode

PaymentEntityDetails

PaymentEntityDetailsPaymentDetails

PaymentMethod

Model for a generic individual - different from User model by not having userId field

Person

User's legal identity documents - See Document Model for details

PlaceOfBirth

PostAlertsAlertIdStatusesResponse

PostCasesCaseIdStatusesResponse

PresignedUrlResponse

Fields to be used in the form-data request

PresignedUrlResponseFields

Priority

RequestFileInfo

ResponseFileInfo

RiskLevel

RiskLevelRuleActions

RiskLevelRuleParameters

RiskLevelsTriggersOnHit

Rule

Model for rule action if a rule is hit. This is returned in the API response and can be configured on Console by operational accounts like a Compliance Analyst

Delete a User Comment

DELETE User Comment

Path parameters

Errors

1	curl -X DELETE https://sandbox.api.flagright.com/management/users/userId/comments/commentId \
2	-H "x-api-key: <apiKey>"