Skip to main content

Implement Custom Handshake

The Handshake in the FAsset system is an optional step where an agent verifies the minter's or redeemer's address using an external service to ensure compliance (e.g., sanctions checks) before proceeding with minting or redemption. If enabled, the agent must approve the provided address within a set time; failure to respond allows the user to cancel or proceed based on system rules.

FAssets agents can establish custom handshake mechanisms for verifying minters and redeemers. The most straightforward approach is to create a separate web service that exposes an API which accepts two parameters:

  • API service URL
  • Address that requires verification

You need to configure the kyc block in the secrets.json file.

"kyc": {
    "url": "",
    "api_key": ""
}

The url field represents the web service link, while the api_key field is sent as a custom header using the variable Token.

info

You can check HandshakeAddressVerifier.ts for implementation details related to the ChainalysisClient class in the fasset-bots repo.