View User
User
GET
https://api.synapsefi.com/v3.1/users/:user_id
This endpoint allows you to get a specific user document.
Path Parameters
Name
Type
Description
user_id
string
ID of the user to get.
Query Parameters
Name
Type
Description
full_dehydrate
string
Set to YES
if you wish to receive all user PII in the response. Default is NO
.
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.
{
"_id": "5ecfb7b5f8db9323b12cfa46",
"_links": {
"self": {
"href": "https://uat-api.synapsefi.com/v3.1/users/5ecfb7b5f8db9323b12cfa46"
}
},
"account_closure_date": null,
"client": {
"id": "589acd9ecb3cd400fa75ac06",
"name": "SynapseFi"
},
"documents": [
{
"entity_scope": "Arts & Entertainment",
"entity_type": "M",
"id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
"id_score": 1.0,
"is_active": true,
"name": "Test User",
"permission_scope": "SEND|RECEIVE",
"physical_docs": [
{
"document_type": "GOVT_ID",
"id": "38dd7abbefd347315bebeaeb3a6f210e506066abc27b36c87dde060e9baf7c3d",
"last_updated": 1590671292685,
"status": "SUBMITTED|VALID"
},
{
"document_type": "GOVT_ID_BACK",
"id": "f2296315e36857799e5c7f5d85b33e554fa3fc9074ca85dbf04cef9b70bcfb7e",
"last_updated": 1590671292686,
"status": "SUBMITTED"
}
],
"required_edd_docs": [],
"social_docs": [
{
"document_type": "EMAIL",
"id": "2c45158f6431ca874bbe82f63d5905567854dde4d8b81539944e5779e5eee741",
"last_updated": 1590671292686,
"status": "SUBMITTED|VALID"
},
{
"document_type": "IP",
"id": "28d9177b22c127d9a51d8903893864accf6e553ac326704a4c0d585eaad2516a",
"last_updated": 1590671292686,
"status": "SUBMITTED|VALID"
},
{
"document_type": "ADDRESS",
"id": "c615c761d68c578a98fde8e73c490df405ff5d5e34fc11f029660d7e9743df21",
"last_updated": 1590671292686,
"status": "SUBMITTED"
},
{
"document_type": "PHONE_NUMBER",
"id": "fda60784d6375bc44edafaaeae149626c4c13dcb92e85a2a7a00eec2cdfd2b6f",
"last_updated": 1590671292686,
"status": "SUBMITTED|VALID"
},
{
"document_type": "DATE",
"id": "2b52edae636ca2fbe12ab1b08a344d381dabc3d2b92844cf7a8d8b6052b26d8e",
"last_updated": 1590671292686,
"status": "SUBMITTED"
}
],
"virtual_docs": [
{
"document_type": "SSN",
"id": "ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f",
"last_updated": 1590671292685,
"status": "SUBMITTED|VALID"
}
],
"watchlists": "NO_MATCH"
}
],
"emails": [],
"extra": {
"cip_tag": 1,
"date_joined": 1590671281454,
"extra_security": false,
"is_business": false,
"is_trusted": false,
"last_updated": 1590671292335,
"public_note": null,
"supp_id": "122eddfgbeafrfvbbb"
},
"flag": "NOT-FLAGGED",
"flag_code": null,
"is_hidden": false,
"legal_names": [
"Test User"
],
"logins": [
{
"email": "[email protected]",
"scope": "READ_AND_WRITE"
}
],
"permission": "SEND-AND-RECEIVE",
"permission_code": null,
"phone_numbers": [
"901.111.1111"
],
"photos": [],
"refresh_token": "refresh_sXEqp57kSz6uMvVDUmho1KlJRdAbrYCG2WP9f8g4",
"watchlists": "NO_MATCH"
}
Example Request
GET /v3.1/users/5fd7acfd8677040053ad486d?full_dehydrate=yes HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_6zZVr8biuqGkyo9IxMO5jY2QlSp0nmD4EBAgKcJW
X-SP-USER-IP: 255.127.79.76
X-SP-USER: |e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json
Last updated
Was this helpful?