View User

GET User to retrieve a specific user

Use this call to view a specific user's details. This can be used to:

  • Grab a new refresh_token from the user (when you need to OAuth the user).
  • Check the status of a user or their documents.
  • View KYC documents, including those not stored on your servers.

API ENDPOINT

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

PATH PARAMETER

Path Params

user_id :
required
string

The user ID of the user

QUERY PARAMETER

full_dehydrate :
string no

[yes/no] Full Dehydrate yes will return back user's KYC info..

EXAMPLE REQUEST

GET /v3.1/users/594e0fa2838454002ea317a0 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
Content-Type: application/json
GET /v3.1/users/594e0fa2838454002ea317a0?full_dehydrate=yes 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
Content-Type: application/json
user_id = 594e0fa2838454002ea317a0

client.get_user(user_id, full_dehydrate=True)
const userID = '594e0fa2838454002ea317a0';
const fullDehydrate = true;

client.getUser(userID, fullDehydrate);
user_id = “594e0fa2838454002ea317a0”

client.get_user(use_id: user, full_dehydrate: true)
$full_dehydrate = 'yes';
$user_id = '5c65b5b47f9c208c97ea1e7e';

$user = $client->get_user($user_id, $full_dehydrate);
userID := “594e0fa2838454002ea317a0”
fullDehydrate := true

user, err := client.GetUser(userID, fullDehydrate)

EXAMPLE RESPONSE

