Newline Platform API

Number of APIs: 56

Getting Started

Welcome to Newline! We’re an infrastructure platform that bridges the gap between banks and fintechs, allowing them to work together seamlessly while maintaining full regulatory compliance. Newline offers banks cost-efficient, compliant access to new Customers, deposits, and capabilities at scale, while providing fintech developers access to all of the tools they need to efficiently build, launch, and grow new financial products and services.

Here we’ll explain how to use our API to build your financial products and services using our network of banks and brokerages. Over the following sections you can learn about the Newline terminology, our endpoints, and what we have available to test in our Sandbox environment. If you have questions, feedback, or a use case you want to discuss with us - please contact our our Sales & Partnership team.

About our API:

The Newline API is organized around REST. With few exceptions, our API has standard resource-oriented URLs, accepts form-encoded OR JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

The Newline Terminology

The terms below are referenced in our API documentation and endpoint definitions. If you have any questions about these terms or how they are used or represented when building your application, please contact our Sales & Partnership team.

Customer: The end user of your application and the owner of the assets held by the Custodian(s) participating in your Program.

Custodian / Custodial Partner: A regulated entity legally allowed to hold assets (Chartered Bank, Brokerage, etc.).

Custodial Accounts: Where assets are held at the Custodian participating in your Program.

Program: The Program is custom tailored to your offering and purpose built to enable financial products on your application. The Program defines what Custodian(s) and Synthetic and Custodial Account types and Transactions are available for you to utilize. The Program configuration is defined with you, Newline, and the Custodian(s) based on your use case.

Synthetic Accounts: How Newline represents the assets held by your Customers. These are the accounts that Customers view and interact with on your application. Synthetic Accounts can be made up of different assets (stocks, bonds, cash) held at different Custodians (banks, brokerages, 529 providers, etc…). Synthetic Accounts are also used to manage external accounts that your Customers will likely use within your application.

Partner: Any infrastructure partner or Custodian integrated within the Newline Platform.

Pool: Container for one or more Synthetic Accounts, with Assets owned by one or more Customers. Pools allow for shared assets and flexibility in ownership and transfer of assets.

Transfer: The movement of assets from one Synthetic Account to another Synthetic Account. The majority of asset movement initiated by your application will result in a Transfer. When Transfers result in the movement of assets between Custodial Accounts, Custodians may institute some limitations (e.g., a daily Transfer limit of $10,000). These limits will be defined with you, Newline, and the participating Custodian(s) when your Program is created. A successful Transfer will result in at least one transaction.

Transaction: Transactions are created based on how you instruct Newline to move assets (a Transfer) or how assets are moved or spent outside of your application (ATM withdrawals, debit card purchase, wire transfers, etc…). The Transaction contains the amount, origin, and destination of assets. Newline categorizes Transactions into types to assist in their classification and representation.

Transaction Events: The steps taken to complete the Transaction. These can be used to view the progress of an in-flight Transaction or see the history of a completed Transaction.

Service Offering: The financial product offered by the Custodians. These can be (but are not limited to) checking, saving, brokerage, or retirement accounts.

Newline Sandbox

The Newline Sandbox is available to fintechs to build against and exercise our API. The Sandbox is configured with a default Custodial Partner, Program configuration, and service offering that covers common use cases. You’ll get access to our administrative application in addition to the API as part of your sandbox setup.

The Newline Sandbox endpoints enable clients to stage outcomes and interactions that are not available in production. The table below outlines some of the key differences between the sandbox and production environments.

Endpoint	Sandbox	Production
Customers	Last_name values submitted with a Customer will trigger a specified Know Your Customer/Anti-Money Laundering (KYC/AML) Evaluation Outcome. Evaluation Outcomes are used by Newline and the Custodian to determine if a Customer is eligible for a Program. The Evaluation Outcome values in the Sandbox are Approved, Denied, or Manual Review.	KYC/AML Evaluations Outcomes are generated from a workflow defined by the Custodian(s) in your Program.
Synthetic Accounts	When creating a Synthetic Account of type external, no authentication is performed. The external account information provided will not initiate a connection to a financial institution.	When creating a Synthetic Account of type external, a valid account and routing number is required. The external account connection will be used to transfer funds to/from a financial institution.
Transfers	Transfers to and from external accounts will be simulated. No real money movement will occur.	Transfer limits (frequency and volume) may exist based on the rules of the Custodian participating in your Program (e.g., 20 daily external transfers, a total daily $10,000 transfer limit).
Sandbox: Mock Transactions	Transaction auto-generation exists to validate how transactions render on your application. These can be auto-generated using a Sandbox specific endpoint.	Unavailable in production.

For access to the Newline Sandbox, an overview of what’s available, and a guide to get you started, please contact our Sales & Partnership team.

Debit Cards - Get a single Debit Card GET {{baseUrl}}/debit_cards/:uid
Transactions - Get a single Transaction GET {{baseUrl}}/transactions/:uid
Transfers - Cancel a Transfer PUT {{baseUrl}}/transfers/:uid/cancel
Sandbox - Simulate a Transaction POST {{baseUrl}}/sandbox/mock_transactions
Transactions - List Transactions GET {{baseUrl}}/transactions
Transactions - List Transaction Events GET {{baseUrl}}/transaction_events
Transactions - Get a single Custodial Line Item GET {{baseUrl}}/custodial_line_items/:uid
Debit Cards - List all Debit Cards GET {{baseUrl}}/debit_cards
Customers - Adjust Customer Data PUT {{baseUrl}}/customers/:uid
Customers - Archive a Customer DELETE {{baseUrl}}/customers/:uid