Generated Types Reference
This file is auto-generated from the GraphQL schema. Do not edit directly.
AcceptAuditAdjustmentResult
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
adjustmentId | Int | - |
journalEntryId | Int | - |
error | String | - |
AcceptGoNetworkConnectionInput (Input)
| Field | Type | Description |
|---|---|---|
connectionId | Int! | - |
AcceptQuoteInput (Input)
| Field | Type | Description |
|---|---|---|
quoteId | Int! | - |
signature | String | - |
AcceptQuoteResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
error | String | - |
quoteId | Int | - |
invoiceId | Int | - |
caseId | Int | - |
AcceptUserOrganizationInviteResponse
| Field | Type | Description |
|---|---|---|
redirectUrl | String | - |
message | String! | - |
AddGetTrackedTokensInput (Input)
| Field | Type | Description |
|---|---|---|
timestamp | timestamptz | - |
limit | Int | - |
allTokens | Boolean | - |
AddPolicyResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
policyId | String | - |
dbId | Int | - |
error | String | - |
AddressSuggestion
Autocomplete suggestion from Google Places API
| Field | Type | Description |
|---|---|---|
text | String! | Display text for the suggestion |
placeId | String! | Google Place ID (can be used for further lookups) |
mainText | String! | Main text (primary part of address) |
secondaryText | String! | Secondary text (locality, region, country) |
types | [String!]! | Place types (e.g., "street_address", "locality") |
AddressValidationResponse
Response from address validation API. Uses Google Address Validation API to verify addresses.
| Field | Type | Description |
|---|---|---|
success | Boolean! | Whether the address is valid |
isValid | Boolean | Whether the address passed validation |
confidence | AddressValidationConfidence | Confidence level of the validation (if available) |
formattedAddress | String | Formatted address returned by Google |
location | GeocodeLocation | Geocode location (latitude/longitude) |
error | String | Error message if validation failed |
AddSmartWalletSessionKeyInput (Input)
| Field | Type | Description |
|---|---|---|
digitalWalletId | Int! | - |
encryptedSessionKey | String! | - |
encryptionSessionId | String! | - |
sessionKeyAddress | String! | - |
permissionsContext | String | - |
signature | String | - |
permissions | jsonb | - |
expiresAt | bigint | - |
AddSmartWalletSessionKeyResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
sessionId | String | - |
error | String | - |
AddSpendingLimitInput (Input)
| Field | Type | Description |
|---|---|---|
digitalWalletId | Int! | - |
amount | Float! | - |
coin | String | - |
AddVelocityLimitInput (Input)
| Field | Type | Description |
|---|---|---|
digitalWalletId | Int! | - |
amount | Float! | - |
timeWindow | Int! | - |
coin | String | - |
Admin
| Field | Type | Description |
|---|---|---|
id | ID | - |
user_id | String | - |
servicesStatuses | [ServicesStatus] | - |
servicesStatus | ServicesStatus | - |
walletPolicies | [WalletPolicy!]! | - |
walletPolicyAudit | [WalletPolicyAuditEntry!]! | - |
whitelistSyncLogs | [WhitelistSyncLog!]! | - |
whitelistDiff | WhitelistDiff! | - |
whitelistRequests | [WhitelistRequest!]! | - |
whitelistRequest | WhitelistRequest | - |
blacklistedTokens | BlacklistedTokenPage! | - |
blacklistedTokensByUser | [BlacklistedToken!]! | - |
childEnterprises | [ChildEnterprise!]! | - |
childEnterprise | ChildEnterprise | - |
goAccounts | [GoAccount!]! | - |
goAccount | GoAccount | - |
goAccountBalances | [GoAccountBalance!]! | - |
goTradeHistory | [GoTrade!]! | - |
goFiatOperations | [GoFiatOperation!]! | - |
tradingPairs | [TradingPair!]! | - |
marketData | MarketData | - |
organizationStatus | OrganizationStatus! | - |
enterpriseUsers | [jsonb!]! | - |
enterpriseDetails | jsonb | - |
webhooksForWallet | [BitgoWebhookRegistration!]! | - |
webhookPayloadHistory | WebhookPayloadPage! | - |
webhookStats | WebhookStats! | - |
goNetworkConnections | [GoNetworkConnection!]! | - |
goNetworkDirectory | [GoNetworkDirectoryEntry!]! | - |
AdminCreatePartnerWebhookSubscriptionInput (Input)
| Field | Type | Description |
|---|---|---|
organizationId | ID! | The partner organization (AgioAuth.organization.id) the subscription belongs to. |
url | String! | HTTPS URL that will receive signed event POSTs. Private / loopback / cloud-metadata IPs are rejected at dispatch. |
events | [String!]! | Event names to subscribe to (e.g. "card_application.status_changed"). At least one required. |
| Only subscribable events are accepted; system-only events are rejected. |
AdminCreatePartnerWebhookSubscriptionResult
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
subscriptionId | ID | - |
signingSecret | String | The HMAC signing secret — returned ONCE on create. Capture it immediately and hand it to the |
| partner; it is never readable again. Used to verify the x-agio-signature header on event POSTs. | ||
errorCode | String | - |
errorMessage | String | - |
AdminSmartWalletSendTransactionInput (Input)
Admin-only send from any smart wallet, bypassing user/organization ownership checks. Reuses the same execution path as smartWalletSendTransaction (session-key signing first, with BYOA owner-signing as the AA23 fallback). Requires admin role, request Origin matching ADMIN_APP_URL, a Twilio OTP submitted in the request context bound to the admin's verified JWT phone claim, and is rate-limited at 10/min.
| Field | Type | Description |
|---|---|---|
digitalWalletId | Int! | - |
recipient | String! | - |
amount | String! | - |
data | String | - |
AgioOnboardingDocumentGenerateInput (Input)
| Field | Type | Description |
|---|---|---|
documentTypeName | String! | - |
fileName | String | - |
originalFileName | String | - |
identifier | String | - |
caseId | Int | - |
metadata | jsonb | - |
waitUntilFinished | Boolean | - |
waitUntilFinishedTimeoutMs | Int | - |
AgioOnboardingDocumentGenerateResponse
| Field | Type | Description |
|---|---|---|
jobId | uuid! | - |
queueName | String! | - |
documentId | uuid | - |
documentUrl | String | - |
job | BullJobResponse | - |
AgioOnboardingDocumentSearchInput (Input)
| Field | Type | Description |
|---|---|---|
query | String! | - |
parentDocumentId | uuid | - |
matchCount | Int | - |
filter | jsonb | - |
distinctOn | String | - |
AgioOnboardingDocumentSearchItem
| Field | Type | Description |
|---|---|---|
id | uuid! | - |
similarity | Float! | - |
content | String! | - |
metadata | jsonb! | - |
documentId | uuid | - |
AgioOnboardingDocumentSearchResponse
| Field | Type | Description |
|---|---|---|
count | Int! | - |
items | [AgioOnboardingDocumentSearchItem] | - |
ApproveWhitelistRequestInput (Input)
| Field | Type | Description |
|---|---|---|
requestId | Int! | - |
AttachKybBeneficiaryInput (Input)
| Field | Type | Description |
|---|---|---|
organizationId | ID! | - |
beneficiaryApplicantId | String! | Sumsub applicant ID of the individual to link |
types | [KybBeneficiaryType!]! | Roles this person holds — at least one required |
shareSize | Float | Ownership percentage (0–100) — required for UBOs / shareholders |
AttachKybBeneficiaryResult
| Field | Type | Description |
|---|---|---|
beneficiaryId | String! | Junction record ID — use this for detachKybBeneficiary |
applicantId | String! | The individual's Sumsub applicant ID |
types | [String!]! | - |
AuditAdjustmentResult
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
id | Int | - |
error | String | - |
AuditAdjustmentVoidResult
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
id | Int | - |
reversalJournalEntryId | Int | - |
error | String | - |
Auth0
| Field | Type | Description |
|---|---|---|
profile | Auth0Profile | - |
profileById | Auth0Profile | - |
Auth0Identity
| Field | Type | Description |
|---|---|---|
connection | String | - |
user_id | String | - |
provider | String | - |
isSocial | Boolean | - |
Auth0Profile
| Field | Type | Description |
|---|---|---|
user_id | String | - |
email | String | - |
email_verified | Boolean | - |
picture | String | - |
created_at | String | - |
updated_at | String | - |
name | String | - |
given_name | String | - |
family_name | String | - |
nickname | String | - |
multifactor_last_modified | String | - |
last_ip | String | - |
last_login | String | - |
logins_count | String | - |
city | String | - |
country_code | String | - |
address | String | - |
address2 | String | - |
company_name | String | - |
mobile_phone | String | - |
postal_code | String | - |
state_or_province | String | - |
preferred_location_code | String | - |
preferred_currency_code | String | - |
preferred_language_code | String | - |
color_scheme | String | - |
signature | String | - |
Auth0ProfileMetadata
| Field | Type | Description |
|---|---|---|
city | String | - |
address | String | - |
address2 | String | - |
mobile_phone | String | - |
country_code | String | - |
postal_code | String | - |
state_or_province | String | - |
company_name | String | - |
preferred_location_code | String | - |
preferred_currency_code | String | - |
preferred_language_code | String | - |
color_scheme | String | - |
signature | String | - |
Auth0ProfileMetadataInput (Input)
| Field | Type | Description |
|---|---|---|
city | String | - |
address | String | - |
address2 | String | - |
mobile_phone | String | - |
country_code | String | - |
postal_code | String | - |
state_or_province | String | - |
company_name | String | - |
preferred_location_code | String | - |
preferred_currency_code | String | - |
preferred_language_code | String | - |
color_scheme | String | - |
signature | String | - |
AutocompleteAddressInput (Input)
Input for autocomplete address search
| Field | Type | Description |
|---|---|---|
input | String! | Search query (partial address or place name) |
includedRegionCodes | [String!] | Limit results to specific country codes (e.g., ["US", "ID"]) |
AutocompleteAddressResponse
Response from address autocomplete API
| Field | Type | Description |
|---|---|---|
success | Boolean! | Whether the request was successful |
suggestions | [AddressSuggestion!] | List of address suggestions |
error | String | Error message if request failed |
BackfillAlchemyTransactionsInput (Input)
| Field | Type | Description |
|---|---|---|
digitalWalletId | Int | - |
cutoffDate | String | - |
BackfillAlchemyTransactionsResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
jobId | String | - |
message | String | - |
error | String | - |
BackfillDigitalWalletAssetsInput (Input)
| Field | Type | Description |
|---|---|---|
fundId | Int! | - |
digitalWalletId | Int | - |
startDate | String! | - |
endDate | String! | - |
skipDelay | Boolean | - |
BackfillDigitalWalletAssetsResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
jobId | String | - |
message | String | - |
error | String | - |
BackfillTokenPricesInput (Input)
| Field | Type | Description |
|---|---|---|
startTimestamp | timestamptz! | - |
endTimestamp | timestamptz | - |
tokenId | Int! | - |
priceSourceIds | [Int!] | - |
unit | TokenPriceIntervalUnit | - |
interval | Int | - |
BackfillTokenPricesManyInput (Input)
| Field | Type | Description |
|---|---|---|
startTimestamp | timestamptz! | - |
endTimestamp | timestamptz | - |
tokenIds | [Int!]! | - |
priceSourceIds | [Int!] | - |
unit | TokenPriceIntervalUnit | - |
interval | Int | - |
BackfillTopTokenPricesInput (Input)
| Field | Type | Description |
|---|---|---|
clearExisting | Boolean! | - |
count | Int | - |
BalancerLPPrice
| Field | Type | Description |
|---|---|---|
priceUsd | Float! | - |
totalShares | Float! | - |
totalLiquidityUsd | Float! | - |
priceTimestamp | String! | - |
balancerVersion | BalancerVersion! | - |
underlyingPrices | JSON | - |
BalancerLPPriceHistoryItem
| Field | Type | Description |
|---|---|---|
priceUsd | Float! | - |
priceDate | String! | - |
priceTimestamp | String! | - |
totalLiquidityUsd | Float | - |
BalancerPool
| Field | Type | Description |
|---|---|---|
id | Int! | - |
poolId | String! | - |
poolAddress | String! | - |
poolType | String! | - |
balancerVersion | BalancerVersion! | - |
network | BalancerNetwork! | - |
name | String | - |
symbol | String | - |
isTracked | Boolean! | - |
isActive | Boolean! | - |
backfillStatus | String | - |
backfillStartedAt | String | - |
backfillCompletedAt | String | - |
backfillError | String | - |
tokens | [BalancerPoolToken!]! | - |
BalancerPoolToken
| Field | Type | Description |
|---|---|---|
id | Int! | - |
tokenAddress | String! | - |
tokenSymbol | String! | - |
tokenDecimals | Int! | - |
weight | Float | - |
tokenId | Int | - |
BitgoAddress
| Field | Type | Description |
|---|---|---|
id | String! | - |
address | String! | - |
chain | Int! | - |
index | Int! | - |
coin | String! | - |
wallet | String | - |
addressType | String | Enum: "p2sh" "p2sh-p2wsh" "p2wsh" |
baseAddress | String | - |
keychains | [BitgoKey] | - |
balance | BitgoAddressBalance | - |
BitgoAddressBalance
| Field | Type | Description |
|---|---|---|
balance | bigint | - |
balanceString | String | - |
totalReceived | bigint | - |
totalSent | bigint | - |
confirmedBalanceString | String | - |
spendableBalanceString | String | - |
BitgoApprovalResolveInput (Input)
| Field | Type | Description |
|---|---|---|
state | BitgoApprovalStateResolveType! | - |
digitalWalletId | ID! | - |
approvalId | String! | - |
password | String | - |
otp | String | - |
xprv | String | - |
BitgoApprovalResponse
| Field | Type | Description |
|---|---|---|
id | String | - |
wallet | String | - |
coin | String | - |
creator | String | - |
createDate | timestamptz | - |
state | BitgoApprovalState | - |
approvalsRequired | Int | - |
scope | BitgoScope | - |
userIds | [String] | - |
enterprise | String | - |
walletLabel | String | - |
info | BitgoApprovalResponseInfo | - |
BitgoApprovalResponseInfo
| Field | Type | Description |
|---|---|---|
type | BitgoApprovalResponseType! | - |
transactionRequest | jsonb | - |
transactionRequestFull | jsonb | - |
userChangeRequest | jsonb | - |
policyRuleRequest | jsonb | - |
updateApprovalsRequiredRequest | jsonb | - |
BitgoBuildDefaults
| Field | Type | Description |
|---|---|---|
minFeeRate | Int | - |
BitgoCoinData
| Field | Type | Description |
|---|---|---|
id | String | - |
baseFactor | bigint | - |
decimalPlaces | Int | - |
chain | String | - |
family | String | - |
name | String | - |
supportsBlockTarget | Boolean | - |
supportsLightning | Boolean | - |
supportsBlsDkg | Boolean | - |
supportsMessageSigning | Boolean | - |
supportsStaking | Boolean | - |
supportsTss | Boolean | - |
allowsAccountConsolidations | Boolean | - |
enabled | Boolean | - |
isTestnet | Boolean | - |
coinFamily | BitgoCoinFamily | - |
supportedWalletTypes | [BitgoWalletType] | - |
supportedBackupProviderTypes | [BitgoBackupProviderType] | - |
defaultBackupProviderType | BitgoBackupProviderType | - |
isToken | Boolean | - |
bip44Id | Int | - |
BitgoCreateAddressInput (Input)
| Field | Type | Description |
|---|---|---|
label | String | - |
chain | Int | - |
BitgoCustomChangeKeySignatures
| Field | Type | Description |
|---|---|---|
user | String | - |
backup | String | - |
bitgo | String | - |
BitgoEncryptedPassphraseInput (Input)
| Field | Type | Description |
|---|---|---|
sessionId | String! | - |
encryptedPassphrase | String! | - |
BitgoEncryptionKeyPair
| Field | Type | Description |
|---|---|---|
pub | String! | - |
encryptedPrv | String! | - |
BitgoEncryptionKeyPairInput (Input)
| Field | Type | Description |
|---|---|---|
pub | String! | - |
encryptedPrv | String! | - |
BitgoKey
| Field | Type | Description |
|---|---|---|
id | String! | - |
encryptedPrv | String | - |
isBitGo | Boolean | - |
source | BitgoSourceType | - |
type | BitgoKeyType! | - |
ethAddress | String | - |
pub | String | - |
commonKeychain | String | - |
commonPub | String | - |
commonKeychainSig | String | - |
commonPublicKeySig | String | - |
keyShares | [BitgoKeyShare] | - |
walletHSMGPGPublicKeySigs | String | - |
BitgoKeyShare
| Field | Type | Description |
|---|---|---|
from | BitgoKeyShareType! | - |
to | BitgoKeyShareType! | - |
publicShare | String! | - |
privateShare | String! | - |
hsmSig | String! | - |
BitgoKeySignature
| Field | Type | Description |
|---|---|---|
backupPub | String | - |
bitgoPub | String | - |
BitgoPendingApproval
| Field | Type | Description |
|---|---|---|
id | String! | - |
coin | String! | - |
wallet | String! | - |
enterprise | String! | - |
organization | String | - |
creator | String! | - |
createDate | timestamptz! | - |
info | BitgoPendingApprovalInfo! | - |
state | BitgoPendingApprovalState! | - |
scope | BitgoScope! | - |
userIds | [String!]! | - |
approvalsRequired | Int! | - |
walletLabel | String | - |
resolvers | [jsonb] | - |
addressLabels | [BitgoPendingApprovalAddressLabel] | - |
BitgoPendingApprovalAddressLabel
| Field | Type | Description |
|---|---|---|
address | String! | - |
label | String! | - |
BitgoPendingApprovalBuildParams
| Field | Type | Description |
|---|---|---|
recipients | [BitgoPendingApprovalRecipient] | - |
comment | String | - |
instant | Boolean | - |
BitgoPendingApprovalInfo
| Field | Type | Description |
|---|---|---|
type | String! | - |
transactionRequest | BitgoPendingApprovalTransactionRequest | - |
transactionRequestFull | jsonb | - |
userChangeRequest | jsonb | - |
policyRuleRequest | jsonb | - |
updateApprovalsRequiredRequest | jsonb | - |
enterpriseModificationRequest | jsonb | - |
enterpriseInviteRequest | jsonb | - |
BitgoPendingApprovalRecipient
| Field | Type | Description |
|---|---|---|
_id | String | - |
address | String | - |
amount | String | - |
BitgoPendingApprovalsInput (Input)
| Field | Type | Description |
|---|---|---|
prevId | String | - |
limit | Int | - |
coin | [String] | - |
enterpriseId | String | - |
organizationId | String | - |
requestType | BitgoPendingApprovalRequestType | - |
state | [BitgoPendingApprovalState] | - |
walletId | String | - |
expandWalletLabels | Boolean | - |
expandAddressLabels | Boolean | - |
BitgoPendingApprovalsResponse
| Field | Type | Description |
|---|---|---|
pendingApprovals | [BitgoPendingApproval!]! | - |
count | Int! | - |
nextBatchPrevId | String | - |
BitgoPendingApprovalTransactionRequest
| Field | Type | Description |
|---|---|---|
coinSpecific | jsonb | - |
verificationItems | [String] | - |
videoApprovers | [jsonb] | - |
requestedAmount | String | - |
fee | Float | - |
sourceWallet | String | - |
recipients | [BitgoPendingApprovalRecipient] | - |
isUnsigned | Boolean | - |
buildParams | BitgoPendingApprovalBuildParams | - |
policyUniqueId | String | - |
verificationRuleId | String | - |
BitgoSendCoinsInput (Input)
| Field | Type | Description |
|---|---|---|
coin | String | - |
amount | bigint! | - |
address | String! | - |
data | String | - |
feeLimit | bigint | - |
message | String | - |
prv | String | - |
tokenName | String | - |
minConfirms | Int | - |
walletPassphrase | String | - |
BitgoSendCoinsResponse
| Field | Type | Description |
|---|---|---|
transfer | BitgoTransfer! | - |
txid | String! | - |
tx | String! | - |
status | String! | - |
BitgoSendTransactionInput (Input)
| Field | Type | Description |
|---|---|---|
digitalWalletId | ID! | - |
size | String! | - |
recipient | String! | - |
password | String! | - |
coin | String | - |
data | String | - |
feeLimit | String | - |
invoiceId | Int | - |
note | String | - |
saveToAddressBook | Boolean | - |
addressBookNickname | String | - |
BitgoSendTransactionResponse
| Field | Type | Description |
|---|---|---|
errors | [String] | - |
warnings | [String] | - |
txHex | String | - |
pendingApprovalId | String | - |
txId | String | - |
cooldownSeconds | Int | - |
BitgoSyncAllTransactionsInput (Input)
| Field | Type | Description |
|---|---|---|
syncFromBeginning | Boolean | If true, ignores Redis timestamp and syncs all transfers from the beginning of time. |
| Use with caution - this will process ALL historical transactions. |
BitgoSyncAllTransactionsResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
jobCount | Int! | - |
walletCount | Int | - |
error | String | - |
BitgoSyncDigitalWalletTransactionsInput (Input)
| Field | Type | Description |
|---|---|---|
digitalWalletId | Int! | - |
syncFromBeginning | Boolean | If true, ignores Redis timestamp and syncs all transfers from the beginning of time. |
| Use with caution - this will process ALL historical transactions for this wallet. |
BitgoSyncDigitalWalletTransactionsResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
jobCount | Int! | - |
error | String | - |
BitgoSyncTokenSupportResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
totalTokens | Int! | - |
markedSupported | Int! | - |
markedUnsupported | Int! | - |
error | String | - |
BitgoSyncTransactionInput (Input)
| Field | Type | Description |
|---|---|---|
coin | String! | - |
walletId | String! | - |
transferId | String! | - |
BitgoSyncTransactionResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
transactionId | String | - |
error | String | - |
BitgoSyncWalletTransactionsInput (Input)
| Field | Type | Description |
|---|---|---|
walletId | String! | - |
syncFromBeginning | Boolean | If true, ignores Redis timestamp and syncs all transfers from the beginning of time. |
| Use with caution - this will process ALL historical transactions for this wallet. |
BitgoSyncWalletTransactionsResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
jobCount | Int! | - |
error | String | - |
BitgoTransfer
| Field | Type | Description |
|---|---|---|
normalizedTxHash | String | - |
entries | [BitgoTransferEntry] | - |
id | String | - |
coin | String | - |
wallet | String | - |
walletType | String | - |
enterprise | String | - |
txid | String | - |
height | bigint | - |
heightId | String | - |
date | timestamptz | - |
confirmations | bigint | - |
type | BitgoTransferType | - |
value | bigint | - |
valueString | String | - |
baseValue | bigint | - |
baseValueString | String | - |
feeString | String | - |
payGoFee | bigint | - |
payGoFeeString | String | - |
usd | Float | - |
usdRate | Float | - |
state | BitgoTransferState | - |
instant | Boolean | - |
isReward | Boolean | - |
isFee | Boolean | - |
tags | [String] | - |
history | [BitgoTransferHistory] | - |
coinSpecific | jsonb | - |
usersNotified | Boolean | - |
confirmedTime | timestamptz | - |
createdTime | timestamptz | - |
label | String | - |
BitgoTransferEntry
| Field | Type | Description |
|---|---|---|
address | String | - |
value | bigint | - |
valueString | String | - |
isPayGo | Boolean | - |
wallet | String | - |
BitgoTransferHistory
| Field | Type | Description |
|---|---|---|
date | timestamptz | - |
action | BitgoTransferHistoryActionType | - |
comment | String | - |
BitgoTransferInput (Input)
| Field | Type | Description |
|---|---|---|
amount | Int! | - |
BitgoWallet
| Field | Type | Description |
|---|---|---|
id | String | - |
label | String | - |
approvalsRequired | Int | - |
balance | bigint | - |
confirmedBalance | bigint | - |
spendableBalance | bigint | - |
balanceString | String | - |
confirmedBalanceString | String | - |
spendableBalanceString | String | - |
coin | String! | - |
keys | [String] | - |
tags | [String] | - |
receiveAddress | BitgoAddress | - |
m | Int | Number of signatures required. This value must be 2 for hot wallets, 1 for ofc wallets, and not specified for custodial wallets. |
n | Int | Number of keys provided. This value must be 3 for hot wallets, 1 for ofc wallets, and not specified for custodial wallets. |
migratedFrom | String | - |
coinSpecific | jsonb | - |
enterprise | String | - |
customChangeKeySignatures | BitgoCustomChangeKeySignatures | - |
isCold | Boolean | - |
deleted | Boolean | - |
allowBackupKeySigning | Boolean | - |
recoverable | Boolean! | - |
startDate | timestamptz | - |
type | BitgoWalletType | - |
pendingChainInitialization | Boolean | - |
hasLargeNumberOfAddresses | Boolean | - |
multisigType | BitgoMultiSigType | - |
buildDefaults | BitgoBuildDefaults | BTC only |
transfers | [BitgoTransfer] | - |
addresses | [BitgoAddress] | - |
coinData | BitgoCoinData | - |
BitgoWebhookRegistration
| Field | Type | Description |
|---|---|---|
id | String! | - |
type | String! | - |
url | String! | - |
coin | String | - |
walletId | String! | - |
numConfirmations | Int | - |
allToken | Boolean | - |
createdAt | String | - |
BitgoWhitelistEntry
| Field | Type | Description |
|---|---|---|
id | ID! | - |
walletId | String | - |
createdAt | timestamptz | - |
ruleType | String | - |
actionType | String | - |
address | String | - |
coin | String | - |
entryType | String | - |
label | String | - |
verificationState | String | - |
BlacklistedToken
| Field | Type | Description |
|---|---|---|
jti | String! | - |
sub | String | - |
reason | String | - |
revokedAt | String! | - |
revokedBy | String | - |
ttlSeconds | Int! | - |
BlacklistedTokenPage
| Field | Type | Description |
|---|---|---|
tokens | [BlacklistedToken!]! | - |
nextCursor | String | - |
BookFundRedemptionInput (Input)
| Field | Type | Description |
|---|---|---|
redemptionId | Int! | - |
fundNavId | Int | - |
BookFundRedemptionResult
| Field | Type | Description |
|---|---|---|
redemptionId | Int! | - |
fundNavId | Int! | - |
navPerShare | Float! | - |
sharesRedeemed | Float! | - |
amount | Float! | - |
pdfUrl | String! | - |
BookFundSubscriptionInput (Input)
| Field | Type | Description |
|---|---|---|
subscriptionId | Int! | - |
fundNavId | Int | - |
BookFundSubscriptionResult
| Field | Type | Description |
|---|---|---|
subscriptionId | Int! | - |
fundNavId | Int! | - |
navPerShare | Float! | - |
sharesIssued | Float! | - |
pdfUrl | String! | - |
BridgeQuoteData
| Field | Type | Description |
|---|---|---|
quoteId | Int! | - |
sourceAmount | String! | - |
destinationMinimumAmount | String! | - |
destinationTokenSymbol | String! | - |
estimatedTime | Int | - |
priceImpact | String | - |
amountInUsd | String | - |
symbiosisFee | String | - |
platformFeeBps | Int | - |
platformFeeAmount | String | - |
expiresAt | timestamptz! | - |
routes | [BridgeRoute!] | - |
BridgeQuoteResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
quote | BridgeQuoteData | - |
error | String | - |
structuredError | SmartWalletErrorResponse | - |
BridgeResultResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
transactionHash | String | - |
quoteId | Int | - |
status | String | - |
error | String | - |
structuredError | SmartWalletErrorResponse | - |
BridgeRoute
| Field | Type | Description |
|---|---|---|
provider | String! | - |
tokens | [BridgeRouteToken!]! | - |
BridgeRouteToken
| Field | Type | Description |
|---|---|---|
symbol | String! | - |
chainId | Int! | - |
BridgeToTronInput (Input)
| Field | Type | Description |
|---|---|---|
sourceDigitalWalletId | ID! | - |
destinationDigitalWalletId | ID! | - |
tokenAddress | String! | - |
amount | String! | - |
slippageBps | Int | - |
BulkImportWhitelistInput (Input)
| Field | Type | Description |
|---|---|---|
digitalWalletId | Int! | - |
entries | [WhitelistEntryInput!]! | - |
BulkImportWhitelistResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
added | Int | - |
skipped | Int | - |
errors | [String!] | - |
error | String | - |
BulkInvoiceEmailResult
| Field | Type | Description |
|---|---|---|
invoiceId | Int! | - |
success | Boolean! | - |
error | String | - |
BullJobResponse
| Field | Type | Description |
|---|---|---|
name | String | - |
data | jsonb | - |
opts | BullJobResponseOpts | - |
id | String | - |
progress | Int | - |
returnvalue | jsonb | - |
stacktrace | jsonb | - |
attemptsMade | Int | - |
delay | Int | - |
timestamp | bigint | - |
queueQualifiedName | String | - |
BullJobResponseOpts
| Field | Type | Description |
|---|---|---|
attempts | Int | - |
delay | Int | - |
BurnDustResult
| Field | Type | Description |
|---|---|---|
walletsScanned | Int! | - |
burnableFound | Int! | - |
txsSubmitted | Int! | - |
txsFailed | Int! | - |
tokens | [BurnDustToken!]! | - |
errors | [String!]! | - |
BurnDustToken
| Field | Type | Description |
|---|---|---|
chainId | Int! | - |
contractAddress | String! | - |
tokenSymbol | String! | - |
balanceWei | String! | - |
usdValue | Float | - |
walletId | Int! | - |
txHash | String | - |
error | String | - |
CalculateBalancerLPPriceResponse
| Field | Type | Description |
|---|---|---|
price | BalancerLPPrice | - |
jobId | String | - |
success | Boolean! | - |
error | String | - |
CalculateOtcQuoteInput (Input)
| Field | Type | Description |
|---|---|---|
fromCurrency | String! | - |
toCurrency | String! | - |
side | String! | - |
size | Float! | - |
slippage | Float | - |
userId | String | - |
tradeType | Int | - |
limitPrice | Float | - |
CalculateOtcQuoteResponse
| Field | Type | Description |
|---|---|---|
quoteExchangeRate | Float! | - |
feePercentage | Float! | - |
feeAmount | Float! | - |
userId | String! | - |
fromCurrency | String! | - |
toCurrency | String! | - |
side | String! | - |
size | Float! | - |
sizeUsd | Float! | - |
feeAmountUsd | Float! | - |
netSize | Float! | - |
netSizeUsd | Float! | - |
baseRateUsd | Float! | - |
fromCurrencyRateUsd | Float! | - |
toCurrencyRateUsd | Float! | - |
CampaignAdUploadTicket
| Field | Type | Description |
|---|---|---|
uploadUrl | String! | - |
gcsPath | String! | - |
publicUrl | String! | - |
contentType | String! | - |
expiresIn | Int! | - |
mediaToken | String! | - |
CancelCardDisputeResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
error | String | - |
CancelCardInput (Input)
Input for canceling a Card (irreversible)
| Field | Type | Description |
|---|---|---|
cardId | Int! | Card ID (AgioCard_card.id - our internal card ID) |
reason | String | Optional reason for cancellation |
CancelEmailCampaignResult
| Field | Type | Description |
|---|---|---|
campaignId | ID! | - |
cancelled | Boolean! | - |
CancelGoTradeInput (Input)
| Field | Type | Description |
|---|---|---|
goAccountId | Int! | - |
tradeId | Int! | - |
CancelGoTradeResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
error | String | - |
CancelLimitOrderInput (Input)
| Field | Type | Description |
|---|---|---|
id | Int! | - |
CancelQueueJobInput (Input)
| Field | Type | Description |
|---|---|---|
queueName | String! | - |
jobId | String! | - |
CancelQueueJobResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
queueName | String! | - |
jobId | String! | - |
error | String | - |
CardAddress
| Field | Type | Description |
|---|---|---|
line1 | String! | - |
line2 | String | - |
city | String! | - |
region | String! | - |
postalCode | String! | - |
countryCode | String! | - |
CardAddressInput (Input)
Address input for the card issuer API applications
| Field | Type | Description |
|---|---|---|
line1 | String! | - |
line2 | String | - |
city | String! | - |
region | String! | - |
postalCode | String! | - |
countryCode | String! | - |
country | String | - |
CardApplication
| Field | Type | Description |
|---|---|---|
id | ID! | - |
cardApplicationExternalId | String! | - |
applicantId | String! | - |
walletAddress | String! | - |
applicationStatus | CardApplicationStatus! | - |
applicationReason | String | - |
isActive | Boolean! | - |
firstName | String | - |
lastName | String | - |
email | String | - |
phoneCountryCode | String | - |
phoneNumber | String | - |
address | CardAddress | - |
applicationExternalVerificationLink | CardApplicationLink | - |
applicationCompletionLink | CardApplicationLink | - |
createdAt | timestamptz | - |
updatedAt | timestamptz | - |
CardApplicationLink
| Field | Type | Description |
|---|---|---|
url | String! | - |
userId | String | - |
CardApplicationPrefill
Prefilled data for an individual card application, sourced from the user's Sumsub KYC questionnaire (the optional "Credit Card Details" section). Every field is optional — populated only when the applicant answered that question during KYC, otherwise null. occupation is the raw questionnaire free-text; annualSalary / accountPurpose / expectedMonthlyVolume are already mapped to the Rain form enum values.
| Field | Type | Description |
|---|---|---|
occupation | String | - |
annualSalary | String | - |
accountPurpose | String | - |
expectedMonthlyVolume | String | - |
CardApplicationResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
applicantId | String | - |
cardApplicationId | Int | Internal numeric application id (AgioCard_card_application.id). Pass this to createCard. |
cardApplicationExternalId | String | - |
applicationStatus | String | - |
applicationCompletionUrl | String | URL to complete additional verification if status is NEEDSVERIFICATION |
shareToken | String | - |
walletAddress | String | EVM wallet address on the application. Echoes back the input walletAddress, |
or the provisioned smart wallet address when createWallet: true was used. | ||
error | String | - |
errorCode | String | Machine-readable error code if the application failed (e.g. CARD_INSUFFICIENT_FUNDS). |
CardBalance
User balance information from the card issuer API. All monetary values are in USD (converted from cents).
| Field | Type | Description |
|---|---|---|
creditLimit | Float! | Credit limit of the user, in USD |
pendingCharges | Float! | Pending charges (authorized but not settled), in USD |
postedCharges | Float! | Posted charges (settled transactions), in USD |
balanceDue | Float! | Balance due (amount owed), in USD |
spendingPower | Float! | Available spending power (creditLimit - pendingCharges - postedCharges), in USD |
CardBalanceResponse
Response from fetching card balance
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
id | Int | Our internal card ID (AgioCard_card.id) |
balance | CardBalance | - |
error | String | - |
CardCorporateAddressPrefill
Prefilled address from verified KYB data (all fields optional — populate what's available)
| Field | Type | Description |
|---|---|---|
line1 | String | - |
city | String | - |
region | String | - |
postalCode | String | - |
countryCode | String | - |
CardCorporateApplicationPrefill
Prefilled data for a corporate card application, sourced from the organization's verified KYB record. Returns whatever verified data is available — may be partial if KYB is incomplete.
| Field | Type | Description |
|---|---|---|
name | String | - |
registrationNumber | String | - |
taxId | String | - |
address | CardCorporateAddressPrefill | - |
ubos | [CardCorporatePersonPrefill!]! | - |
representatives | [CardCorporatePersonPrefill!]! | - |
CardCorporateApplicationResponse
Response from creating a corporate Card application
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
companyId | String | - |
name | String | - |
applicationStatus | String | - |
error | String | - |
CardCorporatePersonPrefill
Prefilled person data for UBOs / representatives from verified KYB sub-applicants
| Field | Type | Description |
|---|---|---|
firstName | String | - |
lastName | String | - |
birthDate | String | - |
nationalId | String | - |
countryOfIssue | String | - |
email | String | - |
phoneCountryCode | String | - |
phoneRegionCode | String | - |
phoneNumber | String | - |
address | CardCorporateAddressPrefill | - |
CardExpiry
Card expiry date returned from the card issuer API
| Field | Type | Description |
|---|---|---|
month | String! | - |
year | String! | - |
CardFundSubClientFromTreasuryInput (Input)
Input for funding a sub-client's collateral from the partner Treasury wallet.
| Field | Type | Description |
|---|---|---|
externalUserId | String! | card_user_id of the sub-client to fund. |
amountCents | Int! | Funding amount in integer cents. |
CardFundSubClientFromTreasuryResponse
Response from enqueueing a sub-client funding job.
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
jobId | String | BullMQ job id for status polling. |
errorCode | String | Synchronous enqueue errorCode: INVALID_AMOUNT |
| Async job failures (e.g. COLLATERAL_CONTRACT_NOT_READY) surface via job status, not here. | ||
error | String | - |
CardFundSubClientStatusResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
jobId | String! | - |
status | String | Funding job lifecycle. One of: pending, running, submitted, completed, failed, |
insufficient_balance. An indeterminate on-chain send is left in the guarded submitted | ||
state (never failed) for out-of-band reconciliation. | ||
txHash | String | - |
failedReason | String | Human-readable async failure diagnostic. Not a stable code — do not branch on its text. |
failedCode | String | Machine-readable async failure code (e.g. COLLATERAL_CONTRACT_NOT_READY, |
| TREASURY_WALLET_MISMATCH, FUNDING_SEND_INDETERMINATE, INVALID_AMOUNT, | ||
SUBCLIENT_NOT_FOUND, TREASURY_NOT_CONFIGURED). Separate from the query-level errorCode. | ||
attempts | Int | - |
errorCode | String | Query-level error: FORBIDDEN, NOT_FOUND, or INTERNAL_ERROR. |
errorMessage | String | - |
CardLimitInput (Input)
Spending limit configuration
| Field | Type | Description |
|---|---|---|
amount | Int! | Amount in cents |
frequency | CardLimitFrequency! | Limit frequency period |
CardLimitResponse
Response from updating card limit
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
id | Int | Our internal card ID (AgioCard_card.id) |
cardId | String | card ID |
limitAmount | Int | - |
limitFrequency | String | - |
error | String | - |
CardOperationResponse
Response from the card issuer API card operations (freeze, unfreeze, cancel)
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
id | Int | Our internal card ID (AgioCard_card.id) |
cardId | String | card ID |
status | String | - |
error | String | - |
errorCode | String | Machine-readable error code if the operation failed (e.g. CARD_INSUFFICIENT_FUNDS). |
CardPinResponse
Response from PIN operations (set/get)
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
id | Int | Our internal card ID (AgioCard_card.id) |
encryptedPin | String | Encrypted PIN. Decrypt with decryptWithSessionKey from agio-utils. |
error | String | - |
CardReminderResultItem
| Field | Type | Description |
|---|---|---|
cardId | String! | - |
sent | Boolean! | - |
skipped | Boolean | - |
dryRun | Boolean | - |
reminderNumber | Int | - |
error | String | - |
cardType | String | - |
last4 | String | - |
nickname | String | - |
cardHolderName | String | - |
cardHolderEmail | String | - |
organizationName | String | - |
daysSinceCreation | Int | - |
CardReminderRunResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
total | Int! | - |
sent | Int! | - |
skipped | Int! | - |
errors | Int! | - |
results | [CardReminderResultItem!]! | - |
CardReplacedCard
Details of a replaced card from the card issuer API
| Field | Type | Description |
|---|---|---|
id | String! | New card ID from the card issuer |
type | String! | Card type (always "virtual" for replacements) |
status | String! | Card status after replacement |
last4 | String! | Last 4 digits of new card number |
expirationMonth | String! | Expiration month (MM format) |
expirationYear | String! | Expiration year (YYYY format) |
CardReplacementResponse
Response from replacing a virtual card
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
id | Int | Our internal card ID (AgioCard_card.id) |
newCard | CardReplacedCard | Details of the new replacement card |
oldCardId | String | ID of the old card that was canceled |
error | String | - |
CardSecrets
Decrypted card secrets from the card issuer API. These are sensitive values - handle with care.
| Field | Type | Description |
|---|---|---|
pan | String! | Full Primary Account Number (card number) |
cvc | String! | Card Verification Code (CVV/CVC) |
expiry | CardExpiry | Card expiration date |
CardSecretsResponse
Response from revealing card secrets
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
id | Int | Our internal card ID (AgioCard_card.id) |
encryptedSecrets | String | Encrypted card secrets JSON. Decrypt with decryptWithSessionKey from agio-utils. |
| Format: { pan: string, cvc: string, expiry: { month: string, year: string } } | ||
error | String | - |
CardShippingInput (Input)
Shipping address input for physical cards
| Field | Type | Description |
|---|---|---|
line1 | String! | - |
line2 | String | - |
city | String! | - |
region | String! | - |
postalCode | String! | - |
countryCode | String! | - |
phoneNumber | String! | Phone number (required by the card issuer API for shipping) |
firstName | String | - |
lastName | String | - |
method | CardShippingMethod | Shipping method (standard or express) |
CardWithdrawForPartnerInput (Input)
Input for a partner-scoped collateral withdrawal routed to the partner Treasury wallet.
| Field | Type | Description |
|---|---|---|
externalUserId | String! | The sub-client's card_user_id (issued by createPartnerCardUser). |
amountCents | Int! | Withdrawal amount in integer cents (e.g., 12345 = $123.45). |
chainId | Int | Chain to withdraw from. Defaults to the partner treasury config chain_id when omitted. |
dryRun | Boolean | When true, validates and prices the withdrawal without submitting an on-chain transaction. |
CardWithdrawForPartnerResponse
Response from a partner-scoped collateral withdrawal.
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
transactionHash | String | - |
errorCode | String | INVALID_AMOUNT |
| INSUFFICIENT_SPENDING_POWER | CARD_SIGNING_IN_FLIGHT | INTERNAL_ERROR |
error | String | - |
spendingPowerCents | Int | Populated on INSUFFICIENT_SPENDING_POWER: available spending power in integer cents. |
requestedCents | Int | Populated on INSUFFICIENT_SPENDING_POWER: the requested amount echoed back, in cents. |
retryAfterSec | Int | Populated on CARD_SIGNING_IN_FLIGHT: seconds to wait before retrying. |
CardWithdrawInput (Input)
Input for withdrawing collateral from a Card smart wallet
| Field | Type | Description |
|---|---|---|
tokenAddress | String! | ERC-20 token contract address to withdraw |
amount | String! | Amount to withdraw (human-readable, e.g. "100.5") |
chainId | Int | Chain ID to withdraw from. When omitted, resolved by matching tokenAddress across all chains. |
CardWithdrawResponse
Response from card withdrawal operation
| Field | Type | Description |
|---|---|---|
success | Boolean! | Whether the withdrawal succeeded |
transactionHash | String | On-chain transaction hash |
chainId | Int | Chain ID where the withdrawal occurred |
tokenAddress | String | Token contract address withdrawn |
amount | String | Amount withdrawn (human-readable) |
error | String | Error message if the withdrawal failed |
errorCode | String | Machine-readable error code if the withdrawal failed (e.g. CARD_INSUFFICIENT_FUNDS) |
retryAfterSec | Int | Seconds until the active the card issuer signature expires. Present when success=false due to a signature conflict (409/425). |
| The client should surface this to the user and retry after this duration. |
ChargeCardInput (Input)
Input for charging a Card with a fee. Requires card:charge permission. Debits from the user's collateral balance.
| Field | Type | Description |
|---|---|---|
cardUserId | uuid! | The cardholder's cardUserId (the same UUID returned by createPartnerCardUser). |
feeCents | Int! | Fee amount in cents (e.g., 2550 for $25.50) |
feeDescription | String! | Description of the fee (e.g., "Monthly service fee", "Card replacement fee") |
| Stored in fee_description field and used as the card issuer API description. |
ChargeCardResponse
Response from card charge operation
| Field | Type | Description |
|---|---|---|
success | Boolean! | Whether the charge succeeded |
chargeId | String | Charge ID returned by the card issuer API |
amount | Float | Amount charged in USD |
feeDescription | String | Description of the fee that was charged |
error | String | Error message if the charge failed |
errorCode | String | Machine-readable error code if the charge failed (e.g. CARD_INSUFFICIENT_FUNDS) |
ChatMessageResponse
| Field | Type | Description |
|---|---|---|
id | Int | - |
chatId | Int | - |
peerAUserId | String | - |
peerBUserId | String | - |
createdAt | timestamptz | - |
updatedAt | timestamptz | - |
text | String | - |
payload | jsonb | - |
userId | String | - |
telegramMessageId | bigint | - |
ChildEnterprise
| Field | Type | Description |
|---|---|---|
id | Int! | - |
organizationId | uuid! | - |
userId | String! | - |
bitgoEnterpriseId | String! | - |
kycStatus | String! | - |
kycData | jsonb | - |
label | String | - |
createdAt | timestamptz! | - |
updatedAt | timestamptz! | - |
goAccounts | [GoAccount!] | - |
CoinPrice
| Field | Type | Description |
|---|---|---|
coin_id | String | - |
created_at | timestamptz! | - |
id | ID! | - |
market_cap | String! | - |
market_cap_rank | Int | - |
price_updated_at | timestamptz! | - |
price_usd | String! | - |
symbol | String! | - |
CoinsWhereInput (Input)
| Field | Type | Description |
|---|---|---|
chain | String | - |
family | String | - |
enabled | Boolean | - |
CommitJournalsResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
createdCount | Int! | - |
skippedCount | Int! | - |
journalEntryIds | [Int!]! | - |
error | String | - |
CompleteProfileInput (Input)
| Field | Type | Description |
|---|---|---|
sessionToken | String! | - |
stateToken | String! | - |
givenName | String! | - |
familyName | String! | - |
phoneNumber | String! | - |
countryCode | String! | - |
address | String! | - |
address2 | String | - |
city | String! | - |
postalCode | String! | - |
country | String! | - |
stateOrProvince | String! | - |
picture | String | - |
email | String! | - |
termsAndConditionsAccepted | Boolean | - |
appSlug | String | - |
personas | [String!] | - |
hasAcceptedRiskDisclaimer | Boolean | - |
fundAccreditedType | String | - |
isOrganization | Boolean | - |
organizationName | String | - |
organizationType | String | - |
organizationTypeId | Int | - |
organizationLogoUrl | String | - |
organizationParentOrganizationId | uuid | - |
organizationCountryCode | String | - |
organizationAddress | String | - |
organizationAddress2 | String | - |
organizationCity | String | - |
organizationPostalCode | String | - |
organizationStateOrProvince | String | - |
CompleteProfileResponse
| Field | Type | Description |
|---|---|---|
redirectUrl | String! | - |
ComplianceApproveInput (Input)
| Field | Type | Description |
|---|---|---|
applicantId | String! | - |
kycProfileId | String! | - |
notes | String | - |
riskLevel | String | - |
tags | [String!] | - |
ComplianceNoteInput (Input)
| Field | Type | Description |
|---|---|---|
kycProfileId | String! | - |
notes | String! | - |
action | String | - |
ComplianceRejectInput (Input)
| Field | Type | Description |
|---|---|---|
applicantId | String! | - |
kycProfileId | String! | - |
reasons | jsonb! | - |
notes | String | - |
tags | [String!] | - |
ComplianceReviewResult
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
reviewId | String | - |
message | String | - |
ComplianceRiskLevelInput (Input)
| Field | Type | Description |
|---|---|---|
applicantId | String! | - |
kycProfileId | String! | - |
riskLevel | String! | - |
comment | String! | - |
ComplianceUpgradeMemberGap
| Field | Type | Description |
|---|---|---|
userId | String | - |
email | String | - |
name | String | - |
role | String | - |
ownershipPercentage | Float | - |
isBeneficialOwner | Boolean | - |
ComplianceUpgradeResult
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
message | String | - |
organizationId | String! | - |
newLevelName | String | - |
beneficiariesAttached | Int | - |
membersNeedingKyc | Int | - |
membersWithoutKyc | [ComplianceUpgradeMemberGap!] | - |
ComplianceUpgradeToNestedKybInput (Input)
| Field | Type | Description |
|---|---|---|
organizationId | String! | - |
sendKycInvites | Boolean | - |
notes | String | - |
CorporateApplicationEntityInput (Input)
Legal entity information for corporate applications
| Field | Type | Description |
|---|---|---|
name | String! | Legal name of the entity |
description | String! | Description of the business |
industry | String! | NAICS industry code (e.g., "541512" for Computer Systems Design) |
registrationNumber | String! | Business registration number |
taxId | String! | Tax ID (EIN) |
website | String! | Company website URL (REQUIRED by the card issuer API) |
type | String! | Entity type (LLC, Corporation, Partnership, etc.) |
expectedSpend | String! | Expected monthly spend range |
CorporateApplicationInitialUserInput (Input)
Initial user for corporate application (must have wallet address)
| Field | Type | Description |
|---|---|---|
firstName | String! | - |
lastName | String! | - |
birthDate | String! | - |
nationalId | String! | - |
countryOfIssue | String! | - |
email | String! | - |
address | CardAddressInput! | - |
phoneCountryCode | String | - |
phoneNumber | String | - |
isTermsOfServiceAccepted | Boolean! | - |
role | String | - |
walletAddress | String | - |
cardNickname | String | User-defined card nickname for the initial user's card (optional). |
| Max 26 chars: alphanumeric, spaces, periods, hyphens only. | ||
requestedLimitAmount | Int | Desired credit limit amount in dollars for initial user's card (e.g., 25000) |
requestedLimitFrequency | String | Limit frequency for initial user's card (e.g., "30 day", "7 day") |
sessionId | String | Session ID from generateEncryptionKeys mutation (required if encryptedPin provided) |
encryptedPin | String | Encrypted PIN for initial user (use encryptPassphraseForTransfer from agio-utils). |
| PIN (4-6 digits) is staged during application and set automatically when card is activated. | ||
| Must meet security requirements: no repeated digits, no sequential patterns. |
CorporateApplicationPersonInput (Input)
Person data for corporate applications (UBOs, representatives)
| Field | Type | Description |
|---|---|---|
firstName | String! | - |
lastName | String! | - |
birthDate | String! | - |
nationalId | String! | - |
countryOfIssue | String! | - |
email | String! | - |
address | CardAddressInput! | - |
phoneCountryCode | String | - |
phoneNumber | String | - |
CreateBitgoWalletInput (Input)
| Field | Type | Description |
|---|---|---|
label | String! | - |
backupProvider | BitgoBackupProviderType | - |
encryptedUserKeyPair | BitgoEncryptionKeyPairInput! | - |
multisigType | BitgoMultiSigType | - |
type | BitgoWalletType! | - |
CreateBitgoWalletResponse
| Field | Type | Description |
|---|---|---|
id | String! | - |
userKey | BitgoKey! | - |
bitgoKey | BitgoKey! | - |
backupKey | BitgoKey! | - |
label | String! | - |
coinId | String! | - |
wallet | BitgoWallet | - |
webhookId | String | - |
receiveAddress | String | - |
CreateCardApplicationInput (Input)
| Field | Type | Description |
|---|---|---|
walletAddress | String! | Ethereum wallet address for the card (0x... format) |
occupation | String! | SOC occupation description (e.g., "Software Developers", "Chief Executives") |
annualSalary | String! | Estimated annual salary |
accountPurpose | String! | Purpose of the account (e.g., "Savings", "Business") |
expectedMonthlyVolume | String! | Expected monthly transaction volume |
isTermsOfServiceAccepted | Boolean! | User must accept the card issuer's terms of service |
cardNickname | String | User-defined card nickname (optional) |
requestedLimitAmount | Int | Desired credit limit amount in dollars (e.g., 25000) |
requestedLimitFrequency | String | Limit frequency (e.g., "30 day", "7 day") |
sessionId | String | Session ID from generateEncryptionKeys mutation (required if encryptedPin provided) |
encryptedPin | String | Encrypted PIN (use encryptPassphraseForTransfer from agio-utils). |
| PIN (4-6 digits) is staged during application and set automatically when card is activated. | ||
| Must meet security requirements: no repeated digits, no sequential patterns. |
CreateCardCorporateApplicationInput (Input)
Input for creating a corporate (company) Card application
| Field | Type | Description |
|---|---|---|
name | String! | Company name |
address | CardAddressInput! | Company physical address |
entity | CorporateApplicationEntityInput! | Company legal entity information |
initialUser | CorporateApplicationInitialUserInput! | Initial user/admin of the company - must have a wallet address |
representatives | [CorporateApplicationPersonInput!]! | Company representatives |
ultimateBeneficialOwners | [CorporateApplicationPersonInput!]! | Ultimate beneficial owners (UBOs) |
sourceKey | String | Source key for tracking (optional) |
CreateCardDisputeInput (Input)
| Field | Type | Description |
|---|---|---|
transactionId | Int! | - |
textEvidence | String | - |
CreateCardDisputeResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
disputeId | String | - |
error | String | - |
CreateCardInput (Input)
Input for creating a new Card (virtual or physical) Unified mutation that handles both card types via cardType discriminator.
| Field | Type | Description |
|---|---|---|
cardApplicationId | Int! | Card application ID (AgioCard_card_application.id) - the approved application to create card under |
cardType | CardType! | Card type - determines whether shipping is required |
sessionId | String | Session ID from generateEncryptionKeys mutation (required if encryptedPin provided) |
encryptedPin | String | Encrypted PIN (use encryptPassphraseForTransfer from agio-utils). |
| For virtual cards, PIN is set immediately. For physical cards, PIN is staged and set when card is activated. | ||
limit | CardLimitInput | Optional spending limit |
displayName | String | Display name on card (max 26 chars: alphanumeric, space, period, hyphen) |
| Can only be set at creation - immutable after. | ||
shipping | CardShippingInput | Shipping address - REQUIRED for physical cards, ignored for virtual |
billing | CardAddressInput | Billing address - defaults to shipping address if omitted |
CreateCardResponse
Response from creating a new card
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
id | Int | Our internal card ID (AgioCard_card.id) |
cardId | String | New card ID from the card issuer |
cardType | String | Card type (virtual or physical) |
status | String | Card status after creation |
last4 | String | Last 4 digits of card number |
expirationMonth | String | Expiration month |
expirationYear | String | Expiration year |
error | String | - |
CreateChildEnterpriseInput (Input)
| Field | Type | Description |
|---|---|---|
organizationId | uuid! | - |
userId | String! | - |
label | String | - |
firstName | String! | - |
lastName | String! | - |
email | String! | - |
dateOfBirth | String! | - |
nationality | String! | - |
countryOfResidence | String! | - |
phoneNumber | String | - |
address | KYCAddressInput! | - |
identityDocument | KYCIdentityDocumentInput! | - |
CreateChildEnterpriseResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
childEnterprise | ChildEnterprise | - |
error | String | - |
CreateDigitalWalletAddressResponse
| Field | Type | Description |
|---|---|---|
address | DigitalWalletDepositAddress | - |
errors | [String] | - |
warnings | [String] | - |
CreateDigitalWalletInput (Input)
| Field | Type | Description |
|---|---|---|
label | String! | - |
walletTypeId | Int! | - |
walletTypeSpecificOptions | CreateDigitalWalletTypeSpecificOptions | - |
CreateDigitalWalletResponse
| Field | Type | Description |
|---|---|---|
digitalWallet | DigitalWalletSummary | - |
backupCardPdf | String | - |
activationCode | String | - |
errors | [String] | - |
warnings | [String] | - |
CreateDigitalWalletTypeSpecificOptions (Input)
| Field | Type | Description |
|---|---|---|
evmChainId | Int | - |
evmSignedMessage | String | - |
evmSignature | String | - |
evmReadOnly | Boolean | - |
evmReadOnlyAddress | String | - |
coinId | String | - |
bitgoEncryptedUserKeyPair | BitgoEncryptionKeyPairInput | - |
bitgoEncryptedPassphrase | BitgoEncryptedPassphraseInput | - |
bitgoBackupProvider | BitgoBackupProviderType | - |
bitgoMultisigType | BitgoMultiSigType | - |
bitgoType | BitgoWalletType | - |
smartWalletAccountAddress | String | - |
smartWalletSignerAddress | String | - |
smartWalletSessionKey | String | - |
smartWalletSessionKeyAddress | String | - |
smartWalletPermissionsContext | String | - |
smartWalletSignature | String | - |
smartWalletPermissions | jsonb | - |
smartWalletExpiresAt | bigint | - |
smartWalletIndex | Int | - |
CreateEmailSegmentInput (Input)
| Field | Type | Description |
|---|---|---|
name | String! | - |
description | String | - |
filter | EmailSegmentFilter! | - |
category | EmailCategory! | - |
CreateEncryptedKeypairInput (Input)
| Field | Type | Description |
|---|---|---|
password | String! | - |
seed | String | - |
CreateGoAccountInput (Input)
| Field | Type | Description |
|---|---|---|
childEnterpriseId | Int! | - |
label | String! | - |
enableTrading | Boolean | - |
enableFiat | Boolean | - |
digitalWalletId | Int | - |
CreateGoAccountResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
goAccount | GoAccount | - |
error | String | - |
CreateLimitOrderInput (Input)
| Field | Type | Description |
|---|---|---|
digitalWalletId | Int! | - |
chainId | Int! | - |
side | String! | - |
fromTokenAddress | String! | - |
fromTokenSymbol | String! | - |
fromTokenChainId | Int | - |
fromTokenDecimals | Int | - |
toTokenAddress | String! | - |
toTokenSymbol | String! | - |
toTokenChainId | Int | - |
toTokenDecimals | Int | - |
amount | String! | - |
limitPrice | String | - |
expiry | String! | - |
twapTotalTrades | Int | - |
twapIntervalMinutes | Int | - |
twapMaxDurationMinutes | Int | - |
CreateOrGetApplicantForUserResult
| Field | Type | Description |
|---|---|---|
created | Boolean! | - |
sumsubApplicantId | String! | - |
kycProfileId | uuid | - |
applicant | SumsubApplicantResponse! | - |
CreatePartnerCardApplicationInput (Input)
| Field | Type | Description |
|---|---|---|
cardUserId | uuid! | UUID of the card user the partner has already provisioned. |
| The card user's company must belong to a partner-managed organization. | ||
walletAddress | String | Ethereum wallet address for the card (0x... format). |
Either provide walletAddress OR set createWallet: true — exactly one is required. | ||
createWallet | Boolean | When true, Agio provisions an org-scoped smart wallet on Base mainnet and |
uses its deterministic address. Mutually exclusive with walletAddress. | ||
occupation | String! | SOC occupation description (e.g., "Software Developers", "Chief Executives"). |
annualSalary | String! | Estimated annual salary in USD (string to preserve the card issuer API compatibility). |
accountPurpose | String! | Purpose of the account (e.g., "Savings", "Business"). |
expectedMonthlyVolume | String! | Expected monthly transaction volume in USD. |
isTermsOfServiceAccepted | Boolean! | The partner is responsible for collecting end-user ToS acceptance before |
| submitting this application. MUST be true; the card issuer rejects the application otherwise. | ||
cardNickname | String | User-defined card nickname (optional, max 26 chars: alphanumeric, spaces, periods, hyphens). |
requestedLimitAmount | Int | Desired credit limit amount in dollars (e.g., 25000). |
requestedLimitFrequency | String | Limit frequency (e.g., "30 day", "7 day"). See CardLimitFrequency for canonical values. |
sessionId | String | Session ID from the generateEncryptionKeys mutation (required if encryptedPin provided). |
encryptedPin | String | Encrypted PIN (use encryptPassphraseForTransfer from agio-utils). |
| PIN (4-6 digits) is staged during application and set automatically when the card is activated. | ||
| Must meet security requirements: no repeated digits, no sequential patterns. | ||
partnerKycShareToken | String | Optional opaque share-token from your KYC provider workspace. |
| When present, Agio uses it to derive applicant data instead of requiring an | ||
| out-of-band KYC packet handover. Contact Agio onboarding to register your | ||
| workspace before using this field. Tokens are short-lived (minutes-to-hours) | ||
| and single-use — expired or replayed tokens return KYC_TOKEN_EXPIRED. |
CreatePartnerCardUserInput (Input)
Input for partner-side cardholder provisioning. All identity fields are forwarded to the card processor when an application is created against this cardUserId. nationalId is KMS-encrypted at rest; the resolver wraps before INSERT and only unwraps when forwarding to the card processor.
| Field | Type | Description |
|---|---|---|
customerOrganizationId | uuid! | UUID of the customer organization this cardholder belongs to. Must be a |
partner-managed customer org from createPartnerCustomerOrganization. | ||
firstName | String! | First name on the cardholder's ID. |
lastName | String! | Last name on the cardholder's ID. |
email | String! | Cardholder email. Used as the idempotency key within customerOrganizationId. |
addressCountryCode | String! | ISO-3166 alpha-2 country code (e.g., "US") for the cardholder's address. |
addressLine1 | String! | Cardholder's street address line 1. |
addressLine2 | String | Optional street address line 2. |
addressCity | String! | City. |
addressRegion | String! | State / province / region (e.g., "CA", "NSW"). |
addressPostalCode | String! | Postal / ZIP code. |
phoneCountryCode | String! | Phone country dialing code, digits only (e.g., "1" for US, "44" for UK). |
phoneNumber | String! | National phone number, digits only. |
birthDate | String! | Date of birth in YYYY-MM-DD format. |
nationalId | String! | Tax / national identifier (SSN, passport number, etc). Plaintext at the API |
| boundary; KMS-encrypted at rest. The card processor uses this for compliance | ||
| checks during application processing. |
CreatePartnerCardUserResponse
Response from createPartnerCardUser. The returned cardUserId is the UUID you pass to subsequent createCardApplicationForPartnerUser calls for this cardholder.
| Field | Type | Description |
|---|---|---|
success | Boolean! | True if the cardholder was created (or already existed and was idempotently returned). |
cardUserId | uuid | UUID of the cardholder. Stable across all future operations — store it on |
your side. Pass this as cardUserId in createCardApplicationForPartnerUser. | ||
reused | Boolean | True when an existing cardUser with the same email under the same customer org was returned. |
errorCode | String | Machine-readable error code if creation failed. |
errorMessage | String | Human-readable error message if creation failed. |
CreatePartnerCustomerOrganizationInput (Input)
| Field | Type | Description |
|---|---|---|
name | String! | Legal name of the customer organization as registered with the partner. |
Used as the default organization_name on the new AgioAuth.organization row. |
CreatePartnerCustomerOrganizationResponse
Response from provisioning a partner-managed customer organization. The returned organizationId can be passed to createCardCorporateApplication and other partner mutations that require org-scoped context.
| Field | Type | Description |
|---|---|---|
success | Boolean! | Whether the organization and its partner_managed_organization join row were created. |
organizationId | uuid | UUID of the newly created AgioAuth.organization row. |
error | String | Error message if creation failed (e.g. duplicate name, database error). |
CreateTradeSettlementInput (Input)
| Field | Type | Description |
|---|---|---|
tradeRequestId | uuid! | - |
settlementTypeId | Int! | - |
notes | String | - |
CreateUserAccountInviteInput (Input)
| Field | Type | Description |
|---|---|---|
email | String! | - |
givenName | String! | - |
familyName | String! | - |
password | String | - |
roleId | Int | - |
roleIds | [Int!] | - |
clientId | Int | - |
sendResetPasswordEmail | Boolean | - |
continueOnExisting | Boolean | - |
ttlSec | Int | - |
redirectUrl | String | - |
extraMessage | String | - |
CreateUserAccountInviteResponse
| Field | Type | Description |
|---|---|---|
userId | String! | - |
email | String! | - |
givenName | String! | - |
familyName | String! | - |
clientId | Int | - |
roleId | Int | - |
createdAt | timestamptz! | - |
updatedAt | timestamptz! | - |
inviteUrl | String | - |
emailSent | Boolean! | - |
created | Boolean! | - |
CrsDataQualitySummary
| Field | Type | Description |
|---|---|---|
fundId | Int! | - |
fundName | String! | - |
totalAccounts | Int! | - |
accountsMissingTin | Int! | - |
accountsMissingAddress | Int! | - |
accountsMissingTaxResidence | Int! | - |
individualAccounts | Int! | - |
organizationAccounts | Int! | - |
totalAccountBalance | Float! | - |
receivingCountries | [String!]! | - |
CrsGeneratedReport
| Field | Type | Description |
|---|---|---|
fundId | Int! | - |
receivingCountry | String! | - |
accountCount | Int! | - |
filePath | String! | - |
fileHash | String! | - |
fileSizeBytes | Int! | - |
messageRefId | String! | - |
CrsReceivingCountry
| Field | Type | Description |
|---|---|---|
country | String! | - |
code | String! | - |
DailyNavWorkbookResult
| Field | Type | Description |
|---|---|---|
downloadUrl | String! | - |
rowCount | Int! | - |
DealDocumentDownloadTicket
| Field | Type | Description |
|---|---|---|
downloadUrl | String! | - |
expiresIn | Int! | - |
DealDocumentUploadTicket
| Field | Type | Description |
|---|---|---|
uploadUrl | String! | - |
gcsPath | String! | - |
contentType | String! | - |
expiresIn | Int! | - |
DecryptEncryptedKeypairInput (Input)
| Field | Type | Description |
|---|---|---|
password | String! | - |
encryptedPrv | String! | - |
DecryptEncryptedKeypairResponse
| Field | Type | Description |
|---|---|---|
decryptedPrv | String! | - |
DecryptPrivateKeyInput (Input)
| Field | Type | Description |
|---|---|---|
password | String! | - |
encryptedPrv | String! | - |
DeleteAuth0UserResponse
| Field | Type | Description |
|---|---|---|
statusCode | Int | - |
error | String | - |
message | String | - |
DeleteWebhookInput (Input)
| Field | Type | Description |
|---|---|---|
digitalWalletId | Int! | - |
webhookId | String! | - |
DeleteWebhookResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
error | String | - |
DetachKybBeneficiaryInput (Input)
| Field | Type | Description |
|---|---|---|
organizationId | ID! | - |
beneficiaryId | String! | Junction record ID from AttachKybBeneficiaryResult.beneficiaryId (NOT the applicant ID) |
DigitalAssetsAggregate
| Field | Type | Description |
|---|---|---|
count | Int! | - |
usdValue | String! | - |
DigitalAssetSummary
| Field | Type | Description |
|---|---|---|
id | ID! | - |
walletId | ID | - |
name | String | - |
symbol | String | - |
value | String | - |
usdValue | String | - |
unitPriceUsd | String | - |
coinPrice | CoinPrice | - |
methods | [String] | TODO: implement |
depositAddresses | [DigitalWalletDepositAddress] | TODO: implement |
contractAddress | String | - |
decimals | Int | - |
verified | Boolean | - |
logoUrl | String | - |
DigitalWalletAddress
| Field | Type | Description |
|---|---|---|
id | ID! | - |
address | String! | - |
coinId | String! | - |
DigitalWalletBackupCardInput (Input)
| Field | Type | Description |
|---|---|---|
coinId | String! | - |
walletId | String! | - |
label | String! | - |
userEncryptedPrv | String! | - |
userPub | String! | - |
backupPub | String! | - |
bitgoPub | String! | - |
backupProviderId | String! | - |
activationCode | String | - |
DigitalWalletDepositAddress
| Field | Type | Description |
|---|---|---|
id | ID! | - |
address | String! | - |
coinId | String! | - |
method | String | deposit methods like: 'sol', 'eth', 'arb', etc. |
tag | String | deposit tag is required for some blockchains like XRP, XLM, etc. |
label | String | - |
value | String | - |
valueUsd | String | - |
index | Int | - |
DigitalWalletDetail
| Field | Type | Description |
|---|---|---|
id | ID! | - |
externalId | String | - |
digitalWalletId | Int! | - |
isStarred | Boolean! | - |
label | String | - |
usdValue | String | - |
walletTypeId | Int | - |
native | Boolean | - |
nativeCoinBalance | String | - |
nativeCoinBalanceUsd | String | - |
nativeCoinUnitPriceUsd | String | - |
nativeCoinSymbol | String | - |
nativeDepositAddress | String | - |
nativeNetworkId | Int | - |
type | String | - |
userId | String | - |
readonly | Boolean | - |
organizationId | uuid | - |
sparklineUrl | String | - |
assets | [DigitalAssetSummary] | - |
assetsAggregate | DigitalAssetsAggregate | - |
transactions | [DigitalWalletTransactionSummary] | - |
deposits | [DigitalWalletTransactionSummary] | - |
withdrawals | [DigitalWalletTransactionSummary] | - |
trades | [DigitalWalletTradeSummary] | - |
addresses | [DigitalWalletDepositAddress] | - |
whitelist | [DigitalWalletWhitelistEntry] | - |
DigitalWalletResponse
| Field | Type | Description |
|---|---|---|
id | Int! | - |
created_at | timestamptz! | - |
updated_at | timestamptz! | - |
fund_id | Int | - |
network_id | Int! | - |
nickname | String | - |
user_id | String! | - |
wallet_address | String! | - |
is_whitelisted | Boolean! | - |
DigitalWalletSummary
| Field | Type | Description |
|---|---|---|
id | ID! | - |
externalId | String | - |
digitalWalletId | Int! | - |
isStarred | Boolean! | - |
label | String | - |
usdValue | String | - |
walletTypeId | Int | - |
native | Boolean | - |
nativeCoinBalance | String | - |
nativeCoinBalanceUsd | String | - |
nativeCoinUnitPriceUsd | String | - |
nativeCoinSymbol | String | - |
nativeDepositAddress | String | - |
nativeNetworkId | Int | - |
type | String | - |
userId | String | - |
readonly | Boolean | - |
assets | [DigitalAssetSummary] | - |
assetsAggregate | DigitalAssetsAggregate | - |
organizationId | uuid | - |
sparklineUrl | String | - |
DigitalWalletTradeSummary
| Field | Type | Description |
|---|---|---|
id | ID! | - |
walletId | ID | - |
baseCurrency | String | - |
fee | String | - |
from | String | - |
to | String | - |
price | String | - |
proceeds | String | - |
quoteCurrency | String | - |
size | String | - |
createdAt | timestamptz | - |
DigitalWalletTransactionsAggregate
| Field | Type | Description |
|---|---|---|
totalCount | Int! | - |
lastFetchedAt | timestamptz | - |
lastFetchRequestAt | timestamptz | - |
nextEligibleFetchAt | timestamptz | - |
isFetching | Boolean! | - |
walletId | ID | - |
DigitalWalletTransactionSummary
| Field | Type | Description |
|---|---|---|
id | ID! | - |
walletId | ID | - |
createdAt | timestamptz | - |
confirmedAt | timestamptz | - |
confirmations | Int | - |
size | String | - |
notes | String | - |
data | String | - |
coin | String | - |
transactionId | String | - |
status | DigitalWalletTransactionStatus | - |
from | String | - |
to | String | - |
type | DigitalWalletTransactionType | - |
coinPrice | CoinPrice | - |
pendingApproval | BitgoPendingApproval | - |
pendingApprovalId | String | - |
DigitalWalletWhitelistEntry
| Field | Type | Description |
|---|---|---|
id | ID! | - |
label | String | - |
address | String | - |
createdAt | timestamptz | - |
updatedAt | timestamptz | - |
isApproved | Boolean | - |
symbol | String | - |
status | DigitalWalletWhitelistEntryStatus! | - |
walletId | ID! | - |
DocumentTemplateDictionaryResponse
| Field | Type | Description |
|---|---|---|
caseId | Int | - |
tags | [DocumentTemplateTag] | - |
DocumentTemplateTag
| Field | Type | Description |
|---|---|---|
id | String! | - |
name | String | - |
values | [String] | - |
value | String | - |
description | String | - |
EmailInput (Input)
| Field | Type | Description |
|---|---|---|
bodyTextOnly | String | - |
bodyHtml | String | - |
subject | String | - |
toEmail | String | - |
toFirstName | String | - |
EmailSegment
| Field | Type | Description |
|---|---|---|
id | ID! | - |
name | String! | - |
description | String | - |
filter | jsonb! | - |
category | EmailCategory! | - |
audienceId | Int! | - |
createdBy | String | - |
createdAt | String! | - |
updatedAt | String! | - |
archivedAt | String | - |
EmailSegmentFilter (Input)
| Field | Type | Description |
|---|---|---|
audienceId | Int! | - |
user | UserFilterInput | - |
userOrganization | UserOrganizationFilterInput | - |
lead | LeadFilterInput | - |
leadCompany | LeadCompanyFilterInput | - |
EmailSegmentPreview
| Field | Type | Description |
|---|---|---|
totalCount | Int! | - |
sampleEmails | [String!]! | - |
EncryptedKeypair
| Field | Type | Description |
|---|---|---|
pub | String! | - |
encryptedPrv | String! | - |
EncryptionKeys
| Field | Type | Description |
|---|---|---|
sessionId | String! | - |
key | String! | - |
iv | String! | - |
EnsureTokenChainInput (Input)
| Field | Type | Description |
|---|---|---|
type | EnsureTokenChainType | Resolution type - determines which fields are used. Defaults to AUTO if not provided. |
contractAddress | String | Contract address of the token (0x format). Required for ALCHEMY and CHAIN_ID types. |
identifier | String | Token identifier for AUTO type - can be contract address (0x...) or token symbol |
alchemyNetwork | String | Alchemy network identifier (e.g., 'eth-mainnet', 'polygon-mainnet'). Required for ALCHEMY type. |
chainId | Int | Direct chain ID (e.g., 1 for Ethereum mainnet). Required for CHAIN_ID type. |
coin | String | BitGo coin symbol (e.g., 'eth', 'tbtc', 'hteth'). Required for BITGO_COIN type. |
digitalWalletId | Int | Digital wallet ID for network context. Required for BITGO_COIN type. |
decimals | Int | Optional token decimals (will be fetched from provider if not provided) |
symbol | String | Optional token symbol (will be fetched from provider if not provided) |
name | String | Optional token name (will be fetched from provider if not provided) |
immediate | Boolean | Process synchronously (true) or queue for background processing (false, default) |
EnsureTokenChainResult
| Field | Type | Description |
|---|---|---|
success | Boolean! | Whether the operation was successful |
tokenId | Int | The token ID (if found or created) |
chainId | Int | The chain ID (if found or created) |
created | Boolean | Whether a new token_chain record was created |
message | String | Human-readable message about the result |
error | String | Error message if operation failed |
queued | Boolean | Whether the job was queued for background processing |
jobId | String | Job ID if queued |
deduplicated | Boolean | Whether the job was deduplicated (existing job found) |
EnsureTokenChainsFromTransactionsInput (Input)
| Field | Type | Description |
|---|---|---|
alchemyNetwork | String | Filter by specific alchemy network |
limit | Int | Maximum number of transactions to process |
skipInProgress | Boolean | Skip transactions that are already being processed |
EnsureTokenChainsFromTransactionsResult
| Field | Type | Description |
|---|---|---|
success | Boolean! | Whether the operation was successful |
jobsAdded | Int! | Number of jobs added to the queue |
jobsDeduplicated | Int! | Number of jobs that were deduplicated |
skipped | Int! | Number of transactions that were skipped (no contract address) |
total | Int! | Total number of transactions processed |
error | String | Error message if operation failed |
EvmSignedMessage
| Field | Type | Description |
|---|---|---|
id | String! | - |
message | String! | - |
profileId | String! | - |
EvmVerifiedMessage
| Field | Type | Description |
|---|---|---|
address | String! | - |
signature | String! | - |
profileId | String! | - |
digitalWalletId | Int | - |
ExchangeQuote
| Field | Type | Description |
|---|---|---|
id | String | - |
fromCoin | String | - |
toCoin | String | - |
createdAt | timestamptz | - |
filled | Boolean | - |
expired | Boolean | - |
side | String | - |
fee | Float | - |
size | Float | - |
exchangeId | String | - |
proceeds | Float | - |
price | Float | - |
quoteCoin | String | - |
baseCoin | String | - |
ExchangeQuoteError
| Field | Type | Description |
|---|---|---|
code | String | - |
message | String | - |
payload | jsonb | - |
ExchangeQuoteResponse
| Field | Type | Description |
|---|---|---|
exchangeId | String! | - |
quote | ExchangeQuote | - |
error | ExchangeQuoteError | - |
ExecuteBridgeQuoteInput (Input)
| Field | Type | Description |
|---|---|---|
quoteId | Int! | - |
FeeWalletRebalanceResult
| Field | Type | Description |
|---|---|---|
originsFound | Int! | - |
txsSubmitted | Int! | - |
txsFailed | Int! | - |
txHashes | [String!]! | - |
errors | [String!]! | - |
impactPct | Float | - |
valueInUsd | String | - |
valueOutUsd | String | - |
File
| Field | Type | Description |
|---|---|---|
orginal_filename | String | - |
filename | String | - |
mimetype | String | - |
encoding | String | - |
id | ID! | - |
created_at | String | - |
user_id | String | - |
cloud_url | String | - |
short_url | String | - |
url | String | - |
thumbnail_url | String | - |
case_id | Int | - |
fund_id | Int | - |
title | String | - |
description | String | - |
fundOverviewSlot | String | - |
FileInput (Input)
| Field | Type | Description |
|---|---|---|
name | String | - |
data | String | - |
type | FileInputType | - |
FinanceAdjclose
| Field | Type | Description |
|---|---|---|
adjclose | [Float] | - |
FinanceChartResult
| Field | Type | Description |
|---|---|---|
timestamp | [timestamptz!]! | - |
meta | FinanceMeta | - |
indicators | FinanceIndicators | - |
FinanceCurrentTradingPeriod
| Field | Type | Description |
|---|---|---|
pre | FinanceTradingPeriodItem | - |
regular | FinanceTradingPeriodItem | - |
post | FinanceTradingPeriodItem | - |
FinanceIndicators
| Field | Type | Description |
|---|---|---|
quote | [FinanceQuote] | - |
adjclose | [FinanceAdjclose] | - |
FinanceMeta
| Field | Type | Description |
|---|---|---|
currency | String | - |
symbol | String | - |
exchangeName | String | - |
instrumentType | String | - |
firstTradeDate | Int | - |
regularMarketTime | Int | - |
gmtoffset | Int | - |
timezone | String | - |
exchangeTimezoneName | String | - |
regularMarketPrice | Float | - |
chartPreviousClose | Float | - |
priceHint | Int | - |
currentTradingPeriod | FinanceCurrentTradingPeriod | - |
dataGranularity | String | - |
range | String | - |
validRanges | [String] | - |
FinanceNewsArticle
| Field | Type | Description |
|---|---|---|
title | String | - |
url | String | - |
timePublished | timestamptz! | - |
authors | [String!]! | - |
summary | String! | - |
bannerImage | String | - |
source | String | - |
categoryWithinSource | String | - |
sourceDomain | String | - |
overallSentimentScore | Float! | - |
overallSentimentLabel | String | - |
FinanceQuote
| Field | Type | Description |
|---|---|---|
high | [Float]! | - |
close | [Float]! | - |
open | [Float]! | - |
low | [Float]! | - |
volume | [Float]! | - |
FinanceQuoteResult
| Field | Type | Description |
|---|---|---|
language | String | - |
region | String | - |
quoteType | String | - |
typeDisp | String | - |
quoteSourceName | String | - |
triggerable | Boolean | - |
customPriceAlertConfidence | String | - |
currency | String | - |
fiftyDayAverage | Float | - |
fiftyDayAverageChange | Float | - |
fiftyDayAverageChangePercent | Float | - |
twoHundredDayAverage | Float | - |
twoHundredDayAverageChange | Float | - |
twoHundredDayAverageChangePercent | Float | - |
sourceInterval | Int | - |
exchangeDataDelayedBy | Int | - |
tradeable | Boolean | - |
cryptoTradeable | Boolean | - |
exchange | String | - |
shortName | String | - |
messageBoardId | String | - |
exchangeTimezoneName | String | - |
exchangeTimezoneShortName | String | - |
gmtOffSetMilliseconds | Int | - |
market | String | - |
esgPopulated | Boolean | - |
marketState | String | - |
regularMarketChangePercent | Float | - |
regularMarketPrice | Float | - |
regularMarketChange | Float | - |
regularMarketTime | Int | - |
regularMarketDayHigh | Float | - |
regularMarketDayRange | String | - |
regularMarketDayLow | Float | - |
regularMarketVolume | Float | - |
regularMarketPreviousClose | Float | - |
bid | Float | - |
ask | Float | - |
bidSize | Int | - |
askSize | Int | - |
fullExchangeName | String | - |
regularMarketOpen | Float | - |
averageDailyVolume3Month | Float | - |
averageDailyVolume10Day | Float | - |
fiftyTwoWeekLowChange | Float | - |
fiftyTwoWeekLowChangePercent | Float | - |
fiftyTwoWeekRange | String | - |
fiftyTwoWeekHighChange | Float | - |
fiftyTwoWeekHighChangePercent | Float | - |
fiftyTwoWeekLow | Float | - |
fiftyTwoWeekHigh | Float | - |
firstTradeDateMilliseconds | Float | - |
priceHint | Int | - |
symbol | String | - |
earningsTimestamp | Int | - |
earningsTimestampStart | Int | - |
earningsTimestampEnd | Int | - |
trailingAnnualDividendRate | Float | - |
trailingPE | Float | - |
trailingAnnualDividendYield | Float | - |
epsTrailingTwelveMonths | Float | - |
epsForward | Float | - |
epsCurrentYear | Float | - |
priceEpsCurrentYear | Float | - |
sharesOutstanding | Float | - |
bookValue | Float | - |
marketCap | Float | - |
forwardPE | Float | - |
priceToBook | Float | - |
prevName | String | - |
nameChangeDate | String | - |
averageAnalystRating | String | - |
longName | String | - |
financialCurrency | String | - |
dividendDate | String | - |
displayName | String | - |
FinanceResultMany
| Field | Type | Description |
|---|---|---|
result | [FinanceQuoteResult!] | - |
error | String | - |
FinanceResultOne
| Field | Type | Description |
|---|---|---|
result | FinanceQuoteResult | - |
error | String | - |
FinanceTradingPeriodItem
| Field | Type | Description |
|---|---|---|
timezone | String | - |
end | Int | - |
start | Int | - |
gmtoffset | Int | - |
FreezeWalletInput (Input)
| Field | Type | Description |
|---|---|---|
digitalWalletId | Int! | - |
duration | Int! | - |
FreezeWalletResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
duration | Int | - |
error | String | - |
FundInvestorRecipient
| Field | Type | Description |
|---|---|---|
userId | ID! | - |
email | String! | - |
givenName | String | - |
familyName | String | - |
totalShares | String! | - |
totalPositionValue | String! | - |
organizationContexts | [String!]! | - |
FundInvestorRecipientsInput (Input)
| Field | Type | Description |
|---|---|---|
fundId | Int! | - |
FundInvestorsPreview
| Field | Type | Description |
|---|---|---|
fundId | Int! | - |
totalUsers | Int! | - |
totalSharesAcrossUsers | String! | - |
recipients | [FundInvestorRecipient!]! | - |
sampleEmails | [String!]! | - |
truncated | Boolean! | - |
GenerateBackupKeyInput (Input)
| Field | Type | Description |
|---|---|---|
coinId | String! | - |
GenerateBackupKeyResponse
| Field | Type | Description |
|---|---|---|
backupKey | HotWalletKey | - |
backupProvider | String | - |
errors | [String] | - |
warnings | [String] | - |
GenerateBitGoKeyInput (Input)
| Field | Type | Description |
|---|---|---|
coinId | String! | - |
GenerateBitGoKeyResponse
| Field | Type | Description |
|---|---|---|
bitgoKey | HotWalletKey | - |
errors | [String] | - |
warnings | [String] | - |
GenerateCrsReportsInput (Input)
| Field | Type | Description |
|---|---|---|
fundId | Int! | - |
reportingPeriodEnd | String! | - |
receivingCountry | String | - |
GenerateCrsReportsResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
reports | [CrsGeneratedReport!]! | - |
errors | [String!]! | - |
GenerateHotWalletKeysInput (Input)
| Field | Type | Description |
|---|---|---|
coinId | String! | - |
bitgoEncryptedUserKeyPair | BitgoEncryptionKeyPairInput | - |
bitgoEncryptedPassphrase | BitgoEncryptedPassphraseInput | - |
GenerateHotWalletKeysResponse
| Field | Type | Description |
|---|---|---|
userKey | HotWalletKey | - |
backupKey | HotWalletKey | - |
bitgoKey | HotWalletKey | - |
backupProvider | String | - |
errors | [String] | - |
warnings | [String] | - |
GenerateSmartWalletJwtInput (Input)
| Field | Type | Description |
|---|---|---|
targetPublicKey | String | - |
scope | SmartWalletSubjectScope | - |
organizationId | uuid | - |
GenerateUserKeyInput (Input)
| Field | Type | Description |
|---|---|---|
coinId | String! | - |
bitgoEncryptedUserKeyPair | BitgoEncryptionKeyPairInput | - |
bitgoEncryptedPassphrase | BitgoEncryptedPassphraseInput | - |
GenerateUserKeyResponse
| Field | Type | Description |
|---|---|---|
userKey | HotWalletKey | - |
errors | [String] | - |
warnings | [String] | - |
GeocodeLocation
Geocode location from Google Address Validation
| Field | Type | Description |
|---|---|---|
latitude | Float! | - |
longitude | Float! | - |
GoAccount
| Field | Type | Description |
|---|---|---|
id | Int! | - |
childEnterpriseId | Int! | - |
digitalWalletId | Int | - |
bitgoAccountId | String! | - |
accountStatus | String! | - |
tradingEnabled | Boolean! | - |
fiatEnabled | Boolean! | - |
config | jsonb | - |
createdAt | timestamptz! | - |
updatedAt | timestamptz! | - |
GoAccountBalance
| Field | Type | Description |
|---|---|---|
currency | String! | - |
available | String! | - |
pending | String! | - |
total | String! | - |
fiatValue | String | - |
lastUpdated | String! | - |
GoFiatOperation
| Field | Type | Description |
|---|---|---|
id | Int! | - |
goAccountId | Int! | - |
bitgoOperationId | String! | - |
type | String! | - |
currency | String! | - |
amount | String! | - |
fees | String | - |
status | String! | - |
bankAccount | jsonb | - |
estimatedArrival | timestamptz | - |
createdAt | timestamptz! | - |
updatedAt | timestamptz! | - |
GoFiatOperationInput (Input)
| Field | Type | Description |
|---|---|---|
goAccountId | Int! | - |
type | String! | - |
currency | String! | - |
amount | Float! | - |
bankAccount | jsonb | - |
GoFiatOperationResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
operation | GoFiatOperation | - |
error | String | - |
GoNetworkActionResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
error | String | - |
GoNetworkConnection
| Field | Type | Description |
|---|---|---|
id | Int! | - |
goAccountId | Int! | - |
counterpartyId | String! | - |
counterpartyName | String | - |
connectionStatus | String! | - |
direction | String! | - |
metadata | jsonb | - |
createdAt | timestamptz! | - |
updatedAt | timestamptz! | - |
GoNetworkConnectionResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
connection | GoNetworkConnection | - |
error | String | - |
GoNetworkDirectoryEntry
| Field | Type | Description |
|---|---|---|
id | String! | - |
name | String! | - |
type | String | - |
country | String | - |
GoTrade
| Field | Type | Description |
|---|---|---|
id | Int! | - |
goAccountId | Int! | - |
bitgoTradeId | String! | - |
side | String! | - |
type | String! | - |
baseCurrency | String! | - |
quoteCurrency | String! | - |
requestedAmount | String! | - |
executedAmount | String | - |
price | String | - |
executedPrice | String | - |
feeCurrency | String | - |
feeAmount | String | - |
status | String! | - |
createdAt | timestamptz! | - |
executedAt | timestamptz | - |
GoTradeResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
trade | GoTrade | - |
error | String | - |
HotWalletKey
| Field | Type | Description |
|---|---|---|
id | String! | - |
pub | String! | - |
type | String! | - |
source | String! | - |
encryptedPrv | String | - |
commonKeychain | String | - |
ImportBankStatementInput (Input)
| Field | Type | Description |
|---|---|---|
fundId | Int! | - |
filename | String! | - |
format | String! | - |
fileContent | String! | - |
ImportBankStatementResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
importId | Int | - |
lineCount | Int | - |
skippedRows | Int | - |
errors | [String!] | - |
error | String | - |
InitiateGoTradeInput (Input)
| Field | Type | Description |
|---|---|---|
goAccountId | Int! | - |
side | String! | - |
type | String! | - |
baseCurrency | String! | - |
quoteCurrency | String! | - |
amount | Float! | - |
price | Float | - |
InitiateOutboundSettlementInput (Input)
| Field | Type | Description |
|---|---|---|
settlementId | Int! | - |
toAddress | String | - |
toWalletId | Int | - |
toBankInfoId | Int | - |
autoSend | Boolean | - |
InsertPartnerApiTokenInput (Input)
| Field | Type | Description |
|---|---|---|
partnerOrganizationId | ID! | The partner organization the new token will belong to. |
description | String! | Human-readable label shown in the admin grid (e.g. 'Production integration'). |
expiresAt | String | Optional expiry. When omitted the token does not expire. |
hasuraRoleName | String | Role the API token authenticates as. Only partner-scoped roles are accepted; any other |
| value is rejected. Defaults to the standard Card API partner role when omitted. |
InsertPartnerApiTokenResult
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
tokenId | Int | - |
apiToken | String | The api_token (UUID) — shown in the admin grid, used by the partner as x-agio-api-key. |
| Returned again on subsequent reads via the existing partnerApiTokensList query. | ||
clientSecret | String | The HMAC signing secret — returned ONCE on insert. Capture immediately; |
| it is never readable again. Storage is KMS-envelope-encrypted bytea. | ||
errorCode | String | - |
errorMessage | String | - |
InsertTrainingVersionResult
| Field | Type | Description |
|---|---|---|
id | Int! | - |
InvoiceResponse
| Field | Type | Description |
|---|---|---|
invoiceId | Int | - |
flowTemplateSlug | String | - |
caseId | Int | - |
quoteId | Int | - |
error | String | - |
success | Boolean! | - |
JournalEntryPreview
| Field | Type | Description |
|---|---|---|
entryDate | String! | - |
description | String! | - |
sourceType | String! | - |
lines | [JournalLinePreview!]! | - |
JournalLinePreview
| Field | Type | Description |
|---|---|---|
description | String | - |
accountCode | String! | - |
accountName | String! | - |
debit | Float | - |
credit | Float | - |
KMSDecryptInput (Input)
| Field | Type | Description |
|---|---|---|
encryptedData | String! | - |
KMSDecryptionResult
| Field | Type | Description |
|---|---|---|
plaintext | String! | - |
metadata | jsonb | - |
keyVersion | String! | - |
decryptedAt | String! | - |
KMSEncryptInput (Input)
| Field | Type | Description |
|---|---|---|
plaintext | String! | - |
metadata | jsonb | - |
KMSEncryptionResult
| Field | Type | Description |
|---|---|---|
encryptedData | String! | - |
keyVersion | String! | - |
encryptedAt | String! | - |
KMSKeyRotationResult
| Field | Type | Description |
|---|---|---|
oldVersion | String! | - |
newVersion | String! | - |
rotatedAt | String! | - |
KMSMutation
| Field | Type | Description |
|---|---|---|
encrypt | KMSEncryptionResult! | - |
rotateKey | KMSKeyRotationResult! | - |
reencrypt | KMSEncryptionResult! | - |
KMSQuery
| Field | Type | Description |
|---|---|---|
decrypt | KMSDecryptionResult! | - |
validateEncryptedData | Boolean! | - |
getCurrentKeyVersion | String! | - |
KMSReencryptInput (Input)
| Field | Type | Description |
|---|---|---|
encryptedData | String! | - |
KYCAddressInput (Input)
| Field | Type | Description |
|---|---|---|
street1 | String! | - |
street2 | String | - |
city | String! | - |
state | String | - |
postalCode | String! | - |
country | String! | - |
KYCIdentityDocumentInput (Input)
| Field | Type | Description |
|---|---|---|
type | String! | - |
number | String! | - |
issueDate | String! | - |
expiryDate | String! | - |
issuingCountry | String! | - |
KycProfile
| Field | Type | Description |
|---|---|---|
id | String! | - |
sumsub_email_address | String | - |
sumsub_first_name | String | - |
sumsub_last_name | String | - |
sumsub_phone_number | String | - |
sumsub_country_of_residence | String | - |
most_recent_review_status | String | - |
most_recent_review_level_name | String | - |
last_approved_level_name | String | - |
last_approved_date | timestamptz | - |
sumsub_applicant_type | String | - |
most_recent_review_anwser_is_green | Boolean! | - |
created_at | timestamptz! | - |
updated_at | timestamptz | - |
KycSdkInitTokenInput (Input)
| Field | Type | Description |
|---|---|---|
apiToken | String! | - |
externalUserId | String! | - |
externalUserEmail | String | - |
externalUserFirstName | String | - |
externalUserLastName | String | - |
ttl | Int | - |
currency | String | - |
amount | Float | - |
KycSdkUserAuthenticationInput (Input)
| Field | Type | Description |
|---|---|---|
token | String! | - |
LeadCompanyFilterInput (Input)
| Field | Type | Description |
|---|---|---|
companyNameContains | String | - |
domainEndsWith | String | - |
referredByOrganizationIds | [ID!] | - |
convertedToOrganizationIds | [ID!] | - |
LeadFilterInput (Input)
| Field | Type | Description |
|---|---|---|
tierIds | [Int!] | - |
priorityIds | [Int!] | - |
nbaIds | [Int!] | - |
segmentIds | [Int!] | - |
categoryIds | [Int!] | - |
bucketIds | [Int!] | - |
statusIds | [Int!] | - |
sourceIds | [Int!] | - |
countryIds | [Int!] | - |
scoreMin | Int | - |
scoreMax | Int | - |
estimatedArrUsdMin | Float | - |
estimatedArrUsdMax | Float | - |
decisionMakerLikelihoodMin | Float | - |
enrichmentConfidenceMin | Float | - |
isCompetitor | Boolean | - |
isPartner | Boolean | - |
hasPhone | Boolean | - |
hasCompany | Boolean | - |
isConverted | Boolean | - |
assignedToUserIds | [String!] | - |
lastActivityAfter | timestamptz | - |
enrichedAfter | timestamptz | - |
interestIds | [Int!] | - |
utmSources | [String!] | - |
utmCampaign | String | - |
adId | String | - |
LimitOrderData
| Field | Type | Description |
|---|---|---|
id | Int! | - |
orderType | String! | - |
side | String! | - |
fromTokenSymbol | String! | - |
fromTokenDecimals | Int | - |
toTokenSymbol | String! | - |
toTokenDecimals | Int | - |
amount | String! | - |
filledAmount | String! | - |
limitPrice | String | - |
averageFillPrice | String | - |
status | String! | - |
expiry | String! | - |
expiresAt | String | - |
twapTotalTrades | Int | - |
twapTradesCompleted | Int | - |
twapIntervalMinutes | Int | - |
cowOrderUid | String | - |
createdAt | String! | - |
LimitOrderResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
order | LimitOrderData | - |
error | String | - |
structuredError | SmartWalletErrorResponse | - |
MarketData
| Field | Type | Description |
|---|---|---|
pair | String! | - |
price | String! | - |
bid | String! | - |
ask | String! | - |
volume24h | String! | - |
change24h | String! | - |
MassEmailAttachmentInput (Input)
| Field | Type | Description |
|---|---|---|
content | String! | - |
filename | String! | - |
type | String! | - |
MassEmailRecipientResult
| Field | Type | Description |
|---|---|---|
email | String! | - |
success | Boolean! | - |
error | String | - |
MultiSendFromWalletInput (Input)
| Field | Type | Description |
|---|---|---|
sourceWalletId | Int! | - |
transfers | [MultiSendTransferInput!]! | - |
idempotencyKey | String | - |
MultiSendFromWalletResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
jobId | String | - |
alreadyEnqueued | Boolean | - |
errorCode | String | - |
errorMessage | String | - |
retryAfterSec | Int | - |
MultiSendJobStatusResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
jobId | String! | - |
status | String | - |
txHash | String | - |
failedReason | String | - |
attempts | Int | - |
errorCode | String | - |
errorMessage | String | - |
MultiSendTransferInput (Input)
| Field | Type | Description |
|---|---|---|
tokenChainId | Int! | - |
destination | String! | - |
amount | String! | - |
Mutation
| Field | Type | Description |
|---|---|---|
generateFundUserAgreementPdf | String | - |
previewFundUserAgreementPdf | String | - |
generateEncryptionKeys | EncryptionKeys! | - |
singleUpload | File! | - |
multiUpload | [File!] | - |
resetApplicant | Int | - |
resetApplicantById | Int | - |
resendVerificationEmail | String | - |
resendVerificationEmailById | String | - |
patchAuth0UserById | PatchAuth0UserResponse | - |
patchAuth0User | PatchAuth0UserResponse | - |
deleteAuth0User | DeleteAuth0UserResponse | - |
createUserAccountInvite | CreateUserAccountInviteResponse! | - |
userCreateUserAccountInvite | CreateUserAccountInviteResponse! | - |
sendEmailSharePage | Boolean | - |
runDigitalWalletAmlReport | DigitalWalletResponse | - |
downloadPdf | String | - |
downloadQuotePdf | String | - |
downloadProposalPdf | String | - |
downloadCombinedProposalPdf | String | - |
bundleProposal | String | - |
downloadInvoicePdf | String | - |
downloadInvoiceReceiptPdf | String | - |
downloadInvoiceStatementPdf | String | - |
downloadCasePdf | String | - |
downloadCaseOrgChartPdf | String | - |
downloadEnhancedCasePdf | String | - |
downloadCaseSignOffPdf | String | - |
downloadDocumentTemplatePdf | String | - |
downloadFundInvestorCapitalStatementPdf | String | - |
downloadFundShareRegisterPdf | String | - |
downloadFundShareholderMovementPdf | String | - |
downloadFundInvestorStatementPdf | String | - |
downloadFundInvestorAllocationsPdf | String | - |
downloadFundExpenseReportPdf | String | - |
downloadFundNavReportPdf | String | - |
downloadFundSubscriptionConfirmationPdf | String | - |
downloadFundRedemptionConfirmationPdf | String | - |
downloadFundPerformanceStatementPdf | String | - |
downloadWireTransferPdf | String | - |
sendWireTransferEmail | SendWireTransferEmailResponse! | - |
downloadDigitalWalletBackupCardPdf | String | - |
downloadProductCatalogPdf | String | - |
sendOtpCode | Boolean | - |
sendLink | Boolean | - |
verifyOtpCode | Boolean | - |
sendChatMessage | ChatMessageResponse | - |
requestQuotes | [ExchangeQuoteResponse] | - |
generateFileDownloadToken | String | - |
shortenLink | String | - |
jsonbToCsv | String | - |
sendEmail | Boolean | - |
sendMassEmail | SendMassEmailResponse! | - |
sendTestCampaignEmail | Boolean | - |
cancelEmailCampaign | CancelEmailCampaignResult! | - |
triggerCampaignBlastScan | Boolean! | - |
createEmailSegment | EmailSegment! | - |
updateEmailSegment | EmailSegment! | - |
archiveEmailSegment | EmailSegment! | - |
previewEmailSegment | EmailSegmentPreview! | - |
previewEmailSegmentFull | RecipientPreviewFull! | - |
sendFundInvestorContactEmail | Boolean! | - |
associateKycProfileWithUser | KycProfile! | - |
renderCaseDocuments | [BullJobResponse!]! | - |
sendCaseDocumentsEmail | Boolean | - |
authenticateGuest | String | - |
exchangeTokenForShortLivedToken | String | - |
startSession | SessionResponse | - |
endSession | Boolean! | - |
destroyUserSessions | Boolean! | - |
setAuthToken | Boolean | - |
deleteAuthToken | Boolean | - |
acceptUserOrganizationInvite | AcceptUserOrganizationInviteResponse | - |
completeProfile | CompleteProfileResponse | - |
generateWorkflowSdkInitToken | String | - |
authenticateWorkflowSdkUser | String | - |
generateKycSdkInitToken | String | - |
authenticateKycSdkUser | String | - |
createInvoiceFromQuote | InvoiceResponse | - |
createInvoiceFromCase | InvoiceResponse | - |
resetInvoiceToQuote | InvoiceResponse | - |
sendInvoiceEmail | Boolean | - |
sendInvoicePaymentReceiptEmail | Boolean | - |
sendQuoteEmail | Boolean | - |
sendBulkInvoiceEmails | SendBulkInvoiceEmailsResponse! | - |
getOrCreateQuote | Int | - |
acceptQuote | AcceptQuoteResponse! | - |
submitQuoteQuestion | SubmitQuoteQuestionResponse! | - |
addGetTrackedTokensToQueue | BullJobResponse | - |
backfillTokenPricesMany | BullJobResponse | - |
backfillTokenPrices | BullJobResponse | - |
backfillTopTokenPrices | BullJobResponse | - |
cancelQueueJob | CancelQueueJobResponse! | - |
syncCoinlistPlatforms | BullJobResponse | - |
rebuildTokens | BullJobResponse | - |
reconcileCoingecko | BullJobResponse | - |
verifyTokenChains | BullJobResponse | - |
scrapeCoinIcon | String | - |
scrapeNews | BullJobResponse! | - |
addMarketPricesJob | [BullJobResponse!]! | - |
addWalletSnapshotJob | BullJobResponse | - |
addWalletsSnapshotJob | [BullJobResponse] | - |
updateUserPhoneNumber | Boolean! | - |
updateUserEmail | Boolean! | - |
setEmailVerified | Boolean | - |
generateStatementOfAccountPdf | String | - |
syncApplicantQuestionnaire | SyncApplicantQuestionnaireResponse! | - |
processFundCustodyExpenseAccruals | ProcessFundCustodyExpenseAccrualsResponse! | - |
processExpenseAccruals | ProcessExpenseAccrualsResponse! | - |
processFeeAccruals | ProcessFeeAccrualsResponse! | - |
processAmortization | ProcessAmortizationResponse! | - |
processFundEndOfDay | ProcessFundEndOfDayResponse! | - |
backfillDigitalWalletAssets | BackfillDigitalWalletAssetsResponse! | - |
importBankStatement | ImportBankStatementResponse! | - |
syncSafes | SyncSafesResponse! | - |
redis | RedisMutation! | - |
syncWhitelist | SyncWhitelistResponse | - |
bulkImportWhitelist | BulkImportWhitelistResponse | - |
addVelocityLimitPolicy | AddPolicyResponse | - |
addSpendingLimitPolicy | AddPolicyResponse | - |
removeWalletPolicy | RemovePolicyResponse | - |
freezeWallet | FreezeWalletResponse | - |
submitWhitelistRequest | WhitelistRequestResponse | - |
approveWhitelistRequest | WhitelistRequestResponse | - |
rejectWhitelistRequest | WhitelistRequestResponse | - |
createDigitalWallet | CreateDigitalWalletResponse | - |
createDigitalWalletAddress | CreateDigitalWalletAddressResponse | - |
generateHotWalletKeys | GenerateHotWalletKeysResponse | - |
generateUserKey | GenerateUserKeyResponse | - |
generateBackupKey | GenerateBackupKeyResponse | - |
generateBitGoKey | GenerateBitGoKeyResponse | - |
createEncryptedKeypair | EncryptedKeypair | - |
decryptEncryptedKeypair | DecryptEncryptedKeypairResponse | - |
decryptPrivateKey | String | - |
encryptPassphrase | String | - |
decryptPassphrase | String | - |
addDigitalWalletWhitelistEntry | DigitalWalletWhitelistEntry | - |
removeDigitalWalletWhitelistEntry | Boolean | - |
addSmartWalletSessionKey | AddSmartWalletSessionKeyResponse | - |
revokeSmartWalletSessionKey | RevokeSmartWalletSessionKeyResponse | - |
provisionOrgSmartWalletSessionKeys | ProvisionOrgWalletSessionKeysResponse! | - |
provisionAllDefaultChainWallets | ProvisionAllDefaultChainWalletsResponse! | - |
requestOtcTrade | ChatMessageResponse | - |
requestOtcQuote | RequestQuoteTradeResponse | - |
refreshOtcQuote | RefreshOtcQuoteResponse | - |
calculateOtcQuote | CalculateOtcQuoteResponse | - |
evm | MutationEvm | - |
generateRecurringJournalEntries | RecurringJEResult! | - |
transferDigitalAsset | DigitalWalletTransactionSummary | TODO: implement. Use to transfer, send or withdraw digital asset |
requestConvertDigitalAssetQuote | ExchangeQuote | TODO: implement |
acceptConvertDigitalAssetQuote | DigitalWalletTradeSummary | TODO: implement |
exportDailyNavWorkbook | DailyNavWorkbookResult! | - |
mintCampaignAdUploadUrl | CampaignAdUploadTicket! | - |
rebalanceAgioFeeSmartWallet | FeeWalletRebalanceResult! | - |
burnDust | BurnDustResult! | - |
burnDustAgioFeeSmartWallet | BurnDustResult! | - |
previewCryptoTransactionJournals | PreviewJournalsResponse! | - |
commitCryptoTransactionJournals | CommitJournalsResponse! | - |
previewCashMovementJournals | PreviewJournalsResponse! | - |
commitCashMovementJournals | CommitJournalsResponse! | - |
previewNonCryptoTransactionJournals | PreviewJournalsResponse! | - |
commitNonCryptoTransactionJournals | CommitJournalsResponse! | - |
sumsub | SumsubMutation | - |
smartWalletSendTransaction | SmartWalletSendTransactionResponse | - |
adminSmartWalletSendTransaction | SmartWalletSendTransactionResponse | - |
smartWalletSwapQuote | SwapQuoteResponse | - |
smartWalletSwap | SwapResultResponse | - |
smartWalletExecuteSwapQuote | SwapResultResponse | Execute a swap using a previously obtained quote (by quoteId). |
| Note: Alchemy requires a fresh quote for execution, so a new quote is fetched | ||
| using the same parameters as the original. This ensures the swap executes at | ||
| current market rates while validating the original quote hasn't expired. | ||
generateSmartWalletJwt | SmartWalletJwtResponse! | - |
createLimitOrder | LimitOrderResponse! | - |
cancelLimitOrder | LimitOrderResponse! | - |
createChildEnterprise | CreateChildEnterpriseResponse | - |
createGoAccount | CreateGoAccountResponse | - |
initiateGoTrade | GoTradeResponse | - |
cancelGoTrade | CancelGoTradeResponse | - |
depositFiatToGoAccount | GoFiatOperationResponse | - |
withdrawFiatFromGoAccount | GoFiatOperationResponse | - |
postShareAdjustmentJournalEntry | PostShareAdjustmentJeResult! | - |
createCardDispute | CreateCardDisputeResponse! | - |
uploadCardDisputeEvidence | UploadCardDisputeEvidenceResponse! | - |
cancelCardDispute | CancelCardDisputeResponse! | - |
revokeToken | RevokeTokenResponse! | - |
insertPartnerApiToken | InsertPartnerApiTokenResult! | Mint a new partner API token + HMAC client_secret for the given partner organization. |
| Both are returned in the result; clientSecret is returned ONCE — capture immediately. | ||
| Admin-only. Rate-limited 10/min via adminSensitiveRateLimit. | ||
rotatePartnerApiToken | RotatePartnerApiTokenResult! | Rotate the HMAC client_secret on an existing partner API token. The api_token (UUID) |
| itself is unchanged so existing partner integrations keep their public identifier; | ||
| only the signing secret changes. Returned ONCE — capture immediately. | ||
| Admin-only. Rate-limited 10/min via adminSensitiveRateLimit. | ||
replayPartnerWebhookDelivery | ReplayPartnerWebhookDeliveryResult! | Re-enqueue a previously-failed webhook delivery for replay. The original payload |
- event_id are reused so the receiver sees the same delivery semantics (and can dedupe via event_id if they so choose). Admin-only. Rate-limited 10/min via adminSensitiveRateLimit. | |
testPartnerWebhookSubscription|TestPartnerWebhookSubscriptionResult!| Enqueue a synthetictest.pingdelivery to an existing subscription. Useful for validating a partner's HMAC verifier on the re-enable flow or after URL change. Admin-only. Rate-limited 10/min via adminSensitiveRateLimit. | |adminCreatePartnerWebhookSubscription|AdminCreatePartnerWebhookSubscriptionResult!| Create a webhook subscription on behalf of a partner organization. Returns the HMAC signing secret exactly once — capture it immediately, it is never readable again. Admin-only and rate-limited. | |deleteWebhook|DeleteWebhookResponse| - | |generateCrsReports|GenerateCrsReportsResponse!| - | |complianceApproveApplicant|ComplianceReviewResult!| - | |complianceRejectApplicant|ComplianceReviewResult!| - | |complianceEscalateApplicant|ComplianceReviewResult!| - | |complianceAddReviewNote|ComplianceReviewResult!| - | |complianceSetRiskLevel|ComplianceReviewResult!| - | |complianceUpgradeToNestedKyb|ComplianceUpgradeResult!| - | |backfillAlchemyTransactions|BackfillAlchemyTransactionsResponse!| - | |cancelFundSubscription|Boolean!| - | |cancelFundRedemption|Boolean!| - | |synchronizeEnzymeVaults|SynchronizeEnzymeVaultsResponse!| - | |signFundAgreement|SignFundAgreementResult!| - | |requestFundSubscriptionSignature|RequestFundSubscriptionSignatureResult!| - | |bookFundSubscription|BookFundSubscriptionResult!| - | |requestFundRedemptionSignature|RequestFundRedemptionSignatureResult!| - | |bookFundRedemption|BookFundRedemptionResult!| - | |processSeriesRollup|ProcessSeriesRollupResponse!| - | |registerBalancerPool|RegisterBalancerPoolResponse!| - | |trackBalancerPool|TrackBalancerPoolResponse!| - | |calculateBalancerLPPrice|CalculateBalancerLPPriceResponse!| - | |refreshBalancerLPPrices|RefreshBalancerLPPricesResponse!| - | |rerunBackfillBalancerPool|RerunBackfillResponse!| - | |snoozeTrainingRequired|SnoozeResult!| - | |sendTrainingReminder|SendTrainingReminderResult!| - | |insertTrainingVersionWithIntegrity|InsertTrainingVersionResult!| - | |requestGoNetworkConnection|GoNetworkConnectionResponse| - | |acceptGoNetworkConnection|GoNetworkActionResponse| - | |revokeGoNetworkConnection|GoNetworkActionResponse| - | |proposeAuditAdjustment|AuditAdjustmentResult!| - | |acceptAuditAdjustment|AcceptAuditAdjustmentResult!| - | |rejectAuditAdjustment|AuditAdjustmentResult!| - | |voidAuditAdjustment|AuditAdjustmentVoidResult!| - | |sendCaseStatusUpdateEmail|SendGridClientResponse| - | |sendCaseSubmittedEmail|SendGridClientResponse| - | |sendKycInviteEmail|SendGridClientResponse| - | |sendSignatureInviteEmail|SendGridClientResponse| - | |sendAccountFundingEmail|SendGridClientResponse| - | |sendBankTransactionEmail|SendGridClientResponse| - | |sendCESRAEmail|SendGridClientResponse| - | |sendStandaloneKycInvite|SendGridClientResponse| - | |AgioOnboardingDocumentGenerate|AgioOnboardingDocumentGenerateResponse!| - | |runFullNavCalculation|NavCalcJob!| - | |approveNavRun|NavCalcJob!| - | |resumeNavRun|NavCalcJob!| - | |cancelNavRun|NavCalcJob!| - | |bitgoSendCoins|BitgoSendCoinsResponse| - | |bitgoCreateAddress|BitgoAddress| - | |bitgoResolveApproval|BitgoApprovalResponse| - | |bitgoSendTransaction|BitgoSendTransactionResponse| - | |bitgoSyncTransaction|BitgoSyncTransactionResponse| - | |bitgoSyncWalletTransactions|BitgoSyncWalletTransactionsResponse| - | |bitgoSyncDigitalWalletTransactions|BitgoSyncDigitalWalletTransactionsResponse| - | |bitgoSyncAllTransactions|BitgoSyncAllTransactionsResponse| - | |bitgoSyncTransactionsForWebhooks|BitgoSyncAllTransactionsResponse| - | |bitgoSyncTokenSupport|BitgoSyncTokenSupportResponse| - | |kms|KMSMutation!| - | |nudgeInvestor|NudgeResponse!| - | |zipFiles|ZipResult| - | |AgioOnboardingDocumentZip|ZipResult| - | |createCardApplication|CardApplicationResponse!| Create a Card application for a user with completed KYC. Requires normal-kyc-level verification. | |freezeCard|CardOperationResponse!| Freeze a Card. Calls the card issuer API and returns immediate response. Card status will be updated via webhook. Requires the user to own the card. | |unfreezeCard|CardOperationResponse!| Unfreeze a Card. Calls the card issuer API and returns immediate response. Card status will be updated via webhook. Requires the user to own the card. | |revealCardSecrets|CardSecretsResponse!| Reveal sensitive card details (PAN, CVC, expiry). Requires the user to own the card. Returns encryptedSecrets - use decryptWithSessionKey from agio-utils to decrypt JSON. | |replaceVirtualCard|CardReplacementResponse!| Replace a virtual Card with a new one. The old card is canceled and a new card is created with new PAN, token, and expiration. The new card inherits spending limits from the old card. Only virtual cards can be replaced - physical cards will return an error. Requires the user to own the card. | |setCardPin|CardPinResponse!| Set or update a Card's PIN. PIN must be 4-12 digits and meet security requirements. Requires the user to own the card. | |getCardPin|CardPinResponse!| Retrieve a Card's PIN. Returns encryptedPin - use decryptWithSessionKey from agio-utils to decrypt. Requires the user to own the card. | |freezeCardByExternalCardId|CardOperationResponse!| Admin-only: Freeze Card by card ID. Bypasses ownership checks. | |unfreezeCardByExternalCardId|CardOperationResponse!| Admin-only: Unfreeze Card by card ID. Bypasses ownership checks. | |revealCardSecretsByExternalCardId|CardSecretsResponse!| Admin-only: Reveal card secrets by card ID. Bypasses ownership checks. Returns encryptedSecrets - use decryptWithSessionKey from agio-utils to decrypt JSON. | |replaceVirtualCardByExternalCardId|CardReplacementResponse!| Admin-only: Replace virtual card by card ID. Bypasses ownership checks. | |setCardPinByExternalCardId|CardPinResponse!| Admin-only: Set card PIN by card ID. Bypasses ownership checks. PIN must be encrypted using encryptPassphraseForTransfer from agio-utils. | |getCardPinByExternalCardId|CardPinResponse!| Admin-only: Get card PIN by card ID. Bypasses ownership checks. Returns encryptedPin - use decryptWithSessionKey from agio-utils to decrypt. | |createCardCorporateApplication|CardCorporateApplicationResponse!| Create a the card issuer Corporate Card application for a company. Requires entity information, initial user, representatives, and UBOs. Website is REQUIRED by the card issuer API. | |validateAddress|AddressValidationResponse!| Validate an address using Google Address Validation API. Returns validation result with confidence level (HIGH, MEDIUM, or LOW). Useful for validating user addresses before creating cards, shipping groups, or billing operations. Cached for 30 days per Google's recommendations. | |validateCardShippingAddress|AddressValidationResponse!| Validate a shipping address via the card issuer's address validation endpoint. Determines whether the card issuer can ship a physical card to this address. Uses Google Address Validation with geocoding fallback — broader country coverage than validateAddress. | |autocompleteAddress|AutocompleteAddressResponse!| Autocomplete address search using Google Places API. Returns address suggestions based on partial input. Useful for address entry forms with typeahead functionality. Results cached for 24 hours. | |resolvePlaceAddress|ResolvePlaceAddressResponse!| Resolve a Google Place ID to a structured address object. Use the placeId returned by autocompleteAddress to fetch precise address fields. | |updateCardNickname|CardOperationResponse!| Update a Card's nickname (display name). Validates: max 26 chars, alphanumeric + spaces + periods + hyphens only. Updates local database. Requires the user to own the card. | |updateCardUserProfile|CardOperationResponse!| Update the card issuer user profile (address and/or phone). Syncs to both the card issuer API and local database. Requires the user to own the card application. | |updateCardCompanyAddress|CardOperationResponse!| Update the card company billing address. Synced to the card processor and persisted locally. Scoped to the customer organization on the partner key (or admin role for internal use). | |updateCardLimit|CardLimitResponse!| Update a Card's spending limit. Updates both the card issuer API and local database. Requires the user to own the card application. | |lockCard|CardOperationResponse!| Lock a Card (alias for freeze). Card cannot be used for transactions. Use unlockCard to restore card functionality. Requires the user to own the card. | |unlockCard|CardOperationResponse!| Unlock a Card (alias for unfreeze). Restores card functionality. Requires the user to own the card. | |cancelCard|CardOperationResponse!| Cancel a Card permanently (irreversible). Card cannot be reactivated after cancellation. Requires the user to own the card. | |createCard|CreateCardResponse!| Create a new Card for an approved application. Supports both virtual and physical cards via cardType discriminator.
- Virtual cards: PIN set immediately, card active after creation
- Physical cards: PIN staged, shipping required, activated when received Requires an approved card application. | |
replaceCard|CardReplacementResponse!| Replace an existing Card (for lost/stolen/damaged cards). Creates a new card with new PAN and credentials. The old card is canceled automatically. - Virtual cards: New card created immediately
- Physical cards: Requires shipping address Requires the user to own the card. | |
payInvoiceWithCardBalance|PayInvoiceWithCardBalanceResponse!| Pay an invoice using card balance. Debits the user's card collateral balance and records payment against the invoice. Requires the user to own both the card application and the invoice. | |updateCardLimitByExternalCardId|CardLimitResponse!| Admin-only: Update card limit by card ID. Bypasses ownership checks. | |cancelCardByExternalCardId|CardOperationResponse!| Admin-only: Cancel card by card ID. Bypasses ownership checks. | |createCardByExternalUserId|CreateCardResponse!| Admin-only: Create card for a user by the card issuer user ID. Bypasses ownership checks. | |chargeCard|ChargeCardResponse!| Charge a Card with a fee. Requires card:charge permission. Debits from user's card collateral balance and records the transaction. | |cardWithdraw|CardWithdrawResponse!| Withdraw collateral from a Card smart wallet. Signs the withdrawal with the owner EOA via Alchemy Signer and submits via session key UserOp through the the card issuer coordinator contract. | |runCardReminders|CardReminderRunResponse!| Admin-only: Manually trigger unused card reminder processing. Finds cards with no transactions and sends reminder emails based on the schedule. Use dryRun: true (default) to preview which reminders would be sent. | |createPartnerCustomerOrganization|CreatePartnerCustomerOrganizationResponse!| Partner-only: Create a customer organization managed by the calling partner. Returns an organization_id that can be used with createCardCorporateApplication. | |createCardApplicationForPartnerUser|CardApplicationResponse!| Partner-only: Create a card application for a partner-provisioned card user. Skips Agio-user KYC — the partner is responsible for verifying their end-user's identity. | |createPartnerCardUser|CreatePartnerCardUserResponse!| Partner-only: Provision a cardholder (cardUser) under one of your partner-managed customer organizations. Returns thecardUserIdyou'll pass tocreateCardApplicationForPartnerUser.nationalIdis KMS-encrypted at rest. Idempotent on (customerOrganizationId, email) — re-running with the same email under the same org returns the existing cardUserId rather than creating a duplicate. | |cardWithdrawForPartner|CardWithdrawForPartnerResponse!| Partner-only: Withdraw USDC collateral from a partner-managed sub-client's collateral contract into the partner's configured Treasury wallet. The recipient is hard-locked to the treasury_wallet_address in the partner's treasury config — callers cannot supply a destination. Routes through the same owner-EOA signing + session-key UserOp path as cardWithdraw, but the recipient is the Treasury wallet, not the sub-client smart wallet. (Admin-curated recipient allowlist is deferred — see plan.md.) | |cardFundSubClientFromTreasury|CardFundSubClientFromTreasuryResponse!| Partner-only: Fund a sub-client's collateral contract from the partner Treasury wallet via a plain ERC-20 transfer (NOT a collateral withdrawal). Enqueues an async job and returns its id. Poll cardFundSubClientStatus(jobId) for the async outcome (see #3665). | |upsertPartnerWithdrawalAllowlist|PartnerWithdrawalAllowlistResponse!| Admin-only: Create or update a partner withdrawal-recipient allowlist entry. Passidto update an existing entry; omit it to insert. Approved entries are intended to gate cardWithdrawForPartner destinations once the allowlist gate ships; the gate is not yet enforced (pilot hard-locks the recipient to the treasury config). | |multiSendFromWallet|MultiSendFromWalletResponse!| Partner-only: send tokens from a smart wallet to multiple destinations atomically. All transfers must resolve to the same chain. Enqueues immediately; poll multiSendJobStatus. | |mintDealDocumentUploadUrl|DealDocumentUploadTicket!| - | |getDealDocumentDownloadUrl|DealDocumentDownloadTicket!| - | |createTradeSettlement|TradeSettlementResponse!| - | |resolveSettlementTransaction|TradeSettlementResponse!| - | |resolveSwapSettlement|TradeSettlementResponse!| - | |verifySettlement|TradeSettlementResponse!| - | |initiateOutboundSettlement|TradeSettlementResponse!| - | |recordOutboundTransaction|TradeSettlementResponse!| - | |updateSettlementStatus|TradeSettlementResponse!| - | |recordFiatInbound|TradeSettlementResponse!| - | |bridgeToTronQuote|BridgeQuoteResponse| - | |bridgeToTron|BridgeResultResponse| - | |ensureTokenChain|EnsureTokenChainResult!| Ensure a token_chain record exists for a given contract address and network. If the token_chain doesn't exist, fetches metadata from Alchemy and creates the necessary records. | |ensureTokenChainsFromTransactions|EnsureTokenChainsFromTransactionsResult!| Backfill token chains from existing alchemy_transaction records that have contract addresses but no associated token_chain record yet. | |subscribePartnerWebhook|SubscribePartnerWebhookResult!| Register a new webhook subscription for the calling organization. ThesigningSecretin the result is returned only once — capture it immediately. | |unsubscribePartnerWebhook|UnsubscribePartnerWebhookResult!| Remove a webhook subscription. Subsequent events will not be delivered to its URL. | |rotatePartnerWebhookSecret|RotatePartnerWebhookSecretResult!| Generate a new signing secret for an existing subscription. The previous secret continues to be accepted for 24 hours. | |recomputeFundSpm|RecomputeFundSpmResult!| - |
MutationEvm
| Field | Type | Description |
|---|---|---|
signMessage | EvmSignedMessage | - |
verifyMessage | EvmVerifiedMessage | - |
NavCalcEvent
| Field | Type | Description |
|---|---|---|
jobId | ID! | - |
step | String! | - |
status | NavStepStatus! | - |
error | String | - |
durationMs | Int | - |
at | String! | - |
NavCalcJob
| Field | Type | Description |
|---|---|---|
runId | ID! | - |
fundId | Int! | - |
periodId | Int! | - |
status | String! | - |
steps | [NavStepRecord!]! | - |
lockOnSuccess | Boolean! | - |
overrideLockedPeriod | Boolean! | - |
error | String | - |
NavStepRecord
| Field | Type | Description |
|---|---|---|
step | String! | - |
status | String! | - |
startedAt | String | - |
completedAt | String | - |
error | String | - |
NudgeResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
message | String | - |
lastNudgedAt | String | - |
error | String | - |
OrderBookUpdate
| Field | Type | Description |
|---|---|---|
channel | String! | - |
type | String! | - |
product | String! | - |
time | String! | - |
bids | [[String!]!]! | - |
asks | [[String!]!]! | - |
productMeta | TradingProduct! | - |
midMarketPrice | String! | - |
lastTradedPrice | String! | - |
quotePrice | String! | - |
OrganizationStatus
| Field | Type | Description |
|---|---|---|
hasOrganization | Boolean! | - |
organizationId | String | - |
enterpriseName | String | - |
OtcQuote
| Field | Type | Description |
|---|---|---|
id | uuid! | - |
quote_status_id | Int! | - |
created_at | timestamptz! | - |
updated_at | timestamptz! | - |
from_currency | String! | - |
to_currency | String! | - |
quote_size | Float! | - |
user_id | String! | - |
side | String! | - |
quote_slippage | Float! | - |
quote_fee_perc | Float! | - |
quote_exchange_rate | Float! | - |
total_amount | Float! | - |
expires_at | timestamptz! | - |
base_currency | String! | - |
to_currency_rate_usd | Float! | - |
from_currency_rate_usd | Float! | - |
PartnerWithdrawalAllowlistResponse
Response from an allowlist upsert.
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
id | Int | - |
error | String | - |
PatchAuth0UserInput (Input)
| Field | Type | Description |
|---|---|---|
user_id | ID | - |
email | String | - |
email_verified | Boolean | - |
picture | String | - |
created_at | String | - |
updated_at | String | - |
name | String | - |
given_name | String | - |
family_name | String | - |
nickname | String | - |
multifactor_last_modified | String | - |
last_ip | String | - |
last_login | String | - |
logins_count | String | - |
city | String | - |
user_metadata | Auth0ProfileMetadataInput | - |
PatchAuth0UserResponse
| Field | Type | Description |
|---|---|---|
user_id | ID | - |
email | String | - |
email_verified | Boolean | - |
username | String | - |
phone_number | String | - |
phone_verified | Boolean | - |
created_at | String | - |
updated_at | String | - |
identities | [Auth0Identity] | - |
user_metadata | Auth0ProfileMetadata | - |
picture | String | - |
name | String | - |
nickname | String | - |
multifactor | [String] | - |
last_ip | String | - |
last_login | String | - |
logins_count | Int | - |
blocked | Boolean | - |
given_name | String | - |
family_name | String | - |
PayInvoiceWithCardBalanceInput (Input)
| Field | Type | Description |
|---|---|---|
invoiceId | Int! | Invoice to pay |
cardApplicationId | Int! | Card application to charge (determines the card issuer user ID) |
PayInvoiceWithCardBalanceResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
chargeId | String | - |
amount | Float! | - |
invoiceId | Int! | - |
Ping
| Field | Type | Description |
|---|---|---|
api_version | String! | - |
env | String! | - |
timestamp | bigint! | - |
platform_base_url | String! | - |
domain | String! | - |
name | String! | - |
user_id | String | - |
client_id | Int | - |
default_role | String | - |
roles | [String] | - |
applicant_id | String | - |
Platform
| Field | Type | Description |
|---|---|---|
id | Int! | - |
name | String! | - |
symbol | String! | - |
slug | String! | - |
token_address | String! | - |
PortfolioDashboard
| Field | Type | Description |
|---|---|---|
id | ID! | - |
assets | [DigitalAssetSummary] | - |
assetsAggregate | DigitalAssetsAggregate | - |
whitelist | [DigitalWalletWhitelistEntry] | - |
wallets | [DigitalWalletSummary] | - |
wallet | DigitalWalletDetail | - |
usdValue | String | - |
transactions | [DigitalWalletTransactionSummary!]! | - |
transactionsAggregate | DigitalWalletTransactionsAggregate! | - |
PostShareAdjustmentJeResult
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
adjustmentId | Int | - |
journalEntryId | Int | - |
skipped | Boolean | - |
error | String | - |
PreviewJournalsResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
previews | [JournalEntryPreview!]! | - |
alreadySyncedCount | Int! | - |
pendingCount | Int! | - |
error | String | - |
ProcessAmortizationInput (Input)
| Field | Type | Description |
|---|---|---|
fundId | Int! | - |
asOfDate | String! | - |
ProcessAmortizationResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
jobId | String | - |
message | String | - |
error | String | - |
ProcessExpenseAccrualsInput (Input)
| Field | Type | Description |
|---|---|---|
fundId | Int | - |
expenseId | Int | - |
startDate | String | - |
endDate | String | - |
ProcessExpenseAccrualsResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
jobId | String | - |
message | String | - |
error | String | - |
ProcessFeeAccrualsInput (Input)
| Field | Type | Description |
|---|---|---|
fundId | Int! | - |
accrualDate | String! | - |
dryRun | Boolean | - |
ProcessFeeAccrualsResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
jobId | String | - |
message | String | - |
error | String | - |
ProcessFundCustodyExpenseAccrualsInput (Input)
| Field | Type | Description |
|---|---|---|
fundId | Int | - |
startDate | String | - |
endDate | String | - |
ProcessFundCustodyExpenseAccrualsResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
jobId | String | - |
message | String | - |
error | String | - |
ProcessFundEndOfDayInput (Input)
| Field | Type | Description |
|---|---|---|
processingDate | String! | - |
skipDelay | Boolean | - |
fundId | Int | - |
ProcessFundEndOfDayResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
jobId | String | - |
message | String | - |
error | String | - |
ProcessSeriesRollupInput (Input)
| Field | Type | Description |
|---|---|---|
fundId | Int! | - |
sourceSeriesId | Int! | - |
targetSeriesId | Int! | - |
accountingPeriodId | Int! | - |
ProcessSeriesRollupResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
jobId | String | - |
message | String | - |
error | String | - |
ProposeAuditAdjustmentInput (Input)
| Field | Type | Description |
|---|---|---|
fundId | Int! | - |
periodId | Int! | - |
glAccountId | Int! | - |
debitAmount | Float! | - |
creditAmount | Float! | - |
description | String! | - |
auditFirmName | String | - |
auditRef | String | - |
ProvisionAllDefaultChainWalletsResponse
| Field | Type | Description |
|---|---|---|
provisioned | Int! | - |
alreadyExisted | Int! | - |
failed | Int! | - |
errors | [String!]! | - |
ProvisionOrgWalletSessionKeysResponse
| Field | Type | Description |
|---|---|---|
provisioned | Int! | - |
skipped | Int! | - |
failed | Int! | - |
errors | [String!]! | - |
Query
| Field | Type | Description |
|---|---|---|
api_version | String | - |
ping | Ping | - |
auth0 | Auth0 | - |
context | jsonb | - |
documentTemplateDictionary | DocumentTemplateDictionaryResponse | - |
coinPrice | CoinPrice | - |
activeSession | SessionResponse | - |
session | SessionResponse | - |
queueJobById | BullJobResponse | - |
getPotentialKycProfiles | [KycProfile!]! | - |
userExistsByEmail | Boolean! | - |
sumsubQuestionnaireDataDecrypted | SumsubQuestionnaire | - |
sumsubQuestionnaireDataDecryptedJsonb | jsonb | - |
listSendGridTemplates | [SendGridTemplate!]! | - |
getSendGridTemplate | SendGridTemplateWithContent | - |
bitgo | QueryBitgo | - |
redis | RedisQuery! | - |
myWhitelistRequests | [WhitelistRequest!]! | - |
smartWalletSessionKeys | SmartWalletSessionKeysResponse | - |
tokenSparkline | TokenSparkline | Get sparkline data for a single token. |
| Identifier can be: numeric token ID, CoinGecko slug, or symbol (case-insensitive). | ||
tokenSparklines | [TokenSparkline!]! | Get sparkline data for multiple tokens in a single request. |
tokenSparklineUrl | String | Get sparkline rendered as a base64 SVG data URI. |
| Identifier can be: numeric token ID, CoinGecko slug, or symbol (case-insensitive). | ||
coinMarketCap | QueryCoinMarketCapToken | - |
sumsub | Sumsub | - |
previewFundInvestors | FundInvestorsPreview! | - |
validateTaskAction | TaskValidationResult! | - |
crsDataQuality | CrsDataQualitySummary | - |
crsReceivingCountries | [CrsReceivingCountry!]! | - |
crsReportableFunds | [CrsDataQualitySummary!]! | - |
tradingProducts | [TradingProduct!] | - |
balancerPools | [BalancerPool!]! | - |
balancerPool | BalancerPool | - |
balancerLPPrice | BalancerLPPrice | - |
balancerLPPriceHistory | [BalancerLPPriceHistoryItem!]! | - |
trainingVideoUrl | TrainingVideoUrl! | - |
AgioOnboardingDocumentSearch | AgioOnboardingDocumentSearchResponse | - |
kms | KMSQuery! | - |
user | User | - |
userById | User | - |
checkEmailVerificationStatus | Boolean! | - |
admin | Admin | - |
digitalWalletSummaryById | DigitalWalletSummary | - |
digitalWalletDetailById | DigitalWalletDetail | - |
netWorthUsdByUserId | String | - |
netWorthUsdByOrganizationId | String | - |
digitalAssetsByUserId | [DigitalAssetSummary] | - |
digitalAssetsByOrganizationId | [DigitalAssetSummary] | - |
digitalAssetsByUserIdAggregate | DigitalAssetsAggregate | - |
digitalAssetsByOrganizationIdAggregate | DigitalAssetsAggregate | - |
cardBalance | CardBalanceResponse! | Get balance for a Card. |
| Returns credit limit, pending charges, posted charges, balance due, and spending power. | ||
| Requires the user to own the card. | ||
cardBalanceByExternalUserId | CardBalanceResponse! | Admin-only: Get Card balance by the card issuer user ID. Bypasses ownership checks. |
cardCorporateApplicationPrefill | CardCorporateApplicationPrefill! | Prefill data for the corporate card application form, sourced from the organization's verified KYB record. |
| Returns verified UBO and representative data from nested sub-applicants. | ||
| Empty lists are returned if no verified KYB record exists for the organization. | ||
cardApplicationPrefill | CardApplicationPrefill! | Prefill data for the individual card application form, sourced from the user's Sumsub KYC |
| questionnaire ("Credit Card Details" section). All fields are optional and null when the | ||
| applicant did not provide that answer during KYC. | ||
multiSendJobStatus | MultiSendJobStatusResponse! | Partner-only: poll the status of a multisend job (scoped to the caller's partner org). |
cardFundSubClientStatus | CardFundSubClientStatusResponse! | Partner-only: poll the async outcome of a cardFundSubClientFromTreasury job |
| (scoped to the caller's partner org). Returns the job status, on-chain tx hash on success, | ||
| and a typed failedCode + failedReason on async failure. | ||
tradeSettlement | TradeSettlement | - |
tradeSettlementsByRequest | [TradeSettlement!]! | - |
financeQuotes | FinanceResultMany | - |
financeQuote | FinanceResultOne | - |
financeQuotesCrypto | FinanceResultMany | - |
chartData | FinanceChartResult | - |
chartDataBatch | [FinanceChartResult] | - |
financeNews | [FinanceNewsArticle] | - |
QueryBitgo
| Field | Type | Description |
|---|---|---|
backupProviders | [BitgoBackupProviderType] | - |
coin | QueryBitgoCoin | - |
coins | [QueryBitgoCoin] | - |
pendingApprovals | BitgoPendingApprovalsResponse | - |
pendingApproval | BitgoPendingApproval | - |
QueryBitgoCoin
| Field | Type | Description |
|---|---|---|
coinId | String | - |
data | BitgoCoinData | - |
wallet | BitgoWallet | - |
wallets | [BitgoWallet] | - |
key | BitgoKey | - |
QueryCoinMarketCapToken
| Field | Type | Description |
|---|---|---|
latest | [TokenInfo!]! | - |
upcomingAndNewTokens | [TokenInfo!]! | - |
hotTokens | [TokenInfo!]! | - |
sparkline | Sparkline | - |
sparklines | [Sparkline!]! | - |
QuoteDetails
| Field | Type | Description |
|---|---|---|
price | Float! | - |
volume_24h | Float! | - |
volume_change_24h | Float! | - |
percent_change_1h | Float! | - |
percent_change_24h | Float! | - |
percent_change_7d | Float! | - |
percent_change_30d | Float! | - |
percent_change_60d | Float! | - |
percent_change_90d | Float! | - |
market_cap | Float! | - |
market_cap_dominance | Float! | - |
fully_diluted_market_cap | Float! | - |
last_updated | String! | - |
QuoteType
| Field | Type | Description |
|---|---|---|
USD | QuoteDetails! | - |
RebuildTokensInput (Input)
| Field | Type | Description |
|---|---|---|
tokenIds | [Int!] | - |
dryRun | Boolean! | - |
skipDeduplication | Boolean! | - |
batchSize | Int! | - |
waitForResult | Boolean | - |
RecipientPreviewFull
| Field | Type | Description |
|---|---|---|
audience | String! | - |
totalCount | Int! | - |
rows | [RecipientPreviewRow!]! | - |
RecipientPreviewRow
| Field | Type | Description |
|---|---|---|
userId | ID | - |
leadId | Int | - |
email | String! | - |
givenName | String | - |
familyName | String | - |
organizationContexts | [String!]! | - |
RecomputeFundSpmPeriodResult
| Field | Type | Description |
|---|---|---|
periodId | Int! | - |
skipped | Boolean! | - |
error | String | - |
RecomputeFundSpmResult
| Field | Type | Description |
|---|---|---|
fundId | Int! | - |
periods | [RecomputeFundSpmPeriodResult!]! | - |
success | Boolean! | - |
error | String | - |
ReconcileCoingeckoInput (Input)
| Field | Type | Description |
|---|---|---|
dryRun | Boolean! | - |
forceRefresh | Boolean! | - |
maxNewTokens | Int! | - |
waitForResult | Boolean | - |
RecordFiatInboundInput (Input)
| Field | Type | Description |
|---|---|---|
settlementId | Int! | - |
amount | Float! | - |
currency | String! | - |
bankReference | String | - |
notes | String | - |
RecordOutboundTransactionInput (Input)
| Field | Type | Description |
|---|---|---|
settlementId | Int! | - |
txHash | String! | - |
RecurringJEResult
| Field | Type | Description |
|---|---|---|
generated | Int! | - |
skipped | Int! | - |
errors | [String!]! | - |
RedisKeyValue
| Field | Type | Description |
|---|---|---|
key | String! | - |
value | String! | - |
status | RedisKeyStatus! | - |
RedisMutation
| Field | Type | Description |
|---|---|---|
set | Boolean! | - |
del | Boolean! | - |
flushAll | Boolean! | - |
flushAllSessions | Int! | - |
flushAllTransactions | Int! | - |
delPattern | Int! | - |
RedisQuery
| Field | Type | Description |
|---|---|---|
getValue | String! | - |
getKeyValues | [RedisKeyValue]! | - |
getKeys | [String]! | - |
getKeyCount | Int! | - |
status | RedisStatus! | - |
stats | jsonb! | - |
RefreshBalancerLPPricesResponse
| Field | Type | Description |
|---|---|---|
jobId | String | - |
totalPools | Int! | - |
success | Boolean! | - |
error | String | - |
RefreshOtcQuoteResponse
| Field | Type | Description |
|---|---|---|
quote | OtcQuote | - |
errors | [String!] | - |
RegisterBalancerPoolInput (Input)
| Field | Type | Description |
|---|---|---|
poolId | String! | - |
poolAddress | String! | - |
poolType | String! | - |
balancerVersion | BalancerVersion! | - |
network | BalancerNetwork! | - |
name | String | - |
symbol | String | - |
RegisterBalancerPoolResponse
| Field | Type | Description |
|---|---|---|
pool | BalancerPool | - |
success | Boolean! | - |
error | String | - |
RejectWhitelistRequestInput (Input)
| Field | Type | Description |
|---|---|---|
requestId | Int! | - |
reason | String! | - |
RemovePolicyResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
error | String | - |
RemoveWalletPolicyInput (Input)
| Field | Type | Description |
|---|---|---|
digitalWalletId | Int! | - |
policyId | Int! | - |
RenderCaseDocumentsFilter (Input)
| Field | Type | Description |
|---|---|---|
documentTemplateIds | [uuid!] | - |
documentTypeNames | [String!] | - |
ReplaceCardInput (Input)
Input for replacing an existing card (lost/stolen/damaged)
| Field | Type | Description |
|---|---|---|
cardId | Int! | Card ID (AgioCard_card.id - our internal card ID) |
reason | CardReplacementReason! | Reason for replacement |
shippingAddress | CardShippingInput | Shipping address for physical card replacement (required for physical cards) |
ReplayPartnerWebhookDeliveryResult
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
newDeliveryId | String | The id of the newly enqueued delivery — distinct from the original deliveryId. |
errorCode | String | - |
errorMessage | String | - |
RequestConvertDigitalAssetQuoteInput (Input)
| Field | Type | Description |
|---|---|---|
walletId | ID! | - |
fromCoinId | String | - |
toCoinId | String | - |
size | String! | - |
RequestFundRedemptionSignatureResult
| Field | Type | Description |
|---|---|---|
redemptionId | Int! | - |
invitedAt | String! | - |
toEmailAddress | String! | - |
RequestFundSubscriptionSignatureResult
| Field | Type | Description |
|---|---|---|
subscriptionId | Int! | - |
invitedAt | String! | - |
toEmailAddress | String! | - |
RequestGoNetworkConnectionInput (Input)
| Field | Type | Description |
|---|---|---|
goAccountId | Int! | - |
counterpartyId | String! | - |
counterpartyName | String | - |
RequestOtcQuoteInput (Input)
| Field | Type | Description |
|---|---|---|
fromCurrency | String! | - |
toCurrency | String! | - |
side | String! | - |
size | Float! | - |
slippage | Float | - |
tradeType | Int | - |
limitPrice | Float | - |
RequestOtcTradeInput (Input)
| Field | Type | Description |
|---|---|---|
fromCoin | String! | - |
toCoin | String! | - |
side | String! | - |
size | Float! | - |
slippage | Float | - |
telegramMessageId | bigint | - |
fromWalletId | Int | - |
fromBankInfoId | Int | - |
toWalletId | Int | - |
toBankInfoId | Int | - |
feePerc | Float | - |
limitPrice | Float | - |
expiresAt | timestamptz | - |
tradeType | Int | - |
quoteId | uuid | - |
RequestQuoteTradeResponse
| Field | Type | Description |
|---|---|---|
quote | OtcQuote | - |
errors | [String!] | - |
RerunBackfillResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
jobId | String | - |
error | String | - |
ResolvedPlaceAddress
Structured address resolved from a Google Place ID
| Field | Type | Description |
|---|---|---|
line1 | String! | - |
city | String! | - |
region | String! | - |
postalCode | String! | - |
countryCode | String! | - |
country | String | - |
formattedAddress | String | - |
ResolvePlaceAddressResponse
Response from resolving a place ID to a structured address
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
address | ResolvedPlaceAddress | - |
error | String | - |
ResolveSettlementTransactionInput (Input)
| Field | Type | Description |
|---|---|---|
settlementId | Int! | - |
txHash | String! | - |
network | String! | - |
settlementWalletId | Int | - |
ResolveSwapSettlementInput (Input)
| Field | Type | Description |
|---|---|---|
settlementId | Int! | - |
txHash | String! | - |
network | String! | - |
walletAddress | String! | - |
RevokeGoNetworkConnectionInput (Input)
| Field | Type | Description |
|---|---|---|
connectionId | Int! | - |
RevokeSmartWalletSessionKeyInput (Input)
| Field | Type | Description |
|---|---|---|
sessionId | String! | - |
RevokeSmartWalletSessionKeyResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
error | String | - |
RevokeTokenInput (Input)
| Field | Type | Description |
|---|---|---|
kind | RevokeTokenKind! | Discriminator: JTI revokes a specific jti, HASH revokes a credential by sha256 hex, USER revokes all active sessions for a sub |
jti | String | Required when kind=JTI |
hash | String | Required when kind=HASH — 64-char lowercase hex sha256 |
credentialKind | RevokeTokenCredentialKind | Required when kind=HASH — the type of credential this hash belongs to |
sub | String | Required when kind=USER or as audit payload on JTI — the Auth0 sub (auth0 |
ttlSeconds | Int | Seconds until the blacklist entry expires. Max 30 days (2592000). Defaults to 1 day. |
reason | String! | Free-text audit note; shown in admin listings and Cloud Logging |
RevokeTokenResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
revoked | Int! | Number of entries revoked. For USER: number of jtis fanned out. For JTI/HASH: always 1 when success=true. |
error | String | Set on error paths only (e.g. cannot_revoke_self, invalid_request) |
RotatePartnerApiTokenResult
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
clientSecret | String | The new signing secret. Returned ONCE — capture immediately, never readable again. |
| The previous secret stops being accepted immediately (no grace window — partner must | ||
| re-deploy with the new secret atomically). | ||
errorCode | String | - |
errorMessage | String | - |
RotatePartnerWebhookSecretResult
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
signingSecret | String | Returned ONCE on rotate. Capture immediately — never readable again. |
| The previous secret continues to be accepted for 24 hours after rotation to allow | ||
| zero-downtime handover on the receiving side. | ||
previousSecretValidUntil | String | - |
errorCode | String | - |
errorMessage | String | - |
RunFullNavOpts (Input)
| Field | Type | Description |
|---|---|---|
lockOnSuccess | Boolean | - |
overrideLockedPeriod | Boolean | - |
overrideReason | String | - |
SendAccountFundingEmailInput (Input)
| Field | Type | Description |
|---|---|---|
userId | String | - |
toEmailAddress | String | - |
toFirstName | String | - |
SendBulkInvoiceEmailsInput (Input)
| Field | Type | Description |
|---|---|---|
invoiceIds | [Int!]! | - |
SendBulkInvoiceEmailsResponse
| Field | Type | Description |
|---|---|---|
totalRequested | Int! | - |
totalSent | Int! | - |
totalFailed | Int! | - |
totalSkipped | Int! | - |
results | [BulkInvoiceEmailResult!]! | - |
SendCaseStatusUpdateEmailInput (Input)
| Field | Type | Description |
|---|---|---|
toEmailAddress | String | - |
firstName | String | - |
caseId | Int | - |
oldStatus | String | - |
newStatus | String | - |
notes | String | - |
SendCESRAEmailInput (Input)
| Field | Type | Description |
|---|---|---|
caseId | Int | - |
toEmailAddress | String | - |
toFirstName | String | - |
SendEmailSharePageInput (Input)
| Field | Type | Description |
|---|---|---|
toEmail | String! | - |
toFirstName | String! | - |
subject | String! | - |
body | String! | - |
pageUrl | String! | - |
buttonText | String | - |
SendFundInvestorContactEmailInput (Input)
| Field | Type | Description |
|---|---|---|
fundId | Int! | - |
category | String! | - |
subject | String! | - |
message | String! | - |
SendGridClientResponse
| Field | Type | Description |
|---|---|---|
statusCode | Int | - |
body | jsonb | - |
SendGridTemplate
| Field | Type | Description |
|---|---|---|
id | String! | - |
name | String! | - |
generation | String! | - |
updatedAt | String | - |
versions | [SendGridTemplateVersion!]! | - |
SendGridTemplateVersion
| Field | Type | Description |
|---|---|---|
id | String! | - |
name | String | - |
subject | String | - |
active | Boolean! | - |
updatedAt | String | - |
thumbnailUrl | String | - |
editor | String | - |
SendGridTemplateVersionWithContent
| Field | Type | Description |
|---|---|---|
id | String! | - |
name | String | - |
subject | String | - |
htmlContent | String | - |
plainContent | String | - |
active | Boolean! | - |
updatedAt | String | - |
thumbnailUrl | String | - |
variables | [String!]! | - |
SendGridTemplateWithContent
| Field | Type | Description |
|---|---|---|
id | String! | - |
name | String! | - |
generation | String! | - |
updatedAt | String | - |
activeVersion | SendGridTemplateVersionWithContent | - |
versions | [SendGridTemplateVersion!]! | - |
SendKycEmailInput (Input)
| Field | Type | Description |
|---|---|---|
toEmailAddress | String | - |
fromFirstName | String | - |
fromLastName | String | - |
toFirstName | String | - |
toLastName | String | - |
caseId | Int | - |
notes | String | - |
inviteId | String | - |
kycLevel | String | - |
SendMassEmailInput (Input)
| Field | Type | Description |
|---|---|---|
subject | String! | - |
bodyHtml | String | - |
sendGridTemplateId | String | - |
templateData | jsonb | - |
testEmail | String | - |
dryRun | Boolean | - |
validateOnly | Boolean | - |
segmentId | ID | - |
adHocFilter | EmailSegmentFilter | - |
leadListId | ID | - |
leadIds | [Int!] | - |
category | EmailCategory | - |
fundInvestorRecipients | FundInvestorRecipientsInput | - |
attachments | [MassEmailAttachmentInput!] | - |
SendMassEmailResponse
| Field | Type | Description |
|---|---|---|
totalRecipients | Int! | - |
totalSent | Int! | - |
totalFailed | Int! | - |
results | [MassEmailRecipientResult!] | - |
campaignId | ID | - |
SendSignatureInviteEmailInput (Input)
| Field | Type | Description |
|---|---|---|
toEmailAddress | String! | - |
toFirstName | String! | - |
toLastName | String! | - |
caseId | Int! | - |
notes | String | - |
inviteId | String! | - |
SendStandaloneKycInviteInput (Input)
| Field | Type | Description |
|---|---|---|
toEmail | String! | - |
toFirstName | String! | - |
toLastName | String! | - |
defaultAppId | Int! | - |
sumsubLevelId | Int! | - |
fromFirstName | String | - |
fromLastName | String | - |
notes | String | - |
organizationMemberUserId | String | - |
kycLevel | String | - |
SendTestCampaignEmailInput (Input)
| Field | Type | Description |
|---|---|---|
toEmail | String! | - |
subject | String | - |
bodyHtml | String | - |
sendGridTemplateId | String | - |
dynamicTemplateData | JSON | - |
landingUrl | String | - |
SendTrainingReminderResult
| Field | Type | Description |
|---|---|---|
sent | Boolean! | - |
email | String! | - |
SendWireTransferEmailInput (Input)
| Field | Type | Description |
|---|---|---|
wireTransferId | Int! | - |
overrideEmail | String | - |
overrideCcEmails | [String!] | - |
customMessage | String | - |
SendWireTransferEmailResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
sentTo | String | - |
ccEmails | [String!] | - |
error | String | - |
ServicesStatus
| Field | Type | Description |
|---|---|---|
id | ID! | - |
name | String | - |
status | ServicesStatusType | - |
message | String | - |
lastUpdated | timestamptz | - |
data | jsonb | - |
durationMs | Int | - |
SessionResponse
| Field | Type | Description |
|---|---|---|
id | ID! | - |
userId | String | - |
active | Boolean! | - |
timestamp | timestamptz! | - |
allowedFunds | [Int!]! | - |
allowedOrganizations | [uuid!]! | - |
SetCardPinInput (Input)
Input for setting a card PIN
| Field | Type | Description |
|---|---|---|
cardId | Int! | Card ID (AgioCard_card.id - our internal card ID) |
sessionId | String! | Session ID from generateEncryptionKeys mutation |
encryptedPin | String! | Encrypted PIN (use encryptPassphraseForTransfer from agio-utils). |
| PIN must be 4-12 digits and meet security requirements: |
- No repeated digits (1111, 0000)
- No sequential ascending (1234, 2345)
- No sequential descending (4321, 9876) |
SetSumsubApplicantIdInput (Input)
| Field | Type | Description |
|---|---|---|
userId | String! | Target user's Auth0 user_id (e.g., 'auth0 |
applicantId | String | 24-char hex Sumsub applicant id. Pass null to detach. |
serviceRequestId | uuid | Service request UUID (kyc_transfer type). Required when changeReason = kyc_transfer. |
changeReason | SumsubApplicantChangeReason! | Reason for the change. Required when overwriting a non-null existing value. |
SetSumsubApplicantIdResult
| Field | Type | Description |
|---|---|---|
userId | String! | - |
previousApplicantId | String | - |
applicantId | String | - |
serviceRequestRefNo | String | Service request that was auto-marked completed (null if no SR fulfilled). |
changeReason | SumsubApplicantChangeReason! | - |
SignFundAgreementInput (Input)
| Field | Type | Description |
|---|---|---|
fundId | Int! | - |
signatureBase64 | String! | - |
transactionType | String! | - |
organizationId | String | - |
amount | Float | - |
fundNavId | Int | - |
sharePriceOverride | Float | - |
subscriptionId | Int | - |
redemptionId | Int | - |
isFullRedemption | Boolean | - |
SignFundAgreementResult
| Field | Type | Description |
|---|---|---|
agreementId | Int! | - |
subscriptionId | Int | - |
redemptionId | Int | - |
pdfUrl | String! | - |
SmartWalletErrorResponse
Structured error response for smart wallet operations
| Field | Type | Description |
|---|---|---|
code | String! | Error code (e.g., INSUFFICIENT_BALANCE, SWAP_NOT_SUPPORTED) |
message | String! | Human-readable error message |
details | String | Additional error details as JSON string (optional) |
SmartWalletExecuteSwapQuoteInput (Input)
| Field | Type | Description |
|---|---|---|
quoteId | Int! | The quoteId returned from smartWalletSwapQuote (database ID) |
SmartWalletJwtResponse
| Field | Type | Description |
|---|---|---|
jwt | String! | - |
expiresAt | Int! | - |
subjectId | String! | - |
scope | SmartWalletSubjectScope! | - |
SmartWalletSendTransactionInput (Input)
| Field | Type | Description |
|---|---|---|
digitalWalletId | ID! | - |
recipient | String! | - |
amount | String! | - |
data | String | - |
saveToAddressBook | Boolean | - |
addressBookNickname | String | - |
SmartWalletSendTransactionResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
transactionHash | String | - |
error | String | - |
structuredError | SmartWalletErrorResponse | - |
SmartWalletSessionKey
| Field | Type | Description |
|---|---|---|
id | Int! | - |
sessionId | String! | - |
sessionKeyAddress | String! | - |
expired | Boolean! | - |
revoked | Boolean! | - |
revokedAt | timestamptz | - |
expiresAt | timestamptz | - |
lastUsedAt | timestamptz | - |
createdAt | timestamptz! | - |
SmartWalletSessionKeysResponse
| Field | Type | Description |
|---|---|---|
walletId | Int! | - |
smartWalletId | Int! | - |
address | String! | - |
chain | String! | - |
chainId | Int! | - |
deployed | Boolean! | - |
sessionKeys | [SmartWalletSessionKey!]! | - |
SmartWalletSwapInput (Input)
| Field | Type | Description |
|---|---|---|
digitalWalletId | ID! | - |
fromToken | String! | - |
toToken | String! | - |
amount | String! | Amount in wei (smallest unit). Frontend must convert human-readable to wei using token decimals. |
toChainId | Int | - |
recipient | String | Optional recipient address. If specified, swap output is sent directly to this address |
| instead of back to the wallet. Useful for "swap and send" flows like Rain Card funding. | ||
providers | [SwapProvider!] | Preferred swap providers to query. Empty/null defaults to [RELAY, ALCHEMY] |
| which are compared in parallel and the best executable route is selected automatically. | ||
| Pass [ALL] to include every available provider (adds ONEINCH, COW). | ||
| Pass a single provider (e.g. [COW]) to force routing through that provider only. |
SnoozeResult
| Field | Type | Description |
|---|---|---|
training_version_id | Int! | - |
snooze_count | Int! | - |
last_snooze_at | timestamptz! | - |
snoozed_until | timestamptz! | - |
Sparkline
| Field | Type | Description |
|---|---|---|
id | ID! | - |
price_usd | [Float!]! | - |
timestamp | [Int!]! | - |
SubmitQuoteQuestionInput (Input)
| Field | Type | Description |
|---|---|---|
quoteId | Int! | - |
lineItemId | Int | - |
question | String! | - |
changeType | String | - |
SubmitQuoteQuestionResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
error | String | - |
questionId | Int | - |
SubmitWhitelistRequestInput (Input)
| Field | Type | Description |
|---|---|---|
digitalWalletId | Int! | - |
address | String! | - |
chainId | Int | - |
label | String | - |
notes | String | - |
SubscribePartnerWebhookInput (Input)
| Field | Type | Description |
|---|---|---|
url | String! | HTTPS URL that will receive signed event POSTs. Private / loopback / cloud-metadata IPs are rejected. |
events | [PartnerWebhookEvent!]! | Events to subscribe to. At least one required. |
SubscribePartnerWebhookResult
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
subscriptionId | ID | - |
signingSecret | String | Returned ONCE on create. Capture it immediately — it is never readable again. |
| Use it to verify HMAC-SHA256 signatures on incoming event POSTs (x-agio-signature header). | ||
errorCode | String | - |
errorMessage | String | - |
Subscription
| Field | Type | Description |
|---|---|---|
ping | String | - |
shortLivedToken | String | - |
memory | String | - |
orderBookUpdates | [OrderBookUpdate!] | - |
tradeOrderUpdates | TradeOrderUpdate | - |
navCalcProgress | NavCalcEvent | - |
Sumsub
| Field | Type | Description |
|---|---|---|
getApplicant | jsonb | - |
getApplicantByApplicantId | jsonb | - |
getApplicantTyped | SumsubApplicantResponse | - |
me | SumsubApplicantResponse | - |
applicantLevels | [String] | - |
getApplicantLevels | [SumsubApplicantLevelItem!]! | - |
getApplicantLevel | SumsubApplicantLevelItem | - |
applicantReportPdf | String | - |
applicants | [SumsubApplicantResponse] | - |
tokenByJwt | SumsubTokenResponse | - |
token | SumsubTokenResponse | - |
completeProfileToken | SumsubTokenResponse | - |
guestToken | SumsubTokenResponse | - |
organizationKybToken | SumsubTokenResponse | - |
SumsubAmlWatcherSettings
| Field | Type | Description |
|---|---|---|
categories | [String!]! | - |
fuzziness | String! | - |
SumsubApplicantIdentifiers (Input)
| Field | Type | Description |
|---|---|---|
email | String | - |
phone | String | - |
SumsubApplicantInsightSettings
| Field | Type | Description |
|---|---|---|
advancedEmailCheckEnabled | Boolean! | - |
advancedPhoneCheckEnabled | Boolean! | - |
advancedIpCheckEnabled | Boolean! | - |
advancedIdentityEnrichmentEnabled | Boolean | - |
SumsubApplicantLevelItem
| Field | Type | Description |
|---|---|---|
id | ID! | - |
clientId | String! | - |
name | String! | - |
desc | String | - |
requiredIdDocs | SumsubRequiredIdDocs! | - |
websdkFlowId | String | - |
msdkFlowId | String | - |
websdkNext | Boolean | - |
notificationSettings | SumsubNotificationSettings | - |
created | SumsubDateInfo! | - |
modified | SumsubDateInfo! | - |
createdAt | timestamptz! | - |
createdBy | String! | - |
modifiedAt | timestamptz! | - |
modifiedBy | String | - |
useCustomIdDocSettings | Boolean | - |
customPrivacyNoteText | String | - |
customPrivacyLink | String | - |
watchListCheckSettings | SumsubWatchListCheckSettings | - |
useCustomWatchListCheckSettings | Boolean | - |
applicantInsightSettings | SumsubApplicantInsightSettings | - |
kytSettings | SumsubKytSettings | - |
checkSourceSettings | jsonb | - |
type | String | - |
actionType | String | - |
applicantType | String! | - |
autoCheckGeneratorSettings | SumsubAutoCheckGeneratorSettings | - |
SumsubApplicantResponse
| Field | Type | Description |
|---|---|---|
id | ID! | - |
applicant | jsonb | - |
applicantId | String | - |
externalUserId | String | - |
levelName | String | - |
approved | Boolean | - |
userId | String | - |
questionnaireId | String | - |
applicantStatus | jsonb | - |
requiredIdDocsStatus | jsonb | - |
requiredDocuments | [SumsubRequiredDocument] | - |
sourceKey | String | Represents client_id |
sourceKeyInt | Int | - |
SumsubAutoCheckGeneratorSettings
| Field | Type | Description |
|---|---|---|
autoCheckMode | String | - |
kybType | String | - |
SumsubBulkSyncResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
message | String! | - |
totalProcessed | Int! | - |
totalSuccess | Int! | - |
totalFailed | Int! | - |
totalSkipped | Int! | - |
SumsubCaptureParams
| Field | Type | Description |
|---|---|---|
inputType | String! | - |
SumsubClearAllTransactionsResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
message | String! | - |
totalItems | Int! | - |
SumsubCompanyDocsGroupDefinition
| Field | Type | Description |
|---|---|---|
label | String! | - |
subTypes | [String!]! | - |
required | Boolean! | - |
SumsubComplyAdvantageSettings
| Field | Type | Description |
|---|---|---|
warningTypes | [String!]! | - |
fuzziness | String! | - |
SumsubDateInfo
| Field | Type | Description |
|---|---|---|
date | timestamptz! | - |
clientSubject | String | - |
subjectId | String | - |
SumsubDeleteTransactionResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
message | String! | - |
transactionId | String! | - |
SumsubDocSet
| Field | Type | Description |
|---|---|---|
idDocSetType | String! | - |
types | [String!] | - |
subTypes | [String!] | - |
videoRequired | String | - |
captureParams | SumsubCaptureParams | - |
captureMode | String | - |
uploaderMode | String | - |
nfcVerificationSettings | SumsubNfcVerificationSettings | - |
fields | [SumsubDocumentField!] | - |
steps | [SumsubKybStep!] | - |
companyDocsGroupDefinitions | [SumsubCompanyDocsGroupDefinition!] | - |
questionnaireDefId | String | - |
paymentMethods | [jsonb!] | - |
poaStepSettingsId | String | - |
SumsubDocumentField
| Field | Type | Description |
|---|---|---|
name | String! | - |
required | Boolean! | - |
prefill | String | - |
immutableIfPresent | Boolean | - |
SumsubFile
| Field | Type | Description |
|---|---|---|
id | String | - |
reviewAnswer | SumsubReviewAnswer | - |
uri | String | - |
base64 | String | - |
type | String | - |
mimeType | String | - |
inspectionId | String | - |
SumsubFixedInfoAddress
| Field | Type | Description |
|---|---|---|
country | String | Alpha-3 country code (e.g. DEU or RUS) |
postCode | String | - |
town | String | - |
street | String | - |
subStreet | String | - |
state | String | - |
buildingName | String | - |
flatNumber | String | - |
buildingNumber | String | - |
startDate | String | Date format YYYY-mm-dd, e.g. 2001-09-25 |
endDate | String | Date format YYYY-mm-dd, e.g. 2001-09-25 |
formattedAddress | String | - |
SumsubFixedInfoAddressInput (Input)
| Field | Type | Description |
|---|---|---|
country | String | Alpha-3 country code (e.g. DEU or RUS) |
postCode | String | - |
town | String | - |
street | String | - |
subStreet | String | - |
state | String | - |
buildingName | String | - |
flatNumber | String | - |
buildingNumber | String | - |
startDate | String | Date format YYYY-mm-dd, e.g. 2001-09-25 |
endDate | String | Date format YYYY-mm-dd, e.g. 2001-09-25 |
formattedAddress | String | - |
SumsubFixedInfoInput (Input)
| Field | Type | Description |
|---|---|---|
firstName | String | Applicant first name in the original language |
lastName | String | Applicant last name in the original language |
middleName | String | Applicant middle name in the original language |
firstNameEn | String | - |
lastNameEn | String | - |
middleNameEn | String | - |
legalName | String | Legal name of the company the applicant is related to (UBO or shareholder) |
gender | String | Applicant gender (M or F) |
dob | String | Date of birth (format YYYY-mm-dd, e.g. 2001-09-25) |
placeOfBirth | String | Place of birth. This can be a city, a town or another settlement type |
countryOfBirth | String | Country of birth. Alpha-3 country code (e.g. DEU, GBR, ARG) |
stateOfBirth | String | State, region, district, county or another territorial entity of birth inside a country, if applicable |
country | String | Country of the last uploaded ID document, may differ from country of birth. Alpha-3 country code (e.g. DEU, GBR, ARG) |
nationality | String | Country of origin. Alpha-3 country code (e.g. DEU, GBR, ARG) |
addresses | [SumsubFixedInfoAddressInput!] | - |
phone | String | - |
tin | String | Taxpayer identification number that is unique to each taxpayer |
SumsubFixedInfoResponse
| Field | Type | Description |
|---|---|---|
firstName | String | Applicant first name in the original language |
lastName | String | Applicant last name in the original language |
middleName | String | Applicant middle name in the original language |
firstNameEn | String | - |
lastNameEn | String | - |
middleNameEn | String | - |
legalName | String | Legal name of the company the applicant is related to (UBO or shareholder) |
gender | String | Applicant gender (M or F) |
dob | String | Date of birth (format YYYY-mm-dd, e.g. 2001-09-25) |
placeOfBirth | String | Place of birth. This can be a city, a town or another settlement type |
countryOfBirth | String | Country of birth. Alpha-3 country code (e.g. DEU, GBR, ARG) |
stateOfBirth | String | State, region, district, county or another territorial entity of birth inside a country, if applicable |
country | String | Country of the last uploaded ID document, may differ from country of birth. Alpha-3 country code (e.g. DEU, GBR, ARG) |
nationality | String | Country of origin. Alpha-3 country code (e.g. DEU, GBR, ARG) |
addresses | [SumsubFixedInfoAddress!] | - |
phone | String | - |
tin | String | Taxpayer identification number that is unique to each taxpayer |
SumsubIdDocError
| Field | Type | Description |
|---|---|---|
code | String! | - |
message | String! | - |
field | String | - |
SumsubIdDocMetaData
| Field | Type | Description |
|---|---|---|
idDocType | SumsubIdDocType! | - |
idDocSubType | SumsubIdDocSubType | - |
country | String! | 3-letter country code (Wikipedia) |
firstName | String | - |
middleName | String | - |
lastName | String | - |
issuedDate | String | Date format YYYY-mm-dd, e.g. 2001-09-25 |
validUntil | String | Date format YYYY-mm-dd, e.g. 2001-09-25 |
number | String | - |
dob | String | Date of birth format YYYY-mm-dd, e.g. 2001-09-25 |
placeOfBirth | String | - |
SumsubIdDocMetaDataInput (Input)
| Field | Type | Description |
|---|---|---|
idDocType | SumsubIdDocType! | - |
idDocSubType | SumsubIdDocSubType | - |
country | String! | 3-letter country code (Wikipedia) |
firstName | String | - |
middleName | String | - |
lastName | String | - |
issuedDate | String | Date format YYYY-mm-dd, e.g. 2001-09-25 |
validUntil | String | Date format YYYY-mm-dd, e.g. 2001-09-25 |
number | String | - |
dob | String | Date of birth format YYYY-mm-dd, e.g. 2001-09-25 |
placeOfBirth | String | - |
SumsubIdDocMetaDataResponse
| Field | Type | Description |
|---|---|---|
data | SumsubIdDocMetaDataWithErrors! | - |
imageId | String | - |
correlationId | String | - |
SumsubIdDocMetaDataWithErrors
| Field | Type | Description |
|---|---|---|
idDocType | SumsubIdDocType! | - |
idDocSubType | SumsubIdDocSubType | - |
country | String! | 3-letter country code (Wikipedia) |
firstName | String | - |
middleName | String | - |
lastName | String | - |
issuedDate | String | Date format YYYY-mm-dd, e.g. 2001-09-25 |
validUntil | String | Date format YYYY-mm-dd, e.g. 2001-09-25 |
number | String | - |
dob | String | Date of birth format YYYY-mm-dd, e.g. 2001-09-25 |
placeOfBirth | String | - |
errors | [SumsubIdDocError!] | - |
warnings | [SumsubIdDocWarning!] | - |
SumsubIdDocWarning
| Field | Type | Description |
|---|---|---|
code | String! | - |
message | String! | - |
field | String | - |
SumsubKybSettings
| Field | Type | Description |
|---|---|---|
shareholderThreshold | Int | - |
uboThreshold | Int | - |
disableCompanySearchAndPrefill | Boolean | - |
createKycTxns | Boolean | - |
SumsubKybStep
| Field | Type | Description |
|---|---|---|
name | String! | - |
minDocsCnt | Int! | - |
applicantLevelName | String | - |
idDocTypes | [String!] | - |
idDocSubTypes | [String!] | - |
fields | [SumsubDocumentField!] | - |
customFields | jsonb | - |
captureMode | String | - |
SumsubKytSettings
| Field | Type | Description |
|---|---|---|
createKycTxns | Boolean | - |
SumsubMutation
| Field | Type | Description |
|---|---|---|
tokenByJwt | SumsubTokenResponse | - |
token | SumsubTokenResponse | - |
completeProfileToken | SumsubTokenResponse | - |
guestToken | SumsubTokenResponse | - |
organizationKybToken | SumsubTokenResponse | - |
createOrGetApplicantForUser | CreateOrGetApplicantForUserResult! | - |
createOrGetApplicantForOrganization | CreateOrGetApplicantForUserResult! | - |
generateWebSDKLink | String! | - |
generateWebSDKLinkCompleteProfile | String! | - |
addIdDocument | SumsubIdDocMetaDataResponse! | - |
addIdDocumentByUserOrganizationInviteId | SumsubIdDocMetaDataResponse! | - |
patchFixedInfo | SumsubFixedInfoResponse! | - |
clearAllTransactions | SumsubClearAllTransactionsResponse! | - |
deleteTransactionById | SumsubDeleteTransactionResponse! | - |
deleteTransactionByUtlId | SumsubDeleteTransactionResponse! | - |
syncTransaction | SumsubSyncTransactionResponse! | - |
syncPendingTransactions | SumsubBulkSyncResponse! | - |
attachKybBeneficiary | AttachKybBeneficiaryResult! | Link an existing verified Sumsub individual applicant to the org's KYB 2.0 company structure. |
| The individual must already have a Sumsub applicant ID (from completing or starting individual KYC). | ||
| Returns the junction record ID needed for future detachment. | ||
detachKybBeneficiary | SumsubOkResponse! | Remove a beneficiary from the org's KYB 2.0 company structure. |
| Uses the junction record ID (not the applicant ID) returned from attachKybBeneficiary. | ||
sendKybBeneficiaryReminders | SumsubOkResponse! | Send Sumsub verification reminder emails to all pending beneficiaries |
| of the org's company applicant (max 100 per call). | ||
setSumsubApplicantId | SetSumsubApplicantIdResult! | Canonical write path for AgioAuth.user.sumsub_applicant_id. |
| Replaces direct usePatchUserMutation writes from agio-admin (issue #2852) so admin | ||
| applicant changes are server-validated and audited. Auto-closes the matching | ||
| service_request when serviceRequestId is provided. |
SumsubNfcVerificationSettings
| Field | Type | Description |
|---|---|---|
mode | String! | - |
SumsubNotificationSettings
| Field | Type | Description |
|---|---|---|
applicantNotificationStates | [String!]! | - |
SumsubOkResponse
| Field | Type | Description |
|---|---|---|
ok | Boolean! | - |
SumsubQuantifindSettings
| Field | Type | Description |
|---|---|---|
minRiskLevel | String! | - |
minConfidenceLevel | String! | - |
SumsubQuestionnaire
| Field | Type | Description |
|---|---|---|
id | String! | - |
title | String | - |
sections | [SumsubQuestionnairSection] | - |
applicantId | String | - |
SumsubQuestionnaireItem
| Field | Type | Description |
|---|---|---|
id | String! | - |
title | String | - |
value | String | - |
values | [String] | - |
type | String | - |
files | [SumsubFile] | - |
SumsubQuestionnairSection
| Field | Type | Description |
|---|---|---|
id | String! | - |
title | String | - |
items | [SumsubQuestionnaireItem!]! | - |
SumsubRequiredDocument
| Field | Type | Description |
|---|---|---|
id | String! | - |
name | String | - |
type | String | - |
files | [SumsubFile] | - |
reviewAnswer | SumsubReviewAnswer | - |
forbidden | Boolean | - |
questionnaireData | SumsubQuestionnaire | - |
SumsubRequiredIdDocs
| Field | Type | Description |
|---|---|---|
videoIdent | Boolean | - |
videoIdentUploadTypes | [String!] | - |
stepsOutsideVideoId | [String!] | - |
excludedCountries | [String!] | - |
docSets | [SumsubDocSet!]! | - |
kybSettings | SumsubKybSettings | - |
SumsubSyncTransactionResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
message | String! | - |
utlId | Int! | - |
sumsubTransactionId | String | - |
SumsubTokenResponse
| Field | Type | Description |
|---|---|---|
token | String | - |
levelName | String | - |
userId | String | - |
externalActionId | String | - |
sourceKey | String | - |
applicantId | String | - |
externalUserId | String | - |
SumsubWatchListCheckSettings
| Field | Type | Description |
|---|---|---|
complyAdvantage | SumsubComplyAdvantageSettings | - |
quantifind | SumsubQuantifindSettings | - |
amlWatcher | SumsubAmlWatcherSettings | - |
SwapFeePayment
| Field | Type | Description |
|---|---|---|
sponsored | Boolean! | - |
tokenAddress | String! | - |
maxAmount | String! | - |
SwapGasEstimate
| Field | Type | Description |
|---|---|---|
callGasLimit | String! | - |
verificationGasLimit | String! | - |
preVerificationGas | String! | - |
maxFeePerGas | String! | - |
maxPriorityFeePerGas | String! | - |
SwapPlatformFee
| Field | Type | Description |
|---|---|---|
feeBps | Int! | - |
feeAmountWei | String! | - |
feeTokenAddress | String! | - |
feeChainId | Int! | - |
feeReason | String | - |
SwapQuoteData
Raw quote data without response wrapper
| Field | Type | Description |
|---|---|---|
fromAmount | String! | - |
minimumToAmount | String! | - |
expiry | timestamptz! | Expiry timestamp as ISO 8601 datetime string |
quoteId | Int | Database quote ID for executing the swap. May be null if quote persistence failed. |
feePayment | SwapFeePayment | - |
platformFee | SwapPlatformFee | - |
gasEstimate | SwapGasEstimate | - |
priceImpactPct | Float | Price impact percentage including all fees (null if unavailable from provider) |
amountInUsd | Float | USD value of input amount (null if unavailable from provider) |
amountOutUsd | Float | USD value of expected output (null if unavailable from provider) |
networkFeeUsd | Float | Total network/solver fee in USD (null if unavailable from provider) |
estimatedFillSeconds | Int | Estimated fill time in seconds — primarily meaningful for cross-chain swaps (null if unavailable) |
route | SwapRoute | Route chosen by the swap router. Null for legacy quotes or when routing was not performed. |
SwapQuoteResponse
Response wrapper for swap quote with structured error handling
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
quote | SwapQuoteData | - |
error | String | - |
structuredError | SmartWalletErrorResponse | - |
SwapResultResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
transactionHash | String | - |
quoteId | Int | - |
error | String | - |
quote | SwapQuoteData | - |
structuredError | SmartWalletErrorResponse | - |
sourceWalletId | Int | - |
destinationWalletId | Int | - |
refreshedBalances | [WalletTokenBalance!] | - |
status | String | Swap status: 'submitted' (cross-chain, awaiting background confirmation), |
| 'executed' (confirmed on-chain), or 'failed'. | ||
| Null for legacy responses without status tracking. |
SwapRoute
Describes the route chosen by the swap router — which provider won and why
| Field | Type | Description |
|---|---|---|
provider | SwapProvider! | The provider that was selected for this swap |
providersQueried | [SwapProvider!]! | All providers that were queried (may include ones that failed or returned worse quotes) |
hops | [SwapRouteHop!] | Routing hops — single-element for same-chain, multi-element for cross-chain with intermediate steps |
SwapRouteHop
A single hop in a swap route (e.g. ETH→USDC on Uniswap, then USDC bridged via Across)
| Field | Type | Description |
|---|---|---|
provider | String! | - |
fromToken | String! | - |
toToken | String! | - |
fromChainId | Int! | - |
toChainId | Int! | - |
SyncApplicantQuestionnaireInput (Input)
| Field | Type | Description |
|---|---|---|
applicantId | String! | - |
questionnaireData | jsonb! | - |
logErrors | Boolean | - |
SyncApplicantQuestionnaireResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
applicantId | String! | - |
questionnaireId | String | - |
error | String | - |
skipped | Boolean | - |
reason | String | - |
SyncCoinlistPlatformsInput (Input)
| Field | Type | Description |
|---|---|---|
dryRun | Boolean | - |
forceRefresh | Boolean | - |
symbol | String | - |
waitForResult | Boolean | - |
phases | [SyncCoinlistPhase!] | Run only specific phases. Omit to run all. |
SynchronizeEnzymeVaultsInput (Input)
| Field | Type | Description |
|---|---|---|
startDate | String! | - |
endDate | String! | - |
fundId | Int | - |
syncNavsAndFees | Boolean | - |
syncVaultActivities | Boolean | - |
syncVaultPortfolio | Boolean | - |
syncVaultDepositors | Boolean | - |
backfillAssetValuations | Boolean | - |
calculateCostBasis | Boolean | - |
SynchronizeEnzymeVaultsResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
message | String | - |
error | String | - |
runId | Int | - |
SyncSafesInput (Input)
| Field | Type | Description |
|---|---|---|
digitalWalletId | Int | - |
SyncSafesResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
jobId | String | - |
message | String | - |
error | String | - |
SyncWhitelistInput (Input)
| Field | Type | Description |
|---|---|---|
digitalWalletId | Int! | - |
direction | String! | - |
SyncWhitelistResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
entriesAdded | Int | - |
entriesRemoved | Int | - |
entriesUnchanged | Int | - |
discrepancies | jsonb | - |
error | String | - |
TaskValidationResult
| Field | Type | Description |
|---|---|---|
valid | Boolean! | - |
results | [TaskValidationRuleResult!]! | - |
blockers | [TaskValidationRuleResult!]! | - |
warnings | [TaskValidationRuleResult!]! | - |
correctionTasksCreated | [Int!]! | - |
TaskValidationRuleResult
| Field | Type | Description |
|---|---|---|
ruleId | Int! | - |
ruleType | String! | - |
passed | Boolean! | - |
action | String! | - |
message | String! | - |
correctionTaskId | Int | - |
TestPartnerWebhookSubscriptionResult
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
enqueuedAt | String | Eventually-consistent — the test delivery is enqueued; check delivery history for outcome. |
errorCode | String | - |
errorMessage | String | - |
TokenInfo
| Field | Type | Description |
|---|---|---|
id | Int! | - |
name | String! | - |
symbol | String! | - |
slug | String! | - |
num_market_pairs | Int! | - |
date_added | String! | - |
max_supply | Float | - |
circulating_supply | Float! | - |
total_supply | Float! | - |
is_active | Int! | - |
infinite_supply | Boolean! | - |
platform | Platform | - |
cmc_rank | Float! | - |
is_fiat | Int! | - |
self_reported_circulating_supply | Float | - |
self_reported_market_cap | Float | - |
tvl_ratio | Float | - |
last_updated | String! | - |
quote | QuoteType | - |
sparkline | Sparkline! | - |
sparklineUrl | String! | - |
TokenSparkline
| Field | Type | Description |
|---|---|---|
tokenId | Int! | - |
symbol | String! | - |
prices | [Float!]! | - |
timestamps | [Int!]! | - |
percentageChange | Float! | - |
period | TokenSparklinePeriod! | - |
TrackBalancerPoolResponse
| Field | Type | Description |
|---|---|---|
pool | BalancerPool | - |
jobId | String | - |
success | Boolean! | - |
error | String | - |
TradeOrderUpdate
| Field | Type | Description |
|---|---|---|
channel | String! | - |
time | String! | - |
accountId | String! | - |
orderId | String! | - |
clientOrderId | String! | - |
product | String! | - |
status | String! | - |
type | String! | - |
side | String! | - |
quantity | String! | - |
TradeSettlement
| Field | Type | Description |
|---|---|---|
id | Int! | - |
tradeRequestId | uuid! | - |
settlementTypeId | Int! | - |
settlementStatusId | Int! | - |
settlementTypeName | String | - |
settlementStatusName | String | - |
inboundTransactionHash | String | - |
inboundFromAddress | String | - |
inboundToAddress | String | - |
inboundAmount | Float | - |
inboundTokenSymbol | String | - |
inboundTokenAddress | String | - |
inboundNetwork | String | - |
inboundConfirmations | Int | - |
inboundConfirmedAt | timestamptz | - |
inboundProvider | String | - |
outboundTransactionHash | String | - |
outboundToAddress | String | - |
outboundToDigitalWalletId | Int | - |
outboundInitiatedAt | timestamptz | - |
outboundConfirmedAt | timestamptz | - |
outboundProvider | String | - |
outboundWireTransferId | Int | - |
swapTransactionHash | String | - |
swapInputTokenSymbol | String | - |
swapInputAmount | Float | - |
swapOutputTokenSymbol | String | - |
swapOutputAmount | Float | - |
swapNetwork | String | - |
swapWalletAddress | String | - |
swapConfirmedAt | timestamptz | - |
amountGross | Float! | - |
feeAmount | Float! | - |
amountNet | Float! | - |
settlementCurrency | String! | - |
amountGrossUsd | Float | - |
feeAmountUsd | Float | - |
amountNetUsd | Float | - |
usdRate | Float | - |
notes | String | - |
verifiedByUserId | String | - |
verifiedAt | timestamptz | - |
completedAt | timestamptz | - |
failedReason | String | - |
createdByUserId | String | - |
createdAt | timestamptz! | - |
updatedAt | timestamptz! | - |
TradeSettlementAudit
| Field | Type | Description |
|---|---|---|
id | Int! | - |
tradeSettlementId | Int! | - |
action | String! | - |
oldStatusId | Int | - |
newStatusId | Int | - |
notes | String | - |
metadata | JSON | - |
createdByUserId | String | - |
createdAt | timestamptz! | - |
TradeSettlementListResponse
| Field | Type | Description |
|---|---|---|
settlements | [TradeSettlement!]! | - |
success | Boolean! | - |
error | String | - |
TradeSettlementResponse
| Field | Type | Description |
|---|---|---|
settlement | TradeSettlement | - |
success | Boolean! | - |
error | String | - |
TradingPair
| Field | Type | Description |
|---|---|---|
baseCurrency | String! | - |
quoteCurrency | String! | - |
minTradeSize | String! | - |
TradingProduct
| Field | Type | Description |
|---|---|---|
id | String! | - |
name | String! | - |
baseCurrencyId | String! | - |
baseCurrency | String! | - |
quoteCurrencyId | String! | - |
quoteCurrency | String! | - |
baseMinSize | String! | - |
baseMaxSize | String | - |
baseIncrement | String | - |
quoteMinSize | String! | - |
quoteIncrement | String! | - |
isTradeDisabled | Boolean | - |
TrainingVideoUrl
| Field | Type | Description |
|---|---|---|
url | String! | - |
mode | String! | - |
expiresAt | timestamptz | - |
TransferDigitalAssetInput (Input)
| Field | Type | Description |
|---|---|---|
walletId | ID! | - |
fromCoinId | String | - |
fromCoinAddress | String | - |
toCoinId | String | - |
toCoinAddress | String | - |
size | String! | - |
UnsubscribePartnerWebhookResult
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
errorCode | String | - |
errorMessage | String | - |
UpdateCardCompanyAddressInput (Input)
Input for updating the card issuer company address
| Field | Type | Description |
|---|---|---|
cardApplicationId | Int! | Card application ID to identify the the card issuer company |
address | CardAddressInput! | Updated company address |
UpdateCardLimitInput (Input)
Input for updating a Card's spending limit
| Field | Type | Description |
|---|---|---|
cardId | Int! | Card ID (AgioCard_card.id - our internal card ID) |
limitAmount | Int! | Limit amount in cents (e.g., 50000 = $500.00) |
limitFrequency | CardLimitFrequency! | Limit frequency period |
UpdateCardUserProfileInput (Input)
Input for updating the card issuer user billing address
| Field | Type | Description |
|---|---|---|
cardApplicationId | Int! | Card application ID to identify the the card issuer user |
address | CardAddressInput! | Updated billing address |
UpdateEmailSegmentInput (Input)
| Field | Type | Description |
|---|---|---|
name | String | - |
description | String | - |
filter | EmailSegmentFilter | - |
category | EmailCategory | - |
UpdateSettlementStatusInput (Input)
| Field | Type | Description |
|---|---|---|
settlementId | Int! | - |
statusId | Int! | - |
notes | String | - |
UploadCardDisputeEvidenceResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
error | String | - |
UpsertPartnerWithdrawalAllowlistInput (Input)
Admin input for upserting a partner withdrawal-recipient allowlist entry.
| Field | Type | Description |
|---|---|---|
id | Int | Existing entry id to update; omit to insert a new entry. |
partnerOrganizationId | uuid! | The partner organization the allowlist entry belongs to. |
address | String! | Approved recipient (Treasury) address. |
chainId | Int! | Chain id the address is approved on. |
label | String | - |
notes | String | - |
status | String! | pending |
User
| Field | Type | Description |
|---|---|---|
id | ID | - |
user_id | String | - |
portfolioDashboard | PortfolioDashboard | - |
UserCreateUserAccountInviteInput (Input)
| Field | Type | Description |
|---|---|---|
email | String! | - |
givenName | String! | - |
familyName | String! | - |
redirectUrl | String | - |
extraMessage | String | - |
UserFilterInput (Input)
| Field | Type | Description |
|---|---|---|
hasFunded | Boolean | - |
emailVerified | Boolean | - |
servicesUsed | [String!] | - |
countryCodes | [String!] | - |
kycStatuses | [String!] | - |
roles | [String!] | - |
languages | [String!] | - |
createdAfter | timestamptz | - |
lastLoginAfter | timestamptz | - |
fundIds | [Int!] | - |
includeOrgAdminsForOrgPositions | Boolean | - |
UserOrganizationFilterInput (Input)
| Field | Type | Description |
|---|---|---|
organizationIds | [ID!] | - |
countryCodes | [String!] | - |
kybStatuses | [String!] | - |
hasFundSubscription | Boolean | - |
createdAfter | timestamptz | - |
ValidateAddressInput (Input)
Input for validating an address
| Field | Type | Description |
|---|---|---|
address | CardAddressInput! | Address to validate before creating cards, shipping groups, or billing operations |
VerifySettlementInput (Input)
| Field | Type | Description |
|---|---|---|
settlementId | Int! | - |
approved | Boolean! | - |
notes | String | - |
VerifyTokenChainsInput (Input)
| Field | Type | Description |
|---|---|---|
tokenId | Int | - |
recheck | Boolean! | - |
batchSize | Int! | - |
dryRun | Boolean! | - |
waitForResult | Boolean | - |
WalletPolicy
| Field | Type | Description |
|---|---|---|
id | Int! | - |
digitalWalletId | Int! | - |
bitgoPolicyId | String | - |
policyType | String! | - |
config | jsonb! | - |
isActive | Boolean! | - |
createdBy | String! | - |
createdAt | timestamptz! | - |
updatedAt | timestamptz! | - |
WalletPolicyAuditEntry
| Field | Type | Description |
|---|---|---|
id | Int! | - |
walletPolicyId | Int! | - |
action | String! | - |
previousConfig | jsonb | - |
newConfig | jsonb | - |
performedBy | String! | - |
notes | String | - |
createdAt | timestamptz! | - |
WalletTokenBalance
| Field | Type | Description |
|---|---|---|
digitalWalletId | Int! | - |
tokenSymbol | String! | - |
tokenName | String | - |
balance | String! | - |
currentValueUsd | String | - |
latestTokenPrice | String | - |
tokenLogoUrl | String | - |
tokenId | Int! | - |
networkId | Int | - |
networkName | String | - |
decimals | Int | - |
contractAddress | String | - |
isSpam | Boolean | - |
dataSource | String | - |
WebhookPayload
| Field | Type | Description |
|---|---|---|
id | Int! | - |
type | String! | - |
state | String! | - |
walletId | String | - |
hash | String | - |
transfer | String | - |
coin | String | - |
pendingApprovalId | String | - |
createdAt | timestamptz! | - |
WebhookPayloadPage
| Field | Type | Description |
|---|---|---|
payloads | [WebhookPayload!]! | - |
count | Int! | - |
WebhookStats
| Field | Type | Description |
|---|---|---|
transactionWebhooks | Int! | - |
pendingApprovalWebhooks | Int! | - |
totalWebhooks | Int! | - |
WhitelistDiff
| Field | Type | Description |
|---|---|---|
bitgoOnly | [WhitelistDiffEntry!]! | - |
internalOnly | [WhitelistDiffEntry!]! | - |
matched | Int! | - |
WhitelistDiffEntry
| Field | Type | Description |
|---|---|---|
address | String! | - |
label | String! | - |
WhitelistEntryInput (Input)
| Field | Type | Description |
|---|---|---|
address | String! | - |
label | String! | - |
WhitelistRequest
| Field | Type | Description |
|---|---|---|
id | Int! | - |
userId | String! | - |
organizationId | uuid! | - |
digitalWalletId | Int! | - |
address | String! | - |
chainId | Int | - |
label | String | - |
notes | String | - |
status | String! | - |
reviewedBy | String | - |
reviewedAt | timestamptz | - |
rejectionReason | String | - |
bitgoPendingApprovalId | String | - |
createdAt | timestamptz! | - |
updatedAt | timestamptz! | - |
WhitelistRequestResponse
| Field | Type | Description |
|---|---|---|
success | Boolean! | - |
request | WhitelistRequest | - |
error | String | - |
WhitelistSyncLog
| Field | Type | Description |
|---|---|---|
id | Int! | - |
digitalWalletId | Int! | - |
direction | String! | - |
status | String! | - |
entriesAdded | Int! | - |
entriesRemoved | Int! | - |
entriesUnchanged | Int! | - |
discrepancies | jsonb | - |
errorMessage | String | - |
initiatedBy | String! | - |
startedAt | timestamptz | - |
completedAt | timestamptz | - |
createdAt | timestamptz! | - |
WorkflowSdkInitTokenInput (Input)
| Field | Type | Description |
|---|---|---|
apiToken | String! | - |
externalUserId | String! | - |
externalUserEmail | String | - |
externalUserName | String | - |
ttl | Int | - |
WorkflowSdkUserAuthenticationInput (Input)
| Field | Type | Description |
|---|---|---|
token | String! | - |
ZipResult
| Field | Type | Description |
|---|---|---|
base64Data | String | - |
name | String | - |
hash | String | - |