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
  • Entity Scopes
  • Example Request

Was this helpful?

Export as PDF
  1. API References
  2. Users

Allowed Entity Scopes

Entity Scopes

GET https://api.synapsefi.com/v3.1/users/entity-scopes

This endpoint allows you to get and view all the avaliable entity scopes.

Headers

Name
Type
Description

X-SP-USER

string

Your OAuth key and device fingerprint, separated by a pipe.

X-SP-USER-IP

string

IP address of your device.

X-SP-GATEWAY

string

Your Client ID and Secret, separated by a pipe.

{
    "scopes": [
        "Not Known",
        "Airport",
        "Arts & Entertainment",
        "Automotive",
        "Bank & Financial Services",
        "Bar",
        "Book Store",
        "Business Services",
        "Religious Organization",
        "Club",
        "Community/Government",
        "Concert Venue",
        "Doctor",
        "Event Planning/Event Services",
        "Food/Grocery",
        "Health/Medical/Pharmacy",
        "Home Improvement",
        "Hospital/Clinic",
        "Hotel",
        "Landmark",
        "Lawyer",
        "Library",
        "Licensed Financial Representative",
        "Local Business",
        "Middle School",
        "Movie Theater",
        "Museum/Art Gallery",
        "Outdoor Gear/Sporting Goods",
        "Pet Services",
        "Professional Services",
        "Public Places",
        "Real Estate",
        "Restaurant/Cafe",
        "School",
        "Shopping/Retail",
        "Spas/Beauty/Personal Care",
        "Sports Venue",
        "Sports/Recreation/Activities",
        "Tours/Sightseeing",
        "Train Station",
        "Transportation",
        "University",
        "Aerospace/Defense",
        "Automobiles and Parts",
        "Bank/Financial Institution",
        "Biotechnology",
        "Cause",
        "Chemicals",
        "Community Organization",
        "Company",
        "Computers/Technology",
        "Consulting/Business Services",
        "Education",
        "Elementary School",
        "Energy/Utility",
        "Engineering/Construction",
        "Farming/Agriculture",
        "Food/Beverages",
        "Government Organization",
        "Health/Beauty",
        "Health/Medical/Pharmaceuticals",
        "Industrials",
        "Insurance Company",
        "Internet/Software",
        "Legal/Law",
        "Media/News/Publishing",
        "Mining/Materials",
        "Non-Governmental Organization (NGO)",
        "Non-Profit Organization",
        "Organization",
        "Political Organization",
        "Political Party",
        "Preschool",
        "Retail and Consumer Merchandise",
        "Small Business",
        "Telecommunication",
        "Transport/Freight",
        "Travel/Leisure"
    ]
}

Example Request

GET /v3.1/users/entity-scopes HTTP/1.1
Host: uat-api.synapsefi.com
curl --location --request GET 'https://uat-api.synapsefi.com/v3.1/users/entity-scopes'
//
//
//
//
PreviousAllowed Document TypesNextAllowed Entity Types

Last updated 4 years ago

Was this helpful?