Skip to content
On this page

Generated Types Reference

This file is auto-generated from the GraphQL schema. Do not edit directly.

AcceptAuditAdjustmentResult

FieldTypeDescription
successBoolean!-
adjustmentIdInt-
journalEntryIdInt-
errorString-

AcceptGoNetworkConnectionInput (Input)

FieldTypeDescription
connectionIdInt!-

AcceptQuoteInput (Input)

FieldTypeDescription
quoteIdInt!-
signatureString-

AcceptQuoteResponse

FieldTypeDescription
successBoolean!-
errorString-
quoteIdInt-
invoiceIdInt-
caseIdInt-

AcceptUserOrganizationInviteResponse

FieldTypeDescription
redirectUrlString-
messageString!-

AddGetTrackedTokensInput (Input)

FieldTypeDescription
timestamptimestamptz-
limitInt-
allTokensBoolean-

AddPolicyResponse

FieldTypeDescription
successBoolean!-
policyIdString-
dbIdInt-
errorString-

AddressSuggestion

Autocomplete suggestion from Google Places API

FieldTypeDescription
textString!Display text for the suggestion
placeIdString!Google Place ID (can be used for further lookups)
mainTextString!Main text (primary part of address)
secondaryTextString!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.

FieldTypeDescription
successBoolean!Whether the address is valid
isValidBooleanWhether the address passed validation
confidenceAddressValidationConfidenceConfidence level of the validation (if available)
formattedAddressStringFormatted address returned by Google
locationGeocodeLocationGeocode location (latitude/longitude)
errorStringError message if validation failed

AddSmartWalletSessionKeyInput (Input)

FieldTypeDescription
digitalWalletIdInt!-
encryptedSessionKeyString!-
encryptionSessionIdString!-
sessionKeyAddressString!-
permissionsContextString-
signatureString-
permissionsjsonb-
expiresAtbigint-

AddSmartWalletSessionKeyResponse

FieldTypeDescription
successBoolean!-
sessionIdString-
errorString-

AddSpendingLimitInput (Input)

FieldTypeDescription
digitalWalletIdInt!-
amountFloat!-
coinString-

AddVelocityLimitInput (Input)

FieldTypeDescription
digitalWalletIdInt!-
amountFloat!-
timeWindowInt!-
coinString-

Admin

FieldTypeDescription
idID-
user_idString-
servicesStatuses[ServicesStatus]-
servicesStatusServicesStatus-
walletPolicies[WalletPolicy!]!-
walletPolicyAudit[WalletPolicyAuditEntry!]!-
whitelistSyncLogs[WhitelistSyncLog!]!-
whitelistDiffWhitelistDiff!-
whitelistRequests[WhitelistRequest!]!-
whitelistRequestWhitelistRequest-
blacklistedTokensBlacklistedTokenPage!-
blacklistedTokensByUser[BlacklistedToken!]!-
childEnterprises[ChildEnterprise!]!-
childEnterpriseChildEnterprise-
goAccounts[GoAccount!]!-
goAccountGoAccount-
goAccountBalances[GoAccountBalance!]!-
goTradeHistory[GoTrade!]!-
goFiatOperations[GoFiatOperation!]!-
tradingPairs[TradingPair!]!-
marketDataMarketData-
organizationStatusOrganizationStatus!-
enterpriseUsers[jsonb!]!-
enterpriseDetailsjsonb-
webhooksForWallet[BitgoWebhookRegistration!]!-
webhookPayloadHistoryWebhookPayloadPage!-
webhookStatsWebhookStats!-
goNetworkConnections[GoNetworkConnection!]!-
goNetworkDirectory[GoNetworkDirectoryEntry!]!-

AdminCreatePartnerWebhookSubscriptionInput (Input)

FieldTypeDescription
organizationIdID!The partner organization (AgioAuth.organization.id) the subscription belongs to.
urlString!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

FieldTypeDescription
successBoolean!-
subscriptionIdID-
signingSecretStringThe 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.
errorCodeString-
errorMessageString-

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.

FieldTypeDescription
digitalWalletIdInt!-
recipientString!-
amountString!-
dataString-

AgioOnboardingDocumentGenerateInput (Input)

FieldTypeDescription
documentTypeNameString!-
fileNameString-
originalFileNameString-
identifierString-
caseIdInt-
metadatajsonb-
waitUntilFinishedBoolean-
waitUntilFinishedTimeoutMsInt-

AgioOnboardingDocumentGenerateResponse

FieldTypeDescription
jobIduuid!-
queueNameString!-
documentIduuid-
documentUrlString-
jobBullJobResponse-

AgioOnboardingDocumentSearchInput (Input)

FieldTypeDescription
queryString!-
parentDocumentIduuid-
matchCountInt-
filterjsonb-
distinctOnString-

AgioOnboardingDocumentSearchItem

FieldTypeDescription
iduuid!-
similarityFloat!-
contentString!-
metadatajsonb!-
documentIduuid-

AgioOnboardingDocumentSearchResponse

FieldTypeDescription
countInt!-
items[AgioOnboardingDocumentSearchItem]-

ApproveWhitelistRequestInput (Input)

FieldTypeDescription
requestIdInt!-

AttachKybBeneficiaryInput (Input)

FieldTypeDescription
organizationIdID!-
beneficiaryApplicantIdString!Sumsub applicant ID of the individual to link
types[KybBeneficiaryType!]!Roles this person holds — at least one required
shareSizeFloatOwnership percentage (0–100) — required for UBOs / shareholders

AttachKybBeneficiaryResult

FieldTypeDescription
beneficiaryIdString!Junction record ID — use this for detachKybBeneficiary
applicantIdString!The individual's Sumsub applicant ID
types[String!]!-

AuditAdjustmentResult

FieldTypeDescription
successBoolean!-
idInt-
errorString-

AuditAdjustmentVoidResult

FieldTypeDescription
successBoolean!-
idInt-
reversalJournalEntryIdInt-
errorString-

Auth0

FieldTypeDescription
profileAuth0Profile-
profileByIdAuth0Profile-

Auth0Identity

FieldTypeDescription
connectionString-
user_idString-
providerString-
isSocialBoolean-

Auth0Profile

FieldTypeDescription
user_idString-
emailString-
email_verifiedBoolean-
pictureString-
created_atString-
updated_atString-
nameString-
given_nameString-
family_nameString-
nicknameString-
multifactor_last_modifiedString-
last_ipString-
last_loginString-
logins_countString-
cityString-
country_codeString-
addressString-
address2String-
company_nameString-
mobile_phoneString-
postal_codeString-
state_or_provinceString-
preferred_location_codeString-
preferred_currency_codeString-
preferred_language_codeString-
color_schemeString-
signatureString-

Auth0ProfileMetadata

FieldTypeDescription
cityString-
addressString-
address2String-
mobile_phoneString-
country_codeString-
postal_codeString-
state_or_provinceString-
company_nameString-
preferred_location_codeString-
preferred_currency_codeString-
preferred_language_codeString-
color_schemeString-
signatureString-

Auth0ProfileMetadataInput (Input)

FieldTypeDescription
cityString-
addressString-
address2String-
mobile_phoneString-
country_codeString-
postal_codeString-
state_or_provinceString-
company_nameString-
preferred_location_codeString-
preferred_currency_codeString-
preferred_language_codeString-
color_schemeString-
signatureString-

AutocompleteAddressInput (Input)

Input for autocomplete address search

FieldTypeDescription
inputString!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

FieldTypeDescription
successBoolean!Whether the request was successful
suggestions[AddressSuggestion!]List of address suggestions
errorStringError message if request failed

BackfillAlchemyTransactionsInput (Input)

FieldTypeDescription
digitalWalletIdInt-
cutoffDateString-

BackfillAlchemyTransactionsResponse

FieldTypeDescription
successBoolean!-
jobIdString-
messageString-
errorString-

BackfillDigitalWalletAssetsInput (Input)

FieldTypeDescription
fundIdInt!-
digitalWalletIdInt-
startDateString!-
endDateString!-
skipDelayBoolean-

BackfillDigitalWalletAssetsResponse

FieldTypeDescription
successBoolean!-
jobIdString-
messageString-
errorString-

BackfillTokenPricesInput (Input)

FieldTypeDescription
startTimestamptimestamptz!-
endTimestamptimestamptz-
tokenIdInt!-
priceSourceIds[Int!]-
unitTokenPriceIntervalUnit-
intervalInt-

BackfillTokenPricesManyInput (Input)

FieldTypeDescription
startTimestamptimestamptz!-
endTimestamptimestamptz-
tokenIds[Int!]!-
priceSourceIds[Int!]-
unitTokenPriceIntervalUnit-
intervalInt-

BackfillTopTokenPricesInput (Input)

FieldTypeDescription
clearExistingBoolean!-
countInt-

BalancerLPPrice

FieldTypeDescription
priceUsdFloat!-
totalSharesFloat!-
totalLiquidityUsdFloat!-
priceTimestampString!-
balancerVersionBalancerVersion!-
underlyingPricesJSON-

BalancerLPPriceHistoryItem

FieldTypeDescription
priceUsdFloat!-
priceDateString!-
priceTimestampString!-
totalLiquidityUsdFloat-

BalancerPool

FieldTypeDescription
idInt!-
poolIdString!-
poolAddressString!-
poolTypeString!-
balancerVersionBalancerVersion!-
networkBalancerNetwork!-
nameString-
symbolString-
isTrackedBoolean!-
isActiveBoolean!-
backfillStatusString-
backfillStartedAtString-
backfillCompletedAtString-
backfillErrorString-
tokens[BalancerPoolToken!]!-

BalancerPoolToken

FieldTypeDescription
idInt!-
tokenAddressString!-
tokenSymbolString!-
tokenDecimalsInt!-
weightFloat-
tokenIdInt-

BitgoAddress

FieldTypeDescription
idString!-
addressString!-
chainInt!-
indexInt!-
coinString!-
walletString-
addressTypeStringEnum: "p2sh" "p2sh-p2wsh" "p2wsh"
baseAddressString-
keychains[BitgoKey]-
balanceBitgoAddressBalance-

BitgoAddressBalance

FieldTypeDescription
balancebigint-
balanceStringString-
totalReceivedbigint-
totalSentbigint-
confirmedBalanceStringString-
spendableBalanceStringString-

BitgoApprovalResolveInput (Input)

FieldTypeDescription
stateBitgoApprovalStateResolveType!-
digitalWalletIdID!-
approvalIdString!-
passwordString-
otpString-
xprvString-

BitgoApprovalResponse

FieldTypeDescription
idString-
walletString-
coinString-
creatorString-
createDatetimestamptz-
stateBitgoApprovalState-
approvalsRequiredInt-
scopeBitgoScope-
userIds[String]-
enterpriseString-
walletLabelString-
infoBitgoApprovalResponseInfo-

BitgoApprovalResponseInfo

FieldTypeDescription
typeBitgoApprovalResponseType!-
transactionRequestjsonb-
transactionRequestFulljsonb-
userChangeRequestjsonb-
policyRuleRequestjsonb-
updateApprovalsRequiredRequestjsonb-

BitgoBuildDefaults

FieldTypeDescription
minFeeRateInt-

BitgoCoinData

FieldTypeDescription
idString-
baseFactorbigint-
decimalPlacesInt-
chainString-
familyString-
nameString-
supportsBlockTargetBoolean-
supportsLightningBoolean-
supportsBlsDkgBoolean-
supportsMessageSigningBoolean-
supportsStakingBoolean-
supportsTssBoolean-
allowsAccountConsolidationsBoolean-
enabledBoolean-
isTestnetBoolean-
coinFamilyBitgoCoinFamily-
supportedWalletTypes[BitgoWalletType]-
supportedBackupProviderTypes[BitgoBackupProviderType]-
defaultBackupProviderTypeBitgoBackupProviderType-
isTokenBoolean-
bip44IdInt-

BitgoCreateAddressInput (Input)

FieldTypeDescription
labelString-
chainInt-

BitgoCustomChangeKeySignatures

FieldTypeDescription
userString-
backupString-
bitgoString-

BitgoEncryptedPassphraseInput (Input)

FieldTypeDescription
sessionIdString!-
encryptedPassphraseString!-

BitgoEncryptionKeyPair

FieldTypeDescription
pubString!-
encryptedPrvString!-

BitgoEncryptionKeyPairInput (Input)

FieldTypeDescription
pubString!-
encryptedPrvString!-

BitgoKey

FieldTypeDescription
idString!-
encryptedPrvString-
isBitGoBoolean-
sourceBitgoSourceType-
typeBitgoKeyType!-
ethAddressString-
pubString-
commonKeychainString-
commonPubString-
commonKeychainSigString-
commonPublicKeySigString-
keyShares[BitgoKeyShare]-
walletHSMGPGPublicKeySigsString-

BitgoKeyShare

FieldTypeDescription
fromBitgoKeyShareType!-
toBitgoKeyShareType!-
publicShareString!-
privateShareString!-
hsmSigString!-

BitgoKeySignature

FieldTypeDescription
backupPubString-
bitgoPubString-

BitgoPendingApproval

FieldTypeDescription
idString!-
coinString!-
walletString!-
enterpriseString!-
organizationString-
creatorString!-
createDatetimestamptz!-
infoBitgoPendingApprovalInfo!-
stateBitgoPendingApprovalState!-
scopeBitgoScope!-
userIds[String!]!-
approvalsRequiredInt!-
walletLabelString-
resolvers[jsonb]-
addressLabels[BitgoPendingApprovalAddressLabel]-

BitgoPendingApprovalAddressLabel

FieldTypeDescription
addressString!-
labelString!-

BitgoPendingApprovalBuildParams

FieldTypeDescription
recipients[BitgoPendingApprovalRecipient]-
commentString-
instantBoolean-

BitgoPendingApprovalInfo

FieldTypeDescription
typeString!-
transactionRequestBitgoPendingApprovalTransactionRequest-
transactionRequestFulljsonb-
userChangeRequestjsonb-
policyRuleRequestjsonb-
updateApprovalsRequiredRequestjsonb-
enterpriseModificationRequestjsonb-
enterpriseInviteRequestjsonb-

BitgoPendingApprovalRecipient

FieldTypeDescription
_idString-
addressString-
amountString-

BitgoPendingApprovalsInput (Input)

FieldTypeDescription
prevIdString-
limitInt-
coin[String]-
enterpriseIdString-
organizationIdString-
requestTypeBitgoPendingApprovalRequestType-
state[BitgoPendingApprovalState]-
walletIdString-
expandWalletLabelsBoolean-
expandAddressLabelsBoolean-

BitgoPendingApprovalsResponse

FieldTypeDescription
pendingApprovals[BitgoPendingApproval!]!-
countInt!-
nextBatchPrevIdString-

BitgoPendingApprovalTransactionRequest

FieldTypeDescription
coinSpecificjsonb-
verificationItems[String]-
videoApprovers[jsonb]-
requestedAmountString-
feeFloat-
sourceWalletString-
recipients[BitgoPendingApprovalRecipient]-
isUnsignedBoolean-
buildParamsBitgoPendingApprovalBuildParams-
policyUniqueIdString-
verificationRuleIdString-

BitgoSendCoinsInput (Input)

FieldTypeDescription
coinString-
amountbigint!-
addressString!-
dataString-
feeLimitbigint-
messageString-
prvString-
tokenNameString-
minConfirmsInt-
walletPassphraseString-

BitgoSendCoinsResponse

FieldTypeDescription
transferBitgoTransfer!-
txidString!-
txString!-
statusString!-

BitgoSendTransactionInput (Input)

FieldTypeDescription
digitalWalletIdID!-
sizeString!-
recipientString!-
passwordString!-
coinString-
dataString-
feeLimitString-
invoiceIdInt-
noteString-
saveToAddressBookBoolean-
addressBookNicknameString-

BitgoSendTransactionResponse

FieldTypeDescription
errors[String]-
warnings[String]-
txHexString-
pendingApprovalIdString-
txIdString-
cooldownSecondsInt-

BitgoSyncAllTransactionsInput (Input)

FieldTypeDescription
syncFromBeginningBooleanIf true, ignores Redis timestamp and syncs all transfers from the beginning of time.
Use with caution - this will process ALL historical transactions.

BitgoSyncAllTransactionsResponse

FieldTypeDescription
successBoolean!-
jobCountInt!-
walletCountInt-
errorString-

BitgoSyncDigitalWalletTransactionsInput (Input)

FieldTypeDescription
digitalWalletIdInt!-
syncFromBeginningBooleanIf 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

FieldTypeDescription
successBoolean!-
jobCountInt!-
errorString-

BitgoSyncTokenSupportResponse

FieldTypeDescription
successBoolean!-
totalTokensInt!-
markedSupportedInt!-
markedUnsupportedInt!-
errorString-

BitgoSyncTransactionInput (Input)

FieldTypeDescription
coinString!-
walletIdString!-
transferIdString!-

BitgoSyncTransactionResponse

FieldTypeDescription
successBoolean!-
transactionIdString-
errorString-

BitgoSyncWalletTransactionsInput (Input)

FieldTypeDescription
walletIdString!-
syncFromBeginningBooleanIf 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

FieldTypeDescription
successBoolean!-
jobCountInt!-
errorString-

BitgoTransfer

FieldTypeDescription
normalizedTxHashString-
entries[BitgoTransferEntry]-
idString-
coinString-
walletString-
walletTypeString-
enterpriseString-
txidString-
heightbigint-
heightIdString-
datetimestamptz-
confirmationsbigint-
typeBitgoTransferType-
valuebigint-
valueStringString-
baseValuebigint-
baseValueStringString-
feeStringString-
payGoFeebigint-
payGoFeeStringString-
usdFloat-
usdRateFloat-
stateBitgoTransferState-
instantBoolean-
isRewardBoolean-
isFeeBoolean-
tags[String]-
history[BitgoTransferHistory]-
coinSpecificjsonb-
usersNotifiedBoolean-
confirmedTimetimestamptz-
createdTimetimestamptz-
labelString-

