API reference
Expand each endpoint to inspect its request, response, parameters, and authentication requirement.
This read-only reference is generated from the same OpenAPI document used by the typed client. Expand an endpoint below to inspect its parameters, validated body, response fields, and status codes.
Health
Liveness and dependency readiness.
GET/health/liveCheck API liveness
Confirms that the API process is running. This route does not require authentication.
- Authentication
- Public
Responses
200Default Response
application/json
statusokrequiredserviceapirequiredversionstringrequired
GET/health/readyCheck API readiness
Reports whether the API and its required database dependency are ready. This route does not require authentication.
- Authentication
- Public
Responses
200Default Response
application/json
statusok | errorrequiredchecksobjectrequired
503Default Response
application/json
statusok | errorrequiredchecksobjectrequired
Identity
Privy session bootstrap and current-principal reads.
PUT/v1/consumer/session
- Authentication
- Bearer token required
Request body — required
application/json
identityTokenstring
Responses
200Default Response
application/json
accountobjectrequiredwalletsobject[]requiredmembershipsobject[]required
401Default Response
application/json
errorobjectrequired
409Default Response
application/json
errorobjectrequired
GET/v1/consumer/me
- Authentication
- Bearer token required
Responses
200Default Response
application/json
accountobjectrequiredwalletsobject[]requiredmembershipsobject[]required
401Default Response
application/json
errorobjectrequired
PUT/v1/admin/session
- Authentication
- Bearer token required
Responses
200Default Response
application/json
accountobjectrequiredroleoperatorrequiredactivebooleanrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
GET/v1/admin/me
- Authentication
- Bearer token required
Responses
200Default Response
application/json
accountobjectrequiredroleoperatorrequiredactivebooleanrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
Organizations
Organization membership and workspace discovery.
GET/v1/consumer/organizations
- Authentication
- Bearer token required
Responses
200Default Response
application/json
organizationsobject[]required
401Default Response
application/json
errorobjectrequired
POST/v1/consumer/organizations
- Authentication
- Bearer token required
Request body — required
application/json
namestringrequired
Responses
201Default Response
application/json
idstring (uuid)requirednamestringrequiredroleowner | manager | employeerequired
400Default Response
application/json
errorobjectrequired
401Default Response
application/json
errorobjectrequired
Treasury
Vaults, expenses, approvals, payments, and audit activity.
GET/v1/consumer/organizations/{organizationId}/overview
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)required
Responses
200Default Response
application/json
configuredbooleanrequiredvaultobject or nullrequiredpolicyobject or nullrequiredbalanceBaseUnitsstring or nullrequiredremainingAllowanceBaseUnitsstring or nullrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
GET/v1/consumer/organizations/{organizationId}/member-funds
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)required
Responses
200Default Response
application/json
assetUSDCrequiredchainIdintegerrequiredtokenAddressstringrequiredreceivedBaseUnitsstringrequiredconfirmedPaymentCountintegerrequiredlatestConfirmedAtstring (date-time) or nullrequiredwalletAddressesstring[]requiredsourceconfirmed_payment_receiptsrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
GET/v1/consumer/organizations/{organizationId}/members
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)required
Responses
200Default Response
application/json
membersobject[]required
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
POST/v1/consumer/organizations/{organizationId}/wallet-roles
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)required
Request body — required
application/json
membershipIdstring (uuid)requiredwalletIdstring (uuid)requiredroletreasury_owner | approverrequired
Responses
201Default Response
application/json
membershipIdstring (uuid)requiredwalletIdstring (uuid)requiredroletreasury_owner | approverrequiredidstring (uuid)requiredorganizationIdstring (uuid)requiredaddressstringrequiredactivebooleanrequired
400Default Response
application/json
errorobjectrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
409Default Response
application/json
errorobjectrequired
POST/v1/consumer/organizations/{organizationId}/vault
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)required
Request body — required
application/json
labelstringaddressstringrequireddeploymentTransactionHashstringrequired
Responses
201Default Response
application/json
idstring (uuid)requiredorganizationIdstring (uuid)requiredlabelstringrequiredisDefaultbooleanrequiredarchivedAtstring (date-time) or nullrequiredcreatedByAccountIdstring (uuid) or nullrequiredchainIdintegerrequiredaddressstringrequiredtokenAddressstringrequiredownerAddressstringrequiredartifactHashstringrequireddeploymentTransactionHashstringrequiredstatuspending | verified | disabledrequired
400Default Response
application/json
errorobjectrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
409Default Response
application/json
errorobjectrequired
POST/v1/consumer/organizations/{organizationId}/vault-deployments/prepare
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)requiredidempotency-keyheaderstringrequired
Request body — required
application/json
labelstringrequired
Responses
201Default Response
application/json
idstring (uuid)requiredorganizationIdstring (uuid)requiredlabelstringrequiredchainIdintegerrequiredtokenAddressstringrequiredownerAddressstringrequiredorganizationHashstringrequiredartifactHashstringrequiredconstructorDataHashstringrequiredtransactionobjectrequiredstateprepared | submitted | confirmed | reconciling | rejected | failedrequiredtransactionHashstring or nullrequiredvaultobject or nullrequiredfailureCodestring or nullrequiredcreatedAtstring (date-time)requiredupdatedAtstring (date-time)required
400Default Response
application/json
errorobjectrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
409Default Response
application/json
errorobjectrequired
POST/v1/consumer/organizations/{organizationId}/vault-deployments/{intentId}/confirm
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)requiredintentIdpathstring (uuid)required
Request body — required
application/json
transactionHashstringrequired
Responses
200Default Response
application/json
idstring (uuid)requiredorganizationIdstring (uuid)requiredlabelstringrequiredchainIdintegerrequiredtokenAddressstringrequiredownerAddressstringrequiredorganizationHashstringrequiredartifactHashstringrequiredconstructorDataHashstringrequiredtransactionobjectrequiredstateprepared | submitted | confirmed | reconciling | rejected | failedrequiredtransactionHashstring or nullrequiredvaultobject or nullrequiredfailureCodestring or nullrequiredcreatedAtstring (date-time)requiredupdatedAtstring (date-time)required
400Default Response
application/json
errorobjectrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
404Default Response
application/json
errorobjectrequired
409Default Response
application/json
errorobjectrequired
GET/v1/consumer/organizations/{organizationId}/executor
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)required
Responses
200Default Response
application/json
bindingobject or nullrequiredprovisioningobject or nullrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
POST/v1/consumer/organizations/{organizationId}/executor/provision
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)requiredidempotency-keyheaderstringrequired
Responses
202Default Response
application/json
bindingobject or nullrequiredprovisioningobject or nullrequired
400Default Response
application/json
errorobjectrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
409Default Response
application/json
errorobjectrequired
POST/v1/consumer/organizations/{organizationId}/executor/reconcile
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)required
Responses
202Default Response
application/json
bindingobject or nullrequiredprovisioningobject or nullrequired
400Default Response
application/json
errorobjectrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
409Default Response
application/json
errorobjectrequired
POST/v1/consumer/organizations/{organizationId}/vaults/{vaultId}/policy-intents/prepare
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)requiredvaultIdpathstring (uuid)requiredidempotency-keyheaderstringrequired
Request body — required
application/json
approvedCapstringrequiredautomaticCapstringrequiredlifetimeCapstringrequiredreserveFloorstringrequiredexpiresAtstring (date-time)requiredautomaticEnabledbooleanrequiredpausedbooleanrequired
Responses
201Default Response
application/json
idstring (uuid)requiredorganizationIdstring (uuid)requiredvaultIdstring (uuid)requiredexecutorAddressstringrequiredapproverAddressesstring[]requiredrecipientAddressesstring[]requiredapprovedCapstringrequiredautomaticCapstringrequiredlifetimeCapstringrequiredreserveFloorstringrequiredexpiresAtstring (date-time)requiredautomaticEnabledbooleanrequiredpausedbooleanrequiredtransactionobjectrequiredstateprepared | submitted | confirmed | reconciling | rejected | failedrequiredtransactionHashstring or nullrequiredpolicyVersioninteger or nullrequiredfailureCodestring or nullrequiredcreatedAtstring (date-time)requiredupdatedAtstring (date-time)required
400Default Response
application/json
errorobjectrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
404Default Response
application/json
errorobjectrequired
409Default Response
application/json
errorobjectrequired
POST/v1/consumer/organizations/{organizationId}/vaults/{vaultId}/policy-intents/{intentId}/confirm
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)requiredvaultIdpathstring (uuid)requiredintentIdpathstring (uuid)required
Request body — required
application/json
transactionHashstringrequired
Responses
200Default Response
application/json
idstring (uuid)requiredorganizationIdstring (uuid)requiredvaultIdstring (uuid)requiredexecutorAddressstringrequiredapproverAddressesstring[]requiredrecipientAddressesstring[]requiredapprovedCapstringrequiredautomaticCapstringrequiredlifetimeCapstringrequiredreserveFloorstringrequiredexpiresAtstring (date-time)requiredautomaticEnabledbooleanrequiredpausedbooleanrequiredtransactionobjectrequiredstateprepared | submitted | confirmed | reconciling | rejected | failedrequiredtransactionHashstring or nullrequiredpolicyVersioninteger or nullrequiredfailureCodestring or nullrequiredcreatedAtstring (date-time)requiredupdatedAtstring (date-time)required
400Default Response
application/json
errorobjectrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
404Default Response
application/json
errorobjectrequired
409Default Response
application/json
errorobjectrequired
GET/v1/consumer/organizations/{organizationId}/vaults
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)required
Responses
200Default Response
application/json
vaultsobject[]required
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
POST/v1/consumer/organizations/{organizationId}/vaults/{vaultId}/default
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)requiredvaultIdpathstring (uuid)required
Responses
200Default Response
application/json
idstring (uuid)requiredorganizationIdstring (uuid)requiredlabelstringrequiredisDefaultbooleanrequiredarchivedAtstring (date-time) or nullrequiredcreatedByAccountIdstring (uuid) or nullrequiredchainIdintegerrequiredaddressstringrequiredtokenAddressstringrequiredownerAddressstringrequiredartifactHashstringrequireddeploymentTransactionHashstringrequiredstatuspending | verified | disabledrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
404Default Response
application/json
errorobjectrequired
409Default Response
application/json
errorobjectrequired
POST/v1/consumer/organizations/{organizationId}/vaults/{vaultId}/archive
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)requiredvaultIdpathstring (uuid)required
Responses
200Default Response
application/json
idstring (uuid)requiredorganizationIdstring (uuid)requiredlabelstringrequiredisDefaultbooleanrequiredarchivedAtstring (date-time) or nullrequiredcreatedByAccountIdstring (uuid) or nullrequiredchainIdintegerrequiredaddressstringrequiredtokenAddressstringrequiredownerAddressstringrequiredartifactHashstringrequireddeploymentTransactionHashstringrequiredstatuspending | verified | disabledrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
404Default Response
application/json
errorobjectrequired
409Default Response
application/json
errorobjectrequired
POST/v1/consumer/organizations/{organizationId}/policies/sync
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)required
Request body — required
application/json
chainTransactionHashstringrequired
Responses
200Default Response
application/json
idstring (uuid)requiredorganizationIdstring (uuid)requiredversionintegerrequiredexecutorAddressstringrequiredapprovedCapstringrequiredautomaticCapstringrequiredlifetimeCapstringrequiredspentTotalstringrequiredreserveFloorstringrequiredexpiresAtstring (date-time)requiredautomaticEnabledbooleanrequiredpausedbooleanrequiredchainTransactionHashstringrequired
400Default Response
application/json
errorobjectrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
409Default Response
application/json
errorobjectrequired
GET/v1/consumer/organizations/{organizationId}/invitations
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)required
Responses
200Default Response
application/json
invitationsobject[]required
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
POST/v1/consumer/organizations/{organizationId}/invitations
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)requiredidempotency-keyheaderstringrequired
Request body — required
application/json
rolemanager | employeerequired
Responses
201Default Response
application/json
idstring (uuid)requiredorganizationIdstring (uuid)requiredrolemanager | employeerequiredinviteTokenstringrequiredexpiresAtstring (date-time)required
400Default Response
application/json
errorobjectrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
409Default Response
application/json
errorobjectrequired
POST/v1/consumer/organizations/{organizationId}/invitations/{invitationId}/revoke
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)requiredinvitationIdpathstring (uuid)required
Responses
200Default Response
application/json
idstring (uuid)required
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
404Default Response
application/json
errorobjectrequired
409Default Response
application/json
errorobjectrequired
POST/v1/consumer/invitations/{token}/accept
- Authentication
- Bearer token required
Parameters
tokenpathstringrequired
Responses
200Default Response
application/json
organizationIdstring (uuid)requiredorganizationNamestringrequiredrolemanager | employeerequired
401Default Response
application/json
errorobjectrequired
409Default Response
application/json
errorobjectrequired
GET/v1/consumer/organizations/{organizationId}/recipients
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)required
Responses
200Default Response
application/json
recipientsobject[]required
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
POST/v1/consumer/organizations/{organizationId}/recipients
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)requiredidempotency-keyheaderstringrequired
Request body — required
application/json
labelstringrequiredaddressstringrequiredchainIdintegerrequired
Responses
201Default Response
application/json
labelstringrequiredaddressstringrequiredchainIdintegerrequiredidstring (uuid)requiredorganizationIdstring (uuid)requiredactivebooleanrequired
400Default Response
application/json
errorobjectrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
409Default Response
application/json
errorobjectrequired
GET/v1/consumer/organizations/{organizationId}/expenses
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)required
Responses
200Default Response
application/json
expensesobject[]required
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
POST/v1/consumer/organizations/{organizationId}/expenses
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)requiredidempotency-keyheaderstringrequired
Request body — required
application/json
vaultIdstring (uuid)requiredpurposestringrequiredrecipientIdstring (uuid)requiredamountBaseUnitsstringrequiredrequestedModeapproved | automaticrequired
Responses
201Default Response
application/json
idstring (uuid)requiredorganizationIdstring (uuid)requiredsubmitterAccountIdstring (uuid)requiredpaymentIdstring (uuid)requiredcurrentRevisionintegerrequiredstatedraft | analysis_queued | analyzing | needs_review | revision_requested | awaiting_approval | approved_ready_for_payment | automatic_ready_for_payment | executing | reconciling | paid | rejected | cancelled | blockedrequiredcurrentReportIdstring (uuid) or nullrequiredcreatedAtstring (date-time)requiredupdatedAtstring (date-time)requiredrevisionobjectrequiredrevisionsobject[]requiredcommentsobject[]required
400Default Response
application/json
errorobjectrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
409Default Response
application/json
errorobjectrequired
GET/v1/consumer/organizations/{organizationId}/expenses/{expenseId}
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)requiredexpenseIdpathstring (uuid)required
Responses
200Default Response
application/json
idstring (uuid)requiredorganizationIdstring (uuid)requiredsubmitterAccountIdstring (uuid)requiredpaymentIdstring (uuid)requiredcurrentRevisionintegerrequiredstatedraft | analysis_queued | analyzing | needs_review | revision_requested | awaiting_approval | approved_ready_for_payment | automatic_ready_for_payment | executing | reconciling | paid | rejected | cancelled | blockedrequiredcurrentReportIdstring (uuid) or nullrequiredcreatedAtstring (date-time)requiredupdatedAtstring (date-time)requiredrevisionobjectrequiredrevisionsobject[]requiredcommentsobject[]required
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
404Default Response
application/json
errorobjectrequired
POST/v1/consumer/organizations/{organizationId}/expenses/{expenseId}/revisions
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)requiredexpenseIdpathstring (uuid)required
Request body — required
application/json
vaultIdstring (uuid)requiredpurposestringrequiredrecipientIdstring (uuid)requiredamountBaseUnitsstringrequiredrequestedModeapproved | automaticrequiredexpectedVersionintegerrequiredreasonstringrequired
Responses
201Default Response
application/json
idstring (uuid)requiredorganizationIdstring (uuid)requiredsubmitterAccountIdstring (uuid)requiredpaymentIdstring (uuid)requiredcurrentRevisionintegerrequiredstatedraft | analysis_queued | analyzing | needs_review | revision_requested | awaiting_approval | approved_ready_for_payment | automatic_ready_for_payment | executing | reconciling | paid | rejected | cancelled | blockedrequiredcurrentReportIdstring (uuid) or nullrequiredcreatedAtstring (date-time)requiredupdatedAtstring (date-time)requiredrevisionobjectrequiredrevisionsobject[]requiredcommentsobject[]required
400Default Response
application/json
errorobjectrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
409Default Response
application/json
errorobjectrequired
POST/v1/consumer/organizations/{organizationId}/expenses/{expenseId}/submit
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)requiredexpenseIdpathstring (uuid)required
Request body — required
application/json
expectedVersionintegerrequired
Responses
202Default Response
application/json
taskIdstring (uuid)requiredexpenseIdstring (uuid)required
400Default Response
application/json
errorobjectrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
409Default Response
application/json
errorobjectrequired
POST/v1/consumer/organizations/{organizationId}/expenses/{expenseId}/review
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)requiredexpenseIdpathstring (uuid)required
Request body — required
application/json
expectedVersionintegerrequiredactionrequest_revision | reject | advance_to_approvalrequiredreasonstringrequired
Responses
200Default Response
application/json
idstring (uuid)requiredorganizationIdstring (uuid)requiredsubmitterAccountIdstring (uuid)requiredpaymentIdstring (uuid)requiredcurrentRevisionintegerrequiredstatedraft | analysis_queued | analyzing | needs_review | revision_requested | awaiting_approval | approved_ready_for_payment | automatic_ready_for_payment | executing | reconciling | paid | rejected | cancelled | blockedrequiredcurrentReportIdstring (uuid) or nullrequiredcreatedAtstring (date-time)requiredupdatedAtstring (date-time)requiredrevisionobjectrequiredrevisionsobject[]requiredcommentsobject[]required
400Default Response
application/json
errorobjectrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
409Default Response
application/json
errorobjectrequired
POST/v1/consumer/organizations/{organizationId}/expenses/{expenseId}/comments
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)requiredexpenseIdpathstring (uuid)required
Request body — required
application/json
bodystringrequired
Responses
201Default Response
application/json
idstring (uuid)requiredorganizationIdstring (uuid)requiredsubmitterAccountIdstring (uuid)requiredpaymentIdstring (uuid)requiredcurrentRevisionintegerrequiredstatedraft | analysis_queued | analyzing | needs_review | revision_requested | awaiting_approval | approved_ready_for_payment | automatic_ready_for_payment | executing | reconciling | paid | rejected | cancelled | blockedrequiredcurrentReportIdstring (uuid) or nullrequiredcreatedAtstring (date-time)requiredupdatedAtstring (date-time)requiredrevisionobjectrequiredrevisionsobject[]requiredcommentsobject[]required
400Default Response
application/json
errorobjectrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
404Default Response
application/json
errorobjectrequired
GET/v1/consumer/organizations/{organizationId}/reports/{reportId}
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)requiredreportIdpathstring (uuid)required
Responses
200Default Response
application/json
idstring (uuid)requiredorganizationIdstring (uuid)requiredexpenseIdstring (uuid)requiredexpenseRevisionintegerrequiredrunIdstring (uuid)requiredversionintegerrequiredreportHashstringrequiredoutputobjectrequiredcreatedAtstring (date-time) or string (date-time)required
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
404Default Response
application/json
errorobjectrequired
POST/v1/consumer/organizations/{organizationId}/expenses/{expenseId}/approvals/prepare
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)requiredexpenseIdpathstring (uuid)required
Request body — required
application/json
expectedVersionintegerrequireddeadlineSecondsinteger
Responses
200Default Response
application/json
domainobjectrequiredtypesobjectrequiredprimaryTypePaymentApprovalrequiredmessageobjectrequireddigeststringrequiredapprovalIdstring (uuid)requiredapproverAddressstringrequired
400Default Response
application/json
errorobjectrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
409Default Response
application/json
errorobjectrequired
POST/v1/consumer/organizations/{organizationId}/expenses/{expenseId}/approvals/submit-signature
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)requiredexpenseIdpathstring (uuid)required
Request body — required
application/json
expectedVersionintegerrequiredapprovalIdstring (uuid)requiredsignaturestringrequired
Responses
202Default Response
application/json
idstring (uuid)requiredorganizationIdstring (uuid)requiredexecutorBindingIdstring (uuid) or nullrequiredexecutorProviderTypeagent_stack_cli | developer_controlled_wallet | local or nullrequiredexecutorAddressstring or nullrequiredexpenseIdstring (uuid)requiredexpenseRevisionintegerrequiredexpenseVersionHashstringrequiredchainPaymentIdstringrequiredmodeapproved | automaticrequiredrecipientAddressstringrequiredtokenAddressstringrequiredamountBaseUnitsstringrequiredpolicyVersionintegerrequiredreportHashstringrequiredapprovalIdstring (uuid) or nullrequiredapprovalDigeststring or nullrequireddeadlinestring (date-time) or string (date-time)requiredproviderReferencestring or nullrequiredtransactionHashstring or nullrequiredstatereserved | queued | submitting | broadcast | reconciling | confirmed | blocked | failedrequiredcreatedAtstring (date-time)requiredupdatedAtstring (date-time)required
400Default Response
application/json
errorobjectrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
409Default Response
application/json
errorobjectrequired
POST/v1/consumer/organizations/{organizationId}/expenses/{expenseId}/approvals/cancel-signing
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)requiredexpenseIdpathstring (uuid)required
Request body — required
application/json
expectedVersionintegerrequiredapprovalIdstring (uuid)required
Responses
200Default Response
application/json
approvalIdstring (uuid)requiredstatepreparedrequiredcancelledtruerequired
400Default Response
application/json
errorobjectrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
409Default Response
application/json
errorobjectrequired
POST/v1/consumer/organizations/{organizationId}/approvals/{approvalId}/invalidate
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)requiredapprovalIdpathstring (uuid)required
Request body — required
application/json
transactionHashstringrequired
Responses
200Default Response
application/json
approvalIdstring (uuid)requiredstateinvalidatedrequiredtransactionHashstringrequired
400Default Response
application/json
errorobjectrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
409Default Response
application/json
errorobjectrequired
POST/v1/consumer/organizations/{organizationId}/expenses/{expenseId}/payments
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)requiredexpenseIdpathstring (uuid)required
Request body — required
application/json
expectedVersionintegerrequired
Responses
202Default Response
application/json
idstring (uuid)requiredorganizationIdstring (uuid)requiredexecutorBindingIdstring (uuid) or nullrequiredexecutorProviderTypeagent_stack_cli | developer_controlled_wallet | local or nullrequiredexecutorAddressstring or nullrequiredexpenseIdstring (uuid)requiredexpenseRevisionintegerrequiredexpenseVersionHashstringrequiredchainPaymentIdstringrequiredmodeapproved | automaticrequiredrecipientAddressstringrequiredtokenAddressstringrequiredamountBaseUnitsstringrequiredpolicyVersionintegerrequiredreportHashstringrequiredapprovalIdstring (uuid) or nullrequiredapprovalDigeststring or nullrequireddeadlinestring (date-time) or string (date-time)requiredproviderReferencestring or nullrequiredtransactionHashstring or nullrequiredstatereserved | queued | submitting | broadcast | reconciling | confirmed | blocked | failedrequiredcreatedAtstring (date-time)requiredupdatedAtstring (date-time)required
400Default Response
application/json
errorobjectrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
409Default Response
application/json
errorobjectrequired
GET/v1/consumer/organizations/{organizationId}/payments/{paymentId}
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)requiredpaymentIdpathstring (uuid)required
Responses
200Default Response
application/json
paymentobjectrequiredattemptsobject[]requiredreceiptobject or nullrequiredevidenceobject
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
404Default Response
application/json
errorobjectrequired
GET/v1/consumer/organizations/{organizationId}/activity
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)required
Responses
200Default Response
application/json
paymentsobject[]required
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
POST/v1/consumer/organizations/{organizationId}/support-cases
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)required
Request body — required
application/json
subjectstringrequiredpriorityintegerexpenseIdstring (uuid)paymentIdstring (uuid)
Responses
201Default Response
application/json
idstring (uuid)requiredorganizationIdstring (uuid)requiredopenedByAccountIdstring (uuid)requiredexpenseIdstring (uuid) or nullrequiredpaymentIntentIdstring (uuid) or nullrequiredsubjectstringrequiredpriorityintegerrequiredstatusopen | investigating | resolved | reopenedrequiredcreatedAtstring (date-time) or string (date-time)requiredupdatedAtstring (date-time) or string (date-time)required
400Default Response
application/json
errorobjectrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
409Default Response
application/json
errorobjectrequired
Live
Persisted snapshots, event streams, and reconciliation.
GET/v1/consumer/organizations/{organizationId}/live/snapshot
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)required
Responses
200Default Response
application/json
serverTimestring (date-time)requiredcursorstring or nullrequiredscopeobjectrequiredtransportPolicyobjectrequiredseverityhealthy | degraded | action_requiredrequiredtasksobject[]requiredservicesobject[]requiredeventsobject[]required
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
GET/v1/consumer/organizations/{organizationId}/live/stream
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)required
Responses
200Default Response
No response body.
GET/v1/admin/live/snapshot
- Authentication
- Bearer token required
Responses
200Default Response
application/json
serverTimestring (date-time)requiredcursorstring or nullrequiredscopeobjectrequiredtransportPolicyobjectrequiredseverityhealthy | degraded | action_requiredrequiredtasksobject[]requiredservicesobject[]requiredeventsobject[]required
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
GET/v1/admin/live/stream
- Authentication
- Bearer token required
Responses
200Default Response
No response body.
POST/v1/consumer/organizations/{organizationId}/payments/{paymentId}/reconcile
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)requiredpaymentIdpathstring (uuid)required
Request body — required
application/json
expectedVersionintegerrequired
Responses
202Default Response
application/json
idstring (uuid)requiredorganizationIdstring (uuid)requiredexecutorBindingIdstring (uuid) or nullrequiredexecutorProviderTypeagent_stack_cli | developer_controlled_wallet | local or nullrequiredexecutorAddressstring or nullrequiredexpenseIdstring (uuid)requiredexpenseRevisionintegerrequiredexpenseVersionHashstringrequiredchainPaymentIdstringrequiredmodeapproved | automaticrequiredrecipientAddressstringrequiredtokenAddressstringrequiredamountBaseUnitsstringrequiredpolicyVersionintegerrequiredreportHashstringrequiredapprovalIdstring (uuid) or nullrequiredapprovalDigeststring or nullrequireddeadlinestring (date-time) or string (date-time)requiredproviderReferencestring or nullrequiredtransactionHashstring or nullrequiredstatereserved | queued | submitting | broadcast | reconciling | confirmed | blocked | failedrequiredcreatedAtstring (date-time)requiredupdatedAtstring (date-time)required
400Default Response
application/json
errorobjectrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
404Default Response
application/json
errorobjectrequired
409Default Response
application/json
errorobjectrequired
Privy
Privy-backed wallet and constrained funding operations.
GET/v1/consumer/organizations/{organizationId}/vaults/{vaultId}/funding-control
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)requiredvaultIdpathstring (uuid)required
Responses
200Default Response
application/json
object or null
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
404Default Response
application/json
errorobjectrequired
POST/v1/consumer/organizations/{organizationId}/vaults/{vaultId}/funding-control
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)requiredvaultIdpathstring (uuid)required
Request body — required
application/json
providerPolicyIdstringrequiredsignerIdstringrequired
Responses
200Default Response
application/json
idstring (uuid)requiredorganizationIdstring (uuid)requiredvaultIdstring (uuid)requiredproviderPolicyIdstringrequiredsignerIdstringrequiredattachmentStatepending | attached | verified | revoked | failedrequiredconstraintsobjectrequiredexpiresAtstring (date-time) or string (date-time)requiredreadbackAtstring (date-time) or string (date-time) or nullrequiredfailureCodestring or nullrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
404Default Response
application/json
errorobjectrequired
409Default Response
application/json
errorobjectrequired
503Default Response
application/json
errorobjectrequired
GET/v1/consumer/organizations/{organizationId}/privy-signer
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)required
Responses
200Default Response
application/json
enabledbooleanrequiredsignerIdstring or nullrequiredpolicyIdstring or nullrequiredchainIdintegerrequiredvaultAddressstringrequiredallowedFunctiondeposit(uint256)requiredmaxAmountBaseUnitsstring or nullrequirednativeValue0requiredexpiresAtstring or nullrequiredsignerStatusunavailable | unverified | attached | not_attachedrequiredpolicyStatusunavailable | unverified | verified | invalid | expiredrequiredevidenceStatuslive-unprovenrequiredblockersstring[]requiredwalletRolesobject[]required
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
GET/v1/consumer/organizations/{organizationId}/privy-funding-actions
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)required
Responses
200Default Response
application/json
object[]
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
POST/v1/consumer/organizations/{organizationId}/privy-funding-actions
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)required
Request body — required
application/json
actiondeposit | withdraw_proberequiredamountBaseUnitsstringrequiredidempotencyKeystring (uuid)requiredapprovalTransactionHashstring
Responses
202Default Response
application/json
idstring (uuid)requiredvaultIdstring (uuid) or nullrequiredactiondeposit | withdraw_proberequiredamountBaseUnitsstringrequiredstaterequested | broadcast | confirmed | denied | failedrequiredtransactionHashstring or nullrequiredproviderReferencestring or nullrequiredfailureCodestring or nullrequiredcreatedAtstringrequiredupdatedAtstringrequiredbroadcastAtstring or nullrequiredconfirmedAtstring or nullrequiredreconciledAtstring or nullrequiredreconciliationStatepending | required | confirmed | denied | failedrequiredbalanceBeforeBaseUnitsstring or nullrequiredbalanceAfterBaseUnitsstring or nullrequired
400Default Response
application/json
errorobjectrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
409Default Response
application/json
errorobjectrequired
503Default Response
application/json
errorobjectrequired
GET/v1/consumer/organizations/{organizationId}/privy-funding-actions/{actionId}
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)requiredactionIdpathstring (uuid)required
Responses
200Default Response
application/json
idstring (uuid)requiredvaultIdstring (uuid) or nullrequiredactiondeposit | withdraw_proberequiredamountBaseUnitsstringrequiredstaterequested | broadcast | confirmed | denied | failedrequiredtransactionHashstring or nullrequiredproviderReferencestring or nullrequiredfailureCodestring or nullrequiredcreatedAtstringrequiredupdatedAtstringrequiredbroadcastAtstring or nullrequiredconfirmedAtstring or nullrequiredreconciledAtstring or nullrequiredreconciliationStatepending | required | confirmed | denied | failedrequiredbalanceBeforeBaseUnitsstring or nullrequiredbalanceAfterBaseUnitsstring or nullrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
404Default Response
application/json
errorobjectrequired
Wallets
Server-created wallet lifecycle operations.
GET/v1/consumer/wallets/
- Authentication
- Bearer token required
Responses
200Default Response
application/json
walletsobject[]required
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
POST/v1/consumer/wallets/
- Authentication
- Bearer token required
Request body — required
application/json
organizationIdstring (uuid)chainTypeethereum | solanapurposestringrequiredidempotencyKeystringrequired
Responses
201Default Response
application/json
idstring (uuid)requiredaddressstringrequiredkindembedded | external | serverrequiredchainTypeethereum | solanapurposestringcreationEnvironmentstringlifecycleStatusprovisioning | active | failed | disabledcustomExportAvailableboolean
400Default Response
application/json
errorobjectrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
503Default Response
application/json
errorobjectrequired
GET/v1/admin/wallets/
- Authentication
- Bearer token required
Responses
200Default Response
application/json
walletsobject[]required
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
POST/v1/admin/wallets/
- Authentication
- Bearer token required
Request body — required
application/json
organizationIdstring (uuid)chainTypeethereum | solanapurposestringrequiredidempotencyKeystringrequired
Responses
201Default Response
application/json
idstring (uuid)requiredaddressstringrequiredkindembedded | external | serverrequiredchainTypeethereum | solanapurposestringcreationEnvironmentstringlifecycleStatusprovisioning | active | failed | disabledcustomExportAvailableboolean
400Default Response
application/json
errorobjectrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
503Default Response
application/json
errorobjectrequired
Wallet Export
Fresh-authentication wallet export ceremonies.
POST/v1/consumer/wallets/{walletId}/export-requests
- Authentication
- Bearer token required
Parameters
walletIdpathstring (uuid)required
Request body — required
application/json
organizationIdstring (uuid)recipientPublicKeystringrequired
Responses
201Default Response
application/json
requestIdstring (uuid)requiredwalletIdstring (uuid)requiredexpiresAtstring (date-time)requiredauthorizationPayloadobjectrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
404Default Response
application/json
errorobjectrequired
429Default Response
application/json
errorobjectrequired
503Default Response
application/json
errorobjectrequired
POST/v1/consumer/wallets/{walletId}/export-requests/{requestId}/complete
- Authentication
- Bearer token required
Parameters
walletIdpathstring (uuid)requiredrequestIdpathstring (uuid)required
Request body — required
application/json
recipientPublicKeystringrequiredauthorizationSignaturestringrequiredmfaAssertionstringrequired
Responses
200Default Response
application/json
encryptionTypeHPKErequiredencapsulatedKeystringrequiredciphertextstringrequiredexpiresAtstring (date-time)requiredrequestIdstring (uuid)required
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
409Default Response
application/json
errorobjectrequired
503Default Response
application/json
errorobjectrequired
POST/v1/consumer/wallets/{walletId}/export-requests/{requestId}/cancel
- Authentication
- Bearer token required
Parameters
walletIdpathstring (uuid)requiredrequestIdpathstring (uuid)required
Responses
204Default Response
No response body.
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
POST/v1/admin/wallets/{walletId}/export-requests
- Authentication
- Bearer token required
Parameters
walletIdpathstring (uuid)required
Request body — required
application/json
organizationIdstring (uuid)recipientPublicKeystringrequired
Responses
201Default Response
application/json
requestIdstring (uuid)requiredwalletIdstring (uuid)requiredexpiresAtstring (date-time)requiredauthorizationPayloadobjectrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
404Default Response
application/json
errorobjectrequired
429Default Response
application/json
errorobjectrequired
503Default Response
application/json
errorobjectrequired
POST/v1/admin/wallets/{walletId}/export-requests/{requestId}/complete
- Authentication
- Bearer token required
Parameters
walletIdpathstring (uuid)requiredrequestIdpathstring (uuid)required
Request body — required
application/json
recipientPublicKeystringrequiredauthorizationSignaturestringrequiredmfaAssertionstringrequired
Responses
200Default Response
application/json
encryptionTypeHPKErequiredencapsulatedKeystringrequiredciphertextstringrequiredexpiresAtstring (date-time)requiredrequestIdstring (uuid)required
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
409Default Response
application/json
errorobjectrequired
503Default Response
application/json
errorobjectrequired
POST/v1/admin/wallets/{walletId}/export-requests/{requestId}/cancel
- Authentication
- Bearer token required
Parameters
walletIdpathstring (uuid)requiredrequestIdpathstring (uuid)required
Responses
204Default Response
No response body.
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
Push
Web Push configuration, subscriptions, and notification resolution.
GET/v1/consumer/push/config
- Authentication
- Bearer token required
Responses
200Default Response
application/json
activebooleanrequiredpublicKeystringrequired
401Default Response
application/json
errorobjectrequired
POST/v1/consumer/push/subscriptions
- Authentication
- Bearer token required
Request body — required
application/json
endpointstring (uri)requiredexpirationTimenumber or nullrequiredkeysobjectrequireddeviceLabelstringrequired
Responses
201Default Response
application/json
idstring (uuid)requireddeviceLabelstringrequiredactivebooleanrequired
400Default Response
application/json
errorobjectrequired
401Default Response
application/json
errorobjectrequired
503Default Response
application/json
errorobjectrequired
DELETE/v1/consumer/push/subscriptions
- Authentication
- Bearer token required
Request body — required
application/json
endpointstring (uri)required
Responses
204Default Response
application/json
idstring (uuid)requireddeviceLabelstringrequiredactivebooleanrequired
400Default Response
application/json
errorobjectrequired
401Default Response
application/json
errorobjectrequired
GET/v1/consumer/notifications/{eventId}
- Authentication
- Bearer token required
Parameters
eventIdpathstring (uuid)required
Responses
200Default Response
application/json
categorystringrequiredroutestringrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
404Default Response
application/json
errorobjectrequired
Integrations
Sanitized provider readiness for administrators.
GET/v1/admin/integrations/status
- Authentication
- Bearer token required
Responses
200Default Response
application/json
integrationsobject[]required
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
Admin Investigation
Cross-organization support and failure investigation.
GET/v1/admin/organizations
- Authentication
- Bearer token required
Parameters
qquerystring
Responses
200Default Response
application/json
organizationsobject[]required
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
GET/v1/admin/organizations/{organizationId}/executor
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)required
Responses
200Default Response
application/json
bindingobject or nullrequiredprovisioningobject or nullrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
POST/v1/admin/organizations/{organizationId}/executor/reconcile
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)required
Responses
202Default Response
application/json
bindingobject or nullrequiredprovisioningobject or nullrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
409Default Response
application/json
errorobjectrequired
GET/v1/admin/overview
- Authentication
- Bearer token required
Responses
200Default Response
application/json
checkedAtstring (date-time) or string (date-time)requiredorganizationsintegerrequiredactiveAnalysisRunsintegerrequiredfailedAnalysisRunsintegerrequiredfailedPaymentsintegerrequiredreconcilingPaymentsintegerrequiredopenSupportCasesintegerrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
GET/v1/admin/organizations/{organizationId}
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)required
Responses
200Default Response
application/json
organizationobjectrequiredtreasuryVaultsobject[]requiredmembersobject[]requiredexpensesobject[]requiredexpenseCommentsobject[]requiredreportsobject[]requiredagentRunsobject[]requiredapprovalsobject[]requiredauditEventsobject[]requiredpaymentsobject[]requiredattemptsobject[]requiredreceiptsobject[]requiredsupportCasesobject[]requiredsupportNotesobject[]required
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
404Default Response
application/json
errorobjectrequired
GET/v1/admin/failures
- Authentication
- Bearer token required
Responses
200Default Response
application/json
analysisRunsobject[]requiredpaymentsobject[]requiredpaymentAttemptsobject[]required
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
GET/v1/admin/support-cases
- Authentication
- Bearer token required
Parameters
pagequeryintegerstatusqueryopen | investigating | resolved | reopenedpriorityquerylow | medium | highsortquerynewest | oldest | priority_desc | priority_asc
Responses
200Default Response
application/json
casesobject[]requiredpaginationobjectrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
POST/v1/admin/support-cases/{caseId}/notes
- Authentication
- Bearer token required
Parameters
caseIdpathstring (uuid)required
Request body — required
application/json
bodystringrequiredstatusopen | investigating | resolved | reopened
Responses
201Default Response
application/json
idstring (uuid)requiredsupportCaseIdstring (uuid)requiredauthorAccountIdstring (uuid)requiredbodystringrequiredstatusAfteropen | investigating | resolved | reopened or nullrequiredcreatedAtstring (date-time) or string (date-time)required
400Default Response
application/json
errorobjectrequired
401Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
404Default Response
application/json
errorobjectrequired
Integration Proofs
Non-production sponsor proof workflows.
POST/v1/admin/organizations/{organizationId}/integration-proofs/arc/signatures
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)required
Request body — required
application/json
kinddeployment | funding | configure | approvalrequiredsignerstringrequiredownerstringrequiredvaultstringexecutorstringrecipientstringpaymentIntentIdstring (uuid)
Responses
201Default Response
application/json
idstringrequiredorganizationIdstringrequiredaccountIdstringrequiredproviderstringrequiredintentHashstringrequiredintentJsonstringrequiredstatestringrequiredtransactionHashstringproviderRequestIdstringerrorCodestringevidenceJsonstring
400Default Response
application/json
errorobjectrequired
403Default Response
application/json
errorobjectrequired
GET/v1/admin/organizations/{organizationId}/integration-proofs/arc/signatures/{id}
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)requiredidpathstring (uuid)required
Responses
200Default Response
application/json
idstringrequiredorganizationIdstringrequiredaccountIdstringrequiredproviderstringrequiredintentHashstringrequiredintentJsonstringrequiredstatestringrequiredtransactionHashstringproviderRequestIdstringerrorCodestringevidenceJsonstring
403Default Response
application/json
errorobjectrequired
404Default Response
application/json
errorobjectrequired
POST/v1/admin/organizations/{organizationId}/integration-proofs/arc/signatures/{id}/claim
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)requiredidpathstring (uuid)required
Responses
200Default Response
application/json
idstringrequiredorganizationIdstringrequiredaccountIdstringrequiredproviderstringrequiredintentHashstringrequiredintentJsonstringrequiredstatestringrequiredtransactionHashstringproviderRequestIdstringerrorCodestringevidenceJsonstring
403Default Response
application/json
errorobjectrequired
409Default Response
application/json
errorobjectrequired
POST/v1/admin/organizations/{organizationId}/integration-proofs/arc/signatures/{id}/confirm
- Authentication
- Bearer token required
Parameters
organizationIdpathstring (uuid)requiredidpathstring (uuid)required
Request body — required
application/json
hashstringrequired
Responses
200Default Response
application/json
idstringrequiredorganizationIdstringrequiredaccountIdstringrequiredproviderstringrequiredintentHashstringrequiredintentJsonstringrequiredstatestringrequiredtransactionHashstringproviderRequestIdstringerrorCodestringevidenceJsonstring
403Default Response
application/json
errorobjectrequired