The following API endpoints are available from the gateway:
| Endpoint | URL | Description |
|---|---|---|
| Transaction Checks | POST /v1/transaction-checks |
Creates a new case processing a transaction for AML & Fraud Transaction Monitoring and/or Payment Screening checks |
| Transaction Checks | PATCH /v1/transaction-checks |
Reprocess AML & Fraud Transaction Monitoring and/or Payment Screening checks on an existing transaction. This is for exceptional use cases only (e.g. timeout or when correcting wrong data in case of a bug on the client side). Do not use this for good-case workflows. It comes with serious performance penalties and has various limitiations (e.g. when exceeding the month boundary). |
| Customer Checks | POST /v1/customerChecks |
Perform Customer Risk Rating and/or Customer Screening checks on a customer |
| Workflows | POST /v1/workflows |
Perform a workflow creation action based on the request body |
| Account Checks | POST /v1/accounts |
Create a new account under a customer profile |
| Account Checks | PUT /v1/accounts/accountUuid |
Update an existing account under a customer profile |
Customer Data
If using the Customer Checks API and its associated solutions, it is possible to simply provide the customerId within the accountHoldingPartyData object for Transaction Checks and the gateway will lookup the previously submitted data within our database.
This relies on the customer data in the gateway system being up-to-date. As such, any updates to customer data on within your systems should trigger new Customer Checks.
Note: in all cases where customer data is being provided to the gateway, the full set of customer information should be included. If partial data is sent, any fields not provided will set those customer data points in the gateways database as blank. This is intentional to allow customer data to be updated.
Important
The previous version of the Transaction Checks API, AML Checks, has been deprecated. This change has no impact on existing integrations which will continue to be supported.