Contract Plaid services through zerohash and get access to bank account verification services through our SDK.

Onboarding with Plaid

A zerohash relationship manager will coordinate with platforms to gather all necessary information and handle the Plaid KYB verification process from start to finish on their behalf. This process must be completed before platforms can start invoking the zerohash SDK to verify and link end customer’s accounts.

Using the zerohash SDK

Once Plaid onboarding has been completed, platforms can invoke the zerohash SDK with appIdentifier: FIAT_ACCOUNT_LINK to link and manage end customers’ bank accounts. See the example below for how to implement this in a React application. Keep in mind that if you're using a Native Mobile App (Swift, Flutter, etc) instead of using zh-web-sdk you should follow the WebView approach, described here:

import React from 'react';
import ZeroHashSDK, { AppIdentifier } from 'zh-web-sdk';

const App = () => {
  const sdk = new ZeroHashSDK({
    zeroHashAppsURL: "https://web-sdk.cert.zerohash.com",
    PAYJWT: "<JWT_TOKEN_HERE>" 
  });

    sdk.openModal({
    appIdentifier: FIAT_ACCOUNT_LINK, 
  })
  return <></>;
}

export default App;

The Plaid Link UX is wrapped within the zerohash SDK, delivering a streamlined bank account verification and linking process for end customers.

Accept T's and C's

First time users will need to accept the zerohash terms and conditions.

Link a bank account

End customers verify and link their external bank accounts. On success, zerohash will create a corresponding external account and return an external_account_id to the platform which can be stored by platforms and referenced for future payment requests. Adding a bank account is a one-time process for an end customer that verifies account ownership, so it is not something a customer has to do every time they want to initiate a transaction.

📘

There is a limit on external accounts linked to a participant

There is a default limit of three accounts linked per participant. If you need to change this, please contact your account manager.

Successful Bank Account Link

Once an end user has successfully verified and linked their external account, we’ll send you a webhook that looks like this:

{
  "request_id": "0f68333e-2114-469d-b505-c850d776e063",
  "participant_code": "CUST01",
  "platform_code": "TES123",
  "account_nickname": "",
  "status": "approved",
  "external_account_id": "0f68333e-2114-469d-b505-c850d776e063",
  "created_at": "1975-08-19T23:15:30.000Z"
}

Managing accounts linked via zerohash SDK

Platforms leveraging zerohash’s Fiat products should subscribe to webhooks to stay notified of external account updates, and can fetch external account details at any time.

Querying accounts

Platforms can fetch linked external accounts via API using the GET /payments/external_accounts endpoint.

Expired accounts

When an external account has expired, platforms will receive the following webhook:

{
  "request_id": "0f68333e-2114-469d-b505-c850d776e063",
  "participant_code": "CUST01",
  "platform_code": "TES123",
  "account_nickname": "",
  "status": "expired",
  "external_account_id": "0f68333e-2114-469d-b505-c850d776e063",
  "created_at": "1975-08-19T23:15:30.000Z"
}

Platforms can invoke the zerohash SDK for re-linking:

import React from 'react';
import ZeroHashSDK, { AppIdentifier } from 'zh-web-sdk';

const App = () => {
  const sdk = new ZeroHashSDK({
    zeroHashAppsURL: "https://web-sdk.cert.zerohash.com",
    PAYJWT: "<JWT_TOKEN_HERE>" 
  });

    sdk.openModal({
    appIdentifier: FIAT_ACCOUNT_UPDATE, 
  })
  return <></>;
}

export default App;

Revoked accounts

When an external account has revoked, platforms will receive the following webhook:

{
  "request_id": "0f68333e-2114-469d-b505-c850d776e063",
  "participant_code": "CUST01",
  "platform_code": "TES123",
  "account_nickname": "",
  "status": "revoked",
  "external_account_id": "0f68333e-2114-469d-b505-c850d776e063",
  "created_at": "1975-08-19T23:15:30.000Z"
}

Platforms can invoke the zerohash SDK for end customers to link a new account:

import React from 'react';
import ZeroHashSDK, { AppIdentifier } from 'zh-web-sdk';