{
    "_id": "594e0fa2838454002ea317a0",
    "_links": {
        "self": {
            "href": "https://uat-api.synapsefi.com/v3.1/users/594e0fa2838454002ea317a0"
        }
    },
    "client": {
        "id": "589acd9ecb3cd400fa75ac06",
        "name": "SynapseFI"
    },
    "doc_status": {
        "physical_doc": "SUBMITTED|VALID",
        "virtual_doc": "SUBMITTED|VALID"
    },
    "documents": [
        {
            "id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
            "name": "Test User",
            "permission_scope": "SEND|RECEIVE|1000|DAILY",
            "physical_docs": [
                {
                    "document_type": "GOVT_ID",
                    "id": "c486c2cb8c1bce695fcfae3197e14aa5b8ddec184c2779d00d581abee5d9a04c",
                    "last_updated": 1498288034877,
                    "status": "SUBMITTED|VALID"
                }
            ],
            "social_docs": [
                {
                    "document_type": "FACEBOOK",
                    "id": "8f314a6a53f36ee569455761e49a2a7fe790d251c5611c65255befdb303602b7",
                    "last_updated": 1498288034880,
                    "status": "SUBMITTED|VALID"
                },
                {
                    "document_type": "PHONE_NUMBER",
                    "id": "fda60784d6375bc44edafaaeae149626c4c13dcb92e85a2a7a00eec2cdfd2b6f",
                    "last_updated": 1498288034880,
                    "status": "SUBMITTED|VALID"
                },
                {
                    "document_type": "EMAIL",
                    "id": "2c45158f6431ca874bbe82f63d5905567854dde4d8b81539944e5779e5eee741",
                    "last_updated": 1498288034880,
                    "status": "SUBMITTED|VALID"
                },
                {
                    "document_type": "IP",
                    "id": "28d9177b22c127d9a51d8903893864accf6e553ac326704a4c0d585eaad2516a",
                    "last_updated": 1498288034880,
                    "status": "SUBMITTED|VALID"
                }
            ],
            "virtual_docs": [
                {
                    "document_type": "SSN",
                    "id": "ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f",
                    "last_updated": 1498288034875,
                    "status": "SUBMITTED|VALID"
                }
            ]
        }
    ],
    "emails": [],
    "extra": {
        "cip_tag": 1,
        "date_joined": 1498288029784,
        "extra_security": false,
        "is_business": false,
        "last_updated": 1498288034864,
        "public_note": null,
        "supp_id": "122eddfgbeafrfvbbb"
    },
    "is_hidden": false,
    "legal_names": [
        "Test User"
    ],
    "logins": [
        {
            "email": "[email protected]",
            "scope": "READ_AND_WRITE"
        }
    ],
    "permission": "SEND-AND-RECEIVE",
    "phone_numbers": [
        "[email protected]",
        "901.111.1111"
    ],
    "photos": [],
    "refresh_token": "refresh_ehG7YBS8ZiD0sLa6PQHMUxryovVkJzElC5gWROXq"
}
{
    "_id": "594e0fa2838454002ea317a0",
    "_links": {
        "self": {
            "href": "https://uat-api.synapsefi.com/v3.1/users/594e0fa2838454002ea317a0"
        }
    },
    "_v": 2,
    "client": {
        "id": "589acd9ecb3cd400fa75ac06",
        "name": "SynapseFI"
    },
    "doc_status": {
        "physical_doc": "SUBMITTED|VALID",
        "virtual_doc": "SUBMITTED|VALID"
    },
    "documents": [
        {
            "address_city": "SF",
            "address_country_code": "US",
            "address_postal_code": "94114",
            "address_street": "1 Market St.",
            "address_subdivision": "CA",
            "alias": "Test",
            "day": 2,
            "email": "[email protected]",
            "entity_scope": "Arts & Entertainment",
            "entity_type": "M",
            "id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
            "ip": "::1",
            "month": 5,
            "name": "Test User",
            "permission_scope": "SEND|RECEIVE|1000|DAILY",
            "phone_number": "901.111.1111",
            "physical_docs": [
                {
                    "document_type": "GOVT_ID",
                    "document_value": "https://cdn.synapsepay.com/uploads/2017/06/24/DioeVvEbMOfxzpLGZNCPnJKYuHQ7t89s4FBmTk00rRgyc35WXU.gif",
                    "id": "c486c2cb8c1bce695fcfae3197e14aa5b8ddec184c2779d00d581abee5d9a04c",
                    "last_updated": 1498288034877,
                    "meta": {
                        "matches": {
                            "address": "not_found",
                            "dob": "not_found",
                            "identification": "not_found"
                        }
                    },
                    "status": "SUBMITTED|VALID"
                }
            ],
            "screening_results": {
                "561": "NO_MATCH",
                "aucl": "NO_MATCH",
                "concern_location": "NO_MATCH",
                "dpl": "NO_MATCH",
                "dtc": "NO_MATCH",
                "el": "NO_MATCH",
                "eucl": "NO_MATCH",
                "fatf_non_cooperative_jurisdiction": "NO_MATCH",
                "fbi_bank_robbers": "NO_MATCH",
                "fbi_counter_intelligence": "NO_MATCH",
                "fbi_crimes_against_children": "NO_MATCH",
                "fbi_criminal_enterprise_investigations": "NO_MATCH",
                "fbi_cyber": "NO_MATCH",
                "fbi_domestic_terrorism": "NO_MATCH",
                "fbi_human_trafficking": "NO_MATCH",
                "fbi_murders": "NO_MATCH",
                "fbi_violent_crimes": "NO_MATCH",
                "fbi_wanted_terrorists": "NO_MATCH",
                "fbi_white_collar": "NO_MATCH",
                "fincen_red_list": "NO_MATCH",
                "fse": "NO_MATCH",
                "fto_sanctions": "NO_MATCH",
                "futures_sanctions": "NO_MATCH",
                "hkma_sanctions": "NO_MATCH",
                "hm_treasury_sanctions": "NO_MATCH",
                "isn": "NO_MATCH",
                "mas_sanctions": "NO_MATCH",
                "monitored_location": "NO_MATCH",
                "ns-isa": "NO_MATCH",
                "ofac_561_list": "NO_MATCH",
                "ofac_eo13645": "NO_MATCH",
                "ofac_fse": "NO_MATCH",
                "ofac_fse_ir": "NO_MATCH",
                "ofac_fse_sy": "NO_MATCH",
                "ofac_isa": "NO_MATCH",
                "ofac_ns_isa": "NO_MATCH",
                "ofac_plc": "NO_MATCH",
                "ofac_sdn": "NO_MATCH",
                "ofac_ssi": "NO_MATCH",
                "ofac_syria": "NO_MATCH",
                "ofac_ukraine_eo13662": "NO_MATCH",
                "osfi": "NO_MATCH",
                "pep": "NO_MATCH",
                "plc": "NO_MATCH",
                "primary_concern": "NO_MATCH",
                "sdn": "NO_MATCH",
                "ssi": "NO_MATCH",
                "tel_sanctions": "NO_MATCH",
                "ukcl": "NO_MATCH",
                "uvl": "NO_MATCH"
            },
            "social_docs": [
                {
                    "document_type": "FACEBOOK",
                    "document_value": "https://www.facebook.com/valid",
                    "id": "8f314a6a53f36ee569455761e49a2a7fe790d251c5611c65255befdb303602b7",
                    "last_updated": 1498288034880,
                    "meta": {
                        "matches": {
                            "address": "not_found",
                            "dob": "not_found",
                            "identification": "not_found"
                        }
                    },
                    "status": "SUBMITTED|VALID"
                },
                {
                    "document_type": "PHONE_NUMBER",
                    "document_value": "901.111.1111",
                    "id": "fda60784d6375bc44edafaaeae149626c4c13dcb92e85a2a7a00eec2cdfd2b6f",
                    "last_updated": 1498288034880,
                    "meta": {
                        "matches": {
                            "address": "not_found",
                            "dob": "not_found",
                            "identification": "not_found"
                        }
                    },
                    "status": "SUBMITTED|VALID"
                },
                {
                    "document_type": "EMAIL",
                    "document_value": "[email protected]",
                    "id": "2c45158f6431ca874bbe82f63d5905567854dde4d8b81539944e5779e5eee741",
                    "last_updated": 1498288034880,
                    "meta": {
                        "matches": {
                            "address": "not_found",
                            "dob": "not_found",
                            "identification": "not_found"
                        }
                    },
                    "status": "SUBMITTED|VALID"
                },
                {
                    "document_type": "IP",
                    "document_value": "::1",
                    "id": "28d9177b22c127d9a51d8903893864accf6e553ac326704a4c0d585eaad2516a",
                    "last_updated": 1498288034880,
                    "meta": {
                        "matches": {
                            "address": "not_found",
                            "dob": "not_found",
                            "identification": "not_found"
                        }
                    },
                    "status": "SUBMITTED|VALID"
                }
            ],
            "virtual_docs": [
                {
                    "document_type": "SSN",
                    "document_value": "2222",
                    "id": "ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f",
                    "last_updated": 1498288034875,
                    "meta": {
                        "matches": {
                            "address": "not_found",
                            "dob": "not_found",
                            "identification": "not_found"
                        }
                    },
                    "status": "SUBMITTED|VALID"
                }
            ],
            "year": 1989
        }
    ],
    "emails": [],
    "extra": {
        "cip_tag": 1,
        "date_joined": 1498288029784,
        "extra_security": false,
        "is_business": false,
        "last_updated": 1498288034864,
        "note": null,
        "public_note": null,
        "supp_id": "122eddfgbeafrfvbbb"
    },
    "flag": "NOT-FLAGGED",
    "ips": [
        "127.0.0.1"
    ],
    "is_hidden": false,
    "legal_names": [
        "Test User"
    ],
    "logins": [
        {
            "email": "[email protected]",
            "scope": "READ_AND_WRITE"
        }
    ],
    "permission": "SEND-AND-RECEIVE",
    "phone_numbers": [
        "[email protected]",
        "901.111.1111"
    ],
    "photos": [],
    "refresh_token": "refresh_ehG7YBS8ZiD0sLa6PQHMUxryovVkJzElC5gWROXq"
}

Information about Sanctions

If a user is a match on a sanctions screening list, documents.screening_results will display MATCH as the value. If that happens, we would need a government ID in almost all instances to be able to resolve the sanctions screenings match.

A user who wasn’t previously a match could end up a match at a later time, as OFAC sanctions/screenings lists are updated frequently, so these lists are re-run against users each time a transaction is created.

Subscribe to Webhooks

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