Docs
Search
⌃K

Types Glossary

Models

AchLimit

Name
Type
Description
Required
currency
Currency
The fiat currency for the limit
Yes
limit
string
The maximum allowable sum of ACH transaction amounts
Yes
used
string
The current sum of ACH transaction amounts by the ACH limit type (e.g. daily)
Yes
remaining
string
The remaining allowable sum, calculated as the delta between the limit and used values
Yes

ActivateBankLinkResponse

Name
Type
Description
Required
bankAccount
The bank account of the user
No

ActivateBankLinkRequest

Name
Type
Description
Required
publicToken
string
The public token from the Plaid integration
Yes

ActivityItem

Name
Type
Description
Required
id
string
The unique identifier of the allocation
No
createTime
string
The time the allocation was created
No
updateTime
string
The time the allocation was last updated
No
fiat
The fiat component of the activity item
No
crypto
The crypto component of the activity item
No
metadata
object
(Optional) Additional metadata of the activity item
No

ActivityItemCrypto

Name
Type
Description
Required
status
The status of the crypto activity item
No
currency
Currency
The crypto currency acquired for the activity item
No
wallet
Wallet
The destination wallet for the crypto currency
No
direction
Direction
The direction the crypto is moving
No
amount
string
The amount of crypto currency acquired
No
price
string
The price of a single unit of the crypto currency; specified in the fiat currency
No
fee
string
The fee to execute the crypto purchase and withdrawal; specified in the fiat currency
No
transactionHash
string
The on-chain transaction hash of the activity item
No

ActivityItemFiat

Name
Type
Description
Required
status
The status of the fiat activity item
No
currency
Currency
The fiat currency of the activity item
No
amount
string
The amount of fiat currency exchanged
No
direction
Direction
The direction the fiat is moving
No
fundingMethod
The method used for fiat, if funded
No
bankAccount
The Bank Account used for fiat, if funded
No

ActivityItems

Name
Type
Description
Required
items
The activity items of the user
Yes
nextPageToken
string
The token for the next page of results, if available
No

AuthenticateCryptoWalletRequest

Name
Type
Description
Required
walletAddress
string
The wallet address to authenticate
Yes
walletNetwork
Network
The wallet network to authenticate
Yes
signature
string
The signature of the challenge
Yes

AuthenticateCryptoWalletStartResponse

Name
Type
Description
Required
challenge
string
The challenge string to be signed by the requested wallet
Yes

AuthenticateCryptoWalletStartRequest

Name
Type
Description
Required
walletAddress
string
The wallet address to authenticate
Yes
walletNetwork
Network
The wallet network to authenticate
Yes

AuthenticateEmailOtpRequest

Name
Type
Description
Required
otp
string
The OTP to authenticate
Yes
emailId
string
The phone identifier to authenticate
Yes

AuthenticateSmsOtpRequest

Name
Type
Description
Required
otp
string
The OTP to authenticate
Yes
phoneId
string
The phone identifier to authenticate
Yes

BankAccount

Name
Type
Description
Required
id
string
The unique identifier of the bank account
No
createTime
string
The time the bank account connection was created
No
updateTime
string
The time the bank account connection was last updated
No
name
string
The name of the bank account
No
mask
string
The account number mask
No
linkStatus
The status of the bank account link to the user
No
verificationStatus
The status of the bank account user identity verification
No

CalculatedAchLimitsResponse

Name
Type
Description
Required
instant
AchLimit
The ACH limit for transactions processed instantly
Yes
daily
AchLimit
The ACH limit for transactions processed in the last day
Yes
weekly
AchLimit
The ACH limit for transactions processed in the last 7 days
Yes

ConnectWalletRequest

Name
Type
Description
Required
address
string
The network address of the wallet
Yes
network
Network
The network this wallet belongs to
Yes
name
string
A name for the wallet
No

CreateUserRequest

Name
Type
Description
Required
firstName
string
The first name of the user
Yes
middleName
string
The middle name of the user
No
lastName
string
The last name of the user
Yes
email
string
The email of the user
Yes
country
string
The country of the user (Format: ISO 3166 alpha-2)
Yes
phone
string
The phone number of the user (Format: E-164)
Yes
acceptedTerms
string
A boolean indicating the user has accepted the terms
Yes

CreateWebhookRequest

