View Node

Node

GET https://api.synapsefi.com/v3.1/users/:user_id/nodes/:node_id

This endpoint allows you to get a specific node document.

Path Parameters

Name	Type	Description
node_id	string	ID of the node.
user_id	string	ID of the user.

Query Parameters

Name	Type	Description
tx_date_end	string	If performing force refresh this param can be used to specify the date range of transactions that should be pulled. Format: %Y-%m-%d.
tx_date_start	string	If performing force refresh this param can be used to specify the date range of transactions that should be pulled. Format: %Y-%m-%d.
force_refresh	string	Set to YES if you wish to refresh the ACH-US bank data. Only works for ACH accounts linked using Account Aggregation. Default is NO.
full_dehydrate	string	Set to YES if you wish to receive all node PII in the response. Default is NO.

Headers

Name	Type	Description
X-SP-USER	string	User's 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 User successfully retrieved.

Full Dehydrate = NO

{
    "_id": "5fd91504cb0fca4d508af942",
    "_links": {
        "self": {
            "href": "https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd91504cb0fca4d508af942"
        }
    },
    "allowed": "LOCKED",
    "allowed_status_code": "USER_REQUESTED",
    "client": {
        "id": "589acd9ecb3cd400fa75ac06",
        "name": "SynapseFi"
    },
    "extra": {
        "note": null,
        "other": {
            "access_token": null,
            "micro_meta": {
                "micro_attempts": 0,
                "micro_sent_count": 1,
                "skip_micro": false
            },
            "updated_on": null
        },
        "supp_id": ""
    },
    "info": {
        "account_num": "2134",
        "address": "8001 VILLA PARK DRIVE, HENRICO, VA, US",
        "balance": {
            "amount": "0.00",
            "currency": "USD"
        },
        "bank_code": "bofa",
        "bank_hlogo": "https://cdn.synapsepay.com/bank_logos_v3p1/bankofamerica_h.png",
        "bank_logo": "https://cdn.synapsepay.com/bank_logos_v3p1/bankofamerica_v.png",
        "bank_long_name": "BANK OF AMERICA  N A ",
        "bank_name": "BANK OF AMERICA  N A ",
        "bank_url": "https://www.bankofamerica.com/",
        "class": "CHECKING",
        "match_info": {
            "email_match": "not_found",
            "name_match": "not_found",
            "phonenumber_match": "not_found"
        },
        "name_on_account": " ",
        "nickname": "Fake Account",
        "routing_num": "0017",
        "type": "PERSONAL"
    },
    "is_active": true,
    "timeline": [
        {
            "date": 1608062211651,
            "note": "Node created."
        },
        {
            "date": 1608062212574,
            "note": "Micro deposits initiated."
        },
        {
            "date": 1608065952868,
            "note": "Correct Micro Deposit amounts attempted. Node's 'allowed' changed to 'CREDIT-AND-DEBIT'"
        }
    ],
    "type": "ACH-US",
    "user_id": "5fd7acfd8677040053ad486d"
}

Full Dehydrate = YES

{
    "_id": "5fd91504cb0fca4d508af942",
    "_links": {
        "self": {
            "href": "https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd91504cb0fca4d508af942"
        }
    },
    "allowed": "LOCKED",
    "allowed_status_code": "USER_REQUESTED",
    "client": {
        "id": "589acd9ecb3cd400fa75ac06",
        "name": "SynapseFi"
    },
    "extra": {
        "note": null,
        "other": {
            "access_token": null,
            "info": {},
            "micro_meta": {
                "micro_attempts": 0,
                "micro_sent_count": 1,
                "skip_micro": false
            },
            "transactions": [],
            "updated_on": null
        },
        "supp_id": ""
    },
    "info": {
        "account_num": "12322134",
        "address": "8001 VILLA PARK DRIVE, HENRICO, VA, US",
        "balance": {
            "amount": "0.00",
            "currency": "USD"
        },
        "bank_code": "bofa",
        "bank_hlogo": "https://cdn.synapsepay.com/bank_logos_v3p1/bankofamerica_h.png",
        "bank_logo": "https://cdn.synapsepay.com/bank_logos_v3p1/bankofamerica_v.png",
        "bank_long_name": "BANK OF AMERICA  N A ",
        "bank_name": "BANK OF AMERICA  N A ",
        "bank_url": "https://www.bankofamerica.com/",
        "class": "CHECKING",
        "match_info": {
            "email_match": "not_found",
            "name_match": "not_found",
            "phonenumber_match": "not_found"
        },
        "name_on_account": " ",
        "nickname": "Fake Account",
        "routing_num": "051000017",
        "type": "PERSONAL"
    },
    "is_active": true,
    "timeline": [
        {
            "date": 1608062211651,
            "note": "Node created."
        },
        {
            "date": 1608062212574,
            "note": "Micro deposits initiated."
        },
        {
            "date": 1608065952868,
            "note": "Correct Micro Deposit amounts attempted. Node's 'allowed' changed to 'CREDIT-AND-DEBIT'"
        }
    ],
    "type": "ACH-US",
    "user_id": "5fd7acfd8677040053ad486d"
}

400 Query failing

{
    "error": {
        "code": "missing_user_ip",
        "en": "User IP is missing from the request."
    },
    "error_code": "200",
    "http_code": "400",
    "success": false
}

Example Request

HTTP

GET /v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd906e520b3aa0bc5caee71 HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 255.127.79.76
X-SP-USER: oauth_0YFNLHvg2c0mjGopszQ45yOBiqSUl8xruCRfaZXw|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

cURL

curl --location --request GET 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd906e520b3aa0bc5caee71' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_0YFNLHvg2c0mjGopszQ45yOBiqSUl8xruCRfaZXw|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json'

Python

//

JS

//

PHP

//

GO

//