BitgoTransferEntry

FieldTypeDescription
addressString-
valuebigint-
valueStringString-
isPayGoBoolean-
walletString-

BitgoTransferHistory

FieldTypeDescription
datetimestamptz-
actionBitgoTransferHistoryActionType-
commentString-

BitgoTransferInput (Input)

FieldTypeDescription
amountInt!-

BitgoWallet

FieldTypeDescription
idString-
labelString-
approvalsRequiredInt-
balancebigint-
confirmedBalancebigint-
spendableBalancebigint-
balanceStringString-
confirmedBalanceStringString-
spendableBalanceStringString-
coinString!-
keys[String]-
tags[String]-
receiveAddressBitgoAddress-
mIntNumber of signatures required. This value must be 2 for hot wallets, 1 for ofc wallets, and not specified for custodial wallets.
nIntNumber of keys provided. This value must be 3 for hot wallets, 1 for ofc wallets, and not specified for custodial wallets.
migratedFromString-
coinSpecificjsonb-
enterpriseString-
customChangeKeySignaturesBitgoCustomChangeKeySignatures-
isColdBoolean-
deletedBoolean-
allowBackupKeySigningBoolean-
recoverableBoolean!-
startDatetimestamptz-
typeBitgoWalletType-
pendingChainInitializationBoolean-
hasLargeNumberOfAddressesBoolean-
multisigTypeBitgoMultiSigType-
buildDefaultsBitgoBuildDefaultsBTC only
transfers[BitgoTransfer]-
addresses[BitgoAddress]-
coinDataBitgoCoinData-

BitgoWebhookRegistration

FieldTypeDescription
idString!-
typeString!-
urlString!-
coinString-
walletIdString!-
numConfirmationsInt-
allTokenBoolean-
createdAtString-

BitgoWhitelistEntry

FieldTypeDescription
idID!-
walletIdString-
createdAttimestamptz-
ruleTypeString-
actionTypeString-
addressString-
coinString-
entryTypeString-
labelString-
verificationStateString-

BlacklistedToken

FieldTypeDescription
jtiString!-
subString-
reasonString-
revokedAtString!-
revokedByString-
ttlSecondsInt!-

BlacklistedTokenPage

FieldTypeDescription
tokens[BlacklistedToken!]!-
nextCursorString-

BookFundRedemptionInput (Input)

FieldTypeDescription
redemptionIdInt!-
fundNavIdInt-

BookFundRedemptionResult

FieldTypeDescription
redemptionIdInt!-
fundNavIdInt!-
navPerShareFloat!-
sharesRedeemedFloat!-
amountFloat!-
pdfUrlString!-

BookFundSubscriptionInput (Input)

FieldTypeDescription
subscriptionIdInt!-
fundNavIdInt-

BookFundSubscriptionResult

FieldTypeDescription
subscriptionIdInt!-
fundNavIdInt!-
navPerShareFloat!-
sharesIssuedFloat!-
pdfUrlString!-

BridgeQuoteData

FieldTypeDescription
quoteIdInt!-
sourceAmountString!-
destinationMinimumAmountString!-
destinationTokenSymbolString!-
estimatedTimeInt-
priceImpactString-
amountInUsdString-
symbiosisFeeString-
platformFeeBpsInt-
platformFeeAmountString-
expiresAttimestamptz!-
routes[BridgeRoute!]-

BridgeQuoteResponse

FieldTypeDescription
successBoolean!-
quoteBridgeQuoteData-
errorString-
structuredErrorSmartWalletErrorResponse-

BridgeResultResponse

FieldTypeDescription
successBoolean!-
transactionHashString-
quoteIdInt-
statusString-
errorString-
structuredErrorSmartWalletErrorResponse-

BridgeRoute

FieldTypeDescription
providerString!-
tokens[BridgeRouteToken!]!-

BridgeRouteToken

FieldTypeDescription
symbolString!-
chainIdInt!-

BridgeToTronInput (Input)

FieldTypeDescription
sourceDigitalWalletIdID!-
destinationDigitalWalletIdID!-
tokenAddressString!-
amountString!-
slippageBpsInt-

BulkImportWhitelistInput (Input)

FieldTypeDescription
digitalWalletIdInt!-
entries[WhitelistEntryInput!]!-

BulkImportWhitelistResponse

FieldTypeDescription
successBoolean!-
addedInt-
skippedInt-
errors[String!]-
errorString-

BulkInvoiceEmailResult

FieldTypeDescription
invoiceIdInt!-
successBoolean!-
errorString-

BullJobResponse

FieldTypeDescription
nameString-
datajsonb-
optsBullJobResponseOpts-
idString-
progressInt-
returnvaluejsonb-
stacktracejsonb-
attemptsMadeInt-
delayInt-
timestampbigint-
queueQualifiedNameString-

BullJobResponseOpts

FieldTypeDescription
attemptsInt-
delayInt-

BurnDustResult

FieldTypeDescription
walletsScannedInt!-
burnableFoundInt!-
txsSubmittedInt!-
txsFailedInt!-
tokens[BurnDustToken!]!-
errors[String!]!-

BurnDustToken

FieldTypeDescription
chainIdInt!-
contractAddressString!-
tokenSymbolString!-
balanceWeiString!-
usdValueFloat-
walletIdInt!-
txHashString-
errorString-

CalculateBalancerLPPriceResponse

FieldTypeDescription
priceBalancerLPPrice-
jobIdString-
successBoolean!-
errorString-

CalculateOtcQuoteInput (Input)

FieldTypeDescription
fromCurrencyString!-
toCurrencyString!-
sideString!-
sizeFloat!-
slippageFloat-
userIdString-
tradeTypeInt-
limitPriceFloat-

CalculateOtcQuoteResponse

FieldTypeDescription
quoteExchangeRateFloat!-
feePercentageFloat!-
feeAmountFloat!-
userIdString!-
fromCurrencyString!-
toCurrencyString!-
sideString!-
sizeFloat!-
sizeUsdFloat!-
feeAmountUsdFloat!-
netSizeFloat!-
netSizeUsdFloat!-
baseRateUsdFloat!-
fromCurrencyRateUsdFloat!-
toCurrencyRateUsdFloat!-

CampaignAdUploadTicket

FieldTypeDescription
uploadUrlString!-
gcsPathString!-
publicUrlString!-
contentTypeString!-
expiresInInt!-
mediaTokenString!-

CancelCardDisputeResponse

FieldTypeDescription
successBoolean!-
errorString-

CancelCardInput (Input)

Input for canceling a Card (irreversible)

FieldTypeDescription
cardIdInt!Card ID (AgioCard_card.id - our internal card ID)
reasonStringOptional reason for cancellation

CancelEmailCampaignResult

FieldTypeDescription
campaignIdID!-
cancelledBoolean!-

CancelGoTradeInput (Input)

FieldTypeDescription
goAccountIdInt!-
tradeIdInt!-

CancelGoTradeResponse

FieldTypeDescription
successBoolean!-
errorString-

CancelLimitOrderInput (Input)

FieldTypeDescription
idInt!-

CancelQueueJobInput (Input)

FieldTypeDescription
queueNameString!-
jobIdString!-

CancelQueueJobResponse

FieldTypeDescription
successBoolean!-
queueNameString!-
jobIdString!-
errorString-

CardAddress

FieldTypeDescription
line1String!-
line2String-
cityString!-
regionString!-
postalCodeString!-
countryCodeString!-

CardAddressInput (Input)

Address input for the card issuer API applications

FieldTypeDescription
line1String!-
line2String-
cityString!-
regionString!-
postalCodeString!-
countryCodeString!-
countryString-

CardApplication

FieldTypeDescription
idID!-
cardApplicationExternalIdString!-
applicantIdString!-
walletAddressString!-
applicationStatusCardApplicationStatus!-
applicationReasonString-
isActiveBoolean!-
firstNameString-
lastNameString-
emailString-
phoneCountryCodeString-
phoneNumberString-
addressCardAddress-
applicationExternalVerificationLinkCardApplicationLink-
applicationCompletionLinkCardApplicationLink-
createdAttimestamptz-
updatedAttimestamptz-

FieldTypeDescription
urlString!-
userIdString-

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.

FieldTypeDescription
occupationString-
annualSalaryString-
accountPurposeString-
expectedMonthlyVolumeString-

CardApplicationResponse

FieldTypeDescription
successBoolean!-
applicantIdString-
cardApplicationIdIntInternal numeric application id (AgioCard_card_application.id). Pass this to createCard.
cardApplicationExternalIdString-
applicationStatusString-
applicationCompletionUrlStringURL to complete additional verification if status is NEEDSVERIFICATION
shareTokenString-
walletAddressStringEVM wallet address on the application. Echoes back the input walletAddress,
or the provisioned smart wallet address when createWallet: true was used.
errorString-
errorCodeStringMachine-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).

FieldTypeDescription
creditLimitFloat!Credit limit of the user, in USD
pendingChargesFloat!Pending charges (authorized but not settled), in USD
postedChargesFloat!Posted charges (settled transactions), in USD
balanceDueFloat!Balance due (amount owed), in USD
spendingPowerFloat!Available spending power (creditLimit - pendingCharges - postedCharges), in USD

CardBalanceResponse

Response from fetching card balance

FieldTypeDescription
successBoolean!-
idIntOur internal card ID (AgioCard_card.id)
balanceCardBalance-
errorString-

CardCorporateAddressPrefill

Prefilled address from verified KYB data (all fields optional — populate what's available)

FieldTypeDescription
line1String-
cityString-
regionString-
postalCodeString-
countryCodeString-

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.

FieldTypeDescription
nameString-
registrationNumberString-
taxIdString-
addressCardCorporateAddressPrefill-
ubos[CardCorporatePersonPrefill!]!-
representatives[CardCorporatePersonPrefill!]!-

CardCorporateApplicationResponse

Response from creating a corporate Card application

FieldTypeDescription
successBoolean!-
companyIdString-
nameString-
applicationStatusString-
errorString-

CardCorporatePersonPrefill

Prefilled person data for UBOs / representatives from verified KYB sub-applicants

FieldTypeDescription
firstNameString-
lastNameString-
birthDateString-
nationalIdString-
countryOfIssueString-
emailString-
phoneCountryCodeString-
phoneRegionCodeString-
phoneNumberString-
addressCardCorporateAddressPrefill-

CardExpiry

Card expiry date returned from the card issuer API

FieldTypeDescription
monthString!-
yearString!-

CardFundSubClientFromTreasuryInput (Input)

Input for funding a sub-client's collateral from the partner Treasury wallet.

FieldTypeDescription
externalUserIdString!card_user_id of the sub-client to fund.
amountCentsInt!Funding amount in integer cents.

CardFundSubClientFromTreasuryResponse

Response from enqueueing a sub-client funding job.

FieldTypeDescription
successBoolean!-
jobIdStringBullMQ job id for status polling.
errorCodeStringSynchronous enqueue errorCode: INVALID_AMOUNT
Async job failures (e.g. COLLATERAL_CONTRACT_NOT_READY) surface via job status, not here.
errorString-

CardFundSubClientStatusResponse

FieldTypeDescription
successBoolean!-
jobIdString!-
statusStringFunding 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.
txHashString-
failedReasonStringHuman-readable async failure diagnostic. Not a stable code — do not branch on its text.
failedCodeStringMachine-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.
attemptsInt-
errorCodeStringQuery-level error: FORBIDDEN, NOT_FOUND, or INTERNAL_ERROR.
errorMessageString-

CardLimitInput (Input)

Spending limit configuration

FieldTypeDescription
amountInt!Amount in cents
frequencyCardLimitFrequency!Limit frequency period

CardLimitResponse

Response from updating card limit

FieldTypeDescription
successBoolean!-
idIntOur internal card ID (AgioCard_card.id)
cardIdStringcard ID
limitAmountInt-
limitFrequencyString-
errorString-

CardOperationResponse

Response from the card issuer API card operations (freeze, unfreeze, cancel)

FieldTypeDescription
successBoolean!-
idIntOur internal card ID (AgioCard_card.id)
cardIdStringcard ID
statusString-
errorString-
errorCodeStringMachine-readable error code if the operation failed (e.g. CARD_INSUFFICIENT_FUNDS).

CardPinResponse

Response from PIN operations (set/get)

FieldTypeDescription
successBoolean!-
idIntOur internal card ID (AgioCard_card.id)
encryptedPinStringEncrypted PIN. Decrypt with decryptWithSessionKey from agio-utils.
errorString-

CardReminderResultItem

FieldTypeDescription
cardIdString!-
sentBoolean!-
skippedBoolean-
dryRunBoolean-
reminderNumberInt-
errorString-
cardTypeString-
last4String-
nicknameString-
cardHolderNameString-
cardHolderEmailString-
organizationNameString-
daysSinceCreationInt-

CardReminderRunResponse

FieldTypeDescription
successBoolean!-
totalInt!-
sentInt!-
skippedInt!-
errorsInt!-
results[CardReminderResultItem!]!-

CardReplacedCard

Details of a replaced card from the card issuer API

FieldTypeDescription
idString!New card ID from the card issuer
typeString!Card type (always "virtual" for replacements)
statusString!Card status after replacement
last4String!Last 4 digits of new card number
expirationMonthString!Expiration month (MM format)
expirationYearString!Expiration year (YYYY format)

CardReplacementResponse

Response from replacing a virtual card

FieldTypeDescription
successBoolean!-
idIntOur internal card ID (AgioCard_card.id)
newCardCardReplacedCardDetails of the new replacement card
oldCardIdStringID of the old card that was canceled
errorString-

CardSecrets

Decrypted card secrets from the card issuer API. These are sensitive values - handle with care.

FieldTypeDescription
panString!Full Primary Account Number (card number)
cvcString!Card Verification Code (CVV/CVC)
expiryCardExpiryCard expiration date

CardSecretsResponse

Response from revealing card secrets

FieldTypeDescription
successBoolean!-
idIntOur internal card ID (AgioCard_card.id)
encryptedSecretsStringEncrypted card secrets JSON. Decrypt with decryptWithSessionKey from agio-utils.
Format: { pan: string, cvc: string, expiry: { month: string, year: string } }
errorString-

CardShippingInput (Input)

Shipping address input for physical cards

FieldTypeDescription
line1String!-
line2String-
cityString!-
regionString!-
postalCodeString!-
countryCodeString!-
phoneNumberString!Phone number (required by the card issuer API for shipping)
firstNameString-
lastNameString-
methodCardShippingMethodShipping method (standard or express)

CardWithdrawForPartnerInput (Input)

Input for a partner-scoped collateral withdrawal routed to the partner Treasury wallet.

FieldTypeDescription
externalUserIdString!The sub-client's card_user_id (issued by createPartnerCardUser).
amountCentsInt!Withdrawal amount in integer cents (e.g., 12345 = $123.45).
chainIdIntChain to withdraw from. Defaults to the partner treasury config chain_id when omitted.
dryRunBooleanWhen true, validates and prices the withdrawal without submitting an on-chain transaction.

CardWithdrawForPartnerResponse

Response from a partner-scoped collateral withdrawal.

FieldTypeDescription
successBoolean!-
transactionHashString-
errorCodeStringINVALID_AMOUNT
INSUFFICIENT_SPENDING_POWERCARD_SIGNING_IN_FLIGHTINTERNAL_ERROR
errorString-
spendingPowerCentsIntPopulated on INSUFFICIENT_SPENDING_POWER: available spending power in integer cents.
requestedCentsIntPopulated on INSUFFICIENT_SPENDING_POWER: the requested amount echoed back, in cents.
retryAfterSecIntPopulated on CARD_SIGNING_IN_FLIGHT: seconds to wait before retrying.

CardWithdrawInput (Input)

Input for withdrawing collateral from a Card smart wallet

FieldTypeDescription
tokenAddressString!ERC-20 token contract address to withdraw
amountString!Amount to withdraw (human-readable, e.g. "100.5")
chainIdIntChain ID to withdraw from. When omitted, resolved by matching tokenAddress across all chains.

CardWithdrawResponse

Response from card withdrawal operation

FieldTypeDescription
successBoolean!Whether the withdrawal succeeded
transactionHashStringOn-chain transaction hash
chainIdIntChain ID where the withdrawal occurred
tokenAddressStringToken contract address withdrawn
amountStringAmount withdrawn (human-readable)
errorStringError message if the withdrawal failed
errorCodeStringMachine-readable error code if the withdrawal failed (e.g. CARD_INSUFFICIENT_FUNDS)
retryAfterSecIntSeconds 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.

FieldTypeDescription
cardUserIduuid!The cardholder's cardUserId (the same UUID returned by createPartnerCardUser).
feeCentsInt!Fee amount in cents (e.g., 2550 for $25.50)
feeDescriptionString!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

FieldTypeDescription
successBoolean!Whether the charge succeeded
chargeIdStringCharge ID returned by the card issuer API
amountFloatAmount charged in USD
feeDescriptionStringDescription of the fee that was charged
errorStringError message if the charge failed
errorCodeStringMachine-readable error code if the charge failed (e.g. CARD_INSUFFICIENT_FUNDS)

ChatMessageResponse

FieldTypeDescription
idInt-
chatIdInt-
peerAUserIdString-
peerBUserIdString-
createdAttimestamptz-
updatedAttimestamptz-
textString-
payloadjsonb-
userIdString-
telegramMessageIdbigint-

ChildEnterprise

FieldTypeDescription
idInt!-
organizationIduuid!-
userIdString!-
bitgoEnterpriseIdString!-
kycStatusString!-
kycDatajsonb-
labelString-
createdAttimestamptz!-
updatedAttimestamptz!-
goAccounts[GoAccount!]-

CoinPrice

FieldTypeDescription
coin_idString-
created_attimestamptz!-
idID!-
market_capString!-
market_cap_rankInt-
price_updated_attimestamptz!-
price_usdString!-
symbolString!-

CoinsWhereInput (Input)

FieldTypeDescription
chainString-
familyString-
enabledBoolean-

CommitJournalsResponse

FieldTypeDescription
successBoolean!-
createdCountInt!-
skippedCountInt!-
journalEntryIds[Int!]!-
errorString-

CompleteProfileInput (Input)

FieldTypeDescription
sessionTokenString!-
stateTokenString!-
givenNameString!-
familyNameString!-
phoneNumberString!-
countryCodeString!-
addressString!-
address2String-
cityString!-
postalCodeString!-
countryString!-
stateOrProvinceString!-
pictureString-
emailString!-
termsAndConditionsAcceptedBoolean-
appSlugString-
personas[String!]-
hasAcceptedRiskDisclaimerBoolean-
fundAccreditedTypeString-
isOrganizationBoolean-
organizationNameString-
organizationTypeString-
organizationTypeIdInt-
organizationLogoUrlString-
organizationParentOrganizationIduuid-
organizationCountryCodeString-
organizationAddressString-
organizationAddress2String-
organizationCityString-
organizationPostalCodeString-
organizationStateOrProvinceString-

CompleteProfileResponse

FieldTypeDescription
redirectUrlString!-

ComplianceApproveInput (Input)

FieldTypeDescription
applicantIdString!-
kycProfileIdString!-
notesString-
riskLevelString-
tags[String!]-

ComplianceNoteInput (Input)

FieldTypeDescription
kycProfileIdString!-
notesString!-
actionString-

ComplianceRejectInput (Input)

FieldTypeDescription
applicantIdString!-
kycProfileIdString!-
reasonsjsonb!-
notesString-
tags[String!]-

ComplianceReviewResult

FieldTypeDescription
successBoolean!-
reviewIdString-
messageString-

ComplianceRiskLevelInput (Input)

FieldTypeDescription
applicantIdString!-
kycProfileIdString!-
riskLevelString!-
commentString!-

ComplianceUpgradeMemberGap

FieldTypeDescription
userIdString-
emailString-
nameString-
roleString-
ownershipPercentageFloat-
isBeneficialOwnerBoolean-

ComplianceUpgradeResult

FieldTypeDescription
successBoolean!-
messageString-
organizationIdString!-
newLevelNameString-
beneficiariesAttachedInt-
membersNeedingKycInt-
membersWithoutKyc[ComplianceUpgradeMemberGap!]-

ComplianceUpgradeToNestedKybInput (Input)

FieldTypeDescription
organizationIdString!-
sendKycInvitesBoolean-
notesString-

CorporateApplicationEntityInput (Input)

Legal entity information for corporate applications

FieldTypeDescription
nameString!Legal name of the entity
descriptionString!Description of the business
industryString!NAICS industry code (e.g., "541512" for Computer Systems Design)
registrationNumberString!Business registration number
taxIdString!Tax ID (EIN)
websiteString!Company website URL (REQUIRED by the card issuer API)
typeString!Entity type (LLC, Corporation, Partnership, etc.)
expectedSpendString!Expected monthly spend range

CorporateApplicationInitialUserInput (Input)

Initial user for corporate application (must have wallet address)

FieldTypeDescription
firstNameString!-
lastNameString!-
birthDateString!-
nationalIdString!-
countryOfIssueString!-
emailString!-
addressCardAddressInput!-
phoneCountryCodeString-
phoneNumberString-
isTermsOfServiceAcceptedBoolean!-
roleString-
walletAddressString-
cardNicknameStringUser-defined card nickname for the initial user's card (optional).
Max 26 chars: alphanumeric, spaces, periods, hyphens only.
requestedLimitAmountIntDesired credit limit amount in dollars for initial user's card (e.g., 25000)
requestedLimitFrequencyStringLimit frequency for initial user's card (e.g., "30 day", "7 day")
sessionIdStringSession ID from generateEncryptionKeys mutation (required if encryptedPin provided)
encryptedPinStringEncrypted 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)

