Skip to main content
PUT
Pre-Transaction Compliance Checklist
Call this before create-transaction to find out exactly what compliance actions are required for the given transaction parameters. The platform evaluates all applicable KYC rules and business transaction rules and returns a checklist of outstanding items. If transactionQuote is provided, AML checks are also included in the evaluation. All authenticated user types can call this endpoint.

Request Headers

string
required
JWT Access Token of the authenticated user.
string
The customer’s userId (UUID). Pass this when an agent or manager is checking on behalf of a customer.
string
default:"fincode"
required
Platform identifier. Use fincode.
string
default:"200"
required
Unique request identifier.

Request Body

object
required
The transaction parameters to evaluate compliance against.

Response

string
SUCCESS or FAILED.
object

Code Example

cURL
Node.js

Headers

platform
string
default:fincode
required
uuid
string
default:200
required
X-Auth-Token
string
required
X-CUSTOMER-ID
string<uuid>

The customer's userId UUID. Pass when an agent or manager is checking on behalf of a customer.

Body

application/json
transactionQuote
object

Response

200 - application/json

Compliance checklist retrieved successfully

status
string
Example:

"SUCCESS"

data
object