GET /subscribers

Data Subscriber API Documentation

Overview
Quick Start | Sandbox Usage
Consumer Consent
Auth
Transactions
Merchants
Pay with Points
Code Samples
Deleting Resources
Endpoints - clients

POST /subscribers/login GET /subscribers/refresh GET /subscribers POST /reset-password
Endpoints - Persons

POST /persons GET /persons GET /persons/:id/accounts DELETE /persons/:id/banking DELETE /persons/:id/report DELETE /persons/:id GET /persons/:id/cards
Endpoints - Banking

POST /accounts GET /accounts/:id/transactions GET /accounts/:id/ach GET /accounts/:id/owner GET /accounts/:id/balance GET /accounts/:id/statement GET /accounts/:id/report GET /accounts/:id/bank DELETE /accounts/:id DELETE /accounts/:id/bank GET /institutions
Endpoints - Cards

POST /cards DELETE /cards/:id
Endpoints - UGetMe

POST /persons/:id/authenticate POST /persons/:id/verify GET /persons/:id/income
Endpoints - Merchants

POST /merchants/mcc POST /merchants/sight GET /merchants/:id/transactions POST /merchants
Endpoints - Consents

POST /consents GET /consents/:personId DELETE /consents/:id GET /consents/signature/:personId/:useCase
Endpoints - Pay Me Back

POST /persons/:id/pay GET /persons/:id/pay POST /persons/:id/pay-verify POST /persons/:id/pay-send
Endpoints - Offers

POST /offers GET /offers GET /offers/:id POST /cards/:id/offers GET /cards/:id/offers
Frequently Asked Questions

API Documentation

GET /subscribers

This is the endpoint that you can use to fetch the overall status of your account. It will show several pieces of information, including your API key and your current usage of each product.

Headers

NAME	VALUE
Authorization	Bearer {JWT}

Response

NAME	VALUE
id	int. Your user ID
email	string
first_name	string
last_name	string
phone	string
company_name	string
company_address	string
company_postal_code	string
company_city	string
company_state	string
company_country	string
api_key	string
alert_token	string
products	JSON object
products.auth	JSON object
products.auth.is_active	boolean
products.auth.monthly_limit	int
products.auth.monthly_count	int
products.transactions	JSON object
products.transactions.is_active	boolean
products.transactions.monthly_limit	int
products.transactions.monthly_count	int
products.merchant_id	JSON object
products.merchant_id.is_active	boolean
products.merchant_id.monthly_limit	int
products.merchant_id.monthly_count	int
mfa_enabled	boolean. True if you have activated MFA to login.
mfa_channel	string. Null if mfa_enabled is false.

Data Subscriber API Documentation

GET /subscribers

Headers

Response

Ready to get started?