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.

200

{
    "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

HTTP

GET /v3.1/users/entity-scopes HTTP/1.1
Host: uat-api.synapsefi.com

cURL

curl --location --request GET 'https://uat-api.synapsefi.com/v3.1/users/entity-scopes'

Python

//

JS

//

PHP

//

GO

//