Approvals

Creating or changing certain resources through the API opens a change request. The change does not take effect until your API user approves it. Every change request uses the same two endpoints: Get Approval Message and Submit Approval Action.

What needs approval

For each change below, pass the id from the create or update response as entityId.

Change	Endpoint	SDK: create and approve
Create a transaction	Any transaction create call. See Transactions.	See Transactions.
Create a vault	Create a Vault	`createVaultWithApproval()`
Create a contact	Create Contact	`createContactWithApproval()`
Update a contact	Update Contact	`updateContactWithApproval()`
Create a bank account	Create Bank Account	`createBankAccountWithApproval()`

Transactions

A new transaction comes back with status: "PENDING". If your policy approves on creation, it comes back in a later status and needs no action.

Flow	Create endpoint	SDK
Transfer	Create Transfer	`createTransactionWithApproval()` creates and approves. `createTransferTransaction()` only creates.
Contract call	Create Contract Call	Call `approveChangeRequest()` after create.
Stake	Stake Resource	Call `approveChangeRequest()` after create.
Delegate	Delegate Resource	Call `approveChangeRequest()` after create.
Replace	Replace Transaction	Call `approveChangeRequest()` after create.
Ramp	Execute a Ramp Quote	`createTransactionFromIntent()` approves for you.
FX	Execute an FX Quote	`createTransactionFromIntent()` approves for you.
Trade	Execute a Trade Quote	`createTransactionFromIntent()` approves for you.

Approval flow

Create or update the entity

Call the endpoint from What needs approval and keep the id from the response.

Get the approval message

Call Get Approval Message with entityId set to that id. Save the approvalId and message.

Sign the message

Sign the exact message with your API user’s private key, the same key that signs your requests (ECDSA with SHA-256), and hex-encode the signature.

Submit the action

Call Submit Approval Action with the approvalId, action: "approve" (or "reject"), and the signature.

Confirm the result

Fetch the entity. Track a transaction with Retrieve a Transaction or webhooks until it reaches COMPLETED, FAILED, or DECLINED. Check a vault with Retrieve a Vault. Check that a contact or bank account status moved from PENDING to APPROVED with Retrieve Contact or Retrieve Bank Account.

Approve with the SDK

approveChangeRequest() gets the approval message, signs it with the client’s configured key (a private key or AWS KMS), and submits the action. It works for any entityId in the table above. The ...WithApproval() helpers call it for you.

// Create and approve in one call
const contact = await apiClient.createContactWithApproval(request);

// Or create first, then approve
const vault = await apiClient.createVault(request);
await apiClient.approveChangeRequest({
  entityId: vault.id,
  action: "approve",
});
const approvedVault = await apiClient.getVaultById(vault.id);

Get Approval Message

The message to sign for a pending change request.

Submit Approval Action

Approve or reject with the signed message.

API Basics

Accounts

Sub-Orgs

Transactions

Approvals

What needs approval

Transactions

Approval flow

Approve with the SDK

Get Approval Message

Submit Approval Action

​What needs approval

​Transactions

​Approval flow

​Approve with the SDK

Get Approval Message

Submit Approval Action

What needs approval

Transactions

Approval flow

Approve with the SDK