const App = () => {
  const sdk = new ZeroHashSDK({
    zeroHashAppsURL: "https://web-sdk.cert.zerohash.com",
    PAYJWT: "<JWT_TOKEN_HERE>" 
  });

    sdk.openModal({
    appIdentifier: FIAT_ACCOUNT_LINK, 
  })
  return <></>;
}

export default App;

Close an account

Platforms can close linked external accounts via API with REST endpoint POST payments/external_accounts/{external\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\_account\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\_id}/close

Contract with Plaid directly for the required products (Auth, Balance, Identity, and Identity Match) to link end customer bank accounts through a tokenized solution.

Onboarding with Plaid

To kick things off:

1. Set up a Plaid production or sandbox account.
2. Enable zerohash as an integration in your Plaid account settings (Developers > Integrations > search for Zero Hash). Your Plaid Account Manager can assist.

If you need an intro to Plaid please contact your zerohash relationship manager, who can expedite the agreement process.

The most integral implementation lift is linking the end customer account and exchanging it for a token that is shareable with zerohash. This will require a series of Plaid calls* for a platform:

1. /link/token/create
   1. Plaid's Auth service allows customers to sign in to their bank via the Plaid interface and authorize linking their bank account. This gives you tokenized access to the customer's bank account for debits and credits.
   2. Note: You can also offer manual account linking (account and routing number entry), which can take 1-2 days and requires slight changes to the Auth configuration.
2. /item/public_token/exchange
3. /processor/token/create

Once the processor token is created and shared with zerohash, via Create external accounts zerohash can connect the end customer bank account and initiate transactions.

*The listed calls are the minimum calls required to Plaid. To take advantage of the partnerships, you must contract for balance and identity as well, but zerohash can handle the calls.

Adding a bank account is a one-time process for an end customer that verifies account ownership, so it is not something a customer has to do every time they want to initiate an ACH transaction.

Contract Plaid

In order to use ACH or RTP via zerohash, platforms must have the following products enabled with Plaid. Auth and Identity calls are billed to platforms, but zerohash is permitted to access this data thanks to the processor token model.

Using the zerohash API

Once a Plaid onboarding has been completed, platforms can use Plaid processor tokens to link end customers’ bank accounts through the zerohash API. zerohash uses the platform supplied Plaid processor token to set up an account via Create external accounts. zerohash returns an external_account_id to the platform which can be used for later payment requests without needing to link another account. Platforms may also Get external accounts if the external_account_id is needed.

📘

There is a limit on external accounts linked to a participant

There is a default limit of three accounts linked per participant. If you need to change this, please contact your account manager.

zerohash API Calls

Request body

Additional fields in response

Create, Link, and Manage Bank Accounts via zerohash API

Platforms leveraging zerohash’s fiat products should subscribe to webhooks to stay notified of external account updates, and can fetch external account details at any time.

Create an external account

After end customers verify their bank account details through Plaid, the platform uses the returned plaid_processor_token to create an external account via API.

Querying accounts

Platforms can fetch linked external accounts via API using the GET /payments/external_accounts endpoint.

Expired accounts

When an external account has expired, platforms will receive the following webhook:

{
  "request_id": "0f68333e-2114-469d-b505-c850d776e063",
  "participant_code": "CUST01",
  "platform_code": "TES123",
  "account_nickname": "",
  "status": "expired",
  "external_account_id": "0f68333e-2114-469d-b505-c850d776e063",
  "created_at": "1975-08-19T23:15:30.000Z"
}

Platforms can re-verify end customers bank account details through Plaid and use the returned plaid_processor_token to create an external account via API.

Revoked accounts

When an external account has revoked, Platforms will receive the following webhook:

{
  "request_id": "0f68333e-2114-469d-b505-c850d776e063",
  "participant_code": "CUST01",
  "platform_code": "TES123",
  "account_nickname": "",
  "status": "revoked",
  "external_account_id": "0f68333e-2114-469d-b505-c850d776e063",
  "created_at": "1975-08-19T23:15:30.000Z"
}

Platforms can re-verify end customers bank account details through Plaid and use the returned plaid_processor_token to create an external account via API.

Close an account

Platforms can close linked external accounts via API with REST endpoint POST payments/external_accounts/{external\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\_account\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\_id}/close