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.

200 Users successfully retrieved.

{
   "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": "[email protected]",
               "scope": "READ_AND_WRITE"
            }
         ],
         "permission": "UNVERIFIED",
         "permission_code": null,
         "phone_numbers": [
            "5162325729"
         ],
         "photos": [],
         "refresh_token": "refresh_9DhdCB1PS2olaAQHMtxgpqnwRyi3Z8I7KUzjWsT4",
         "watchlists": "PENDING"
      },
      ...
      ...
   ],
   "users_count": 19952
}

400 Query failing

{
    "error": {
        "code": "missing_client_credentials",
        "en": "Client credentials are missing from the request."
    },
    "error_code": "200",
    "http_code": "400",
    "success": false
}

Example Request

HTTP

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

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>'

Python

//

JS

//

PHP

//

GO

//