Allowed Entity Types

Entity Types

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

This endpoint allows you to get and view all the available entity types.

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

{
    "BUSINESS": [
        {
            "common_name": "Limited Liability Company",
            "type": "LLC"
        },
        {
            "common_name": "Association",
            "type": "ASSOCIATION"
        },
        {
            "common_name": "Corporation (C-Corp, S-Corp, B-Corp)",
            "type": "CORP"
        },
        {
            "common_name": "Partnership",
            "type": "PARTNERSHIP"
        },
        {
            "common_name": "Sole Proprietorship",
            "type": "SOLE-PROPRIETORSHIP"
        },
        {
            "common_name": "Business Trust",
            "type": "TRUST"
        },
        {
            "common_name": "Business Vendor",
            "type": "VENDOR"
        },
        {
            "common_name": "Estate",
            "type": "ESTATE"
        },
        {
            "common_name": "Individual Retirement Accounts",
            "type": "IRA"
        }
    ],
    "PERSONAL": [
        {
            "common_name": "Male",
            "type": "M"
        },
        {
            "common_name": "Female",
            "type": "F"
        },
        {
            "common_name": "Other",
            "type": "O"
        },
        {
            "common_name": "Minor",
            "type": "MINOR"
        },
        {
            "common_name": "Not Known",
            "type": "NOT_KNOWN"
        },
        {
            "common_name": "Personal Trust Account",
            "type": "TRUST"
        }
    ]
}

Example Request

HTTP

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

cURL

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

Python

//

JS

//

PHP

//

GO

//