API Reference

Alert - Create

Authentication

x-api-keystring
API Key authentication via header

Request

This endpoint expects an object.
alertIdstringRequired
createdTimestampdoubleRequired1262300400000-4133890801000
caseIdstringRequired
priorityenumRequired
Allowed values:
ruleDetailsobjectRequired
tagslist of objectsOptional
creationReasonobjectOptional
entityDetailsobjectOptional
assignmentslist of objectsOptional

Response

OK
createdTimestampdouble
ruleInstanceIdstring
ruleNamestring
ruleDescriptionstring
ruleActionenum
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
Allowed values:
numberOfTransactionsHitinteger
priorityenum
Allowed values:
_idinteger or null
alertIdstring or null
parentAlertIdstring or null
availableAfterTimestampdouble or null
latestTransactionArrivalTimestampdouble or null
caseIdstring or null
alertStatusenum or null
assignmentslist of objects or null
reviewAssignmentslist of objects or null
creationReasonobject or null
createdTimestampInternaldouble or null
tagslist of objects or null
ruleIdstring or null
ruleNatureenum or null
Allowed values:
ruleHitMetaobject or null
Details of rule execution, for internal purposes only
ruleQueueIdstring or null
statusChangeslist of objects or null
lastStatusChangeobject or null
updatedAtdouble or null
transactionIdslist of strings or null
originPaymentMethodslist of enums or null
destinationPaymentMethodslist of enums or null
commentslist of objects or null
ruleQaStatusenum or null
Allowed values:
ruleChecklistlist of objects or null
ruleChecklistTemplateIdstring or null
qaAssignmentlist of objects or null
slaPolicyDetailslist of objects or null
caseCreatedTimestampdouble or null
caseSubjectIdentifierslist of strings or null
alertMetaobject or null

Errors