LogoLogo
StatusChangelogDashboardCreate a Ticket
  • Getting Started
  • Intro to APIs
  • How to Contact us
  • How to Go-Live
  • Intro to Risk
  • Intro to Spec Sheets
  • Product Guides
    • Deposit Hub
      • 🌎Global Cash
    • Credit Hub
    • Payment Accounts
    • ID Score
  • API References
    • OAuth
      • OAuth Object Details
      • Create OAuth Key
      • Generate Refresh Token
    • Users
      • User Object Details
      • Testing on UAT
      • View All Users
      • View User
      • Create User
      • Update User
      • Generate UBO Doc
      • Manage Duplicates
      • Allowed Document Types
      • Allowed Entity Scopes
      • Allowed Entity Types
    • Nodes
      • Node Object Details
      • Testing on UAT
      • View all User Nodes
      • View Node
      • Create Node
      • Update Node
      • Generate eCash Barcode
      • Allowed Node Types
      • View ATMs
    • Subnets
      • Subnet Object Details
      • Testing on UAT
      • View all Node Subnets
      • View Subnet
      • Create Subnet
      • Update Subnet
      • Push to Wallet
    • Shipments
      • Shipment Object Details
      • View all Subnet Shipments
      • View Shipment
      • Create Shipment
      • Cancel Shipment
    • Statements
      • Statement Object Details
      • View all User Statements
      • View all Node Statements
    • Transactions
      • Transaction Object Details
      • Testing on UAT
      • View all User Transactions
      • View all Node Transactions
      • View Transaction
      • Create Transaction
      • Create Batch Transactions
      • Cancel Transaction
      • Retry ACH Transaction
      • Dispute Chargebacks
      • Dispute Transaction
    • Subscriptions
      • Subscription Object Details
      • Webhook Object Details
      • Testing on UAT
      • View all Subscriptions
      • View Subscription
      • Create Subscription
      • Update Subscription
      • View Webhook Logs
    • Miscellaneous
      • Dummy Transactions
      • Verify Address
      • Verify Routing Number
      • International WIRE-INT Required Data by Country
      • View Billers
      • View Enriched Data
      • Loan Limits
      • Transaction Decisioning
      • 3D Secure
      • Virtual Terminal
      • Pre-Authorization
      • Card Disputes Guide
      • Mobile Wallets
      • Interchange Revenue
      • Enrichment Guide
  • Developer Guides
    • User Onboarding
      • Create User Flow
      • Authenticate as the User
      • Create Node Flow
        • Cash Advance
        • Credit Builder Loan
        • One Time Loans
        • Secured Open Loans
        • Secured Revolving Loans
        • Unsecured Revolving Loans
      • Create Subnets Flow
        • Creating Cards
        • Creating AC/RT
      • Linking External Accounts
        • Linking Cards
        • Linking External Bank Account
      • Add Additional Documents
    • Account Details
      • Displaying Balances
      • Transaction History
      • Transaction Details
      • Account Agreements
      • Node Statements
      • Card Details
    • Managing Cards
      • Card Preferences
      • Setting PIN
      • Mobile Wallet Flow
        • Integrate with Apple Pay
        • Integrate with Google Pay
        • Integrate with Samsung Pay
      • Shipping Cards
    • Originating Transactions
      • Sending Fed Wires
      • Sending ACH Transfers
      • Sending International Wires
      • Deposit a Check
      • Issuing Checks
      • Recurring Transactions
      • 3rd Party Payment Accounts
      • Cancelling Transactions
      • Exceeding Origination Limits
    • Receiving Transactions
      • Transaction Decisioning
      • Receiving ACH / Wires
      • Card Transactions
      • Exceeding Inbound Limits
    • Managing Disputes
      • ACH Disputes
      • Card Disputes
    • 3rd Party Integrations
      • Payment Integrations
      • Account Aggregators
      • 3rd Parties & Compliance
  • Recipes
    • Overdraft Protection
    • Social Banking
    • Monetizing Transactions
Powered by GitBook
On this page
  • Get Users
  • Example Request

Was this helpful?

Export as PDF
  1. API References
  2. Users

View All Users

Get Users

GET https://api.synapsefi.com/v3.1/users

This endpoint allows you to get all users linked to your client keys.

Query Parameters

Name
Type
Description

per_page

integer

Maximum documents to return per page. Default and max allowed is 20.

page

integer

Page number of the paginated request. Default is 1.

show_refresh_tokens

string

Set to NO if you wish not to receive refresh tokens for all users returned. Default is YES.

Headers

Name
Type
Description

X-SP-USER

string

Your OAuth key and device fingerprint, separated by a pipe. For this request OAuth can be left blank since X-SP-GATEWAY will be used for authentication. But device fingerprint is still required.

X-SP-USER-IP

string

IP address of your device.

X-SP-GATEWAY

string

Your Client ID and Secret, separated by a pipe.

{
   "error_code": "0",
   "http_code": "200",
   "limit": 10,
   "page": 1,
   "page_count": 1996,
   "success": true,
   "users": [
      {
         "_id": "5fa8c5ad867704005459a5f7",
         "_links": {
            "self": {
               "href": "https://uat-api.synapsefi.com/v3.1/users/5fa8c5ad867704005459a5f7"
            }
         },
         "account_closure_date": null,
         "client": {
            "id": "589acd9ecb3cd400fa75ac06",
            "name": "SynapseFi"
         },
         "documents": [],
         "emails": [],
         "extra": {
            "cip_tag": 1,
            "date_joined": 1604896172980,
            "extra_security": true,
            "is_business": true,
            "is_trusted": false,
            "last_updated": 1604896189696,
            "public_note": null,
            "supp_id": null
         },
         "flag": "NOT-FLAGGED",
         "flag_code": null,
         "is_hidden": false,
         "legal_names": [
            "Isaac Gluck"
         ],
         "logins": [
            {
               "email": "isaacbgluck@gmail.com",
               "scope": "READ_AND_WRITE"
            }
         ],
         "permission": "UNVERIFIED",
         "permission_code": null,
         "phone_numbers": [
            "5162325729"
         ],
         "photos": [],
         "refresh_token": "refresh_9DhdCB1PS2olaAQHMtxgpqnwRyi3Z8I7KUzjWsT4",
         "watchlists": "PENDING"
      },
      ...
      ...
   ],
   "users_count": 19952
}
{
    "error": {
        "code": "missing_client_credentials",
        "en": "Client credentials are missing from the request."
    },
    "error_code": "200",
    "http_code": "400",
    "success": false
}

Example Request

GET /v3.1/users?show_refresh_tokens=yes&per_page=10&page=1 HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-GATEWAY: <client_id_###>|<client_secret_###>
X-SP-USER-IP: 255.127.79.76
X-SP-USER: |<user_id>
curl --location --request GET 'https://uat-api.synapsefi.com/v3.1/users?show_refresh_tokens=yes&per_page=10&page=1' \
--header 'X-SP-GATEWAY: <client_id_###>|<client_secret_###>' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: |<user_id>'
//
//
//
//
PreviousTesting on UATNextView User

Last updated 2 years ago

Was this helpful?