View All Users

GET a list of users

API ENDPOINT

https://uat-api.synapsefi.com/v3.1/users

QUERY PARAMETER

query :
string

Name/Email of the user that you wish to search

page :
integer

Page number

per_page :
integer default: 20

How many users do you want us to return per page.

show_refresh_tokens :
string default: yes

[yes/no] When dehydrating if the user object should have refresh tokens or not.

EXAMPLE REQUEST

GET /v3.1/users HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_2bb1e714edd311e6bd04e285d6015267
X-SP-USER-IP: 127.0.0.1
X-SP-USER: |e83cf6ddcf778e37bfe3d48fc78a6502062fc
allusers = client.get_all_users(show_refresh_tokens=True)
client.getAllUsers();
client.get_users(page: 5, per_page: 5)
$query = 'test';
$page = 1;
$per_page = 1;
$show_refresh = 'yes';
$client->get_all_users($query, $page, $per_page, $show_refresh);
data, err := client.GetUsers()

EXAMPLE RESPONSE

{
    "error_code": "0",
    "http_code": "200",
    "limit": 20,
    "page": 1,
    "page_count": 688,
    "success": true,
    "users": [
        {
            "_id": "594dad16838454002da3015f",
            "_links": {
                "self": {
                    "href": "https://uat-api.synapsefi.com/v3.1/users/594dad16838454002da3015f"
                }
            },
            "client": {
                "id": "589acd9ecb3cd400fa75ac06",
                "name": "SynapseFI"
            },
            "doc_status": {
                "physical_doc": "SUBMITTED|VALID",
                "virtual_doc": "SUBMITTED|VALID"
            },
            "documents": [
                {
                    "id": "189d2fc37c1ee5694aa62f302bcd7c0efa",
                    "name": "Charlie Brown",
                    "permission_scope": "SEND|RECEIVE|1000|DAILY",
                    "physical_docs": [
                        {
                            "document_type": "GOVT_ID",
                            "id": "e6b44cb52985fd9f46197bec0fb4e9c",
                            "last_updated": 1498262807101,
                            "status": "SUBMITTED|VALID"
                        }
                    ],
                    "social_docs": [
                        {
                            "document_type": "PHONE_NUMBER",
                            "id": "54522fd5748d2dedeab0034a09f91",
                            "last_updated": 1498262807104,
                            "status": "SUBMITTED|VALID"
                        },
                        {
                            "document_type": "FACEBOOK",
                            "id": "0c32234c59b71311b0f3057635",
                            "last_updated": 1498262807104,
                            "status": "SUBMITTED|VALID"
                        },
                        {
                            "document_type": "EMAIL",
                            "id": "2c45158f6431ca874bbe82",
                            "last_updated": 1498262807104,
                            "status": "SUBMITTED|VALID"
                        },
                        {
                            "document_type": "IP",
                            "id": "28d9177b22c127d9a51d8903",
                            "last_updated": 1498262807104,
                            "status": "SUBMITTED|VALID"
                        }
                    ],
                    "virtual_docs": [
                        {
                            "document_type": "SSN",
                            "id": "acaff78248e74aac19c2a4531",
                            "last_updated": 1498262807099,
                            "status": "SUBMITTED|INVALID"
                        }
                    ]
                }
            ],
            "emails": [],
            "extra": {
                "cip_tag": 1,
                "date_joined": 1498262801436,
                "extra_security": true,
                "is_business": false,
                "last_updated": 1498262807088,
                "public_note": null,
                "supp_id": "122eddfgbeafrfvbbb"
            },
            "is_hidden": false,
            "legal_names": [
                "Charlie Brown"
            ],
            "logins": [
                {
                    "email": "[email protected]",
                    "scope": "READ_AND_WRITE"
                }
            ],
            "permission": "SEND-AND-RECEIVE",
            "phone_numbers": [
                "[email protected]",
                "901.942.8167"
            ],
            "photos": [],
            "refresh_token": "refresh_xsAb2Pv9Sf8QNBq1yMhlcGoTwVJ0mEUjeF3XnILi"
        },
        {
            ...
        },
        {
            ...
        },
        {   ...
        },
        ...
    ],
    "users_count": 13760
}

A successful response will show the field users_count with the number of on-boarded users as the value.

Additional Query Features

SEARCHING FOR USERS

You can also query for users by email or name. When you query for name, it will filter users by legal_names. When you query by email it will filter users by the logins.email.

EXAMPLE

GET /v3.1/users?query=name1 HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_2bb1e714edd311e6bd04e285d6015267
X-SP-USER-IP: 127.0.0.1
X-SP-USER: |e83cf6ddcf778e37bfe3d48fc78a6502062fc

PAGINATION

Responses are paginated. To move through pages, add page as a GET parameter.

EXAMPLE

GET /v3.1/users?page=1 HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_2bb1e714edd311e6bd04e285d6015267
X-SP-USER-IP: 127.0.0.1
X-SP-USER: |e83cf6ddcf778e37bfe3d48fc78a6502062fc

COMBINATION

A combination of page and query is also available.

EXAMPLE

GET /v3.1/users?query=test&page=1 HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_2bb1e714edd311e6bd04e285d6015267
X-SP-USER-IP: 127.0.0.1
X-SP-USER: |e83cf6ddcf778e37bfe3d48fc78a6502062fc

Subscribe to user Webhooks

Subscribe to user webhooks to stay updated on the status of users.