Types Glossary
A complete list of models and enums
Models
AchLimit
Name | Type | Description | Required |
---|---|---|---|
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 | The crypto currency acquired for the activity item | No | |
wallet | The destination wallet for the crypto currency | No | |
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 | The fiat currency of the activity item | No | |
amount | string | The amount of fiat currency exchanged | No |
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 |
walletType | The type of wallet 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 |
walletType | The type of wallet 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 | The ACH limit for transactions processed instantly | Yes | |
daily | The ACH limit for transactions processed in the last day | Yes | |
weekly | 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 |
type | The type of wallet | 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 |
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 |
EstimateAchRequest
Name | Type | Description | Required |
---|---|---|---|
fiatAmount | string | The fiat amount to be exchanged | No |
minCryptoAmount | string | The minimum amount of crypto to be exchanged for | No |
cryptoCurrency | The crypto currency to be purchased | Yes | |
type | The type of ACH request | Yes |
EstimateAchResponse
Name | Type | Description | Required |
---|---|---|---|
fiat | The estimated fiat for the exchange | Yes | |
crypto | The estimated crypto for the exchange | Yes |
EstimateCrypto
Name | Type | Description | Required |
---|---|---|---|
currency | The crypto currency of the estimated exchange | Yes | |
direction | The direction the crypto is moving | Yes | |
amount | string | The amount of crypto currency estimated in the exchange | Yes |
price | string | The price of a single unit of the crypto currency; specified in the fiat currency | Yes |
ratioFee | string | The Ratio fee to execute the crypto transaction; specified in the fiat currency | Yes |
networkFee | string | The network fee to execute the crypto transaction; specified in the fiat currency | Yes |
EstimateFiat
Name | Type | Description | Required |
---|---|---|---|
currency | The fiat currency of the estimated exchange | Yes | |
direction | The direction the fiat is moving | Yes | |
amount | string | The amount of fiat currency estimated in the exchange | Yes |
fundingMethod | The method used for fiat, if funded | Yes |
FirstFactorAuthResponse
Name | Type | Description | Required |
---|---|---|---|
sessionJwt | string | The authenticated Bearer token | Yes |
userMask | The user mask object | No |
GetCryptoPricesResponse
Name | Type | Description | Required |
---|---|---|---|
prices | 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 | The crypto currency to be purchased | Yes | |
walletId | string | The ID of the wallet to receive the crypto | Yes |
type | 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 | The result of the KYC address verification | No | |
dobResult | The result of the KYC date of birth verification | No | |
fraudResult | The result of the KYC fraud verification | No | |
idvResult | The result of the KYC identity documentation verification | No |
NetworkFee
Name | Type | Description | Required |
---|---|---|---|
cryptoCurrency | Crypto currency | No | |
cryptoFee | string | Fee amount in crypto currency | No |
fiatCurrency | 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 |
signingType | The type of signing wallet 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 | Yes |
createTime | string | The time the session was created | Yes |
updateTime | string | The time the session was last updated | Yes |
depositAddress | string | The address of the deposit wallet | Yes |
depositType | WalletType | The type of deposit wallet | Yes |
userMask | The user mask object | No | |
signingAddress | string | The address of the signing wallet | Yes |
signingType | string | The type of signing wallet | Yes |
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 | Crypto currency | No | |
fiatCurrency | 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 | 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 | No |
events | The events to subscribe to | No | |
name | string | A name for the webhook | No |
User
Name | Type | Description | Required |
---|---|---|---|
id | string | The unique identifier of the user | No |
createTime | string | The time the user was created | No |
updateTime | string | The time the user was last updated | No |
firstName | string | The first name of the user | No |
middleName | string | The middle name of the user | No |
lastName | string | The last name of the user | No |
string | The email of the user | No | |
country | string | The country of the user | No |
phone | string | The phone number of the user | No |
nationality | string | The nationality of the user | No |
occupation | string | The occupation of the user | No |
kyc | The KYC information of the user | No | |
connectedBankAccounts | The array of connected bank accounts for the user | No |
UserMask
Name | Type | Description | Required |
---|---|---|---|
id | string | The unique identifier of the user | No |
createTime | string | The time the user was created | No |
updateTime | string | The time the user was last updated | No |
phoneMask | string | The last 4 digits of the user's phone number | No |
Wallet
Name | Type | Description | Required |
---|---|---|---|
id | string | The unique identifier of the wallet | Yes |
createTime | string | The time the wallet was created | Yes |
updateTime | string | The time the wallet was last updated | Yes |
address | string | The address of the wallet | Yes |
name | string | The nickname of the wallet | No |
type | The type of wallet | Yes |
Wallets
Name | Type | Description | Required |
---|---|---|---|
items | The wallets of the user | Yes | |
nextPageToken | string | The token for the next page of results, if available | No |
Webhook
Name | Type | Description | Required |
---|---|---|---|
id | string | The unique identifier of the webhook | Yes |
createTime | string | The time the webhook was created | Yes |
updateTime | string | The time the webhook was last updated | Yes |
name | string | The name of the webhook | No |
events | Yes | ||
secret | string | The secret of the webhook. This is only returned here when creating a webhook. | No |
WebhookEvents
Name | Type | Description | Required |
---|---|---|---|
items | The available webhook events | Yes |
Webhooks
Name | Type | Description | Required |
---|---|---|---|
items | The client's webhooks | Yes |
Enums
AchType
Value | Description |
---|---|
STANDARD | Standard ACH settlement |
INSTANT | Instant ACH settlement |
ActivityItemStatus
Value | Description |
---|---|
PENDING | Activity is pending processing |
COMPLETED | Activity has completed processing |
FAILED | Activity failed to process |
BankLinkStatus
Value | Description |
---|---|
ACTIVE | |
INACTIVE | |
LOGIN_REQUIRED | User's bank link requires them to re-authenticate |
BankVerificationStatus
Value | Description |
---|---|
APPROVED | |
DECLINED | |
IN_REVIEW |
Fiat Currencies & Crypto Tokens
Value | Description |
---|---|
USD | US Dollars |
ETH | Ether |
USDC_ETHEREUM | USDC |
USDC_POLYGON | USDC |
Direction
Value | Description |
---|---|
CREDIT | Activity is credit transaction |
DEBIT | Activity is a debit transaction |
FundingMethod
Value | Description |
---|---|
ACH_ORIGINATED_STANDARD | Standard ACH Pull request |
ACH_ORIGINATED_INSTANT | Instant ACH Pull request |
ACH_RECEIVED | ACH directly deposited |
IdType
Value | Description |
---|---|
SSN | Social Security Number |
KycResult
Value | Description |
---|---|
APPROVED | KYC is approved for this check |
DECLINED | KYC is declined for this check |
IN_REVIEW | This check is currently undergoing KYC review |
NOT_STARTED | This check has not started KYC review |
SUBMITTED | This check has been submitted for KYC review |
UNKNOWN | Unknown status |
Network
Value | Description |
---|---|
ETHEREUM | |
POLYGON |
WalletType
Value | Description |
---|---|
EVM |
WebhookEvent
Value | Description |
---|---|
ACTIVITY_UPDATED | Published whenever a user's transaction activity changes. |
BANK_UPDATED | Published whenever a user's bank accounts or authentication statuses change. |
KYC_UPDATED | Published whenever a user's KYC status changes. |
Last updated