FieldTypeDescription
firstNameString!-
lastNameString!-
birthDateString!-
nationalIdString!-
countryOfIssueString!-
emailString!-
addressCardAddressInput!-
phoneCountryCodeString-
phoneNumberString-

CreateBitgoWalletInput (Input)

FieldTypeDescription
labelString!-
backupProviderBitgoBackupProviderType-
encryptedUserKeyPairBitgoEncryptionKeyPairInput!-
multisigTypeBitgoMultiSigType-
typeBitgoWalletType!-

CreateBitgoWalletResponse

FieldTypeDescription
idString!-
userKeyBitgoKey!-
bitgoKeyBitgoKey!-
backupKeyBitgoKey!-
labelString!-
coinIdString!-
walletBitgoWallet-
webhookIdString-
receiveAddressString-

CreateCardApplicationInput (Input)

FieldTypeDescription
walletAddressString!Ethereum wallet address for the card (0x... format)
occupationString!SOC occupation description (e.g., "Software Developers", "Chief Executives")
annualSalaryString!Estimated annual salary
accountPurposeString!Purpose of the account (e.g., "Savings", "Business")
expectedMonthlyVolumeString!Expected monthly transaction volume
isTermsOfServiceAcceptedBoolean!User must accept the card issuer's terms of service
cardNicknameStringUser-defined card nickname (optional)
requestedLimitAmountIntDesired credit limit amount in dollars (e.g., 25000)
requestedLimitFrequencyStringLimit frequency (e.g., "30 day", "7 day")
sessionIdStringSession ID from generateEncryptionKeys mutation (required if encryptedPin provided)
encryptedPinStringEncrypted 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

FieldTypeDescription
nameString!Company name
addressCardAddressInput!Company physical address
entityCorporateApplicationEntityInput!Company legal entity information
initialUserCorporateApplicationInitialUserInput!Initial user/admin of the company - must have a wallet address
representatives[CorporateApplicationPersonInput!]!Company representatives
ultimateBeneficialOwners[CorporateApplicationPersonInput!]!Ultimate beneficial owners (UBOs)
sourceKeyStringSource key for tracking (optional)

CreateCardDisputeInput (Input)

FieldTypeDescription
transactionIdInt!-
textEvidenceString-

CreateCardDisputeResponse

FieldTypeDescription
successBoolean!-
disputeIdString-
errorString-

CreateCardInput (Input)

Input for creating a new Card (virtual or physical) Unified mutation that handles both card types via cardType discriminator.

FieldTypeDescription
cardApplicationIdInt!Card application ID (AgioCard_card_application.id) - the approved application to create card under
cardTypeCardType!Card type - determines whether shipping is required
sessionIdStringSession ID from generateEncryptionKeys mutation (required if encryptedPin provided)
encryptedPinStringEncrypted 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.
limitCardLimitInputOptional spending limit
displayNameStringDisplay name on card (max 26 chars: alphanumeric, space, period, hyphen)
Can only be set at creation - immutable after.
shippingCardShippingInputShipping address - REQUIRED for physical cards, ignored for virtual
billingCardAddressInputBilling address - defaults to shipping address if omitted

CreateCardResponse

Response from creating a new card

FieldTypeDescription
successBoolean!-
idIntOur internal card ID (AgioCard_card.id)
cardIdStringNew card ID from the card issuer
cardTypeStringCard type (virtual or physical)
statusStringCard status after creation
last4StringLast 4 digits of card number
expirationMonthStringExpiration month
expirationYearStringExpiration year
errorString-

CreateChildEnterpriseInput (Input)

FieldTypeDescription
organizationIduuid!-
userIdString!-
labelString-
firstNameString!-
lastNameString!-
emailString!-
dateOfBirthString!-
nationalityString!-
countryOfResidenceString!-
phoneNumberString-
addressKYCAddressInput!-
identityDocumentKYCIdentityDocumentInput!-

CreateChildEnterpriseResponse

FieldTypeDescription
successBoolean!-
childEnterpriseChildEnterprise-
errorString-

CreateDigitalWalletAddressResponse

FieldTypeDescription
addressDigitalWalletDepositAddress-
errors[String]-
warnings[String]-

CreateDigitalWalletInput (Input)

FieldTypeDescription
labelString!-
walletTypeIdInt!-
walletTypeSpecificOptionsCreateDigitalWalletTypeSpecificOptions-

CreateDigitalWalletResponse

FieldTypeDescription
digitalWalletDigitalWalletSummary-
backupCardPdfString-
activationCodeString-
errors[String]-
warnings[String]-

CreateDigitalWalletTypeSpecificOptions (Input)

FieldTypeDescription
evmChainIdInt-
evmSignedMessageString-
evmSignatureString-
evmReadOnlyBoolean-
evmReadOnlyAddressString-
coinIdString-
bitgoEncryptedUserKeyPairBitgoEncryptionKeyPairInput-
bitgoEncryptedPassphraseBitgoEncryptedPassphraseInput-
bitgoBackupProviderBitgoBackupProviderType-
bitgoMultisigTypeBitgoMultiSigType-
bitgoTypeBitgoWalletType-
smartWalletAccountAddressString-
smartWalletSignerAddressString-
smartWalletSessionKeyString-
smartWalletSessionKeyAddressString-
smartWalletPermissionsContextString-
smartWalletSignatureString-
smartWalletPermissionsjsonb-
smartWalletExpiresAtbigint-
smartWalletIndexInt-

CreateEmailSegmentInput (Input)

FieldTypeDescription
nameString!-
descriptionString-
filterEmailSegmentFilter!-
categoryEmailCategory!-

CreateEncryptedKeypairInput (Input)

FieldTypeDescription
passwordString!-
seedString-

CreateGoAccountInput (Input)

FieldTypeDescription
childEnterpriseIdInt!-
labelString!-
enableTradingBoolean-
enableFiatBoolean-
digitalWalletIdInt-

CreateGoAccountResponse

FieldTypeDescription
successBoolean!-
goAccountGoAccount-
errorString-

CreateLimitOrderInput (Input)

FieldTypeDescription
digitalWalletIdInt!-
chainIdInt!-
sideString!-
fromTokenAddressString!-
fromTokenSymbolString!-
fromTokenChainIdInt-
fromTokenDecimalsInt-
toTokenAddressString!-
toTokenSymbolString!-
toTokenChainIdInt-
toTokenDecimalsInt-
amountString!-
limitPriceString-
expiryString!-
twapTotalTradesInt-
twapIntervalMinutesInt-
twapMaxDurationMinutesInt-

CreateOrGetApplicantForUserResult

FieldTypeDescription
createdBoolean!-
sumsubApplicantIdString!-
kycProfileIduuid-
applicantSumsubApplicantResponse!-

CreatePartnerCardApplicationInput (Input)

FieldTypeDescription
cardUserIduuid!UUID of the card user the partner has already provisioned.
The card user's company must belong to a partner-managed organization.
walletAddressStringEthereum wallet address for the card (0x... format).
Either provide walletAddress OR set createWallet: true — exactly one is required.
createWalletBooleanWhen true, Agio provisions an org-scoped smart wallet on Base mainnet and
uses its deterministic address. Mutually exclusive with walletAddress.
occupationString!SOC occupation description (e.g., "Software Developers", "Chief Executives").
annualSalaryString!Estimated annual salary in USD (string to preserve the card issuer API compatibility).
accountPurposeString!Purpose of the account (e.g., "Savings", "Business").
expectedMonthlyVolumeString!Expected monthly transaction volume in USD.
isTermsOfServiceAcceptedBoolean!The partner is responsible for collecting end-user ToS acceptance before
submitting this application. MUST be true; the card issuer rejects the application otherwise.
cardNicknameStringUser-defined card nickname (optional, max 26 chars: alphanumeric, spaces, periods, hyphens).
requestedLimitAmountIntDesired credit limit amount in dollars (e.g., 25000).
requestedLimitFrequencyStringLimit frequency (e.g., "30 day", "7 day"). See CardLimitFrequency for canonical values.
sessionIdStringSession ID from the generateEncryptionKeys mutation (required if encryptedPin provided).
encryptedPinStringEncrypted 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.
partnerKycShareTokenStringOptional 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.

FieldTypeDescription
customerOrganizationIduuid!UUID of the customer organization this cardholder belongs to. Must be a
partner-managed customer org from createPartnerCustomerOrganization.
firstNameString!First name on the cardholder's ID.
lastNameString!Last name on the cardholder's ID.
emailString!Cardholder email. Used as the idempotency key within customerOrganizationId.
addressCountryCodeString!ISO-3166 alpha-2 country code (e.g., "US") for the cardholder's address.
addressLine1String!Cardholder's street address line 1.
addressLine2StringOptional street address line 2.
addressCityString!City.
addressRegionString!State / province / region (e.g., "CA", "NSW").
addressPostalCodeString!Postal / ZIP code.
phoneCountryCodeString!Phone country dialing code, digits only (e.g., "1" for US, "44" for UK).
phoneNumberString!National phone number, digits only.
birthDateString!Date of birth in YYYY-MM-DD format.
nationalIdString!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.

FieldTypeDescription
successBoolean!True if the cardholder was created (or already existed and was idempotently returned).
cardUserIduuidUUID of the cardholder. Stable across all future operations — store it on
your side. Pass this as cardUserId in createCardApplicationForPartnerUser.
reusedBooleanTrue when an existing cardUser with the same email under the same customer org was returned.
errorCodeStringMachine-readable error code if creation failed.
errorMessageStringHuman-readable error message if creation failed.

CreatePartnerCustomerOrganizationInput (Input)

FieldTypeDescription
nameString!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.

FieldTypeDescription
successBoolean!Whether the organization and its partner_managed_organization join row were created.
organizationIduuidUUID of the newly created AgioAuth.organization row.
errorStringError message if creation failed (e.g. duplicate name, database error).

CreateTradeSettlementInput (Input)

FieldTypeDescription
tradeRequestIduuid!-
settlementTypeIdInt!-
notesString-

CreateUserAccountInviteInput (Input)

FieldTypeDescription
emailString!-
givenNameString!-
familyNameString!-
passwordString-
roleIdInt-
roleIds[Int!]-
clientIdInt-
sendResetPasswordEmailBoolean-
continueOnExistingBoolean-
ttlSecInt-
redirectUrlString-
extraMessageString-

CreateUserAccountInviteResponse

FieldTypeDescription
userIdString!-
emailString!-
givenNameString!-
familyNameString!-
clientIdInt-
roleIdInt-
createdAttimestamptz!-
updatedAttimestamptz!-
inviteUrlString-
emailSentBoolean!-
createdBoolean!-

CrsDataQualitySummary

FieldTypeDescription
fundIdInt!-
fundNameString!-
totalAccountsInt!-
accountsMissingTinInt!-
accountsMissingAddressInt!-
accountsMissingTaxResidenceInt!-
individualAccountsInt!-
organizationAccountsInt!-
totalAccountBalanceFloat!-
receivingCountries[String!]!-

CrsGeneratedReport

FieldTypeDescription
fundIdInt!-
receivingCountryString!-
accountCountInt!-
filePathString!-
fileHashString!-
fileSizeBytesInt!-
messageRefIdString!-

CrsReceivingCountry

FieldTypeDescription
countryString!-
codeString!-

DailyNavWorkbookResult

FieldTypeDescription
downloadUrlString!-
rowCountInt!-

DealDocumentDownloadTicket

FieldTypeDescription
downloadUrlString!-
expiresInInt!-

DealDocumentUploadTicket

FieldTypeDescription
uploadUrlString!-
gcsPathString!-
contentTypeString!-
expiresInInt!-

DecryptEncryptedKeypairInput (Input)

FieldTypeDescription
passwordString!-
encryptedPrvString!-

DecryptEncryptedKeypairResponse

FieldTypeDescription
decryptedPrvString!-

DecryptPrivateKeyInput (Input)

FieldTypeDescription
passwordString!-
encryptedPrvString!-

DeleteAuth0UserResponse

FieldTypeDescription
statusCodeInt-
errorString-
messageString-

DeleteWebhookInput (Input)

FieldTypeDescription
digitalWalletIdInt!-
webhookIdString!-

DeleteWebhookResponse

FieldTypeDescription
successBoolean!-
errorString-

DetachKybBeneficiaryInput (Input)

FieldTypeDescription
organizationIdID!-
beneficiaryIdString!Junction record ID from AttachKybBeneficiaryResult.beneficiaryId (NOT the applicant ID)

DigitalAssetsAggregate

FieldTypeDescription
countInt!-
usdValueString!-

DigitalAssetSummary

FieldTypeDescription
idID!-
walletIdID-
nameString-
symbolString-
valueString-
usdValueString-
unitPriceUsdString-
coinPriceCoinPrice-
methods[String]TODO: implement
depositAddresses[DigitalWalletDepositAddress]TODO: implement
contractAddressString-
decimalsInt-
verifiedBoolean-
logoUrlString-

DigitalWalletAddress

FieldTypeDescription
idID!-
addressString!-
coinIdString!-

DigitalWalletBackupCardInput (Input)

FieldTypeDescription
coinIdString!-
walletIdString!-
labelString!-
userEncryptedPrvString!-
userPubString!-
backupPubString!-
bitgoPubString!-
backupProviderIdString!-
activationCodeString-

