Error Codes

This page provides information on API error codes that will be returned for Client (4xx) errors.

The API error schema can be found here

e.g. 

{
  "createTime": "2023-01-01T12:34:56.000Z",
  "message": "Intended amount violates risk limit for user",
  "code": "EXCEEDS_LIMIT_ACH"
}
CodeDescription

ALREADY_EXISTS_BANK

A bank account already exists for the user

ALREADY_EXISTS_EMAIL

The email already exists on another user

ALREADY_EXISTS_PHONE

The phone number already exists on another user

ALREADY_EXISTS_TOTP

The TOTP already exists on another user

ALREADY_EXISTS_USER

The identity conflicts with another user

ALREADY_EXISTS_USER_KYC

KYC has already been submitted for the user

ALREADY_EXISTS_WALLET_ADDRESS

The wallet address already exists for the user

BANK_VERIFICATION_INCOMPLETE

The bank account has not been verified

EXCEEDS_LIMIT_ACH

The ACH transaction would exceed the user's available limits

EXCEEDS_LIMIT_TRANSACTIONS

The ACH transaction would exceed the daily, allowed transactions for the user

EXCEEDS_LIMIT_WALLETS

The wallet would exceed the allowed number of wallets for the user

EXPIRED_AUTHORIZATION

The provided authorization is expired

EXPIRED_SESSION_ID

The client session is expired

INSUFFICIENT_BALANCE

The user's bank account balance is insufficient

INVALID_ACCEPTED_TERMS

The acceptedTerms must be a boolean specified as true

INVALID_ACTIVE

active is not a valid boolean

INVALID_ACTIVITY_ID

activityId is not a valid UUID

INVALID_AGE

The user's date of birth indicates they are under the age requirement

INVALID_ANDROID_PACKAGE_NAME

androidPackageName is not a valid string

INVALID_ASSESSMENT_ID

assessmentId is not a valid UUID

INVALID_AUTHORIZATION

The Authorization header is not a valid bearer token

INVALID_BANK_ID

bankId is not a valid UUID

INVALID_BODY

The request body is invalid as per the API schema

INVALID_CITY

city is not a valid string

INVALID_CLIENT_ID

clientId is not a valid UUID

INVALID_CLIENT_SECRET

The ratio-client-secret header is invalid

INVALID_CODE

code is not valid

INVALID_COUNTRY

country is not supported or is not a valid 2-Alpha country code string (e.g. "US")

INVALID_CRYPTO_AMOUNT

cryptoAmount is not a valid numerical string

INVALID_CRYPTO_CURRENCY

cryptoCurrency is not a valid Currency enum value

INVALID_CRYPTO_STATUS

cryptoStatus is not a valid ActivityItemStatus enum value

INVALID_DATA

data is empty

INVALID_DATE_OF_BIRTH

dateOfBirth is not a valid, formatted string (e.g. YYYY-MM-DD)

INVALID_DEPOSIT_ADDRESS

depositAddress is not a valid string

INVALID_DISTRIBUTIONS

distributions is empty

INVALID_EMAIL

email is not a valid email formatted string

INVALID_EMAIL_ID

emailId is not a valid string

INVALID_EVENT

event is not a valid WebhookEvent enum value

INVALID_EVENTS

events is empty

INVALID_EXCHANGE

exchange is not a valid Exchange enum value

INVALID_FIAT_AMOUNT

fiatAmount is not a valid numeric string

INVALID_FIAT_CURRENCY

fiatCurrency is not a valid Currency enum value

INVALID_FIAT_STATUS

fiatStatus is not a valid ActivityItemStatus enum value

INVALID_FIRST_NAME

firstName is not a valid string

INVALID_FROM_CREATE_TIME

fromCreateTime is not a valid date time string value

INVALID_FUNDING_METHOD

fundingMethod is not a valid FundingMethod enum value

INVALID_ID_NUMBER

idNumber is not a valid string value for the specififed idType

INVALID_ID_TYPE

idType is not a valie IdType enum value

INVALID_IS_FLAGGED

isFlagged is not a valid boolean

INVALID_KYC_STATUS

kycStatus is not a valid KycResult enum value

INVALID_LAST_NAME

lastName is not a valid string

INVALID_LINE_1

line1 is not a valid string

INVALID_LINE_2

line2 is not a valid string

INVALID_MEMO

memo is not a valid string

INVALID_MIDDLE_NAME

middleName is not a valid string

INVALID_NAME

name is not a valid string

INVALID_NATIONALITY

nationality is not a valid string

INVALID_OCCUPATION

occupation is not a valid string

INVALID_OTP

otp is not a valid string

INVALID_PAGE_SIZE

pageSize is not a valid number

INVALID_PAGE_TOKEN

pageToken is not a valid base64 encoded string value

INVALID_PHONE

phone is not a valid E-164 formatted string value

INVALID_PHONE_COUNTRY_CODE

phone country code is not valid

INVALID_PHONE_ID

phoneId is not a valid string

INVALID_PHONE_TYPE

phone type is not valid. Only mobile phone numbers are supported.

INVALID_POSTAL_CODE

postalCode is not a valid string

INVALID_PUBLIC_TOKEN

publicToken is not a valid string

INVALID_REDIRECT_URI

redirectUri is not a valid string

INVALID_RESOLUTION_MESSAGE

resolutionMessage is not a valid string

INVALID_RESOLVED

resolved is not a valid boolean

INVALID_RISK_LEVEL

riskLevel is not a valid RiskLevel enum value

INVALID_SESSION_ID

sessionId is not a valid string

INVALID_SIGNATURE

signature is not a valid string

INVALID_SIGNING_ADDRESS

signingAddress is not a valid string

