API Endpoints

Accounts

Get all synthetic accounts of type general from the current logged in user.

GET {{url}}/baas/customer-accounts

Query Parameters

Name
Type
Description

category

String

Account category

Headers

Name
Type
Description

Authorization*

String

Bearer token

{
    "statusCode": 200,
    "data": {
        "accounts": [
            {
                "id": "ARBv6t85KujA9k7A",
                "name": "Primary Account - General",
                "accountNumber": "839974664",
                "routingNumber": "123456789",
                "availableBalance": "7496.04",
                "pendingBalance": "7496.04",
                "balance": "7496.04",
                "currencyCode": "USD",
                "status": "active",
                "category": "primary",
                "type": "checking"
            }
        ]
    }
}

Get a single synthetic account of type general from the current logged in user.

GET {{url}}/baas/customer-accounts/:id

Path Parameters

Name
Type
Description

*

String

Synthetic account id

Headers

Name
Type
Description

Authorization*

String

Bearer token

Get all synthetic accounts of type outbound ach from the current logged in user.

GET {{url}}/baas/customer-ach-accounts

Query Parameters

Name
Type
Description

limit

Number

Default: 0

offset

Number

Default: 100

Headers

Name
Type
Description

Authorization*

String

Bearer token

Get a single synthetic account of type outbound ach from the current logged in user.

GET {{url}}/baas/customer-ach-accounts/:id

Path Parameters

Name
Type
Description

id*

String

Synthetic account id

Headers

Name
Type
Description

Authorization*

String

Bearer token

Get all synthetic account types.

GET {{url}}/baas/customer-account-types

Headers

Name
Type
Description

Authorization*

String

Bearer token

Create synthetic account.

POST {{url}}/baas/customer-accounts

Headers

Name
Type
Description

Authorization*

String

Bearer token

Request Body

Name
Type
Description

name*

String

Account name

Archive synthetic account.

DELETE {{url}}/baas/customer-accounts/:id

Path Parameters

Name
Type
Description

id*

String

Synthetic account id

Headers

Name
Type
Description

Authorization*

String

Bearer token

Compliance Workflows

Get the latest compliance workflow. If it doesn't exist one, it creates it.

GET {{url}}/baas/compliance-workflows/latest

A helper endpoint for retrieving the most recent Compliance Workflow for a Customer. If it doesn't exists it creates it.

Headers

Name
Type
Description

Authorization*

String

Bearer token

Acknowledge compliance documents.

PUT {{url}}/baas/compliance-workflows/:id

Given a specific compliance workflow id, this endpoint accepts one or more documents pending to be approved per step.

Path Parameters

Name
Type
Description

id*

String

Compliance Workflow ID that documents need to be acknowledged for

Headers

Name
Type
Description

Authorization*

String

Bearer token

Request Body

Name
Type
Description

[].documentId*

String

Document id

[].accept*

String

"yes" or "no"

[].username

String

NOTE: this is required only if the document requires signature

Onboard a customer with a product.

POST {{url}}/baas/customer-complete-enrollment

Submit a request to onboard a Customer onto a new product. This kicks off the KYC/AML validation

Headers

Name
Type
Description

Authorization*

String

Bearer token

Know Your Customer (KYC)

Get KYC documents.

GET {{url}}/baas/kyc-documents

Get KYC documents needed to continue with the onboarding.

Headers

Name
Type
Description

Authorization*

String

Bearer token

Upload KYC document

POST {{url}}/baas/kyc-documents

Upload required document.

Headers

Name
Type
Description

Authorization*

String

Bearer token

Request Body

Name
Type
Description

id*

String

KYC ID

fileName*

String

Name of the file (ex: firstName_lastName_id.jpg)

note

String

Note describing the document. It's recommended to include app version and/or OS

option*

String

An option from KYC options

document*

String

JPG/PNG/PDF document in base64

Customers

Create customer.

POST {{url}}/baas/customer-enrollment

Create a new customer with an email and external id. PII is provided through a PUT request to /baas/customers endpoint.

Headers

Name
Type
Description

Authorization*

String

Bearer token

Request Body

Name
Type
Description

address*

Object

Address object containing street1, street2, etc.

address.street1*

String

Primary street

address.street2

String

Secondary street

address.city*

String

Customer's city

address.state*

String

Customer's state

address.postalCode*

String

Customer's postal code

firstName*

String

Customer's first name

lastName*

String

Customer's last name

dob*

String

Customer's date of birth

phone*

Object

Object containing number and country code

ssn*

String

Customer's Social Security Number

phone.number*

String

Phone number

phone.countryCode*

String

Phone number's country code

address.countryCode

String

Customer's country code

Adjust customer data.

PUT {{url}}/baas/customers

Update customer data with additional PII, like address, SSN, and more.

Headers

Name
Type
Description

Authorization*

String

Bearer token

Request Body

Name
Type
Description

address*

Object

Address object containing street1, street2, etc

address.street1*

String

Primary street

address.street2

String

Secondary street

address.city*

String

Customer's city

address.state*

String

Customer's state

address.postalCode*

String

Customer's postal code

firstName*

String

Customer's first name

lastName*

String

Customer's last name

phone

Object

Object containing number and country code

phone.number

String

Phone number

phone.countryCode

String

Phone number's country code

Get customer data.