DigitalWalletDepositAddress

FieldTypeDescription
idID!-
addressString!-
coinIdString!-
methodStringdeposit methods like: 'sol', 'eth', 'arb', etc.
tagStringdeposit tag is required for some blockchains like XRP, XLM, etc.
labelString-
valueString-
valueUsdString-
indexInt-

DigitalWalletDetail

FieldTypeDescription
idID!-
externalIdString-
digitalWalletIdInt!-
isStarredBoolean!-
labelString-
usdValueString-
walletTypeIdInt-
nativeBoolean-
nativeCoinBalanceString-
nativeCoinBalanceUsdString-
nativeCoinUnitPriceUsdString-
nativeCoinSymbolString-
nativeDepositAddressString-
nativeNetworkIdInt-
typeString-
userIdString-
readonlyBoolean-
organizationIduuid-
sparklineUrlString-
assets[DigitalAssetSummary]-
assetsAggregateDigitalAssetsAggregate-
transactions[DigitalWalletTransactionSummary]-
deposits[DigitalWalletTransactionSummary]-
withdrawals[DigitalWalletTransactionSummary]-
trades[DigitalWalletTradeSummary]-
addresses[DigitalWalletDepositAddress]-
whitelist[DigitalWalletWhitelistEntry]-

DigitalWalletResponse

FieldTypeDescription
idInt!-
created_attimestamptz!-
updated_attimestamptz!-
fund_idInt-
network_idInt!-
nicknameString-
user_idString!-
wallet_addressString!-
is_whitelistedBoolean!-

DigitalWalletSummary

FieldTypeDescription
idID!-
externalIdString-
digitalWalletIdInt!-
isStarredBoolean!-
labelString-
usdValueString-
walletTypeIdInt-
nativeBoolean-
nativeCoinBalanceString-
nativeCoinBalanceUsdString-
nativeCoinUnitPriceUsdString-
nativeCoinSymbolString-
nativeDepositAddressString-
nativeNetworkIdInt-
typeString-
userIdString-
readonlyBoolean-
assets[DigitalAssetSummary]-
assetsAggregateDigitalAssetsAggregate-
organizationIduuid-
sparklineUrlString-

DigitalWalletTradeSummary

FieldTypeDescription
idID!-
walletIdID-
baseCurrencyString-
feeString-
fromString-
toString-
priceString-
proceedsString-
quoteCurrencyString-
sizeString-
createdAttimestamptz-

DigitalWalletTransactionsAggregate

FieldTypeDescription
totalCountInt!-
lastFetchedAttimestamptz-
lastFetchRequestAttimestamptz-
nextEligibleFetchAttimestamptz-
isFetchingBoolean!-
walletIdID-

DigitalWalletTransactionSummary

FieldTypeDescription
idID!-
walletIdID-
createdAttimestamptz-
confirmedAttimestamptz-
confirmationsInt-
sizeString-
notesString-
dataString-
coinString-
transactionIdString-
statusDigitalWalletTransactionStatus-
fromString-
toString-
typeDigitalWalletTransactionType-
coinPriceCoinPrice-
pendingApprovalBitgoPendingApproval-
pendingApprovalIdString-

DigitalWalletWhitelistEntry

FieldTypeDescription
idID!-
labelString-
addressString-
createdAttimestamptz-
updatedAttimestamptz-
isApprovedBoolean-
symbolString-
statusDigitalWalletWhitelistEntryStatus!-
walletIdID!-

DocumentTemplateDictionaryResponse

FieldTypeDescription
caseIdInt-
tags[DocumentTemplateTag]-

DocumentTemplateTag

FieldTypeDescription
idString!-
nameString-
values[String]-
valueString-
descriptionString-

EmailInput (Input)

FieldTypeDescription
bodyTextOnlyString-
bodyHtmlString-
subjectString-
toEmailString-
toFirstNameString-

EmailSegment

FieldTypeDescription
idID!-
nameString!-
descriptionString-
filterjsonb!-
categoryEmailCategory!-
audienceIdInt!-
createdByString-
createdAtString!-
updatedAtString!-
archivedAtString-

EmailSegmentFilter (Input)

FieldTypeDescription
audienceIdInt!-
userUserFilterInput-
userOrganizationUserOrganizationFilterInput-
leadLeadFilterInput-
leadCompanyLeadCompanyFilterInput-

EmailSegmentPreview

FieldTypeDescription
totalCountInt!-
sampleEmails[String!]!-

EncryptedKeypair

FieldTypeDescription
pubString!-
encryptedPrvString!-

EncryptionKeys

FieldTypeDescription
sessionIdString!-
keyString!-
ivString!-

EnsureTokenChainInput (Input)

FieldTypeDescription
typeEnsureTokenChainTypeResolution type - determines which fields are used. Defaults to AUTO if not provided.
contractAddressStringContract address of the token (0x format). Required for ALCHEMY and CHAIN_ID types.
identifierStringToken identifier for AUTO type - can be contract address (0x...) or token symbol
alchemyNetworkStringAlchemy network identifier (e.g., 'eth-mainnet', 'polygon-mainnet'). Required for ALCHEMY type.
chainIdIntDirect chain ID (e.g., 1 for Ethereum mainnet). Required for CHAIN_ID type.
coinStringBitGo coin symbol (e.g., 'eth', 'tbtc', 'hteth'). Required for BITGO_COIN type.
digitalWalletIdIntDigital wallet ID for network context. Required for BITGO_COIN type.
decimalsIntOptional token decimals (will be fetched from provider if not provided)
symbolStringOptional token symbol (will be fetched from provider if not provided)
nameStringOptional token name (will be fetched from provider if not provided)
immediateBooleanProcess synchronously (true) or queue for background processing (false, default)

EnsureTokenChainResult

FieldTypeDescription
successBoolean!Whether the operation was successful
tokenIdIntThe token ID (if found or created)
chainIdIntThe chain ID (if found or created)
createdBooleanWhether a new token_chain record was created
messageStringHuman-readable message about the result
errorStringError message if operation failed
queuedBooleanWhether the job was queued for background processing
jobIdStringJob ID if queued
deduplicatedBooleanWhether the job was deduplicated (existing job found)

EnsureTokenChainsFromTransactionsInput (Input)

FieldTypeDescription
alchemyNetworkStringFilter by specific alchemy network
limitIntMaximum number of transactions to process
skipInProgressBooleanSkip transactions that are already being processed

EnsureTokenChainsFromTransactionsResult

FieldTypeDescription
successBoolean!Whether the operation was successful
jobsAddedInt!Number of jobs added to the queue
jobsDeduplicatedInt!Number of jobs that were deduplicated
skippedInt!Number of transactions that were skipped (no contract address)
totalInt!Total number of transactions processed
errorStringError message if operation failed

EvmSignedMessage

FieldTypeDescription
idString!-
messageString!-
profileIdString!-

EvmVerifiedMessage

FieldTypeDescription
addressString!-
signatureString!-
profileIdString!-
digitalWalletIdInt-

ExchangeQuote

FieldTypeDescription
idString-
fromCoinString-
toCoinString-
createdAttimestamptz-
filledBoolean-
expiredBoolean-
sideString-
feeFloat-
sizeFloat-
exchangeIdString-
proceedsFloat-
priceFloat-
quoteCoinString-
baseCoinString-

ExchangeQuoteError

FieldTypeDescription
codeString-
messageString-
payloadjsonb-

ExchangeQuoteResponse

FieldTypeDescription
exchangeIdString!-
quoteExchangeQuote-
errorExchangeQuoteError-

ExecuteBridgeQuoteInput (Input)

FieldTypeDescription
quoteIdInt!-

FeeWalletRebalanceResult

FieldTypeDescription
originsFoundInt!-
txsSubmittedInt!-
txsFailedInt!-
txHashes[String!]!-
errors[String!]!-
impactPctFloat-
valueInUsdString-
valueOutUsdString-

File

FieldTypeDescription
orginal_filenameString-
filenameString-
mimetypeString-
encodingString-
idID!-
created_atString-
user_idString-
cloud_urlString-
short_urlString-
urlString-
thumbnail_urlString-
case_idInt-
fund_idInt-
titleString-
descriptionString-
fundOverviewSlotString-

FileInput (Input)

FieldTypeDescription
nameString-
dataString-
typeFileInputType-

FinanceAdjclose

FieldTypeDescription
adjclose[Float]-

FinanceChartResult

FieldTypeDescription
timestamp[timestamptz!]!-
metaFinanceMeta-
indicatorsFinanceIndicators-

FinanceCurrentTradingPeriod

FieldTypeDescription
preFinanceTradingPeriodItem-
regularFinanceTradingPeriodItem-
postFinanceTradingPeriodItem-

FinanceIndicators

FieldTypeDescription
quote[FinanceQuote]-
adjclose[FinanceAdjclose]-

FinanceMeta

FieldTypeDescription
currencyString-
symbolString-
exchangeNameString-
instrumentTypeString-
firstTradeDateInt-
regularMarketTimeInt-
gmtoffsetInt-
timezoneString-
exchangeTimezoneNameString-
regularMarketPriceFloat-
chartPreviousCloseFloat-
priceHintInt-
currentTradingPeriodFinanceCurrentTradingPeriod-
dataGranularityString-
rangeString-
validRanges[String]-

FinanceNewsArticle

FieldTypeDescription
titleString-
urlString-
timePublishedtimestamptz!-
authors[String!]!-
summaryString!-
bannerImageString-
sourceString-
categoryWithinSourceString-
sourceDomainString-
overallSentimentScoreFloat!-
overallSentimentLabelString-

FinanceQuote

FieldTypeDescription
high[Float]!-
close[Float]!-
open[Float]!-
low[Float]!-
volume[Float]!-

FinanceQuoteResult

FieldTypeDescription
languageString-
regionString-
quoteTypeString-
typeDispString-
quoteSourceNameString-
triggerableBoolean-
customPriceAlertConfidenceString-
currencyString-
fiftyDayAverageFloat-
fiftyDayAverageChangeFloat-
fiftyDayAverageChangePercentFloat-
twoHundredDayAverageFloat-
twoHundredDayAverageChangeFloat-
twoHundredDayAverageChangePercentFloat-
sourceIntervalInt-
exchangeDataDelayedByInt-
tradeableBoolean-
cryptoTradeableBoolean-
exchangeString-
shortNameString-
messageBoardIdString-
exchangeTimezoneNameString-
exchangeTimezoneShortNameString-
gmtOffSetMillisecondsInt-
marketString-
esgPopulatedBoolean-
marketStateString-
regularMarketChangePercentFloat-
regularMarketPriceFloat-
regularMarketChangeFloat-
regularMarketTimeInt-
regularMarketDayHighFloat-
regularMarketDayRangeString-
regularMarketDayLowFloat-
regularMarketVolumeFloat-
regularMarketPreviousCloseFloat-
bidFloat-
askFloat-
bidSizeInt-
askSizeInt-
fullExchangeNameString-
regularMarketOpenFloat-
averageDailyVolume3MonthFloat-
averageDailyVolume10DayFloat-
fiftyTwoWeekLowChangeFloat-
fiftyTwoWeekLowChangePercentFloat-
fiftyTwoWeekRangeString-
fiftyTwoWeekHighChangeFloat-
fiftyTwoWeekHighChangePercentFloat-
fiftyTwoWeekLowFloat-
fiftyTwoWeekHighFloat-
firstTradeDateMillisecondsFloat-
priceHintInt-
symbolString-
earningsTimestampInt-
earningsTimestampStartInt-
earningsTimestampEndInt-
trailingAnnualDividendRateFloat-
trailingPEFloat-
trailingAnnualDividendYieldFloat-
epsTrailingTwelveMonthsFloat-
epsForwardFloat-
epsCurrentYearFloat-
priceEpsCurrentYearFloat-
sharesOutstandingFloat-
bookValueFloat-
marketCapFloat-
forwardPEFloat-
priceToBookFloat-
prevNameString-
nameChangeDateString-
averageAnalystRatingString-
longNameString-
financialCurrencyString-
dividendDateString-
displayNameString-

FinanceResultMany

FieldTypeDescription
result[FinanceQuoteResult!]-
errorString-

FinanceResultOne

FieldTypeDescription
resultFinanceQuoteResult-
errorString-

FinanceTradingPeriodItem

FieldTypeDescription
timezoneString-
endInt-
startInt-
gmtoffsetInt-

FreezeWalletInput (Input)

FieldTypeDescription
digitalWalletIdInt!-
durationInt!-

FreezeWalletResponse

FieldTypeDescription
successBoolean!-
durationInt-
errorString-

FundInvestorRecipient

FieldTypeDescription
userIdID!-
emailString!-
givenNameString-
familyNameString-
totalSharesString!-
totalPositionValueString!-
organizationContexts[String!]!-

FundInvestorRecipientsInput (Input)

FieldTypeDescription
fundIdInt!-

FundInvestorsPreview

FieldTypeDescription
fundIdInt!-
totalUsersInt!-
totalSharesAcrossUsersString!-
recipients[FundInvestorRecipient!]!-
sampleEmails[String!]!-
truncatedBoolean!-

GenerateBackupKeyInput (Input)

FieldTypeDescription
coinIdString!-

GenerateBackupKeyResponse

FieldTypeDescription
backupKeyHotWalletKey-
backupProviderString-
errors[String]-
warnings[String]-

GenerateBitGoKeyInput (Input)

FieldTypeDescription
coinIdString!-

GenerateBitGoKeyResponse

FieldTypeDescription
bitgoKeyHotWalletKey-
errors[String]-
warnings[String]-

GenerateCrsReportsInput (Input)

FieldTypeDescription
fundIdInt!-
reportingPeriodEndString!-
receivingCountryString-

GenerateCrsReportsResponse

FieldTypeDescription
successBoolean!-
reports[CrsGeneratedReport!]!-
errors[String!]!-

GenerateHotWalletKeysInput (Input)

FieldTypeDescription
coinIdString!-
bitgoEncryptedUserKeyPairBitgoEncryptionKeyPairInput-
bitgoEncryptedPassphraseBitgoEncryptedPassphraseInput-

GenerateHotWalletKeysResponse

FieldTypeDescription
userKeyHotWalletKey-
backupKeyHotWalletKey-
bitgoKeyHotWalletKey-
backupProviderString-
errors[String]-
warnings[String]-

GenerateSmartWalletJwtInput (Input)

FieldTypeDescription
targetPublicKeyString-
scopeSmartWalletSubjectScope-
organizationIduuid-

GenerateUserKeyInput (Input)

FieldTypeDescription
coinIdString!-
bitgoEncryptedUserKeyPairBitgoEncryptionKeyPairInput-
bitgoEncryptedPassphraseBitgoEncryptedPassphraseInput-

GenerateUserKeyResponse

FieldTypeDescription
userKeyHotWalletKey-
errors[String]-
warnings[String]-

GeocodeLocation

Geocode location from Google Address Validation

FieldTypeDescription
latitudeFloat!-
longitudeFloat!-

GoAccount

FieldTypeDescription
idInt!-
childEnterpriseIdInt!-
digitalWalletIdInt-
bitgoAccountIdString!-
accountStatusString!-
tradingEnabledBoolean!-
fiatEnabledBoolean!-
configjsonb-
createdAttimestamptz!-
updatedAttimestamptz!-

GoAccountBalance

FieldTypeDescription
currencyString!-
availableString!-
pendingString!-
totalString!-
fiatValueString-
lastUpdatedString!-

GoFiatOperation

FieldTypeDescription
idInt!-
goAccountIdInt!-
bitgoOperationIdString!-
typeString!-
currencyString!-
amountString!-
feesString-
statusString!-
bankAccountjsonb-
estimatedArrivaltimestamptz-
createdAttimestamptz!-
updatedAttimestamptz!-

GoFiatOperationInput (Input)

FieldTypeDescription
goAccountIdInt!-
typeString!-
currencyString!-
amountFloat!-
bankAccountjsonb-

GoFiatOperationResponse

FieldTypeDescription
successBoolean!-
operationGoFiatOperation-
errorString-

GoNetworkActionResponse

FieldTypeDescription
successBoolean!-
errorString-

GoNetworkConnection

FieldTypeDescription
idInt!-
goAccountIdInt!-
counterpartyIdString!-
counterpartyNameString-
connectionStatusString!-
directionString!-
metadatajsonb-
createdAttimestamptz!-
updatedAttimestamptz!-

GoNetworkConnectionResponse

FieldTypeDescription
successBoolean!-
connectionGoNetworkConnection-
errorString-

GoNetworkDirectoryEntry

FieldTypeDescription
idString!-
nameString!-
typeString-
countryString-

GoTrade

FieldTypeDescription
idInt!-
goAccountIdInt!-
bitgoTradeIdString!-
sideString!-
typeString!-
baseCurrencyString!-
quoteCurrencyString!-
requestedAmountString!-
executedAmountString-
priceString-
executedPriceString-
feeCurrencyString-
feeAmountString-
statusString!-
createdAttimestamptz!-
executedAttimestamptz-

GoTradeResponse

FieldTypeDescription
successBoolean!-
tradeGoTrade-
errorString-

HotWalletKey

FieldTypeDescription
idString!-
pubString!-
typeString!-
sourceString!-
encryptedPrvString-
commonKeychainString-

ImportBankStatementInput (Input)

FieldTypeDescription
fundIdInt!-
filenameString!-
formatString!-
fileContentString!-

ImportBankStatementResponse

FieldTypeDescription
successBoolean!-
importIdInt-
lineCountInt-
skippedRowsInt-
errors[String!]-
errorString-