Name
Type
Description
Required
url
string
The url for the client's webhook endpoint
Yes
events
The events to subscribe to
Yes
name
string
A name for the webhook
No

Error

Name
Type
Description
Required
message
string
Error message
No
createTime
string
Error creation time
No
code
string
Error code
No
data
object
Error data
No

FirstFactorAuthResponse

Name
Type
Description
Required
sessionJwt
string
The authenticated Bearer token
Yes
userMask
UserMask
The user mask object
No

GetCryptoPricesResponse

Name
Type
Description
Required
prices
[ Price ]
The quoted prices
Yes
networkFees
The current network fees
Yes

InitiateAchResponse

Name
Type
Description
Required
activityItem
The pending activity item
No

InitiateAchRequest

Name
Type
Description
Required
fiatAmount
string
The amount in fiat to be exchanged
Yes
cryptoCurrency
Currency
The crypto currency to be purchased
Yes
walletId
string
The ID of the wallet to receive the crypto
Yes
type
AchType
The type of ACH request
Yes

Kyc

Name
Type
Description
Required
createTime
string
The time the KYC was created
No
updateTime
string
The time the KYC was last updated
No
addressResult
KycResult
The result of the KYC address verification
No
dobResult
KycResult
The result of the KYC date of birth verification
No
fraudResult
KycResult
The result of the KYC fraud verification
No
idvResult
KycResult
The result of the KYC identity documentation verification
No

NetworkFee

Name
Type
Description
Required
cryptoCurrency
Currency
Crypto currency
No
cryptoFee
string
Fee amount in crypto currency
No
fiatCurrency
Currency
Quoted fiat currency
No
fiatFee
string
Fee amount in fiat currency
No

CreateClientSessionRequest

Name
Type
Description
Required
signingAddress
string
The wallet address that will be used to authenticate
Yes
signingNetwork
Network
The wallet network that will be used to authenticate
Yes
depositAddress
string
The wallet address that will be used as the deposit target. If not provided, the signing address will be used
No

ClientSession

Name
Type
Description
Required
id
string
The session ID
No
createTime
string
The time the session was created
No
updateTime
string
The time the session was last updated
No
depositAddress
string
The address of the deposit wallet
No
depositNetwork
Network
The crypto network of the deposit wallet
No
userMask
UserMask
The user mask object
No

Payroll

Name
Type
Description
Required
createTime
string
The time the payroll connection was created
No
updateTime
string
The time the payroll connection was last updated
No
provider
The provider for the payroll
No
distribution
string
The amount being distributed from this payroll
No

Price

Name
Type
Description
Required
cryptoCurrency
Currency
Crypto currency
No
fiatCurrency
Currency
Quoted fiat currency
No
price
string
Price
No

RequestBankLinkResponse

Name
Type
Description
Required
linkToken
string
The link token for the Plaid integration
Yes

SecondFactorAuthResponse

Name
Type
Description
Required
sessionJwt
string
The authenticated Bearer token
Yes
user
User
The user object
No

SendEmailOtpResponse

Name
Type
Description
Required
emailId
string
The ID of the email address
Yes

SendEmailOtpRequest

Name
Type
Description
Required
emailAddress
string
The Email Address to send the Email OTP to
Yes

SendSmsOtpResponse

Name
Type
Description
Required
phoneId
string
The ID of the phone number
Yes
phoneMask
string
The last 4 digits of the phone number
No

SendSmsOtpRequest

Name
Type
Description
Required
phoneNumber
string
The phone number to send the SMS OTP to
Yes

SubmitKycRequest

Name
Type
Description
Required
dateOfBirth
string
The date of birth of the user (Format: YYYY-MM-DD)
Yes
idType
IdType
The type of ID
Yes
idNumber
string
The number of ID
Yes
line1
string
The first address line of the user
Yes
line2
string
The second address line of the user
No
city
string
The city of the user's address
Yes
state
string
The state of the user's address. (Format: 2-Letter state abbreviation. ex: CA)
Yes
postalCode
string
The postal code of the user's address
Yes
nationality
string
The nationality of the user
No
occupation
string
The occupation of the user
No

UpdateWalletRequest

Name
Type
Description
Required
name
string
A name for the wallet
Yes

UpdateWebhookRequest

Name
Type
Description
Required
url
string
The url for the client's webhook endpoint