GET {{url}}/baas/customers

Headers

Name
Type
Description

Authorization*

String

Bearer token

Debit Cards

Get a list of the current customer's debit cards.

GET {{url}}/baas/debit-cards

Retrieve a list of all debit cards in the system scoped by the supplied.

Headers

Name
Type
Description

Authorization*

String

Bearer token

Get debit card image.

GET {{url}}/baas/debit-cards/:id/image

Path Parameters

Name
Type
Description

id*

String

Debit card id

Headers

Name
Type
Description

Authorization*

String

Bearer token

Migrate a virtual card to debit card.

POST {{url}}/baas/debit-cards/physical

Address is optional, but if it is specified, every field will be required except street 2.

Headers

Name
Type
Description

Authorization*

String

Bearer token

Request Body

Name
Type
Description

id*

String

Debit card id

address.street1

String

Primary street

address.street2

String

Secondary street

address.city

String

Customer's city

address.state

String

Customer's state

address.postalCode

String

Customer's postal code

address.countryCode

String

Customer's country code

Activate physical debit card.

PUT {{url}}/baas/debit-cards/:id/activate

Path Parameters

Name
Type
Description

id*

String

Debit card id

Headers

Name
Type
Description

Authorization*

String

Bearer token

Request Body

Name
Type
Description

cardLastFourDigits*

String

Last four digits

cvv*

String

CVV

expirationDate*

String

Expiration date in format YYYY-MM

Get form to set PIN to a physical debit card.

GET {{url}}/baas/debit-cards/:id/set-pin-url

Path Parameters

Name
Type
Description

id*

String

Debit card id

Headers

Name
Type
Description

Authorization*

String

Bearer token

Lock debit card.

PUT {{url}}/baas/debit-cards/:id/lock

Path Parameters

Name
Type
Description

id*

String

Debit card id

Headers

Name
Type
Description

Authorization*

String

Bearer token

Request Body

Name
Type
Description

lockReason*

String

Lock reason

Unlock debit card.

PUT {{url}}/baas/debit-cards/:id/unlock

Path Parameters

Name
Type
Description

id*

String

Debit card id

Headers

Name
Type
Description

Authorization*

String

Bearer token

Reissue physical debit card.

PUT {{url}}/baas/debit-cards/:id/reissue

Address is optional, but if it is specified, every field will be required, except for street 2.

Path Parameters

Name
Type
Description

id*

String

Debit card id

Headers

Name
Type
Description

Authorization*

String

Bearer token

Request Body

Name
Type
Description

reissueReason*

String

Must be one of these reasons: Reissue Reasons

address.street1

String

Primary street

address.street2

String

Secondary street

address.city

String

Customer's city

address.state

String

Customer's state

address.postalCode

String

Customer's postal code

address.countryCode

String

Customer's country code

Transactions

Get the transactions of the current logged in user.

GET {{url}}/baas/transactions

Query Parameters

Name
Type
Description

limit

Int

Default: 100

offset

Int

Default: 0

description

String

Search by description

accountId

String

Search by account

type

String

Filter by: types

debitCardId

String

Search by debit card id

Headers

Name
Type
Description

Authorization*

String

Bearer token

Transfers

Create an internal transfer.

POST {{url}}/baas/transfer-internal

Initiates an internal transfer. Internal and ACH transfers work the same way for Rize.

Headers

Name
Type
Description

Authorization*

String

Bearer token

Request Body

Name
Type
Description

fromAccountId*

String

Source account id

amount*

String

Amount of money to send

toAccountId

String

Destination account id

toAccountNumber

String

Destination account number (not applicable if toAccountId is sent)

toRoutingNumber

String

Destination account routing number (not applicable if toAccountId is sent)

toFirstName

String

Destination customer first name (not applicable if toAccountId is sent)

toLastName

String

Destination customer last name (not applicable if toAccountId is sent)

Create an ACH transfer.

POST {{url}}/baas/transfer-ach

Initiates an ACH transfer. ACH and internal transfers work the same way for Rize.

Headers

Name
Type
Description

Authorization*

String

Bearer token

Request Body

Name
Type
Description

fromAccountId*

String

Source account id

amount*

String

Amount of money to send

toAccountId

String

Destination account id

toAccountNumber

String

Destination account number (not applicable if toAccountId is sent)

toRoutingNumber

String

Destination account routing number (not applicable if toAccountId is sent)

toFirstName

String

Destination customer first name (not applicable if toAccountId is sent)

toLastName

String

Destination customer last name (not applicable if toAccountId is sent)

Statements

Get statements.

GET {{url}}/baas/statements

Gets a list of monthly statements. By default, last 6 months.

Headers

Name
Type
Description

Authorization*

String

Bearer token

Request Body

Name
Type
Description

limit

Number

Quantity of monthly statements to get

accountId

String

Filter by account id

Get statement by id.

GET {{url}}/baas/statements/:id

Gets the statement document by id.

Path Parameters

Name
Type
Description

*

String

Statement id

Headers

Name
Type
Description

Authorization*

String

Bearer token

Fake Transactions

Create 7 fake transactions to the logged in user.

POST {{url}}/baas/fake-transactions

Headers

Name
Type
Description

Authorization*

String

Bearer token

PreviousWeb SocketsNextAccount Enums

Last updated

Was this helpful?