API Errors

A list of error codes from the Rize API and what they mean

General Errors

Code

Title

Details

1000

Internal Server

Something went wrong.

1001

Page Not Found

The route you're looking for does not exist.

1002

Unparseable Date Format

Could not parse date. Please try ISO 8601 calendar date in extended format (YYYY-MM-DD).

1003

Missing Request Parameter

At least one parameter is missing. Cannot continue with the request.

1004

Unauthorized

Invalid or expired authentication.

1005

Invalid Limit Value

The limit parameter value cannot be negative.

1006

Invalid Sort Pattern

The sort parameter value must match the field_name_order pattern (example: "email_asc").

1007

Invalid Method Argument

At least one argument is invalid. Cannot continue with the request.

1008

Archived Customer

The Customer is archived. Cannot continue with the request.

1009

Archived Pool

The Pool is archived. Cannot continue with the request.

Synthetic Account Errors

Code

Title

Detail

2000

Unknown Synthetic Account

Could not find Synthetic Account.

2001

Cannot archive Synthetic Account

Synthetic Account could not be archived.

2002

Cannot create Synthetic Account

Synthetic Account could not be created.

2003

Cannot archive master Synthetic Account

The master Synthetic Account for a Customer cannot be archived.

2004

Cannot archive Synthetic Account with balance

A Synthetic Account with a non-zero balance cannot be archived.

2005

Cannot archive Synthetic Account with pending Transfer

A Synthetic Account with a pending Transfer cannot be archived.

2006

Cannot archive non-general Synthetic Account

Synthetic Accounts must be of the "general" or the "target_return_brokerage" type to be archived. Please contact your Rize account manager to archive external Synthetic Accounts.

2007

Cannot update Synthetic Account

Synthetic Account could not be updated.

2008

Cannot update Synthetic Account

A note is required to update Synthetic Accounts.

2009

Could not create Synthetic Account

The count of this customer's active synthetic accounts in the general synthetic account category has reached the maximum.

2010

Could not create Synthetic Account

This customer already has an active or initiated synthetic account in the external or the
plaid_external synthetic account category.

2011

Failed to retrieve synthetic accounts

An exception occurred while retrieving synthetic accounts.

2012

Malformed Plaid processor token

The Plaid processor token provided is either malformed or unsupported.

Transfer Related Errors

Code

Title

Detail

3000

Unknown transfer uid

Could not find transfer. Invalid uid.

3001

Could not initiate transfer

An exception occurred while creating transfer.

3002

Could not initiate transfer

Requested transfer amount in US dollars must be numeric.

3003

Could not initiate transfer

Requested transfer amount in US dollars must be greater than 0.

3004

Could not initiate transfer

Source has insufficient funds for transfer.

3005

Same source and destination accounts

The source and destination accounts are identical.

3006

Could not initiate transfer

Requested transfer between the chosen accounts is prohibited.

3007

Source or Destination Account is discarded

Transfers to or from a discarded account are not allowed.

3008

Source or Destination Account is locked

Transfers to or from a locked account or an account that belongs to a locked customer are prohibited.

3009

An account balance reconciliation is pending; the Customer status is under_review

Transfers are prohibited when a Customer status is under_review.

3010

Customer daily external transfer request maximum has been reached

The maximum number of daily external transfers defined in the Program configuration has been reached.

3011

Customer daily external transfer amount has been reached

This transfer request exceeds the customer's daily external transfer US dollar amount limit.

3012

Transfer amount exceeds program maximum

This transfer exceeds the maximum dollar amount allowed in the Program configuration.

3013

Transfer amount below program minimum

This transfer does not meet the minimum dollar amount required in the Program configuration.

3014

Failed to retrieve transfers

An exception occurred while retrieving transfers.

3015

Could not initiate transfer

An exception occurred while creating the custodial transfer.

Customer-Related Errors

Code

Title

Detail

4000

Could not create customer

An exception occurred while creating a customer.

4001

Could not update customer

An exception occurred while updating the customer.

4002

Unknown customer

Could not find customer. Invalid customer uid.

4003

Locked customer

No activities regarding this customer are allowed at this time.

4004

Could not archive customer

An exception occurred while archiving the customer.

4005

Could not archive customer

A customer with a non-zero balance cannot be archived.

4006

Could not archive customer

A customer with a pending transfer cannot be archived.

4007

Could not lock customer

An exception occurred while locking the customer.

4008

Could not lock customer

lock_reason must be provided in order to lock the customer.

4009

Could not unlock customer

An exception occurred while unlocking the customer.

4010

Could not lock customer properly

An exception occurred while locking at least one custodial account that belongs to the customer. Some lock features are in place, such as rejecting ODFI transfer requests, but not all RDFI transfers or debit card transactions will be blocked.

4011

Incomplete customer onboarding

The customer must complete the onboarding process or be enrolled in additional product(s) before proceeding.

4012

Could not save customer details

An exception occurred when creating or updating customer details.

4013

Could not initiate customer verification

An exception occurred while initiating customer verification.

4014

Could not initiate customer confirmation

An exception occurred while initiating customer confirmation.

4015

Malformed update parameter

