Get an Approval Message

Request example

{
  "query": {
    "entityId": "transaction_123"
  }
}

# Sample only. Generate a new signed token for each request
# (see Authentication). Tokens expire after 120 seconds.
curl --request GET \
  --url "https://api.primevault.com/api/external/change_requests/approvals/approval_message/?entityId=transaction_123" \
  --header "Authorization: Bearer <signed JWT>" \
  --header "Api-Key: <API key>" \
  --header "Accept: application/json"

// Pass a transaction, vault, contact, or bank account ID.
const approvalMessage = await apiClient.getChangeApprovalMessage("transaction_123");
console.log(approvalMessage.approvalId, approvalMessage.message);

{
  "approvalId": "approval_123",
  "message": "<message to sign>",
  "changeRequestId": "change_request_123",
  "entityId": "transaction_123"
}

GET /api/external/change_requests/approvals/approval_message/ Call this after any create or update call that needs approval: a transaction, a vault, a contact (create or update), or a bank account. Sign the returned message with your API user’s private key, then send the signature to Submit Approval Action. See Approvals for the full flow.

Query parameter

string

required

ID of the entity waiting for approval. Use the id returned by the create or update call: a transaction, vault, contact, or bank account ID.

Response

Returns a GetApprovalMessageResponse.

string

Approval ID. Pass it to Submit Approval Action.

string

Message to sign. Sign the exact string, unchanged.

string

Change request this approval belongs to.

string

ID of the transaction, vault, contact, or bank account being approved.

Request example

{
  "query": {
    "entityId": "transaction_123"
  }
}

# Sample only. Generate a new signed token for each request
# (see Authentication). Tokens expire after 120 seconds.
curl --request GET \
  --url "https://api.primevault.com/api/external/change_requests/approvals/approval_message/?entityId=transaction_123" \
  --header "Authorization: Bearer <signed JWT>" \
  --header "Api-Key: <API key>" \
  --header "Accept: application/json"

// Pass a transaction, vault, contact, or bank account ID.
const approvalMessage = await apiClient.getChangeApprovalMessage("transaction_123");
console.log(approvalMessage.approvalId, approvalMessage.message);

{
  "approvalId": "approval_123",
  "message": "<message to sign>",
  "changeRequestId": "change_request_123",
  "entityId": "transaction_123"
}

⌘I

Request example

{
  "query": {
    "entityId": "transaction_123"
  }
}

# Sample only. Generate a new signed token for each request
# (see Authentication). Tokens expire after 120 seconds.
curl --request GET \
  --url "https://api.primevault.com/api/external/change_requests/approvals/approval_message/?entityId=transaction_123" \
  --header "Authorization: Bearer <signed JWT>" \
  --header "Api-Key: <API key>" \
  --header "Accept: application/json"

// Pass a transaction, vault, contact, or bank account ID.
const approvalMessage = await apiClient.getChangeApprovalMessage("transaction_123");
console.log(approvalMessage.approvalId, approvalMessage.message);

{
  "approvalId": "approval_123",
  "message": "<message to sign>",
  "changeRequestId": "change_request_123",
  "entityId": "transaction_123"
}

API Basics

Approvals

Accounts

Sub-Orgs

Transactions

Query parameter

Response

​Query parameter

​Response

Query parameter

Response