InitiateGoTradeInput (Input)

FieldTypeDescription
goAccountIdInt!-
sideString!-
typeString!-
baseCurrencyString!-
quoteCurrencyString!-
amountFloat!-
priceFloat-

InitiateOutboundSettlementInput (Input)

FieldTypeDescription
settlementIdInt!-
toAddressString-
toWalletIdInt-
toBankInfoIdInt-
autoSendBoolean-

InsertPartnerApiTokenInput (Input)

FieldTypeDescription
partnerOrganizationIdID!The partner organization the new token will belong to.
descriptionString!Human-readable label shown in the admin grid (e.g. 'Production integration').
expiresAtStringOptional expiry. When omitted the token does not expire.
hasuraRoleNameStringRole 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

FieldTypeDescription
successBoolean!-
tokenIdInt-
apiTokenStringThe 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.
clientSecretStringThe HMAC signing secret — returned ONCE on insert. Capture immediately;
it is never readable again. Storage is KMS-envelope-encrypted bytea.
errorCodeString-
errorMessageString-

InsertTrainingVersionResult

FieldTypeDescription
idInt!-

InvoiceResponse

FieldTypeDescription
invoiceIdInt-
flowTemplateSlugString-
caseIdInt-
quoteIdInt-
errorString-
successBoolean!-

JournalEntryPreview

FieldTypeDescription
entryDateString!-
descriptionString!-
sourceTypeString!-
lines[JournalLinePreview!]!-

JournalLinePreview

FieldTypeDescription
descriptionString-
accountCodeString!-
accountNameString!-
debitFloat-
creditFloat-

KMSDecryptInput (Input)

FieldTypeDescription
encryptedDataString!-

KMSDecryptionResult

FieldTypeDescription
plaintextString!-
metadatajsonb-
keyVersionString!-
decryptedAtString!-

KMSEncryptInput (Input)

FieldTypeDescription
plaintextString!-
metadatajsonb-

KMSEncryptionResult

FieldTypeDescription
encryptedDataString!-
keyVersionString!-
encryptedAtString!-

KMSKeyRotationResult

FieldTypeDescription
oldVersionString!-
newVersionString!-
rotatedAtString!-

KMSMutation

FieldTypeDescription
encryptKMSEncryptionResult!-
rotateKeyKMSKeyRotationResult!-
reencryptKMSEncryptionResult!-

KMSQuery

FieldTypeDescription
decryptKMSDecryptionResult!-
validateEncryptedDataBoolean!-
getCurrentKeyVersionString!-

KMSReencryptInput (Input)

FieldTypeDescription
encryptedDataString!-

KYCAddressInput (Input)

FieldTypeDescription
street1String!-
street2String-
cityString!-
stateString-
postalCodeString!-
countryString!-

KYCIdentityDocumentInput (Input)

FieldTypeDescription
typeString!-
numberString!-
issueDateString!-
expiryDateString!-
issuingCountryString!-

KycProfile

FieldTypeDescription
idString!-
sumsub_email_addressString-
sumsub_first_nameString-
sumsub_last_nameString-
sumsub_phone_numberString-
sumsub_country_of_residenceString-
most_recent_review_statusString-
most_recent_review_level_nameString-
last_approved_level_nameString-
last_approved_datetimestamptz-
sumsub_applicant_typeString-
most_recent_review_anwser_is_greenBoolean!-
created_attimestamptz!-
updated_attimestamptz-

KycSdkInitTokenInput (Input)

FieldTypeDescription
apiTokenString!-
externalUserIdString!-
externalUserEmailString-
externalUserFirstNameString-
externalUserLastNameString-
ttlInt-
currencyString-
amountFloat-

KycSdkUserAuthenticationInput (Input)

FieldTypeDescription
tokenString!-

LeadCompanyFilterInput (Input)

FieldTypeDescription
companyNameContainsString-
domainEndsWithString-
referredByOrganizationIds[ID!]-
convertedToOrganizationIds[ID!]-

LeadFilterInput (Input)

FieldTypeDescription
tierIds[Int!]-
priorityIds[Int!]-
nbaIds[Int!]-
segmentIds[Int!]-
categoryIds[Int!]-
bucketIds[Int!]-
statusIds[Int!]-
sourceIds[Int!]-
countryIds[Int!]-
scoreMinInt-
scoreMaxInt-
estimatedArrUsdMinFloat-
estimatedArrUsdMaxFloat-
decisionMakerLikelihoodMinFloat-
enrichmentConfidenceMinFloat-
isCompetitorBoolean-
isPartnerBoolean-
hasPhoneBoolean-
hasCompanyBoolean-
isConvertedBoolean-
assignedToUserIds[String!]-
lastActivityAftertimestamptz-
enrichedAftertimestamptz-
interestIds[Int!]-
utmSources[String!]-
utmCampaignString-
adIdString-

LimitOrderData

FieldTypeDescription
idInt!-
orderTypeString!-
sideString!-
fromTokenSymbolString!-
fromTokenDecimalsInt-
toTokenSymbolString!-
toTokenDecimalsInt-
amountString!-
filledAmountString!-
limitPriceString-
averageFillPriceString-
statusString!-
expiryString!-
expiresAtString-
twapTotalTradesInt-
twapTradesCompletedInt-
twapIntervalMinutesInt-
cowOrderUidString-
createdAtString!-

LimitOrderResponse

FieldTypeDescription
successBoolean!-
orderLimitOrderData-
errorString-
structuredErrorSmartWalletErrorResponse-

MarketData

FieldTypeDescription
pairString!-
priceString!-
bidString!-
askString!-
volume24hString!-
change24hString!-

MassEmailAttachmentInput (Input)

FieldTypeDescription
contentString!-
filenameString!-
typeString!-

MassEmailRecipientResult

FieldTypeDescription
emailString!-
successBoolean!-
errorString-

MultiSendFromWalletInput (Input)

FieldTypeDescription
sourceWalletIdInt!-
transfers[MultiSendTransferInput!]!-
idempotencyKeyString-

MultiSendFromWalletResponse

FieldTypeDescription
successBoolean!-
jobIdString-
alreadyEnqueuedBoolean-
errorCodeString-
errorMessageString-
retryAfterSecInt-

MultiSendJobStatusResponse

FieldTypeDescription
successBoolean!-
jobIdString!-
statusString-
txHashString-
failedReasonString-
attemptsInt-
errorCodeString-
errorMessageString-

MultiSendTransferInput (Input)

FieldTypeDescription
tokenChainIdInt!-
destinationString!-
amountString!-

Mutation

FieldTypeDescription
generateFundUserAgreementPdfString-
previewFundUserAgreementPdfString-
generateEncryptionKeysEncryptionKeys!-
singleUploadFile!-
multiUpload[File!]-
resetApplicantInt-
resetApplicantByIdInt-
resendVerificationEmailString-
resendVerificationEmailByIdString-
patchAuth0UserByIdPatchAuth0UserResponse-
patchAuth0UserPatchAuth0UserResponse-
deleteAuth0UserDeleteAuth0UserResponse-
createUserAccountInviteCreateUserAccountInviteResponse!-
userCreateUserAccountInviteCreateUserAccountInviteResponse!-
sendEmailSharePageBoolean-
runDigitalWalletAmlReportDigitalWalletResponse-
downloadPdfString-
downloadQuotePdfString-
downloadProposalPdfString-
downloadCombinedProposalPdfString-
bundleProposalString-
downloadInvoicePdfString-
downloadInvoiceReceiptPdfString-
downloadInvoiceStatementPdfString-
downloadCasePdfString-
downloadCaseOrgChartPdfString-
downloadEnhancedCasePdfString-
downloadCaseSignOffPdfString-
downloadDocumentTemplatePdfString-
downloadFundInvestorCapitalStatementPdfString-
downloadFundShareRegisterPdfString-
downloadFundShareholderMovementPdfString-
downloadFundInvestorStatementPdfString-
downloadFundInvestorAllocationsPdfString-
downloadFundExpenseReportPdfString-
downloadFundNavReportPdfString-
downloadFundSubscriptionConfirmationPdfString-
downloadFundRedemptionConfirmationPdfString-
downloadFundPerformanceStatementPdfString-
downloadWireTransferPdfString-
sendWireTransferEmailSendWireTransferEmailResponse!-
downloadDigitalWalletBackupCardPdfString-
downloadProductCatalogPdfString-
sendOtpCodeBoolean-
sendLinkBoolean-
verifyOtpCodeBoolean-
sendChatMessageChatMessageResponse-
requestQuotes[ExchangeQuoteResponse]-
generateFileDownloadTokenString-
shortenLinkString-
jsonbToCsvString-
sendEmailBoolean-
sendMassEmailSendMassEmailResponse!-
sendTestCampaignEmailBoolean-
cancelEmailCampaignCancelEmailCampaignResult!-
triggerCampaignBlastScanBoolean!-
createEmailSegmentEmailSegment!-
updateEmailSegmentEmailSegment!-
archiveEmailSegmentEmailSegment!-
previewEmailSegmentEmailSegmentPreview!-
previewEmailSegmentFullRecipientPreviewFull!-
sendFundInvestorContactEmailBoolean!-
associateKycProfileWithUserKycProfile!-
renderCaseDocuments[BullJobResponse!]!-
sendCaseDocumentsEmailBoolean-
authenticateGuestString-
exchangeTokenForShortLivedTokenString-
startSessionSessionResponse-
endSessionBoolean!-
destroyUserSessionsBoolean!-
setAuthTokenBoolean-
deleteAuthTokenBoolean-
acceptUserOrganizationInviteAcceptUserOrganizationInviteResponse-
completeProfileCompleteProfileResponse-
generateWorkflowSdkInitTokenString-
authenticateWorkflowSdkUserString-
generateKycSdkInitTokenString-
authenticateKycSdkUserString-
createInvoiceFromQuoteInvoiceResponse-
createInvoiceFromCaseInvoiceResponse-
resetInvoiceToQuoteInvoiceResponse-
sendInvoiceEmailBoolean-
sendInvoicePaymentReceiptEmailBoolean-
sendQuoteEmailBoolean-
sendBulkInvoiceEmailsSendBulkInvoiceEmailsResponse!-
getOrCreateQuoteInt-
acceptQuoteAcceptQuoteResponse!-
submitQuoteQuestionSubmitQuoteQuestionResponse!-
addGetTrackedTokensToQueueBullJobResponse-
backfillTokenPricesManyBullJobResponse-
backfillTokenPricesBullJobResponse-
backfillTopTokenPricesBullJobResponse-
cancelQueueJobCancelQueueJobResponse!-
syncCoinlistPlatformsBullJobResponse-
rebuildTokensBullJobResponse-
reconcileCoingeckoBullJobResponse-
verifyTokenChainsBullJobResponse-
scrapeCoinIconString-
scrapeNewsBullJobResponse!-
addMarketPricesJob[BullJobResponse!]!-
addWalletSnapshotJobBullJobResponse-
addWalletsSnapshotJob[BullJobResponse]-
updateUserPhoneNumberBoolean!-
updateUserEmailBoolean!-
setEmailVerifiedBoolean-
generateStatementOfAccountPdfString-
syncApplicantQuestionnaireSyncApplicantQuestionnaireResponse!-
processFundCustodyExpenseAccrualsProcessFundCustodyExpenseAccrualsResponse!-
processExpenseAccrualsProcessExpenseAccrualsResponse!-
processFeeAccrualsProcessFeeAccrualsResponse!-
processAmortizationProcessAmortizationResponse!-
processFundEndOfDayProcessFundEndOfDayResponse!-
backfillDigitalWalletAssetsBackfillDigitalWalletAssetsResponse!-
importBankStatementImportBankStatementResponse!-
syncSafesSyncSafesResponse!-
redisRedisMutation!-
syncWhitelistSyncWhitelistResponse-
bulkImportWhitelistBulkImportWhitelistResponse-
addVelocityLimitPolicyAddPolicyResponse-
addSpendingLimitPolicyAddPolicyResponse-
removeWalletPolicyRemovePolicyResponse-
freezeWalletFreezeWalletResponse-
submitWhitelistRequestWhitelistRequestResponse-
approveWhitelistRequestWhitelistRequestResponse-
rejectWhitelistRequestWhitelistRequestResponse-
createDigitalWalletCreateDigitalWalletResponse-
createDigitalWalletAddressCreateDigitalWalletAddressResponse-
generateHotWalletKeysGenerateHotWalletKeysResponse-
generateUserKeyGenerateUserKeyResponse-
generateBackupKeyGenerateBackupKeyResponse-
generateBitGoKeyGenerateBitGoKeyResponse-
createEncryptedKeypairEncryptedKeypair-
decryptEncryptedKeypairDecryptEncryptedKeypairResponse-
decryptPrivateKeyString-
encryptPassphraseString-
decryptPassphraseString-
addDigitalWalletWhitelistEntryDigitalWalletWhitelistEntry-
removeDigitalWalletWhitelistEntryBoolean-
addSmartWalletSessionKeyAddSmartWalletSessionKeyResponse-
revokeSmartWalletSessionKeyRevokeSmartWalletSessionKeyResponse-
provisionOrgSmartWalletSessionKeysProvisionOrgWalletSessionKeysResponse!-
provisionAllDefaultChainWalletsProvisionAllDefaultChainWalletsResponse!-
requestOtcTradeChatMessageResponse-
requestOtcQuoteRequestQuoteTradeResponse-
refreshOtcQuoteRefreshOtcQuoteResponse-
calculateOtcQuoteCalculateOtcQuoteResponse-
evmMutationEvm-
generateRecurringJournalEntriesRecurringJEResult!-
transferDigitalAssetDigitalWalletTransactionSummaryTODO: implement. Use to transfer, send or withdraw digital asset
requestConvertDigitalAssetQuoteExchangeQuoteTODO: implement
acceptConvertDigitalAssetQuoteDigitalWalletTradeSummaryTODO: implement
exportDailyNavWorkbookDailyNavWorkbookResult!-
mintCampaignAdUploadUrlCampaignAdUploadTicket!-
rebalanceAgioFeeSmartWalletFeeWalletRebalanceResult!-
burnDustBurnDustResult!-
burnDustAgioFeeSmartWalletBurnDustResult!-
previewCryptoTransactionJournalsPreviewJournalsResponse!-
commitCryptoTransactionJournalsCommitJournalsResponse!-
previewCashMovementJournalsPreviewJournalsResponse!-
commitCashMovementJournalsCommitJournalsResponse!-
previewNonCryptoTransactionJournalsPreviewJournalsResponse!-
commitNonCryptoTransactionJournalsCommitJournalsResponse!-
sumsubSumsubMutation-
smartWalletSendTransactionSmartWalletSendTransactionResponse-
adminSmartWalletSendTransactionSmartWalletSendTransactionResponse-
smartWalletSwapQuoteSwapQuoteResponse-
smartWalletSwapSwapResultResponse-
smartWalletExecuteSwapQuoteSwapResultResponseExecute 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.
generateSmartWalletJwtSmartWalletJwtResponse!-
createLimitOrderLimitOrderResponse!-
cancelLimitOrderLimitOrderResponse!-
createChildEnterpriseCreateChildEnterpriseResponse-
createGoAccountCreateGoAccountResponse-
initiateGoTradeGoTradeResponse-
cancelGoTradeCancelGoTradeResponse-
depositFiatToGoAccountGoFiatOperationResponse-
withdrawFiatFromGoAccountGoFiatOperationResponse-
postShareAdjustmentJournalEntryPostShareAdjustmentJeResult!-
createCardDisputeCreateCardDisputeResponse!-
uploadCardDisputeEvidenceUploadCardDisputeEvidenceResponse!-
cancelCardDisputeCancelCardDisputeResponse!-
revokeTokenRevokeTokenResponse!-
insertPartnerApiTokenInsertPartnerApiTokenResult!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.
rotatePartnerApiTokenRotatePartnerApiTokenResult!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.
replayPartnerWebhookDeliveryReplayPartnerWebhookDeliveryResult!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 synthetic test.ping delivery 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 the cardUserId you'll pass to createCardApplicationForPartnerUser. nationalId is 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. Pass id to 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. The signingSecret in 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

FieldTypeDescription
signMessageEvmSignedMessage-
verifyMessageEvmVerifiedMessage-

FieldTypeDescription
jobIdID!-
stepString!-
statusNavStepStatus!-
errorString-
durationMsInt-
atString!-

FieldTypeDescription
runIdID!-
fundIdInt!-
periodIdInt!-
statusString!-
steps[NavStepRecord!]!-
lockOnSuccessBoolean!-
overrideLockedPeriodBoolean!-
errorString-

FieldTypeDescription
stepString!-
statusString!-
startedAtString-
completedAtString-
errorString-

NudgeResponse

FieldTypeDescription
successBoolean!-
messageString-
lastNudgedAtString-
errorString-

OrderBookUpdate

FieldTypeDescription
channelString!-
typeString!-
productString!-
timeString!-
bids[[String!]!]!-
asks[[String!]!]!-
productMetaTradingProduct!-
midMarketPriceString!-
lastTradedPriceString!-
quotePriceString!-

OrganizationStatus

FieldTypeDescription
hasOrganizationBoolean!-
organizationIdString-
enterpriseNameString-

OtcQuote

FieldTypeDescription
iduuid!-
quote_status_idInt!-
created_attimestamptz!-
updated_attimestamptz!-
from_currencyString!-
to_currencyString!-
quote_sizeFloat!-
user_idString!-
sideString!-
quote_slippageFloat!-
quote_fee_percFloat!-
quote_exchange_rateFloat!-
total_amountFloat!-
expires_attimestamptz!-
base_currencyString!-
to_currency_rate_usdFloat!-
from_currency_rate_usdFloat!-