One or more parameters were not formatted correctly.

4016

Customer already in use

The supplied Customer information is already associated with the Program.

4017

Failed to retrieve customers

An exception occurred while retrieving customers.

4018

PII Frozen

Cannot update PII once identity verification has begun.

4019

PII Missing

PII could not be obtained for the customer.

4020

Service Offering Enrollment already exists

Service offering enrollments have already been created for this customer.

4021

Identity Verification submitted

This customer has previously submitted identity verification.

4022

Could not update customer profile responses

An exception occurred while updating customer profile responses.

4023

Unknown profile requirement

Could not find profile requirement.

4024

Profile Response formatted incorrectly

There was an issue with the way the submitted response was formatted.

4025

Customer has not been onboarded

The customer has not been onboarded and cannot have PII updated.

4026

Details are locked

One or more details provided cannot be updated once a customer is onboarded.

4027

Customer Inactive

PII cannot be updated if customer is not in 'active' status.

4028

Product Enrollment already exists

An enrollment has already been created for this customer and product.

Compliance Workflow Errors

Code

Title

Detail

4100

Could not create compliance workflow

An exception occurred while creating a compliance workflow.

4101

Could not update compliance workflow

An exception occurred while updating a compliance workflow.

4102

Unknown compliance workflow

Could not find compliance workflow.

4103

External UID mismatch

The supplied external_uid does not match the customer's existing one.

4104

Customer maximum reached

Reached active customer limit for program.

4105

Customer already exists

This customer has already been created.

4106

Compliance workflow not ready for next step

The current step of the Compliance Workflow must be completed before the next step can begin.

4107

Compliance Workflow in progress

A more recent compliance workflow is already in progress.

4108

Compliance Workflow not in progress

The compliance workflow supplied in this request is expired or rejected and is no longer in progress.

4109

Unknown Compliance Document

Could not find Compliance Document.

4110

Compliance Workflow not accepted

This customer's compliance workflow is not in a status of 'accepted'.

4111

Incomplete Customer details

This customer's PII is incomplete. Please see PUT customers/{uid}.

4112

Unknown Product Compliance Plan

Could not find Product Compliance Plan.

4113

Outdated Product Compliance Plan

The product_compliance_plan_uid provided is for a Compliance Plan no longer in use.

4114

Failed to retrieve compliance workflows

An exception occurred while retrieving compliance workflows.

User Errors

Code

Title

Detail

5000

Unknown user

Could not find user. Invalid uid or discarded user.

5001

Could not create user

An exception occurred while creating a new user.

5002

Could not create user

A user with the given email already exists.

5003

Could not grant Custodial Partner access

An unknown Custodial Partner was provided or you are not authorized to grant access to this Custodial Partner. Please check the list of valid Custodial Partners or check your privileges.

5004

Could not grant Partner access

An unknown Client was provided or you are not authorized to grant access to this Client. Please check the list of valid Clients or check your privileges.

5005

Could not update user

An exception occurred while updating the user.

5006

Could not resend invitation

An exception occurred while resending the invitation to the user.

5007

Could not resend invitation

The user is already confirmed.

5008

Could not revoke Custodial Partner or Partner access

The user has additional permissions that you are not authorized to revoke.

5009

Could not archive user

An exception occurred while archiving the user.

Transaction Errors

Code

Title

Detail

6000

Unknown transaction

Could not find transaction.

6001

Unknown transaction event

Could not find transaction event.

6002

Unknown synthetic line item

Could not find synthetic line item.

6003

Unknown custodial line item

Could not find custodial line item.

6004

Failed to retrieve custodial line items

An exception occurred while retrieving custodial line items.

6005

Failed to retrieve synthetic line items

An exception occurred while retrieving synthetic line items.

6006

Failed to retrieve transaction events

An exception occurred while retrieving transaction events.

6007

Failed to retrieve transactions

An exception occurred while retrieving transactions.

Sandbox Transactions

Code

Title

Detail

6100

Failed to mock transaction

An exception occurred while creating a mocked transaction.

6101

Invalid us_dollar_amount

us_dollar_amount must be numeric and cannot be 0.

KYC Document Errors

Code

Title

Detail

7000

Unknown evaluation

Could not find evaluation.

7001

Unknown KYC document

Could not find KYC document.

7002

Failed to retrieve document

Failed to retrieve document from our KYC partner.

7003

Failed to retrieve documents

Failed to retrieve documents from our KYC partner.

7004

Failed to post document

Failed to post document to our KYC partner.

7005

Failed to retrieve evaluations

An exception occurred while retrieving evaluations.

7006

Could not create kyc document

An exception occurred while creating a kyc document.

Custodial Account Errors

Code

Title

Detail

8000

Unknown custodial account

Could not find custodial account.

8001

Failed to retrieve custodial accounts

An exception occurred while retrieving custodial accounts.

Custodial Transaction Errors

Code

Title

Detail

8100

Unknown custodial transaction

Could not find custodial transaction.

8101

Failed to retrieve custodial transactions

An exception occurred while retrieving custodial transactions.

Customer Activity Errors

Code

Title

Detail

9000

Unknown Customer Activity

Could not find specified customer activity.

