Submit an Approval Action

Request example

{
  "path": {
    "approvalId": "approval_123"
  },
  "body": {
    "action": "approve",
    "signature": "<hex-encoded signature of message>",
    "reason": "ok"
  }
}

# Sample only. Generate a new signed token for each request
# (see Authentication). Tokens expire after 120 seconds.
curl --request POST \
  --url "https://api.primevault.com/api/external/change_requests/approvals/approval_123/action/" \
  --header "Authorization: Bearer <signed JWT>" \
  --header "Api-Key: <API key>" \
  --header "Content-Type: application/json" \
  --data '{
    "action": "approve",
    "signature": "<hex-encoded signature of message>",
    "reason": "ok"
  }'

// Sign the message yourself and submit it:
const result = await apiClient.submitChangeApprovalAction(
  approvalMessage.approvalId,
  "approve",
  signatureHex,
);

// Or fetch, sign, and submit in one call.
// entityId is a transaction, vault, contact, or bank account ID.
await apiClient.approveChangeRequest({
  entityId: transaction.id,
  action: "approve",
});

{
  "success": true,
  "entityId": "transaction_123"
}

POST /api/external/change_requests/approvals/{approvalId}/action/ Send the signed approval message from Get Approval Message to approve or reject. See Approvals for the full flow.

Path parameter

string

required

The approvalId returned by Get Approval Message.

Request body

ApprovalAction

required

approve or reject. See ApprovalAction.

string

required

Hex-encoded ECDSA (SHA-256) signature of the approval message, made with your API user’s private key.

string

Note recorded with the action. The SDK sends ok unless you pass another value.

Response

Returns an ApprovalActionResponse.

boolean

Whether PrimeVault accepted the action.

string

Approval status after the action.

string

ID of the approval record.

string

ID of the transaction, vault, contact, or bank account the action applied to.

After you approve, fetch the entity to confirm its state:

Transaction: Retrieve a Transaction or webhooks until it reaches COMPLETED, FAILED, or DECLINED.
Vault: Retrieve a Vault.
Contact: Retrieve a Contact. Status moves from PENDING to APPROVED or DECLINED.
Bank account: Retrieve a Bank Account. Status moves from PENDING to APPROVED or DECLINED.

Request example

{
  "path": {
    "approvalId": "approval_123"
  },
  "body": {
    "action": "approve",
    "signature": "<hex-encoded signature of message>",
    "reason": "ok"
  }
}

# Sample only. Generate a new signed token for each request
# (see Authentication). Tokens expire after 120 seconds.
curl --request POST \
  --url "https://api.primevault.com/api/external/change_requests/approvals/approval_123/action/" \
  --header "Authorization: Bearer <signed JWT>" \
  --header "Api-Key: <API key>" \
  --header "Content-Type: application/json" \
  --data '{
    "action": "approve",
    "signature": "<hex-encoded signature of message>",
    "reason": "ok"
  }'

// Sign the message yourself and submit it:
const result = await apiClient.submitChangeApprovalAction(
  approvalMessage.approvalId,
  "approve",
  signatureHex,
);

// Or fetch, sign, and submit in one call.
// entityId is a transaction, vault, contact, or bank account ID.
await apiClient.approveChangeRequest({
  entityId: transaction.id,
  action: "approve",
});

{
  "success": true,
  "entityId": "transaction_123"
}

⌘I

Request example

{
  "path": {
    "approvalId": "approval_123"
  },
  "body": {
    "action": "approve",
    "signature": "<hex-encoded signature of message>",
    "reason": "ok"
  }
}

# Sample only. Generate a new signed token for each request
# (see Authentication). Tokens expire after 120 seconds.
curl --request POST \
  --url "https://api.primevault.com/api/external/change_requests/approvals/approval_123/action/" \
  --header "Authorization: Bearer <signed JWT>" \
  --header "Api-Key: <API key>" \
  --header "Content-Type: application/json" \
  --data '{
    "action": "approve",
    "signature": "<hex-encoded signature of message>",
    "reason": "ok"
  }'

// Sign the message yourself and submit it:
const result = await apiClient.submitChangeApprovalAction(
  approvalMessage.approvalId,
  "approve",
  signatureHex,
);

// Or fetch, sign, and submit in one call.
// entityId is a transaction, vault, contact, or bank account ID.
await apiClient.approveChangeRequest({
  entityId: transaction.id,
  action: "approve",
});

{
  "success": true,
  "entityId": "transaction_123"
}

API Basics

Approvals

Accounts

Sub-Orgs

Transactions

Path parameter

Request body

Response

​Path parameter

​Request body

​Response

Path parameter

Request body

Response