PartnerWithdrawalAllowlistResponse

Response from an allowlist upsert.

FieldTypeDescription
successBoolean!-
idInt-
errorString-

PatchAuth0UserInput (Input)

FieldTypeDescription
user_idID-
emailString-
email_verifiedBoolean-
pictureString-
created_atString-
updated_atString-
nameString-
given_nameString-
family_nameString-
nicknameString-
multifactor_last_modifiedString-
last_ipString-
last_loginString-
logins_countString-
cityString-
user_metadataAuth0ProfileMetadataInput-

PatchAuth0UserResponse

FieldTypeDescription
user_idID-
emailString-
email_verifiedBoolean-
usernameString-
phone_numberString-
phone_verifiedBoolean-
created_atString-
updated_atString-
identities[Auth0Identity]-
user_metadataAuth0ProfileMetadata-
pictureString-
nameString-
nicknameString-
multifactor[String]-
last_ipString-
last_loginString-
logins_countInt-
blockedBoolean-
given_nameString-
family_nameString-

PayInvoiceWithCardBalanceInput (Input)

FieldTypeDescription
invoiceIdInt!Invoice to pay
cardApplicationIdInt!Card application to charge (determines the card issuer user ID)

PayInvoiceWithCardBalanceResponse

FieldTypeDescription
successBoolean!-
chargeIdString-
amountFloat!-
invoiceIdInt!-

Ping

FieldTypeDescription
api_versionString!-
envString!-
timestampbigint!-
platform_base_urlString!-
domainString!-
nameString!-
user_idString-
client_idInt-
default_roleString-
roles[String]-
applicant_idString-

Platform

FieldTypeDescription
idInt!-
nameString!-
symbolString!-
slugString!-
token_addressString!-

PortfolioDashboard

FieldTypeDescription
idID!-
assets[DigitalAssetSummary]-
assetsAggregateDigitalAssetsAggregate-
whitelist[DigitalWalletWhitelistEntry]-
wallets[DigitalWalletSummary]-
walletDigitalWalletDetail-
usdValueString-
transactions[DigitalWalletTransactionSummary!]!-
transactionsAggregateDigitalWalletTransactionsAggregate!-

PostShareAdjustmentJeResult

FieldTypeDescription
successBoolean!-
adjustmentIdInt-
journalEntryIdInt-
skippedBoolean-
errorString-

PreviewJournalsResponse

FieldTypeDescription
successBoolean!-
previews[JournalEntryPreview!]!-
alreadySyncedCountInt!-
pendingCountInt!-
errorString-

ProcessAmortizationInput (Input)

FieldTypeDescription
fundIdInt!-
asOfDateString!-

ProcessAmortizationResponse

FieldTypeDescription
successBoolean!-
jobIdString-
messageString-
errorString-

ProcessExpenseAccrualsInput (Input)

FieldTypeDescription
fundIdInt-
expenseIdInt-
startDateString-
endDateString-

ProcessExpenseAccrualsResponse

FieldTypeDescription
successBoolean!-
jobIdString-
messageString-
errorString-

ProcessFeeAccrualsInput (Input)

FieldTypeDescription
fundIdInt!-
accrualDateString!-
dryRunBoolean-

ProcessFeeAccrualsResponse

FieldTypeDescription
successBoolean!-
jobIdString-
messageString-
errorString-

ProcessFundCustodyExpenseAccrualsInput (Input)

FieldTypeDescription
fundIdInt-
startDateString-
endDateString-

ProcessFundCustodyExpenseAccrualsResponse

FieldTypeDescription
successBoolean!-
jobIdString-
messageString-
errorString-

ProcessFundEndOfDayInput (Input)

FieldTypeDescription
processingDateString!-
skipDelayBoolean-
fundIdInt-

ProcessFundEndOfDayResponse

FieldTypeDescription
successBoolean!-
jobIdString-
messageString-
errorString-

ProcessSeriesRollupInput (Input)

FieldTypeDescription
fundIdInt!-
sourceSeriesIdInt!-
targetSeriesIdInt!-
accountingPeriodIdInt!-

ProcessSeriesRollupResponse

FieldTypeDescription
successBoolean!-
jobIdString-
messageString-
errorString-

ProposeAuditAdjustmentInput (Input)

FieldTypeDescription
fundIdInt!-
periodIdInt!-
glAccountIdInt!-
debitAmountFloat!-
creditAmountFloat!-
descriptionString!-
auditFirmNameString-
auditRefString-

ProvisionAllDefaultChainWalletsResponse

FieldTypeDescription
provisionedInt!-
alreadyExistedInt!-
failedInt!-
errors[String!]!-

ProvisionOrgWalletSessionKeysResponse

FieldTypeDescription
provisionedInt!-
skippedInt!-
failedInt!-
errors[String!]!-

Query

FieldTypeDescription
api_versionString-
pingPing-
auth0Auth0-
contextjsonb-
documentTemplateDictionaryDocumentTemplateDictionaryResponse-
coinPriceCoinPrice-
activeSessionSessionResponse-
sessionSessionResponse-
queueJobByIdBullJobResponse-
getPotentialKycProfiles[KycProfile!]!-
userExistsByEmailBoolean!-
sumsubQuestionnaireDataDecryptedSumsubQuestionnaire-
sumsubQuestionnaireDataDecryptedJsonbjsonb-
listSendGridTemplates[SendGridTemplate!]!-
getSendGridTemplateSendGridTemplateWithContent-
bitgoQueryBitgo-
redisRedisQuery!-
myWhitelistRequests[WhitelistRequest!]!-
smartWalletSessionKeysSmartWalletSessionKeysResponse-
tokenSparklineTokenSparklineGet 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.
tokenSparklineUrlStringGet sparkline rendered as a base64 SVG data URI.
Identifier can be: numeric token ID, CoinGecko slug, or symbol (case-insensitive).
coinMarketCapQueryCoinMarketCapToken-
sumsubSumsub-
previewFundInvestorsFundInvestorsPreview!-
validateTaskActionTaskValidationResult!-
crsDataQualityCrsDataQualitySummary-
crsReceivingCountries[CrsReceivingCountry!]!-
crsReportableFunds[CrsDataQualitySummary!]!-
tradingProducts[TradingProduct!]-
balancerPools[BalancerPool!]!-
balancerPoolBalancerPool-
balancerLPPriceBalancerLPPrice-
balancerLPPriceHistory[BalancerLPPriceHistoryItem!]!-
trainingVideoUrlTrainingVideoUrl!-
AgioOnboardingDocumentSearchAgioOnboardingDocumentSearchResponse-
kmsKMSQuery!-
userUser-
userByIdUser-
checkEmailVerificationStatusBoolean!-
adminAdmin-
digitalWalletSummaryByIdDigitalWalletSummary-
digitalWalletDetailByIdDigitalWalletDetail-
netWorthUsdByUserIdString-
netWorthUsdByOrganizationIdString-
digitalAssetsByUserId[DigitalAssetSummary]-
digitalAssetsByOrganizationId[DigitalAssetSummary]-
digitalAssetsByUserIdAggregateDigitalAssetsAggregate-
digitalAssetsByOrganizationIdAggregateDigitalAssetsAggregate-
cardBalanceCardBalanceResponse!Get balance for a Card.
Returns credit limit, pending charges, posted charges, balance due, and spending power.
Requires the user to own the card.
cardBalanceByExternalUserIdCardBalanceResponse!Admin-only: Get Card balance by the card issuer user ID. Bypasses ownership checks.
cardCorporateApplicationPrefillCardCorporateApplicationPrefill!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.
cardApplicationPrefillCardApplicationPrefill!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.
multiSendJobStatusMultiSendJobStatusResponse!Partner-only: poll the status of a multisend job (scoped to the caller's partner org).
cardFundSubClientStatusCardFundSubClientStatusResponse!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.
tradeSettlementTradeSettlement-
tradeSettlementsByRequest[TradeSettlement!]!-
financeQuotesFinanceResultMany-
financeQuoteFinanceResultOne-
financeQuotesCryptoFinanceResultMany-
chartDataFinanceChartResult-
chartDataBatch[FinanceChartResult]-
financeNews[FinanceNewsArticle]-

QueryBitgo

FieldTypeDescription
backupProviders[BitgoBackupProviderType]-
coinQueryBitgoCoin-
coins[QueryBitgoCoin]-
pendingApprovalsBitgoPendingApprovalsResponse-
pendingApprovalBitgoPendingApproval-

QueryBitgoCoin

FieldTypeDescription
coinIdString-
dataBitgoCoinData-
walletBitgoWallet-
wallets[BitgoWallet]-
keyBitgoKey-

QueryCoinMarketCapToken

FieldTypeDescription
latest[TokenInfo!]!-
upcomingAndNewTokens[TokenInfo!]!-
hotTokens[TokenInfo!]!-
sparklineSparkline-
sparklines[Sparkline!]!-

QuoteDetails

FieldTypeDescription
priceFloat!-
volume_24hFloat!-
volume_change_24hFloat!-
percent_change_1hFloat!-
percent_change_24hFloat!-
percent_change_7dFloat!-
percent_change_30dFloat!-
percent_change_60dFloat!-
percent_change_90dFloat!-
market_capFloat!-
market_cap_dominanceFloat!-
fully_diluted_market_capFloat!-
last_updatedString!-

QuoteType

FieldTypeDescription
USDQuoteDetails!-

RebuildTokensInput (Input)

FieldTypeDescription
tokenIds[Int!]-
dryRunBoolean!-
skipDeduplicationBoolean!-
batchSizeInt!-
waitForResultBoolean-

RecipientPreviewFull

FieldTypeDescription
audienceString!-
totalCountInt!-
rows[RecipientPreviewRow!]!-

RecipientPreviewRow

FieldTypeDescription
userIdID-
leadIdInt-
emailString!-
givenNameString-
familyNameString-
organizationContexts[String!]!-

RecomputeFundSpmPeriodResult

FieldTypeDescription
periodIdInt!-
skippedBoolean!-
errorString-

RecomputeFundSpmResult

FieldTypeDescription
fundIdInt!-
periods[RecomputeFundSpmPeriodResult!]!-
successBoolean!-
errorString-

ReconcileCoingeckoInput (Input)

FieldTypeDescription
dryRunBoolean!-
forceRefreshBoolean!-
maxNewTokensInt!-
waitForResultBoolean-

RecordFiatInboundInput (Input)

FieldTypeDescription
settlementIdInt!-
amountFloat!-
currencyString!-
bankReferenceString-
notesString-

RecordOutboundTransactionInput (Input)

FieldTypeDescription
settlementIdInt!-
txHashString!-

RecurringJEResult

FieldTypeDescription
generatedInt!-
skippedInt!-
errors[String!]!-

RedisKeyValue

FieldTypeDescription
keyString!-
valueString!-
statusRedisKeyStatus!-

RedisMutation

FieldTypeDescription
setBoolean!-
delBoolean!-
flushAllBoolean!-
flushAllSessionsInt!-
flushAllTransactionsInt!-
delPatternInt!-

RedisQuery

FieldTypeDescription
getValueString!-
getKeyValues[RedisKeyValue]!-
getKeys[String]!-
getKeyCountInt!-
statusRedisStatus!-
statsjsonb!-

RefreshBalancerLPPricesResponse

FieldTypeDescription
jobIdString-
totalPoolsInt!-
successBoolean!-
errorString-

RefreshOtcQuoteResponse

FieldTypeDescription
quoteOtcQuote-
errors[String!]-

RegisterBalancerPoolInput (Input)

FieldTypeDescription
poolIdString!-
poolAddressString!-
poolTypeString!-
balancerVersionBalancerVersion!-
networkBalancerNetwork!-
nameString-
symbolString-

RegisterBalancerPoolResponse

FieldTypeDescription
poolBalancerPool-
successBoolean!-
errorString-

RejectWhitelistRequestInput (Input)

FieldTypeDescription
requestIdInt!-
reasonString!-

RemovePolicyResponse

FieldTypeDescription
successBoolean!-
errorString-

RemoveWalletPolicyInput (Input)

FieldTypeDescription
digitalWalletIdInt!-
policyIdInt!-

RenderCaseDocumentsFilter (Input)

FieldTypeDescription
documentTemplateIds[uuid!]-
documentTypeNames[String!]-

ReplaceCardInput (Input)

Input for replacing an existing card (lost/stolen/damaged)

FieldTypeDescription
cardIdInt!Card ID (AgioCard_card.id - our internal card ID)
reasonCardReplacementReason!Reason for replacement
shippingAddressCardShippingInputShipping address for physical card replacement (required for physical cards)

ReplayPartnerWebhookDeliveryResult

FieldTypeDescription
successBoolean!-
newDeliveryIdStringThe id of the newly enqueued delivery — distinct from the original deliveryId.
errorCodeString-
errorMessageString-

RequestConvertDigitalAssetQuoteInput (Input)

FieldTypeDescription
walletIdID!-
fromCoinIdString-
toCoinIdString-
sizeString!-

RequestFundRedemptionSignatureResult

FieldTypeDescription
redemptionIdInt!-
invitedAtString!-
toEmailAddressString!-

RequestFundSubscriptionSignatureResult

FieldTypeDescription
subscriptionIdInt!-
invitedAtString!-
toEmailAddressString!-

RequestGoNetworkConnectionInput (Input)

FieldTypeDescription
goAccountIdInt!-
counterpartyIdString!-
counterpartyNameString-

RequestOtcQuoteInput (Input)

FieldTypeDescription
fromCurrencyString!-
toCurrencyString!-
sideString!-
sizeFloat!-
slippageFloat-
tradeTypeInt-
limitPriceFloat-

RequestOtcTradeInput (Input)

FieldTypeDescription
fromCoinString!-
toCoinString!-
sideString!-
sizeFloat!-
slippageFloat-
telegramMessageIdbigint-
fromWalletIdInt-
fromBankInfoIdInt-
toWalletIdInt-
toBankInfoIdInt-
feePercFloat-
limitPriceFloat-
expiresAttimestamptz-
tradeTypeInt-
quoteIduuid-

RequestQuoteTradeResponse

FieldTypeDescription
quoteOtcQuote-
errors[String!]-

RerunBackfillResponse

FieldTypeDescription
successBoolean!-
jobIdString-
errorString-

ResolvedPlaceAddress

Structured address resolved from a Google Place ID

FieldTypeDescription
line1String!-
cityString!-
regionString!-
postalCodeString!-
countryCodeString!-
countryString-
formattedAddressString-

ResolvePlaceAddressResponse

Response from resolving a place ID to a structured address

FieldTypeDescription
successBoolean!-
addressResolvedPlaceAddress-
errorString-

ResolveSettlementTransactionInput (Input)

FieldTypeDescription
settlementIdInt!-
txHashString!-
networkString!-
settlementWalletIdInt-

ResolveSwapSettlementInput (Input)

FieldTypeDescription
settlementIdInt!-
txHashString!-
networkString!-
walletAddressString!-

RevokeGoNetworkConnectionInput (Input)

FieldTypeDescription
connectionIdInt!-

RevokeSmartWalletSessionKeyInput (Input)

FieldTypeDescription
sessionIdString!-

RevokeSmartWalletSessionKeyResponse

FieldTypeDescription
successBoolean!-
errorString-

RevokeTokenInput (Input)

FieldTypeDescription
kindRevokeTokenKind!Discriminator: JTI revokes a specific jti, HASH revokes a credential by sha256 hex, USER revokes all active sessions for a sub
jtiStringRequired when kind=JTI
hashStringRequired when kind=HASH — 64-char lowercase hex sha256
credentialKindRevokeTokenCredentialKindRequired when kind=HASH — the type of credential this hash belongs to
subStringRequired when kind=USER or as audit payload on JTI — the Auth0 sub (auth0
ttlSecondsIntSeconds until the blacklist entry expires. Max 30 days (2592000). Defaults to 1 day.
reasonString!Free-text audit note; shown in admin listings and Cloud Logging

RevokeTokenResponse

FieldTypeDescription
successBoolean!-
revokedInt!Number of entries revoked. For USER: number of jtis fanned out. For JTI/HASH: always 1 when success=true.
errorStringSet on error paths only (e.g. cannot_revoke_self, invalid_request)

RotatePartnerApiTokenResult

FieldTypeDescription
successBoolean!-
clientSecretStringThe 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).
errorCodeString-
errorMessageString-

RotatePartnerWebhookSecretResult

FieldTypeDescription
successBoolean!-
signingSecretStringReturned 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.
previousSecretValidUntilString-
errorCodeString-
errorMessageString-

RunFullNavOpts (Input)

FieldTypeDescription
lockOnSuccessBoolean-
overrideLockedPeriodBoolean-
overrideReasonString-

SendAccountFundingEmailInput (Input)

FieldTypeDescription
userIdString-
toEmailAddressString-
toFirstNameString-

SendBulkInvoiceEmailsInput (Input)

FieldTypeDescription
invoiceIds[Int!]!-

SendBulkInvoiceEmailsResponse

FieldTypeDescription
totalRequestedInt!-
totalSentInt!-
totalFailedInt!-
totalSkippedInt!-
results[BulkInvoiceEmailResult!]!-

SendCaseStatusUpdateEmailInput (Input)

FieldTypeDescription
toEmailAddressString-
firstNameString-
caseIdInt-
oldStatusString-
newStatusString-
notesString-

SendCESRAEmailInput (Input)

FieldTypeDescription
caseIdInt-
toEmailAddressString-
toFirstNameString-

SendEmailSharePageInput (Input)

FieldTypeDescription
toEmailString!-
toFirstNameString!-
subjectString!-
bodyString!-
pageUrlString!-
buttonTextString-

SendFundInvestorContactEmailInput (Input)

FieldTypeDescription
fundIdInt!-
categoryString!-
subjectString!-
messageString!-

SendGridClientResponse

FieldTypeDescription
statusCodeInt-
bodyjsonb-

SendGridTemplate

FieldTypeDescription
idString!-
nameString!-
generationString!-
updatedAtString-
versions[SendGridTemplateVersion!]!-

SendGridTemplateVersion

FieldTypeDescription
idString!-
nameString-
subjectString-
activeBoolean!-
updatedAtString-
thumbnailUrlString-
editorString-

SendGridTemplateVersionWithContent

FieldTypeDescription
idString!-
nameString-
subjectString-
htmlContentString-
plainContentString-
activeBoolean!-
updatedAtString-
thumbnailUrlString-
variables[String!]!-

SendGridTemplateWithContent

FieldTypeDescription
idString!-
nameString!-
generationString!-
updatedAtString-
activeVersionSendGridTemplateVersionWithContent-
versions[SendGridTemplateVersion!]!-

SendKycEmailInput (Input)

FieldTypeDescription
toEmailAddressString-
fromFirstNameString-
fromLastNameString-
toFirstNameString-
toLastNameString-
caseIdInt-
notesString-
inviteIdString-
kycLevelString-

SendMassEmailInput (Input)

FieldTypeDescription
subjectString!-
bodyHtmlString-
sendGridTemplateIdString-
templateDatajsonb-
testEmailString-
dryRunBoolean-
validateOnlyBoolean-
segmentIdID-
adHocFilterEmailSegmentFilter-
leadListIdID-
leadIds[Int!]-
categoryEmailCategory-
fundInvestorRecipientsFundInvestorRecipientsInput-
attachments[MassEmailAttachmentInput!]-

SendMassEmailResponse

FieldTypeDescription
totalRecipientsInt!-
totalSentInt!-
totalFailedInt!-
results[MassEmailRecipientResult!]-
campaignIdID-

SendSignatureInviteEmailInput (Input)

FieldTypeDescription
toEmailAddressString!-
toFirstNameString!-
toLastNameString!-
caseIdInt!-
notesString-
inviteIdString!-

SendStandaloneKycInviteInput (Input)

FieldTypeDescription
toEmailString!-
toFirstNameString!-
toLastNameString!-
defaultAppIdInt!-
sumsubLevelIdInt!-
fromFirstNameString-
fromLastNameString-
notesString-
organizationMemberUserIdString-
kycLevelString-

SendTestCampaignEmailInput (Input)

FieldTypeDescription
toEmailString!-
subjectString-
bodyHtmlString-
sendGridTemplateIdString-
dynamicTemplateDataJSON-
landingUrlString-

SendTrainingReminderResult

FieldTypeDescription
sentBoolean!-
emailString!-

SendWireTransferEmailInput (Input)

FieldTypeDescription
wireTransferIdInt!-
overrideEmailString-
overrideCcEmails[String!]-
customMessageString-

SendWireTransferEmailResponse

FieldTypeDescription
successBoolean!-
sentToString-
ccEmails[String!]-
errorString-

ServicesStatus

FieldTypeDescription
idID!-
nameString-
statusServicesStatusType-
messageString-
lastUpdatedtimestamptz-
datajsonb-
durationMsInt-

SessionResponse

FieldTypeDescription
idID!-
userIdString-
activeBoolean!-
timestamptimestamptz!-
allowedFunds[Int!]!-
allowedOrganizations[uuid!]!-

SetCardPinInput (Input)

Input for setting a card PIN

FieldTypeDescription
cardIdInt!Card ID (AgioCard_card.id - our internal card ID)
sessionIdString!Session ID from generateEncryptionKeys mutation
encryptedPinString!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)

