> ## Documentation Index > Fetch the complete documentation index at: https://docs.frankieone.com/llms.txt > Use this file to discover all available pages before exploring further. # Fetch all alerts > List all alerts from previously checked activities. ## OpenAPI ````yaml /specs/KYT-V2-Transaction-Monitoring.json get /alerts openapi: 3.0.3 info: version: 2.0.0 title: KYT V2 Transaction Monitoring description: > The Fraud and Transaction Monitoring API is designed to accept the full details of a transaction, process it, and provide recommendations. The API can analyse the details by comparing them against past history and other data, and run all of these through a set of sophisticated rules. Afterwards, you can get a recommendation as to whether a transaction should be allowed to proceed, proceed with a warning, be held for investigation, or be rejected, outright. The service is designed to respond in realtime to support modern, high-speed, high-volume financial transaction services. **We also hold open the option of accepting existing message formats and we will transform those in real time, mapping the details to our own internal structure for a consistent experience and results.** Please speak with your FrankieOne account manager should you wish us to assist with this. Access to the API and keys available on request. ## Glossary **Check** - A transaction assessment that execute against the API, this represents an event that has happened and wants to verified for risk. **Result** - A categorized risk factor returned for a transaction check, these are returned from the configured upstream vendors and represent the different factors of the transaction's risk profile. **Transaction** - An activity that an end user has performed, the type of the activity is based on the activityType property. **Alert** - A result that has come from a transaction check that meets the criteria defined for your configuration. This represents a result that was returned that requires the attention of someone in your organization. **Entity** - A FrankieOne entity, this can be representative of a business, person or construct that exists within the FrankieOne Platform. contact: email: help@frankieone.com servers: - url: https://api.kycaml.frankiefinancial.io/transaction/v2 description: Production API Base URL - url: https://api.kycaml.uat.frankiefinancial.io/transaction/v2 description: UAT Environment API Base URL security: - apiKey: [] tags: - name: Status description: >- Service status operations you can use to make sure things are up and running. - name: Transactions description: >- Operations that are associated with the execution of a transaction risk assessment - name: Alerts description: Operations that are associated with alerts - name: Risk description: Operations associated with risk assessment for an entity paths: /alerts: get: tags: - Alerts summary: Fetch all alerts description: List all alerts from previously checked activities. operationId: listAlerts parameters: - $ref: '#/components/parameters/X-Frankie-CustomerID' - $ref: '#/components/parameters/X-Frankie-CustomerChildID' - $ref: '#/components/parameters/EntityIdsQuery' - $ref: '#/components/parameters/IsActiveQuery' - $ref: '#/components/parameters/ResultTypeQuery' - $ref: '#/components/parameters/ResultSubtypeQuery' - $ref: '#/components/parameters/RiskLevelQuery' - $ref: '#/components/parameters/AssignedToQuery' - $ref: '#/components/parameters/ActivityTypeQuery' - $ref: '#/components/parameters/OffsetQuery' - $ref: '#/components/parameters/LimitQuery' - $ref: '#/components/parameters/SortOrderQuery' - name: sortField in: query description: Field that the alerts will be sorted upon schema: type: string enum: - createdDate - lastUpdated responses: '200': description: Response from the GET /alerts endpoint content: application/json: schema: $ref: '#/components/schemas/Alerts' '400': $ref: '#/components/responses/400BadRequest' '404': $ref: '#/components/responses/404NotFound' '500': $ref: '#/components/responses/500InternalServerError' security: - apiKey: [] components: parameters: X-Frankie-CustomerID: name: X-Frankie-CustomerID in: header required: true schema: type: string example: 12345678-1234-1234-1234-123456789012 description: Your Customer ID provided by FrankieOne X-Frankie-CustomerChildID: name: X-Frankie-CustomerChildID in: header required: false schema: type: string example: 87654321-4321-4321-4321-210987654321 description: Your Customer Child ID provided by FrankieOne EntityIdsQuery: description: Unique identifier of a FrankieOne entity in: query name: entityId explode: false schema: type: array items: $ref: '#/components/schemas/EntityId' IsActiveQuery: in: query name: isActive description: >- A boolean value to whether we want to only fetch the alerts that have not been resolved example: true schema: type: boolean ResultTypeQuery: in: query name: types description: comma delimited list of EnumRiskResultType example: AML,FRAUD explode: false schema: type: array items: $ref: '#/components/schemas/EnumRiskResultType' ResultSubtypeQuery: in: query name: subtypes description: comma delimited list of strings representing the Subtypes explode: false schema: type: array items: type: string RiskLevelQuery: in: query name: riskLevels description: comma delimited list of strings representing the risk levels explode: false schema: type: array items: $ref: '#/components/schemas/EnumRiskLevel' AssignedToQuery: in: query name: assignedTo description: User identifier that will filter based on which alerts are assigned to schema: type: string ActivityTypeQuery: in: query name: activityType description: comma delimited list of EnumActivityType example: LOGIN,CRYPTO_DEPOSIT explode: false schema: type: array items: $ref: '#/components/schemas/EnumActivityType' OffsetQuery: in: query name: offset description: Number of items to offset by schema: default: 0 type: integer LimitQuery: in: query name: limit description: Limit to the Number of Results to return in the response payload schema: default: 20 type: integer SortOrderQuery: in: query name: order schema: type: string enum: - asc - desc description: >- The order in which the records will be sorted in before returning in the response payload schemas: Alerts: type: object required: - data - meta properties: data: description: List of Transaction Check Alerts found from the query type: array items: $ref: '#/components/schemas/AlertSummary' meta: $ref: '#/components/schemas/ResponseMeta' EntityId: type: string description: The unique identifier for a FrankieOne entity construct example: 98ded7ac-2457-4bde-b27c-fcee05301262 EnumRiskResultType: type: string description: >- Enum of risk assessment groupings, such as customer, device, transaction, AML, PEP as determined by the risk checking service enum: - DEVICE - TRANSACTION - AML - FRAUD EnumRiskLevel: type: string description: Level of risk as determined by the service. example: MEDIUM enum: - NONE - LOW - MEDIUM - HIGH - VERY_HIGH EnumActivityType: type: string description: Type of the activity that was used for the check enum: - REGISTRATION - LOGIN - FIAT_WITHDRAWAL - FIAT_DEPOSIT - CRYPTO_WITHDRAWAL - CRYPTO_DEPOSIT AlertSummary: type: object required: - checkId - alertId - resultId - entityId - activityType - transactionTimestamp - createdDate - lastUpdated - status - riskLevel - source - issueType properties: checkId: $ref: '#/components/schemas/CheckId' alertId: $ref: '#/components/schemas/AlertId' resultId: $ref: '#/components/schemas/ResultId' entityId: $ref: '#/components/schemas/EntityId' riskToken: $ref: '#/components/schemas/RiskToken' paymentId: description: >- Identifier for the customer transaction, only populated for financial transaction checks type: string transactionTimestamp: description: ISO-8601 format date-time that the transaction occurred type: string format: datetime createdDate: description: ISO-8601 format date-time that the alert was created type: string format: datetime lastUpdated: description: ISO-8601 format date-time of the time that alert was last updated type: string format: datetime status: $ref: '#/components/schemas/EnumAlertStatus' riskLevel: $ref: '#/components/schemas/EnumRiskLevel' activityType: $ref: '#/components/schemas/EnumActivityType' paymentType: $ref: '#/components/schemas/EnumPaymentType' source: type: string description: Name of the upstream vendor of where the alert came from sourceLink: type: string description: >- URL to the upstream vendor to provide more information about the transaction deviceId: description: >- Identifier of the device that was used for this check, this would be provided from the initial request data type: string assignedTo: description: Current FrankieOne Portal user that is assigned to this user type: string amount: $ref: '#/components/schemas/AlertAmount' issueType: $ref: '#/components/schemas/EnumRiskResultType' subtype: description: The subtype of the risk check type: string ResponseMeta: type: object required: - total - count properties: total: description: Total number of available results type: integer count: description: Number of items in the current result set type: integer ServiceError: type: object properties: commit: type: string description: Unique identifier of the Service version being used requestId: $ref: '#/components/schemas/RequestId' errorCode: type: string description: FrankieOne error code example: CORE-5990 errorMsg: type: string description: Will describe the error example: Everything went kaflooey. Stay clam. issues: type: array items: $ref: '#/components/schemas/ErrorIssue' CheckId: type: string example: 7eb4432d-398b-40f7-b24b-7d1208b83e2a description: >- The unique identifier for a transaction monitoring check that was execute for a transaction AlertId: type: string example: db30f17e-5e79-4185-b7d5-6dfc06478055 description: >- The unique identifier for an alert that has been created when customer configuration thresholds are breached. ResultId: type: string example: 89022126-ae30-4d06-b73d-95cf16230d3c description: >- The unique identifier for a result that was returned from a transaction check RiskToken: type: object required: - sessionKey - userId description: >- Includes any data required for authorizations by upstream services. To confirm if this is required, please reach out to the FrankieOne Support team. properties: sessionKey: type: string userId: type: string EnumAlertStatus: description: Current status of an alert type: string enum: - PENDING - APPROVED - MANUALLY_APPROVED - MANUALLY_DECLINED EnumPaymentType: type: string description: The type of payment that the transaction used. enum: - CARD - BANK - WIRE - CRYPTO - OTHER AlertAmount: description: The amount described in the transaction risk check type: object required: - value - currCode properties: value: type: string currCode: type: string RequestId: type: string format: ulid minLength: 26 maxLength: 26 description: >- Unique identifier assigned by FrankieOne for every request. Can be used for tracking down answers with technical support. Uses the ULID format (a time-based, sortable UUID) example: 01BFJA617JMJXEW6G7TDDXNSHX ErrorIssue: type: object required: - issueLocation - issue properties: issueLocation: type: string description: Will describe the field or data location of the issue example: date_of_birth issue: type: string description: Description of the problem example: Invalid format. Must be YYYY-MM-DD responses: 400BadRequest: description: >- Bad request. One or more request fields is either missing or incorrect. Details are in the error response. content: application/json: schema: $ref: '#/components/schemas/ServiceError' 404NotFound: description: > Cannot return response. In the case of a query, or reference to a specific entity/check/others, it means that the requested item was not found, or you don't have access to it. Please check your query before trying again. content: application/json: schema: $ref: '#/components/schemas/ServiceError' 500InternalServerError: description: > The system is presently unavailable, running in a severely degraded state or an unexpected error occurred. Check the error message for details content: application/json: schema: $ref: '#/components/schemas/ServiceError' securitySchemes: apiKey: type: apiKey name: apiKey description: API key issued by FrankieOne. This will rotate regularly. in: header ````