9001

Failed to retrieve customer activities

An exception occurred while retrieving customer activities.

Pool Errors

Code

Title

Detail

10000

Unknown pool

Could not find pool.

10001

Failed to retrieve pools

An exception occurred while retrieving pools.

Synthetic Account Type Errors

Code

Title

Detail

11000

Unknown synthetic account type

Could not find synthetic account type.

11001

Failed to retrieve synthetic account types

An exception occurred while retrieving synthetic account types.

Webhook Errors

Code

Title

Detail

12000

Could not process webhook

Could not process webhook.

12001

Empty webhook

Webhook was received with no parameters.

User Exports Errors

Code

Title

Detail

13000

Unknown user export

Could not find user export.

13001

Unsupported resource name

The given resource_name is not supported.

13002

Failed to initiate user export

An exception occurred while recording or initiating a user export.

13003

Failed to retrieve user export

An exception occurred while retrieving the user export.

13004

User export file not available

The user export file is either not yet generated, or an error occurred during generation.

13005

Failed to generate user export

An exception occurred while generating a user export CSV file.

13006

Failed to retrieve user exports

An exception occurred while retrieving user exports.

Debit Card Errors

Code

Title

Detail

14000

Unknown debit card

Could not find debit card.

14001

Could not lock debit card

An exception occurred while locking the debit card.

14002

Could not lock debit card

lock_reason must be provided in order to lock the debit card.

14003

Could not unlock debit card

An exception occurred while unlocking the debit card.

14004

Could not unlock debit card

The debit card is locked because its customer is locked. The card cannot be unlocked on its own and will be unlocked when the customer is unlocked.

14005

Could not create debit card

An exception occurred while creating a debit card.

14006

Could not create debit card

The customer or the pool has reached the maximum number of active debit cards.

14007

Could not reissue debit card

An error occurred when trying to initiate debit card reissuance.

14008

Invalid reissue reason

Debit card reissue reason must be 'lost', 'stolen', or 'damaged'.

14009

Card not lockable

Debit card is not in a lockable status.

14010

Failed to retrieve debit cards

An exception occurred while retrieving debit cards.

14011

Failed to activate debit card

An error occurred when trying to activate a debit card.

14012

Locked debit card

No activities regarding this debit card are allowed at this time.

14013

Failed to retrieve debit card PIN token

An exception occurred while retrieving debit card PIN token.

Permission Group Errors

Code

Title

Detail

15000

Unknown Permission Group

Could not find Permission Group

15001

Failed to retrieve permission groups

An exception occurred while retrieving permission groups.

Client Errors

Code

Title

Detail

16000

Unknown Client

Could not find Client.

Custodial Partner Errors

Code

Title

Detail

17000

Unknown Custodial Partner

Could not find Custodial Partner.

17001

Failed to retrieve custodial partners

An exception occurred while retrieving custodial partners.

Program Errors

Code

Title

Detail

18000

Unknown Program

Could not find Program.

18001

Failed to retrieve programs

An exception occurred while retrieving programs.

Document Errors

Code

Title

Detail

19000

Unknown Document

Could not find Document.

19001

Failed to retrieve documents

An exception occurred while retrieving documents.

Role Errors

Code

Title

Detail

20000

Unknown Role

Could not find Role.

20001

Failed to retrieve roles

An exception occurred while retrieving roles.

User Group Errors

Code

Title

Detail

21000

Unknown User Group

Could not find User Group.

21001

Failed to retrieve user groups

An exception occurred while retrieving user groups.

Product Errors

Code

Title

Detail

22000

Unknown Product

Could not find Product.

22001

Failed to retrieve products

An exception occurred while retrieving products.

Customer Product Errors

Code

Title

Detail

23000

Unknown Customer Product

Could not find Customer Product.

23001

Failed to retrieve customer products

An exception occurred while retrieving customer products.

23002

Could not create customer product

An exception occurred while creating a customer product.

23003

PII Confirmation

PII must be confirmed before proceeding with customer product onboarding.

23004

Customer Inactive

Customers not in 'active' status cannot be onboarded into additional Products.

23005

Compliance Workflow not Begun

A Compliance Workflow for this Customer and Product has not been created.

23006

Profile Response Verification

One or more of the Customer's Profile Responses do not meet requirements for onboarding into this Product.

23007

Profile Responses Incomplete

One or more Profile Requirements have not been given a Profile Response.

23008

Product Prerequisite Required

Customer must be onboarded into one or more Products before this one.

Adjustment Related Errors

Code

Title

Detail

24000

Unknown adjustment request uid

Could not find adjustment request. Invalid uid.

24001

Could not initiate adjustment request

An exception occurred while creating the adjustment request.

24002

Failed to retrieve adjustment requests

An exception occurred while retrieving adjustment requests.

24003

Unknown adjustment type uid

Could not find adjustment type. Invalid uid.

24004

Failed to retrieve adjustment types

An exception occurred while retrieving adjustment types.

Sandbox Onboarding Related Errors

Code

Title

Detail

25000

Failed to onboard sandbox program

An exception occurred while onboarding program.

25001

Invalid Cognito token

The token provided is either outdated or not parseable.