FieldTypeDescription
userIdString!Target user's Auth0 user_id (e.g., 'auth0
applicantIdString24-char hex Sumsub applicant id. Pass null to detach.
serviceRequestIduuidService request UUID (kyc_transfer type). Required when changeReason = kyc_transfer.
changeReasonSumsubApplicantChangeReason!Reason for the change. Required when overwriting a non-null existing value.

SetSumsubApplicantIdResult

FieldTypeDescription
userIdString!-
previousApplicantIdString-
applicantIdString-
serviceRequestRefNoStringService request that was auto-marked completed (null if no SR fulfilled).
changeReasonSumsubApplicantChangeReason!-

SignFundAgreementInput (Input)

FieldTypeDescription
fundIdInt!-
signatureBase64String!-
transactionTypeString!-
organizationIdString-
amountFloat-
fundNavIdInt-
sharePriceOverrideFloat-
subscriptionIdInt-
redemptionIdInt-
isFullRedemptionBoolean-

SignFundAgreementResult

FieldTypeDescription
agreementIdInt!-
subscriptionIdInt-
redemptionIdInt-
pdfUrlString!-

SmartWalletErrorResponse

Structured error response for smart wallet operations

FieldTypeDescription
codeString!Error code (e.g., INSUFFICIENT_BALANCE, SWAP_NOT_SUPPORTED)
messageString!Human-readable error message
detailsStringAdditional error details as JSON string (optional)

SmartWalletExecuteSwapQuoteInput (Input)

FieldTypeDescription
quoteIdInt!The quoteId returned from smartWalletSwapQuote (database ID)

SmartWalletJwtResponse

FieldTypeDescription
jwtString!-
expiresAtInt!-
subjectIdString!-
scopeSmartWalletSubjectScope!-

SmartWalletSendTransactionInput (Input)

FieldTypeDescription
digitalWalletIdID!-
recipientString!-
amountString!-
dataString-
saveToAddressBookBoolean-
addressBookNicknameString-

SmartWalletSendTransactionResponse

FieldTypeDescription
successBoolean!-
transactionHashString-
errorString-
structuredErrorSmartWalletErrorResponse-

SmartWalletSessionKey

FieldTypeDescription
idInt!-
sessionIdString!-
sessionKeyAddressString!-
expiredBoolean!-
revokedBoolean!-
revokedAttimestamptz-
expiresAttimestamptz-
lastUsedAttimestamptz-
createdAttimestamptz!-

SmartWalletSessionKeysResponse

FieldTypeDescription
walletIdInt!-
smartWalletIdInt!-
addressString!-
chainString!-
chainIdInt!-
deployedBoolean!-
sessionKeys[SmartWalletSessionKey!]!-

SmartWalletSwapInput (Input)

FieldTypeDescription
digitalWalletIdID!-
fromTokenString!-
toTokenString!-
amountString!Amount in wei (smallest unit). Frontend must convert human-readable to wei using token decimals.
toChainIdInt-
recipientStringOptional 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

FieldTypeDescription
training_version_idInt!-
snooze_countInt!-
last_snooze_attimestamptz!-
snoozed_untiltimestamptz!-

Sparkline

FieldTypeDescription
idID!-
price_usd[Float!]!-
timestamp[Int!]!-

SubmitQuoteQuestionInput (Input)

FieldTypeDescription
quoteIdInt!-
lineItemIdInt-
questionString!-
changeTypeString-

SubmitQuoteQuestionResponse

FieldTypeDescription
successBoolean!-
errorString-
questionIdInt-

SubmitWhitelistRequestInput (Input)

FieldTypeDescription
digitalWalletIdInt!-
addressString!-
chainIdInt-
labelString-
notesString-

SubscribePartnerWebhookInput (Input)

FieldTypeDescription
urlString!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

FieldTypeDescription
successBoolean!-
subscriptionIdID-
signingSecretStringReturned 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).
errorCodeString-
errorMessageString-

Subscription

FieldTypeDescription
pingString-
shortLivedTokenString-
memoryString-
orderBookUpdates[OrderBookUpdate!]-
tradeOrderUpdatesTradeOrderUpdate-
navCalcProgressNavCalcEvent-

Sumsub

FieldTypeDescription
getApplicantjsonb-
getApplicantByApplicantIdjsonb-
getApplicantTypedSumsubApplicantResponse-
meSumsubApplicantResponse-
applicantLevels[String]-
getApplicantLevels[SumsubApplicantLevelItem!]!-
getApplicantLevelSumsubApplicantLevelItem-
applicantReportPdfString-
applicants[SumsubApplicantResponse]-
tokenByJwtSumsubTokenResponse-
tokenSumsubTokenResponse-
completeProfileTokenSumsubTokenResponse-
guestTokenSumsubTokenResponse-
organizationKybTokenSumsubTokenResponse-

SumsubAmlWatcherSettings

FieldTypeDescription
categories[String!]!-
fuzzinessString!-

SumsubApplicantIdentifiers (Input)

FieldTypeDescription
emailString-
phoneString-

SumsubApplicantInsightSettings

FieldTypeDescription
advancedEmailCheckEnabledBoolean!-
advancedPhoneCheckEnabledBoolean!-
advancedIpCheckEnabledBoolean!-
advancedIdentityEnrichmentEnabledBoolean-

SumsubApplicantLevelItem

FieldTypeDescription
idID!-
clientIdString!-
nameString!-
descString-
requiredIdDocsSumsubRequiredIdDocs!-
websdkFlowIdString-
msdkFlowIdString-
websdkNextBoolean-
notificationSettingsSumsubNotificationSettings-
createdSumsubDateInfo!-
modifiedSumsubDateInfo!-
createdAttimestamptz!-
createdByString!-
modifiedAttimestamptz!-
modifiedByString-
useCustomIdDocSettingsBoolean-
customPrivacyNoteTextString-
customPrivacyLinkString-
watchListCheckSettingsSumsubWatchListCheckSettings-
useCustomWatchListCheckSettingsBoolean-
applicantInsightSettingsSumsubApplicantInsightSettings-
kytSettingsSumsubKytSettings-
checkSourceSettingsjsonb-
typeString-
actionTypeString-
applicantTypeString!-
autoCheckGeneratorSettingsSumsubAutoCheckGeneratorSettings-

SumsubApplicantResponse

FieldTypeDescription
idID!-
applicantjsonb-
applicantIdString-
externalUserIdString-
levelNameString-
approvedBoolean-
userIdString-
questionnaireIdString-
applicantStatusjsonb-
requiredIdDocsStatusjsonb-
requiredDocuments[SumsubRequiredDocument]-
sourceKeyStringRepresents client_id
sourceKeyIntInt-

SumsubAutoCheckGeneratorSettings

FieldTypeDescription
autoCheckModeString-
kybTypeString-

SumsubBulkSyncResponse

FieldTypeDescription
successBoolean!-
messageString!-
totalProcessedInt!-
totalSuccessInt!-
totalFailedInt!-
totalSkippedInt!-

SumsubCaptureParams

FieldTypeDescription
inputTypeString!-

SumsubClearAllTransactionsResponse

FieldTypeDescription
successBoolean!-
messageString!-
totalItemsInt!-

SumsubCompanyDocsGroupDefinition

FieldTypeDescription
labelString!-
subTypes[String!]!-
requiredBoolean!-

SumsubComplyAdvantageSettings

FieldTypeDescription
warningTypes[String!]!-
fuzzinessString!-

SumsubDateInfo

FieldTypeDescription
datetimestamptz!-
clientSubjectString-
subjectIdString-

SumsubDeleteTransactionResponse

FieldTypeDescription
successBoolean!-
messageString!-
transactionIdString!-

SumsubDocSet

FieldTypeDescription
idDocSetTypeString!-
types[String!]-
subTypes[String!]-
videoRequiredString-
captureParamsSumsubCaptureParams-
captureModeString-
uploaderModeString-
nfcVerificationSettingsSumsubNfcVerificationSettings-
fields[SumsubDocumentField!]-
steps[SumsubKybStep!]-
companyDocsGroupDefinitions[SumsubCompanyDocsGroupDefinition!]-
questionnaireDefIdString-
paymentMethods[jsonb!]-
poaStepSettingsIdString-

SumsubDocumentField

FieldTypeDescription
nameString!-
requiredBoolean!-
prefillString-
immutableIfPresentBoolean-

SumsubFile

FieldTypeDescription
idString-
reviewAnswerSumsubReviewAnswer-
uriString-
base64String-
typeString-
mimeTypeString-
inspectionIdString-

SumsubFixedInfoAddress

FieldTypeDescription
countryStringAlpha-3 country code (e.g. DEU or RUS)
postCodeString-
townString-
streetString-
subStreetString-
stateString-
buildingNameString-
flatNumberString-
buildingNumberString-
startDateStringDate format YYYY-mm-dd, e.g. 2001-09-25
endDateStringDate format YYYY-mm-dd, e.g. 2001-09-25
formattedAddressString-

SumsubFixedInfoAddressInput (Input)

FieldTypeDescription
countryStringAlpha-3 country code (e.g. DEU or RUS)
postCodeString-
townString-
streetString-
subStreetString-
stateString-
buildingNameString-
flatNumberString-
buildingNumberString-
startDateStringDate format YYYY-mm-dd, e.g. 2001-09-25
endDateStringDate format YYYY-mm-dd, e.g. 2001-09-25
formattedAddressString-

SumsubFixedInfoInput (Input)

FieldTypeDescription
firstNameStringApplicant first name in the original language
lastNameStringApplicant last name in the original language
middleNameStringApplicant middle name in the original language
firstNameEnString-
lastNameEnString-
middleNameEnString-
legalNameStringLegal name of the company the applicant is related to (UBO or shareholder)
genderStringApplicant gender (M or F)
dobStringDate of birth (format YYYY-mm-dd, e.g. 2001-09-25)
placeOfBirthStringPlace of birth. This can be a city, a town or another settlement type
countryOfBirthStringCountry of birth. Alpha-3 country code (e.g. DEU, GBR, ARG)
stateOfBirthStringState, region, district, county or another territorial entity of birth inside a country, if applicable
countryStringCountry of the last uploaded ID document, may differ from country of birth. Alpha-3 country code (e.g. DEU, GBR, ARG)
nationalityStringCountry of origin. Alpha-3 country code (e.g. DEU, GBR, ARG)
addresses[SumsubFixedInfoAddressInput!]-
phoneString-
tinStringTaxpayer identification number that is unique to each taxpayer

SumsubFixedInfoResponse

FieldTypeDescription
firstNameStringApplicant first name in the original language
lastNameStringApplicant last name in the original language
middleNameStringApplicant middle name in the original language
firstNameEnString-
lastNameEnString-
middleNameEnString-
legalNameStringLegal name of the company the applicant is related to (UBO or shareholder)
genderStringApplicant gender (M or F)
dobStringDate of birth (format YYYY-mm-dd, e.g. 2001-09-25)
placeOfBirthStringPlace of birth. This can be a city, a town or another settlement type
countryOfBirthStringCountry of birth. Alpha-3 country code (e.g. DEU, GBR, ARG)
stateOfBirthStringState, region, district, county or another territorial entity of birth inside a country, if applicable
countryStringCountry of the last uploaded ID document, may differ from country of birth. Alpha-3 country code (e.g. DEU, GBR, ARG)
nationalityStringCountry of origin. Alpha-3 country code (e.g. DEU, GBR, ARG)
addresses[SumsubFixedInfoAddress!]-
phoneString-
tinStringTaxpayer identification number that is unique to each taxpayer

SumsubIdDocError

FieldTypeDescription
codeString!-
messageString!-
fieldString-

SumsubIdDocMetaData

FieldTypeDescription
idDocTypeSumsubIdDocType!-
idDocSubTypeSumsubIdDocSubType-
countryString!3-letter country code (Wikipedia)
firstNameString-
middleNameString-
lastNameString-
issuedDateStringDate format YYYY-mm-dd, e.g. 2001-09-25
validUntilStringDate format YYYY-mm-dd, e.g. 2001-09-25
numberString-
dobStringDate of birth format YYYY-mm-dd, e.g. 2001-09-25
placeOfBirthString-

SumsubIdDocMetaDataInput (Input)

FieldTypeDescription
idDocTypeSumsubIdDocType!-
idDocSubTypeSumsubIdDocSubType-
countryString!3-letter country code (Wikipedia)
firstNameString-
middleNameString-
lastNameString-
issuedDateStringDate format YYYY-mm-dd, e.g. 2001-09-25
validUntilStringDate format YYYY-mm-dd, e.g. 2001-09-25
numberString-
dobStringDate of birth format YYYY-mm-dd, e.g. 2001-09-25
placeOfBirthString-

SumsubIdDocMetaDataResponse

FieldTypeDescription
dataSumsubIdDocMetaDataWithErrors!-
imageIdString-
correlationIdString-

SumsubIdDocMetaDataWithErrors

FieldTypeDescription
idDocTypeSumsubIdDocType!-
idDocSubTypeSumsubIdDocSubType-
countryString!3-letter country code (Wikipedia)
firstNameString-
middleNameString-
lastNameString-
issuedDateStringDate format YYYY-mm-dd, e.g. 2001-09-25
validUntilStringDate format YYYY-mm-dd, e.g. 2001-09-25
numberString-
dobStringDate of birth format YYYY-mm-dd, e.g. 2001-09-25
placeOfBirthString-
errors[SumsubIdDocError!]-
warnings[SumsubIdDocWarning!]-

SumsubIdDocWarning

FieldTypeDescription
codeString!-
messageString!-
fieldString-

SumsubKybSettings

FieldTypeDescription
shareholderThresholdInt-
uboThresholdInt-
disableCompanySearchAndPrefillBoolean-
createKycTxnsBoolean-

SumsubKybStep

FieldTypeDescription
nameString!-
minDocsCntInt!-
applicantLevelNameString-
idDocTypes[String!]-
idDocSubTypes[String!]-
fields[SumsubDocumentField!]-
customFieldsjsonb-
captureModeString-