INVALID_SOLID_CONTACT_ID

solidContactId is not a valid string

INVALID_STATE

state is not a valid string or supported state

INVALID_SUPPORT_TICKET_ID

supportTicketId is not a valid UUID

INVALID_TO_CREATE_TIME

toCreateTime is not a valid date time formatted string

INVALID_TOKEN

token is not a valid string

INVALID_TRANSACTION_HASH

transactionHash is not a valid string

INVALID_TRANSACTION_ID

transactionId is not a valid UUID

INVALID_TYPE

type is not a valid AchType value

INVALID_URL

url is not a valid url formatted string

INVALID_USER_ID

userId is not a valid UUID

INVALID_VERIFICATION_STATUS

verificationStatus is not a valid BankVerificationStatus enum value

INVALID_WALLET_ADDRESS

walletAddress is not a valid string

INVALID_WALLET_ID

walletId is not a valid UUID

INVALID_WALLET_TYPE

walletType is not a valid WalletType enum value

INVALID_WEBHOOK_ID

webhookId is not a valid UUID

MFA_REQUIRED

The bearer token is missing multi-factor authentication

MISMATCH_EMAIL

email does not match the email address on record

MISMATCH_PHONE

phone does not match the phone number on record

MISSING_ACTIVITY_ID

Required activityId is missing

MISSING_ASSESSMENT_ID

Required assessmentId is missing

MISSING_AUTHORIZATION

Required Authorization header is missing

MISSING_BANK_ID

Required bankId is missing

MISSING_CITY

Required city is missing

MISSING_CLIENT_ID

Required clientId is missing

MISSING_CLIENT_SECRET

Required ratio-cient-secret header is missing

MISSING_COUNTRY

Required country is missing

MISSING_CRYPTO_CURRENCY

Required cryptoCurrency is missing

MISSING_DATE_OF_BIRTH

Required dateOfBirth is missing

MISSING_DISTRIBUTIONS

Required distributions is missing

MISSING_EMAIL

Required email is missing

MISSING_EMAIL_ID

Required emailId is missing

MISSING_EVENTS

Required events is missing

MISSING_FIAT_AMOUNT

Required fiatAmount is missing

MISSING_FIRST_NAME

Required firstName is missing

MISSING_FLAGS

Required flags is missing

MISSING_ID_NUMBER

Required idNumber is missing

MISSING_LAST_NAME

Required lastName is missing

MISSING_LINE_1

Required line1 is missing

MISSING_NAME

Required name is missing

MISSING_OTP

Required otp is missing

MISSING_PHONE

Required phone is missing

MISSING_PHONE_ID

Required phoneId is missing

MISSING_POSTAL_CODE

Required postalCode is missing

MISSING_PUBLIC_TOKEN

Required publicToken is missing

MISSING_RESOLUTION_MESSAGE

Required resolutionMessage is missing

MISSING_RISK_LEVEL

Required riskLevel is missing

MISSING_SESSION_ID

Required sessionId is missing

MISSING_SIGNATURE

Required signature is missing

MISSING_SIGNING_ADDRESS

Required signingAddress is missing

MISSING_SOLID_CONTACT_ID

Required solidContactId is missing

MISSING_STATE

Required state is missing

MISSING_SUPPORT_TICKET_ID

Required supportTicketId is missing

MISSING_TOKEN

Required token is missing

MISSING_TRANSACTION_HASH

Required transactionHash is missing

MISSING_TRANSACTION_ID

Required transactionId is missing

MISSING_TYPE

Required type is missing

MISSING_URL

Required url is missing

MISSING_USER_ID

Required userId is missing

MISSING_VERIFICATION_STATUS

Required verificationStatus is missing

MISSING_WALLET_ADDRESS

Required walletAddress is missing

MISSING_WALLET_ID

Required walletId is missing

MISSING_WALLET_TYPE

Required walletTypeis missing

MISSING_WEBHOOK_ID

Required webhookId is missing

NOT_FOUND_ACTIVITY

ActivityItem not found

NOT_FOUND_ASSESSMENT

Assessment not found

NOT_FOUND_BANK

BankAccount not found

NOT_FOUND_CLIENT

Client not found

NOT_FOUND_ENDPOINT

API endpoint not found

NOT_FOUND_SESSION

ClientSession not found

NOT_FOUND_SUPPORT_TICKET

SupportTicket not found

NOT_FOUND_TRANSACTION

Transaction not found

NOT_FOUND_USER

User not found

NOT_FOUND_WALLET

Wallet not found

PLAID_LOGIN_ERROR

BankAccount's linkStatus is invalid for the requested operation

UNAVAILABLE_CRYPTO_CURRENCY

cryptoCurrency is not currently available

UNSUPPORTED_ACH_TYPE

achType is not supported for the specified cryptoCurrency

UNSUPPORTED_ANDROID_PACKAGE_NAME

androidPackageName is not supported with Plaid

UNSUPPORTED_BANK

BankAccount is not supported for use with Ratio

UNSUPPORTED_CRYPTO_CURRENCY

cryptoCurrency is not supported by the specified Wallet

UNSUPPORTED_QUERY_PARAMETERS

Query parameters are not supported with the specified pageToken

UNSUPPORTED_REDIRECT_URI

redirectUri is not supported with Plaid

UNSUPPORTED_WALLET_ADDRESS

walletAddress is not supported by the specified walletType

USER_BLOCKED

User is blocked from the platform

USER_KYC_INCOMPLETE

User's KYC has not been submitted or completed

USER_RISK_INCOMPLETE

User's risk assessment has not been completed

USER_UNDER_REVIEW

User is currently under review

PreviousCustom HeadersNextTypes Glossary

Last updated