Skip to main content

API Co-Signer

In automated transaction approval scenarios, you can deploy the API Co-Signer application to implement custom approval logic. This application runs in your own environment and automatically approves transaction tasks based on your business policies.

Before deployment, you must first create a dedicated API Key for the API Co-Signer. See: Create an API Key.

You can view API Co-Signer details and download deployment documentation on the Tools > API Co-Signer page in the Safeheron Console.

tip

The API Co-signer feature is available only for Standard and higher-tier plans. It is not included in the Starter Plan. See pricing details.

Manual Transaction Approval​

If you are only using the API to initiate transactions and do not require automated approvals, there's no need to deploy the API Co-Signer. The approval and signing process is as follows:

Automated Transaction Approval​

To automate transaction approval, you need to designate the API Co-Signer as the approver in your approval policy. The workflow is shown below:

Example Policy Configuration​

Take a transaction as an example with the following requirements:

  • The API creates transfer transactions for a business
  • If the amount transferred is less than 1,000 USD, the system will automatically process the transaction
  • If the amount transferred is greater than 1,000 USD, the transaction will be finalized once approved by Member A and Member B

A policy can be configured as follows:

InitiatorSourceDestinationAssetSingle transaction value limit
API KeyAnyAnyAsset: Any
Limited by: Value (USD)		Set up range: per transaction < $1,000
Action: Approved by
Approval Node: API Co-Signer (1/1 threshold)
API KeyAnyAnyAsset: Any
Limited by: Value (USD)		Set up range: $1,000 <= per transaction
Action: Approved by
Approval Node: Member A and Member (2/2 threshold)

When the API initiates a transfer with a value under $1,000 USD, the automated approval process is triggered and the task is assigned to the API Co-Signer. For transfers equal to or above $1,000 USD, approval must be completed by both Member A and Member B.