SumsubKytSettings

FieldTypeDescription
createKycTxnsBoolean-

SumsubMutation

FieldTypeDescription
tokenByJwtSumsubTokenResponse-
tokenSumsubTokenResponse-
completeProfileTokenSumsubTokenResponse-
guestTokenSumsubTokenResponse-
organizationKybTokenSumsubTokenResponse-
createOrGetApplicantForUserCreateOrGetApplicantForUserResult!-
createOrGetApplicantForOrganizationCreateOrGetApplicantForUserResult!-
generateWebSDKLinkString!-
generateWebSDKLinkCompleteProfileString!-
addIdDocumentSumsubIdDocMetaDataResponse!-
addIdDocumentByUserOrganizationInviteIdSumsubIdDocMetaDataResponse!-
patchFixedInfoSumsubFixedInfoResponse!-
clearAllTransactionsSumsubClearAllTransactionsResponse!-
deleteTransactionByIdSumsubDeleteTransactionResponse!-
deleteTransactionByUtlIdSumsubDeleteTransactionResponse!-
syncTransactionSumsubSyncTransactionResponse!-
syncPendingTransactionsSumsubBulkSyncResponse!-
attachKybBeneficiaryAttachKybBeneficiaryResult!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.
detachKybBeneficiarySumsubOkResponse!Remove a beneficiary from the org's KYB 2.0 company structure.
Uses the junction record ID (not the applicant ID) returned from attachKybBeneficiary.
sendKybBeneficiaryRemindersSumsubOkResponse!Send Sumsub verification reminder emails to all pending beneficiaries
of the org's company applicant (max 100 per call).
setSumsubApplicantIdSetSumsubApplicantIdResult!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

FieldTypeDescription
modeString!-

SumsubNotificationSettings

FieldTypeDescription
applicantNotificationStates[String!]!-

SumsubOkResponse

FieldTypeDescription
okBoolean!-

SumsubQuantifindSettings

FieldTypeDescription
minRiskLevelString!-
minConfidenceLevelString!-

SumsubQuestionnaire

FieldTypeDescription
idString!-
titleString-
sections[SumsubQuestionnairSection]-
applicantIdString-

SumsubQuestionnaireItem

FieldTypeDescription
idString!-
titleString-
valueString-
values[String]-
typeString-
files[SumsubFile]-

SumsubQuestionnairSection

FieldTypeDescription
idString!-
titleString-
items[SumsubQuestionnaireItem!]!-

SumsubRequiredDocument

FieldTypeDescription
idString!-
nameString-
typeString-
files[SumsubFile]-
reviewAnswerSumsubReviewAnswer-
forbiddenBoolean-
questionnaireDataSumsubQuestionnaire-

SumsubRequiredIdDocs

FieldTypeDescription
videoIdentBoolean-
videoIdentUploadTypes[String!]-
stepsOutsideVideoId[String!]-
excludedCountries[String!]-
docSets[SumsubDocSet!]!-
kybSettingsSumsubKybSettings-

SumsubSyncTransactionResponse

FieldTypeDescription
successBoolean!-
messageString!-
utlIdInt!-
sumsubTransactionIdString-

SumsubTokenResponse

FieldTypeDescription
tokenString-
levelNameString-
userIdString-
externalActionIdString-
sourceKeyString-
applicantIdString-
externalUserIdString-

SumsubWatchListCheckSettings

FieldTypeDescription
complyAdvantageSumsubComplyAdvantageSettings-
quantifindSumsubQuantifindSettings-
amlWatcherSumsubAmlWatcherSettings-

SwapFeePayment

FieldTypeDescription
sponsoredBoolean!-
tokenAddressString!-
maxAmountString!-

SwapGasEstimate

FieldTypeDescription
callGasLimitString!-
verificationGasLimitString!-
preVerificationGasString!-
maxFeePerGasString!-
maxPriorityFeePerGasString!-

SwapPlatformFee

FieldTypeDescription
feeBpsInt!-
feeAmountWeiString!-
feeTokenAddressString!-
feeChainIdInt!-
feeReasonString-

SwapQuoteData

Raw quote data without response wrapper

FieldTypeDescription
fromAmountString!-
minimumToAmountString!-
expirytimestamptz!Expiry timestamp as ISO 8601 datetime string
quoteIdIntDatabase quote ID for executing the swap. May be null if quote persistence failed.
feePaymentSwapFeePayment-
platformFeeSwapPlatformFee-
gasEstimateSwapGasEstimate-
priceImpactPctFloatPrice impact percentage including all fees (null if unavailable from provider)
amountInUsdFloatUSD value of input amount (null if unavailable from provider)
amountOutUsdFloatUSD value of expected output (null if unavailable from provider)
networkFeeUsdFloatTotal network/solver fee in USD (null if unavailable from provider)
estimatedFillSecondsIntEstimated fill time in seconds — primarily meaningful for cross-chain swaps (null if unavailable)
routeSwapRouteRoute 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

FieldTypeDescription
successBoolean!-
quoteSwapQuoteData-
errorString-
structuredErrorSmartWalletErrorResponse-

SwapResultResponse

FieldTypeDescription
successBoolean!-
transactionHashString-
quoteIdInt-
errorString-
quoteSwapQuoteData-
structuredErrorSmartWalletErrorResponse-
sourceWalletIdInt-
destinationWalletIdInt-
refreshedBalances[WalletTokenBalance!]-
statusStringSwap 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

FieldTypeDescription
providerSwapProvider!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)

FieldTypeDescription
providerString!-
fromTokenString!-
toTokenString!-
fromChainIdInt!-
toChainIdInt!-

SyncApplicantQuestionnaireInput (Input)

FieldTypeDescription
applicantIdString!-
questionnaireDatajsonb!-
logErrorsBoolean-

SyncApplicantQuestionnaireResponse

FieldTypeDescription
successBoolean!-
applicantIdString!-
questionnaireIdString-
errorString-
skippedBoolean-
reasonString-

SyncCoinlistPlatformsInput (Input)

FieldTypeDescription
dryRunBoolean-
forceRefreshBoolean-
symbolString-
waitForResultBoolean-
phases[SyncCoinlistPhase!]Run only specific phases. Omit to run all.

SynchronizeEnzymeVaultsInput (Input)

FieldTypeDescription
startDateString!-
endDateString!-
fundIdInt-
syncNavsAndFeesBoolean-
syncVaultActivitiesBoolean-
syncVaultPortfolioBoolean-
syncVaultDepositorsBoolean-
backfillAssetValuationsBoolean-
calculateCostBasisBoolean-

SynchronizeEnzymeVaultsResponse

FieldTypeDescription
successBoolean!-
messageString-
errorString-
runIdInt-

SyncSafesInput (Input)

FieldTypeDescription
digitalWalletIdInt-

SyncSafesResponse

FieldTypeDescription
successBoolean!-
jobIdString-
messageString-
errorString-

SyncWhitelistInput (Input)

FieldTypeDescription
digitalWalletIdInt!-
directionString!-

SyncWhitelistResponse

FieldTypeDescription
successBoolean!-
entriesAddedInt-
entriesRemovedInt-
entriesUnchangedInt-
discrepanciesjsonb-
errorString-

TaskValidationResult

FieldTypeDescription
validBoolean!-
results[TaskValidationRuleResult!]!-
blockers[TaskValidationRuleResult!]!-
warnings[TaskValidationRuleResult!]!-
correctionTasksCreated[Int!]!-

TaskValidationRuleResult

FieldTypeDescription
ruleIdInt!-
ruleTypeString!-
passedBoolean!-
actionString!-
messageString!-
correctionTaskIdInt-

TestPartnerWebhookSubscriptionResult

FieldTypeDescription
successBoolean!-
enqueuedAtStringEventually-consistent — the test delivery is enqueued; check delivery history for outcome.
errorCodeString-
errorMessageString-

TokenInfo

FieldTypeDescription
idInt!-
nameString!-
symbolString!-
slugString!-
num_market_pairsInt!-
date_addedString!-
max_supplyFloat-
circulating_supplyFloat!-
total_supplyFloat!-
is_activeInt!-
infinite_supplyBoolean!-
platformPlatform-
cmc_rankFloat!-
is_fiatInt!-
self_reported_circulating_supplyFloat-
self_reported_market_capFloat-
tvl_ratioFloat-
last_updatedString!-
quoteQuoteType-
sparklineSparkline!-
sparklineUrlString!-

TokenSparkline

FieldTypeDescription
tokenIdInt!-
symbolString!-
prices[Float!]!-
timestamps[Int!]!-
percentageChangeFloat!-
periodTokenSparklinePeriod!-

TrackBalancerPoolResponse

FieldTypeDescription
poolBalancerPool-
jobIdString-
successBoolean!-
errorString-

TradeOrderUpdate

FieldTypeDescription
channelString!-
timeString!-
accountIdString!-
orderIdString!-
clientOrderIdString!-
productString!-
statusString!-
typeString!-
sideString!-
quantityString!-

TradeSettlement

FieldTypeDescription
idInt!-
tradeRequestIduuid!-
settlementTypeIdInt!-
settlementStatusIdInt!-
settlementTypeNameString-
settlementStatusNameString-
inboundTransactionHashString-
inboundFromAddressString-
inboundToAddressString-
inboundAmountFloat-
inboundTokenSymbolString-
inboundTokenAddressString-
inboundNetworkString-
inboundConfirmationsInt-
inboundConfirmedAttimestamptz-
inboundProviderString-
outboundTransactionHashString-
outboundToAddressString-
outboundToDigitalWalletIdInt-
outboundInitiatedAttimestamptz-
outboundConfirmedAttimestamptz-
outboundProviderString-
outboundWireTransferIdInt-
swapTransactionHashString-
swapInputTokenSymbolString-
swapInputAmountFloat-
swapOutputTokenSymbolString-
swapOutputAmountFloat-
swapNetworkString-
swapWalletAddressString-
swapConfirmedAttimestamptz-
amountGrossFloat!-
feeAmountFloat!-
amountNetFloat!-
settlementCurrencyString!-
amountGrossUsdFloat-
feeAmountUsdFloat-
amountNetUsdFloat-
usdRateFloat-
notesString-
verifiedByUserIdString-
verifiedAttimestamptz-
completedAttimestamptz-
failedReasonString-
createdByUserIdString-
createdAttimestamptz!-
updatedAttimestamptz!-

TradeSettlementAudit

FieldTypeDescription
idInt!-
tradeSettlementIdInt!-
actionString!-
oldStatusIdInt-
newStatusIdInt-
notesString-
metadataJSON-
createdByUserIdString-
createdAttimestamptz!-

TradeSettlementListResponse

FieldTypeDescription
settlements[TradeSettlement!]!-
successBoolean!-
errorString-

TradeSettlementResponse

FieldTypeDescription
settlementTradeSettlement-
successBoolean!-
errorString-

TradingPair

FieldTypeDescription
baseCurrencyString!-
quoteCurrencyString!-
minTradeSizeString!-

TradingProduct

FieldTypeDescription
idString!-
nameString!-
baseCurrencyIdString!-
baseCurrencyString!-
quoteCurrencyIdString!-
quoteCurrencyString!-
baseMinSizeString!-
baseMaxSizeString-
baseIncrementString-
quoteMinSizeString!-
quoteIncrementString!-
isTradeDisabledBoolean-

TrainingVideoUrl

FieldTypeDescription
urlString!-
modeString!-
expiresAttimestamptz-

TransferDigitalAssetInput (Input)

FieldTypeDescription
walletIdID!-
fromCoinIdString-
fromCoinAddressString-
toCoinIdString-
toCoinAddressString-
sizeString!-

UnsubscribePartnerWebhookResult

FieldTypeDescription
successBoolean!-
errorCodeString-
errorMessageString-

UpdateCardCompanyAddressInput (Input)

Input for updating the card issuer company address

FieldTypeDescription
cardApplicationIdInt!Card application ID to identify the the card issuer company
addressCardAddressInput!Updated company address

UpdateCardLimitInput (Input)

Input for updating a Card's spending limit

FieldTypeDescription
cardIdInt!Card ID (AgioCard_card.id - our internal card ID)
limitAmountInt!Limit amount in cents (e.g., 50000 = $500.00)
limitFrequencyCardLimitFrequency!Limit frequency period

UpdateCardUserProfileInput (Input)

Input for updating the card issuer user billing address

FieldTypeDescription
cardApplicationIdInt!Card application ID to identify the the card issuer user
addressCardAddressInput!Updated billing address

UpdateEmailSegmentInput (Input)

FieldTypeDescription
nameString-
descriptionString-
filterEmailSegmentFilter-
categoryEmailCategory-

UpdateSettlementStatusInput (Input)

FieldTypeDescription
settlementIdInt!-
statusIdInt!-
notesString-

UploadCardDisputeEvidenceResponse

FieldTypeDescription
successBoolean!-
errorString-

UpsertPartnerWithdrawalAllowlistInput (Input)

Admin input for upserting a partner withdrawal-recipient allowlist entry.

FieldTypeDescription
idIntExisting entry id to update; omit to insert a new entry.
partnerOrganizationIduuid!The partner organization the allowlist entry belongs to.
addressString!Approved recipient (Treasury) address.
chainIdInt!Chain id the address is approved on.
labelString-
notesString-
statusString!pending

User

FieldTypeDescription
idID-
user_idString-
portfolioDashboardPortfolioDashboard-

UserCreateUserAccountInviteInput (Input)

FieldTypeDescription
emailString!-
givenNameString!-
familyNameString!-
redirectUrlString-
extraMessageString-

UserFilterInput (Input)

FieldTypeDescription
hasFundedBoolean-
emailVerifiedBoolean-
servicesUsed[String!]-
countryCodes[String!]-
kycStatuses[String!]-
roles[String!]-
languages[String!]-
createdAftertimestamptz-
lastLoginAftertimestamptz-
fundIds[Int!]-
includeOrgAdminsForOrgPositionsBoolean-

UserOrganizationFilterInput (Input)

FieldTypeDescription
organizationIds[ID!]-
countryCodes[String!]-
kybStatuses[String!]-
hasFundSubscriptionBoolean-
createdAftertimestamptz-

ValidateAddressInput (Input)

Input for validating an address

FieldTypeDescription
addressCardAddressInput!Address to validate before creating cards, shipping groups, or billing operations

VerifySettlementInput (Input)

FieldTypeDescription
settlementIdInt!-
approvedBoolean!-
notesString-

VerifyTokenChainsInput (Input)

FieldTypeDescription
tokenIdInt-
recheckBoolean!-
batchSizeInt!-
dryRunBoolean!-
waitForResultBoolean-

WalletPolicy

FieldTypeDescription
idInt!-
digitalWalletIdInt!-
bitgoPolicyIdString-
policyTypeString!-
configjsonb!-
isActiveBoolean!-
createdByString!-
createdAttimestamptz!-
updatedAttimestamptz!-

WalletPolicyAuditEntry

FieldTypeDescription
idInt!-
walletPolicyIdInt!-
actionString!-
previousConfigjsonb-
newConfigjsonb-
performedByString!-
notesString-
createdAttimestamptz!-

WalletTokenBalance

FieldTypeDescription
digitalWalletIdInt!-
tokenSymbolString!-
tokenNameString-
balanceString!-
currentValueUsdString-
latestTokenPriceString-
tokenLogoUrlString-
tokenIdInt!-
networkIdInt-
networkNameString-
decimalsInt-
contractAddressString-
isSpamBoolean-
dataSourceString-

WebhookPayload

FieldTypeDescription
idInt!-
typeString!-
stateString!-
walletIdString-
hashString-
transferString-
coinString-
pendingApprovalIdString-
createdAttimestamptz!-

WebhookPayloadPage

FieldTypeDescription
payloads[WebhookPayload!]!-
countInt!-

WebhookStats

FieldTypeDescription
transactionWebhooksInt!-
pendingApprovalWebhooksInt!-
totalWebhooksInt!-

WhitelistDiff

FieldTypeDescription
bitgoOnly[WhitelistDiffEntry!]!-
internalOnly[WhitelistDiffEntry!]!-
matchedInt!-

WhitelistDiffEntry

FieldTypeDescription
addressString!-
labelString!-

WhitelistEntryInput (Input)

FieldTypeDescription
addressString!-
labelString!-

WhitelistRequest

FieldTypeDescription
idInt!-
userIdString!-
organizationIduuid!-
digitalWalletIdInt!-
addressString!-
chainIdInt-
labelString-
notesString-
statusString!-
reviewedByString-
reviewedAttimestamptz-
rejectionReasonString-
bitgoPendingApprovalIdString-
createdAttimestamptz!-
updatedAttimestamptz!-

WhitelistRequestResponse

FieldTypeDescription
successBoolean!-
requestWhitelistRequest-
errorString-

WhitelistSyncLog

FieldTypeDescription
idInt!-
digitalWalletIdInt!-
directionString!-
statusString!-
entriesAddedInt!-
entriesRemovedInt!-
entriesUnchangedInt!-
discrepanciesjsonb-
errorMessageString-
initiatedByString!-
startedAttimestamptz-
completedAttimestamptz-
createdAttimestamptz!-

WorkflowSdkInitTokenInput (Input)

FieldTypeDescription
apiTokenString!-
externalUserIdString!-
externalUserEmailString-
externalUserNameString-
ttlInt-

WorkflowSdkUserAuthenticationInput (Input)

FieldTypeDescription
tokenString!-

ZipResult

FieldTypeDescription
base64DataString-
nameString-
hashString-

Generated Types Reference has loaded