RIZE (1.0)

Download OpenAPI specification:Download

Welcome to Rize! We’re making the creation of FinTech products user centric, simple, and secure. Some of the things you can do with the Rize API include:

  • Open banking and brokerage accounts on behalf of your users
  • Define how you want to represent the assets in those accounts to your users via our Synthetic Account structure
  • Request and manage cards

Overview

The Rize Platform enables various financial products using the entities described in the table below. The methods to create and manage these entities are described in detail within our API documentation. If you have questions, feedback, or a use case you want to discuss with us - please contact our support team at hello@rizemoney.com.

Entity Description
Customer
  • Customers are your end users. These are the people using your application to create, fund, and manage the Synthetic Accounts that Rize creates.
  • Because these users have assets held by financial institutions, Customers must pass KYC/AML (Know your customer / Anti-money laundering) requirements set by our partners before they can be onboarded to the Rize platform.
    Partner
    • Partners are the businesses using the Rize platform to offer a financial service to Customers.
    Financial Institution
    • Financial Institutions hold the assets that make up the Synthetic Accounts. These are generally banks or brokerages.
    Program
    • Programs are the joint agreement between a Partner and at least one Financial Institution.
    Service Offering
    • Service Offerings are the financial product offered by the Financial Institutions on the Rize Platform. Service Offerings can be (but are not limited to) checking, saving, brokerage, or retirement accounts. Partners can work with Rize to find the Service Offering for their Program that aligns with the needs of their Customers and business.
    Custodial Account
    • Custodial Accounts are where the assets are held at a Financial Institution.
    Synthetic Account
    • Synthetic Accounts are how Rize represents the assets held by your Customers. Synthetic Accounts can be made up of different assets (stocks, bonds, cash) held at different financial institutions (banks, brokerages, 529 providers, etc…). These are the accounts that Customers view and interact with on the Partner’s application.
    • Rize will work with Partners to define the rules that govern how a Synthetic Account is managed, funded, and represented to their Customers.

    In the diagram below we have a Customer using a Partner’s application to fund and manage a Synthetic Account. This Synthetic Account is represented as a single account to the Customer but is actually made up of multiple Custodial Accounts and multiple asset types held at multiple Financial Institutions. The Customer can withdraw, deposit, and spend from their Synthetic Account in any manner the Partner wants to allow as defined by their Program and Service Offering configuration.

    Alt text

    Customers

    A Customer on the Rize Platform is the final end user of a Business Partner's application. Customers are unique to each Program and, as such, the management of all accounts and identifying information is handled on a Program-by-Program basis. This approach allows for more fine grained control of the onboarding flow and KYC/AML requirements for each Program.

    A new Customer record must be created for each Program even when an identical customer already exists on a different program. The Rize Platform will automatically detect identical Customers based on the provided SSN and loosely associate these customers across Programs to aid with fraud detection efforts. At no point will a Customer record be accessible outside of its program.

    Get Customer Requirements

    Customer onboarding and KYC/AML requirements vary by program. The list of fields necessary to submit to the /customers endpoint to initiate onboarding for a specific Program will be returned here.

    Responses

    200
    get /customer_requirements
    https://dev.rizemoney.com/v1/customer_requirements

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "definitions": { },
    • "type": "object",
    • "title": "Customer",
    • "description": "PII required for customer onboarding.",
    • "required":
      [
      ],
    • "properties":
      {
      }
    }

    Get a list of Customers

    Retrieves a list of Customers filtered by the given parameters. Filter parameters are not case sensitive, but will only return exact matches. Multiple filter parameters can be provided at once, but a result will not be returned unless there are exact matches for all submitted parameters. As an example - submitting first_name=Olive&last_name=Oyl would match exactly "Olive Oyl" but NOT "Olive Boyl" or "Oliver Oyl"

    query Parameters
    status
    string
    Default: "all"
    Enum: "accepted" "archived" "all" "frozen" "initiated" "manual_review" "rejected"

    Filter by onboarding status

    first_name
    string
    Example: first_name=Olive

    Only return Customers with a first name matching exactly what is submitted

    last_name
    string
    Example: last_name=Oyl

    Only return Customers with a last name matching exactly what is submitted

    phone_number
    string
    Example: phone_number=123-456-7890

    Only return Customers with a phone number matching exactly what is submitted

    email
    string
    Example: email=olive.oyl%40popeyes.com

    Only return Customers with an email address matching exactly what is submitted

    program_uid
    string
    Example: program_uid=pQtTCSXz57fuefzp

    Only return Customers belonging to the submitted Program

    external_uid
    string
    Example: external_uid=client-generated-id

    A unique, immutable id provided Client

    limit
    integer
    Default: 100

    maximum number of items to retrieve

    offset
    integer
    Default: 0

    index of the items to start retrieving from

    search
    string
    Example: search=Any%20String

    Attempts to match the provided string against any field. Any record with an exact match on one or more fields will be returned.

    Responses

    200
    get /customers
    https://dev.rizemoney.com/v1/customers

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    [
    • {
      },
    • {
      }
    ]

    Onboard a new Customer

    Request Body schema: application/json

    Submit all necessary fields in the POST body as defined in the Customer Requirements

    external_uid
    string

    A unique identifier Partner supplies. It should be given when creating a new resource and must be unique within the resource type. If the same value is given, no new resource will be created.

    customer_details
    required
    object

    A hash containing the required fields as specified by /customer_requirements

    Responses

    200

    Customer onboarding is NOT initiated if the external_uid given is not unique

    201

    Initiate Customer onboarding based on the Program configuration

    post /customers
    https://dev.rizemoney.com/v1/customers

    Request samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "external_uid": "partner-generated-id",
    • "customer_details":
      {
      }
    }

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "uid": "EhrQZJNjCd79LLYq",
    • "external_uid": "partner-generated-id",
    • "customer_details":
      {
      },
    • "program_uid": "kaxHFJnWvJxRJZxr",
    • "status": "accepted",
    • "total_balance": 12345.67
    }

    Get a single Customer

    Retrieve overall status about a Customer as well as their total Asset Balances across all accounts.

    path Parameters
    uid
    required
    string

    Rize-generated unique id

    Responses

    200
    get /customers/{uid}
    https://dev.rizemoney.com/v1/customers/{uid}

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "uid": "EhrQZJNjCd79LLYq",
    • "external_uid": "partner-generated-id",
    • "customer_details":
      {
      },
    • "program_uid": "kaxHFJnWvJxRJZxr",
    • "status": "accepted",
    • "total_balance": 12345.67
    }

    Adjust Customer Data

    If a Customer is in a manual_review status, previously submitted data can be adjusted to retry the onboarding process. Attributes not mentioned in the request body will be considered unchanged. This route may be called as many times as needed before calling /custodial_accounts/retry

    path Parameters
    uid
    required
    string

    Rize-generated unique id

    Request Body schema: application/json

    Refer to Customer Requirements for the list of required fields

    external_uid
    string

    A unique identifier Partner supplies. It should be given when creating a new resource and must be unique within the resource type. If the same value is given, no new resource will be created.

    customer_details
    required
    object

    A hash containing the required fields as specified by /customer_requirements

    Responses

    200

    The updated Customer resource is returned

    put /customers/{uid}
    https://dev.rizemoney.com/v1/customers/{uid}

    Request samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "customer_details":
      {
      }
    }

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "uid": "EhrQZJNjCd79LLYq",
    • "external_uid": "partner-generated-id",
    • "customer_details":
      {