Suggest Edits

API Initialization

 

About the API

This version of the API is architected around REST using standard HTTP verbs to communicate and HTTP response codes to indicate status and errors. All responses come in standard JSON.

Additional Fields

On occasion, you may see fields in the API responses that are not listed in our examples. These fields are for our testing purposes only and may or may not become permanent in the future. We recommend that you do not rely on these fields for your integration until you see them listed in our API documentation.

Host URLs

Request Headers

Key
Value
Description

X-SP-GATEWAY

CLIENT_ID|CLIENT_SECRET

[Required] This is your client_id and client_secret separated by a vertical bar.

X-SP-USER-IP

USER_IP_ADDRESS

[Required] The ip_address of the user.

X-SP-USER

USER_OAUTH_KEY|USER_FINGERPRINT

[Conditionally Required] User’s oauth_key and fingerprint separated by a vertical bar.

Content-Type

application/json

[Required]

X-SP-IDEMPOTENCY-KEY

IDEMPOTENCY_KEY

Optional. POST calls only.

Example Request Headers

Host: uat-api.synapsefi.com
X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_6zZVr8biuqGkyo9IxMO5jY2QlSp0nmD4EBAgKcJW
X-SP-USER-IP: 127.0.0.1
X-SP-USER: |e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

Idempotent Requests

POST calls support idempotency for safely retrying requests without accidentally performing the same operation twice. For example, if a request to create a transaction fails due to a network connection error, you can retry the request with the same idempotency_key to guarantee that only a single transaction is created.

Idempotency keys expire after 24 hours.

Postman Collection

Run in Postman

 
Suggest Edits

API Rate Limits

 

The following is a table of the the most common API calls and their respective rate limits. These limits cannot be increased. Please take this into account when building out your application.

HTTP Verb
URL
Functionality
Rate Limits (per min/per user)

POST

/oauth/<user:id>

This API call allows you to get oauth_key for users.

30

POST

/oauth/<user:id>/login

Using basic auth to get refresh_token for users.

30

GET

/users

View all users created with your client keys (paginated).

100

POST

/users

Allows you to register a new user.

100

GET

/users/<user:id>

View user info and refresh_token.

30

PATCH

/users/<user:id>

Add/update KYC, log in credentials, profile, etc.

30

GET

/users/<user:id>/nodes

View all nodes linked to a user (paginated).

100

POST

/users/<user:id>/nodes

Allows you to create a deposit account or link an external bank account to a user.

100

GET

/users/<user:id>/nodes/<node:id>

View node info.

100

PATCH

/users/<user:id>/nodes/<node:id>

Update supp_id, verify micro-deposits, etc.

100

DELETE

/users/<user:id>/nodes/<node:id>

Unindex node from a user.

100

POST

/users/<user:id>/nodes/<node:id>/subnets

Allows you to issue a virtual account number on top of a node.

100

GET

/users/<user:id>/nodes/<node:id>/subnets

View all subnets linked to a node (paginated).

100

GET

/users/<user:id>/nodes/<node:id>/subnets/<subnet:id>

View subnet info.

100

PATCH

/users/<user:id>/nodes/<node:id>/subnets/<subnet:id>

Update subnet info.

100

GET

/users/<user:id>/trans

View all transactions of a user (paginated).

100

GET

/users/<user:id>/nodes/<node:id>/trans

View all transactions of a node (paginated).

100

POST

/users/<user:id>/nodes/<node:id>/trans

Allows you to create a transaction.

100

GET

/users/<user:id>/nodes/<node:id>/trans/<trans:id>

View transaction info.

100

PATCH

/users/<user:id>/nodes/<node:id>/trans/<trans:id>

Update notes on a transaction.

100

DELETE

/users/<user:id>/nodes/<node:id>/trans/<trans:id>

Only works if transaction has been created or queued.

100

GET

/subscriptions

View all subscriptions created with your client keys (paginated).

10

POST

/subscriptions

Create a subscription with webhook preferences.

10

GET

/subscriptions/<subscription:id>

View a subscription.

10

PATCH

/subscriptions/<subscription:id>

Update scope, url, is_active, etc.

10

GET

<:user_id>/statements

View a users statement

30

GET

<:node_id>/statements

View a node statements

30

 
Suggest Edits

Client Libraries

Language-specific SDKs built around the Synapse API

 

Currently in Beta

Instead of using the API directly, you can use our client libraries:

Deprecated Client Libraries

For platforms using older versions of the client libraries we recommend updating to the new libraries above. The older libraries are no longer maintained and will soon be deprecated.

Note: The older client libraries do not support changing an account from personal to business. To use this and other newer features, we recommend upgrading to a newer library.

Library Initialization

import synapsepy

client = Client(
	client_id='client_id_1239ABCdefghijk1092312309',
	client_secret='client_secret_1239ABCdefghijk1092312309',
	fingerprint='1023918209480asdf8341098',
	ip_address='1.2.3.132',
	devmode=True
)
const Synapse = require('synapsenode');
const Client = Synapse.Client;

const client = new Client({
  client_id: process.env.CLIENT_ID,
  client_secret: process.env.CLIENT_SECRET,
  fingerprint: process.env.FINGERPRINT,
  ip_address: '<ip_address>',
  isProduction: false
});
args = {
  # synapse client_id
  client_id:        ENV.fetch("client_id"),
  # synapse client_secret
  client_secret:    ENV.fetch("client_secret"),
  # a hashed value, either unique to user or static for app
  fingerprint:      "fp",
  # end user's IP
  ip_address:       'ip',
  # (optional) requests go to sandbox endpoints if true
  development_mode: true,
  # (optional) if true logs requests to stdout
  logging: true,
  # (optional) file path to write logs to
  log_to: nil,
  # (optional) rases for 2FA and MFA if set to true
  raise_for_202: true
}

client  = Synapse::Client.new(args)
require_once 'vendor/synapsefi/synapsephp/synapse_rest/client.php';

$clientObj = (object) [
   'client_id' => 'your_client_id',
   'client_secret' => 'your_client_secret',
   'fingerprint' => '|your_finger_print',
   'ip_address' => 'your_ip_address',
   'devmode' => True,
   'logging' => True,
   'handle202' => True
];
client = Client($clientObj);
import github.com/SynapseFI/SynapseGo

// credentials used to set headers for each method request
var client = synapse.New(
"CLIENT_ID",
"CLIENT_SECRET",
"FINGERPRINT",
"IP_ADDRESS",
)

Automatic OAuth Updates

You do not need to add oauth_key to the headers after a user is created and authentication is performed. The libraries automatically do that for you.

 
Suggest Edits

Encrypting Sensitive Information

 

Best Practices

Whenever transmitting sensitive information such as passwords, card numbers, or pins the data should be encrypted. This adds a necessary layer of protection for your users.

Information to Encrypt

Below is are lists of information that must be encrypted before you send it to Synapse. You may use the associated public key to encrypt the information.

Padding

Please make sure you are using PKCS1_v1_5 padding for encrypting your data

Bank Logins

Field
Required By

info.bank_id

info.password

mfa_answer

If you wish to encrypt bank login info while transmitting the information from the client device, you can use the following encryption key.

-----Begin Public Key-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAxy7xFpupeVxgUiaPneI1WAioSIeL6+/NAIIjbvDOvdTCNUeI//ob4bfdGLYlXpXOor/5POqfheZnHzkTu6BhDQqGZBc2BLaARlqx0s+twIadPwzqOJETzmp7r5U5ZioluOGDw4CF+JKRL6sBOaYr5wJ3BemZOXqQE7SAqIsi6Sej2ijGzVFq4tR3gogAdMKjGhzDwthqzZViZN1Zhzb8jsX/aCY+OWq9IUp4iX41fYmpfI9klVKnneAuVAIOPhI5zMaZ7JiQ+88ZQngTi6IhieyGIjvfG7FTsLNoYEqu1OeKw3SRt+HSs+LpnO3P9wwWODZtr07H7oxNJDAIoXITPwIDAQAB
-----End Public Key-----

Interchange and Debit Cards

Field
Required By

card_number

exp_date

pin

 
Suggest Edits

Common Errors

Common errors returned and their formats

 

The API returns JSON with an error code and description in case of any error during the request as shown. In case the error is in a specific field, it also returns the field name in an error object.

{
  "error": {
    "en": "Generic Error Description"
  },
  "error_code": "400",
  "http_code": "409",
  "success": false
}

Understanding Error Codes

Please remember to check the http_status, error_status, and JSON associated with the error response to better understand the error.

Error Messages

When building out your application, we recommend relying only on the HTTP Status and Error Codes for your error handling logic. Error messages are subject to change.

HTTP Status Codes and Error Status Codes

 
Suggest Edits

FAQ

Frequently Asked Questions

 

Testing

What are the best practices when testing our application?

Sandbox vs Production
We recommend running most tests in sandbox. You do not need to supply real data in sandbox, and our docs contain various test values to test different scenarios.

To run tests in production, you must supply real data. This is because you are opening real accounts and transferring real funds, so for regulatory reasons we need accurate data on the individual/business performing these actions.

App Store
You cannot submit fake data in production. That being said, the app store approval process does not usually run through the on-boarding flow. Instead we recommend you supply login credentials that route to sandbox so the app store can review functionality without creating real transactions.

 
Suggest Edits

List of Codes

Master list of codes

 

HTTP Status Codes

Error Status Codes

Transaction Codes

Transaction Status Codes

Transaction Queue Codes

Transaction Cancellation Codes

ACH Return Codes

Card Return Codes

Check Return Codes

Interchange Return Codes

Wire Return Codes

 
Suggest Edits

Verify Address

Check if an address is valid

 
posthttps://uat-api.synapsefi.com/v3.1/address-verification

Request Body

Key
Type
Description

address_street

string

[Required] Street address associated with the document owner, this can be home address of a person or business address of a corp. Please include apartment suite or unit numbers

address_city

string

[Required] City associated with the document owner, this can be home address of a person or business address of a corp

address_subdivision

string

[Required] State abbreviation associated with the document owner. This value needs to be in ISO Alpha-2 (i.e. CA)

address_country_code

string

[Required] Country associated with the document owner, this can be home address of a person or business address of a corp. This value needs to be in ISO Alpha-2 (i.e. US)

address_postal_code

string

[Required] Postal code associated with the document owner, this can be home address of a person or business address of a corp

Deliverability

:white-check-mark+: usps_deliverable

:white-check-mark+: deliverable

:white-check-mark+: deliverable_incorrect_unit

:white-check-mark+: deliverable_missing_unit

:white-check-mark+: deliverable_unnecessary_unit

:x+: google_undeliverable--user will not be verified, please try reentering or inputting a new address.

POST /v3.1/address-verification HTTP/1.1
Host: uat-api.synapsefi.com
Content-Type: application/json

{
  "address_street": "170 St Germain St",
  "address_city": "SF",
  "address_subdivision": "CA",
  "address_country_code": "US",
  "address_postal_code": "94404"
}
A binary file was returned

You couldn't be authenticated

{
  "deliverability": "usps_deliverable",
  "normalized_address": {
    "address_city": "SAN FRANCISCO",
    "address_country_code": "US",
    "address_postal_code": "94114",
    "address_street": "170 SAINT GERMAIN AVE",
    "address_subdivision": "CA"
  }
}
{
  "deliverability": "google_undeliverable",
  "normalized_address": {
    "address_city": "SAN FRANCISCO",
    "address_country_code": "US",
    "address_postal_code": "94114",
    "address_street": "170 SAINT GERMAIN AVE",
    "address_subdivision": "CA"
  }
}
 
Suggest Edits

Verify Routing Number

View the details of a routing number for verification

 
posthttps://uat-api.synapsefi.com/v3.1/routing-number-verification

Request Object

Key
Type
Description

routing_num

string

Routing number of bank

type

string

Type of account (i.e. ACH-US)

POST /v3.1/routing-number-verification HTTP/1.1
Host: uat-api.synapsefi.com
Content-Type: application/json

{
  "routing_num": "084008426",
  "type": "ACH-US"
}
A binary file was returned

You couldn't be authenticated

{
  "address": "5050 POPLAR AVENUE, MEMPHIS, TN, US",
  "logo": "https://cdn.synapsepay.com/bank_logos/new/ibn.png",
  "name": "INDEPENDENT BANK",
  "url": "http://www.independent-bank.com"
}
 
Suggest Edits

View User

Get user information by user ID

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

Path Params

user_id
string
required

Object ID of user

Query Params

full_dehydrate
string

[yes/no] Return all available user information including address information, screening results, etc.

User Object

Key
Type
Description

_id

string

Object ID of the user

_links.self.href

string

HAL-style link for the object

client.id

string

Object ID of client

client.name

string

Name of the client that created the user

documents[]

array of objects

extra.cip_tag

integer

Customer Identification Program number

extra.date_joined

integer

Date user joined (in Unix time)

extra.is_business

boolean

Flag for businesses

extra.is_trusted

boolean

Flag for trusted users

extra.last_updated

integer

Date user was last updated (in Unix time)

extra.supp_id

string

Additional ID to assign to user

legal_names

array of strings

Legal names associated with the user

logins[]

array of objects

List of login objects

permission

string

See User Permissions for more information

phone_numbers

array of strings

List of emails and phone numbers for verifying MFA

refresh_token

string

User-specific refresh token for oauth (expires after 10 uses)

watchlists

string

Flag to indicate if user is a SOFT_MATCH or MATCH in watchlists / sanctions lists checks performed by Synapse's KYC verification system. Verified users who pass these checks should have NO_MATCH reflected for this flag, while unverified users will generally show as PENDING. See Sanctions Tiers and Watchlists Explained for more information.

Login Object

Key
Type
Description

email

string

Login email

scope

string

Permissions granted to login credentials

Additional Information

Use this call when you need to:

  • Grab a new refresh_token from the user (for Issue OAuth Key)
  • View KYC documents, including those not stored on your servers
  • Check the status of a user's documents
GET /v3.1/users/594e0fa2838454002ea317a0 HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_6zZVr8biuqGkyo9IxMO5jY2QlSp0nmD4EBAgKcJW
X-SP-USER-IP: 127.0.0.1
X-SP-USER: |e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json
user_id = “594e0fa2838454002ea317a0”

client.get_user(user_id)
const userID = '594e0fa2838454002ea317a0';

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

client.get_user(user_id: user)
$user_id = '5c65b5b47f9c208c97ea1e7e';

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

user, err := client.GetUser(userID)
A binary file was returned

You couldn't be authenticated

{
  "_id": "594e0fa2838454002ea317a0",
  "_links": {
    "self": {
      "href": "https://uat-api.synapsefi.com/v3.1/users/594e0fa2838454002ea317a0"
    }
  },
  "client": {
    "id": "589acd9ecb3cd400fa75ac06",
    "name": "SynapseFI"
  },
  "documents": [
    {
      "entity_scope": "Arts & Entertainment",
      "entity_type": "M",
      "id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
      "id_score": 0.95,
      "name": "Test User",
      "permission_scope": "SEND|RECEIVE|TIER|1",
      "physical_docs": [
       {
          "document_type": "GOVT_ID_BACK",
          "id": "07520abc16d0fa4224af7e53d6f57b69080c531a176dcfa249ec570f9192e09e",
          "last_updated": 1498288034877,
                    "status": "SUBMITTED|VALID"
                },
        {
          "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"
        }
      ],
      "virtual_docs": [
        {
          "document_type": "SSN",
          "id": "ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f",
          "last_updated": 1498288034875,
          "status": "SUBMITTED|VALID"
        }
      ],
      "watchlists": "NO_MATCH"

    }
  ],
  "emails": [],
  "extra": {
    "cip_tag": 1,
    "date_joined": 1498288029784,
    "extra_security": false,
    "is_business": false,
    "is_trusted": true,
    "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",
  "watchlists": "NO_MATCH"  
}
{
  "error": {
    "en": "Unable to locate object. Unable to locate user object with filter {'_id': ObjectId('594e0fa2838454002ea317a0')}"
  },
  "error_code": "404",
  "http_code": "404",
  "success": false
}
 
Suggest Edits

View All Users

Get a list of users and their information

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

Query Params

page
int32

Page number

per_page
int32

Number of users per page

query
string

Name/Email to search

show_refresh_tokens
string

[yes/no] If user objects should have refresh tokens

Users Object

Key
Type
Description

error_code

string

See Common Errors for more information

http_code

string

See Common Errors for more information

limit

integer

Number of users per page

page

integer

Page number

page_count

integer

Number of pages

success

boolean

Request success

users[]

array of objects

List of user objects. See View User for more information

users_count

integer

Total number of users

GET /v3.1/users HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_6zZVr8biuqGkyo9IxMO5jY2QlSp0nmD4EBAgKcJW
X-SP-USER-IP: 127.0.0.1
X-SP-USER: |e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json
users = client.get_all_users()
users = client.getAllUsers();
client.get_users()
$client->get_all_users();
data, err := client.GetUsers()
A binary file was returned

You couldn't be authenticated

{
  "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"
      },
      "documents": [
        {
          "entity_scope": "Arts & Entertainment",
          "entity_type": "M",
          "id": "189d2fc37c1ee5694aa62f302bcd7c0efa",
          "id_score": 0.95,
          "name": "Charlie Brown",
          "permission_scope": "SEND|RECEIVE|1000|DAILY",
          "physical_docs": [
           {
              "document_type": "GOVT_ID_BACK",
              "id": "07520abc16d0fa4224af7e53d6f57b69080c531a176dcfa249ec570f9192e09e",
              "last_updated": 1498262807101,
              "status": "SUBMITTED|VALID"
            },
            {
              "document_type": "GOVT_ID",
              "id": "c1a1e29ee0d1d0eeacbbafe5d386498d4f5274a4b7499559544d75a964a05e77",
              "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"
            }
          ],
          "watchlists": "NO_MATCH"
        }
      ],
      "emails": [],
      "extra": {
        "cip_tag": 1,
        "date_joined": 1498262801436,
        "extra_security": true,
        "is_business": false,
        "is_trusted": true,
        "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.111.1111"
      ],
      "photos": [],
      "refresh_token": "refresh_xsAb2Pv9Sf8QNBq1yMhlcGoTwVJ0mEUjeF3XnILi",
      "watchlists": "NO_MATCH"
    },
    {
      ...
    },
    {
      ...
    }
  ],
  "users_count": 13760
}
 
Suggest Edits

View User w/ Full Dehydrate

Return all available user information including address information, screening results, etc.

 
gethttps://uat-api.synapsefi.com/v3.1/users/user_id?full_dehydrate=yes

Path Params

user_id
string
required

Object ID of user

Query Params

full_dehydrate
string
required

yes

User Object

Key
Type
Description

_id

string

Object ID of the user

_links.self.href

string

HAL-style link for the user object

client.id

string

ID of the client that created the user

client.name

string

Name of the client that created the user

documents[]

array of objects

extra.cip_tag

integer

Customer Identification Program number

extra.date_joined

integer

Date user joined in milliseconds since epoch time

extra.is_business

boolean

Flag for businesses

extra.is_trusted

boolean

Flag for trusted users

extra.last_updated

integer

Date user was last updated in milliseconds since epoch time

extra.supp_id

string

Additional ID to assign to the node

legal_names

array of strings

Legal names associated with the user

logins[]

array of objects

List of login objects

permission

string

See User Permissions for mor information

phone_numbers

array of strings

List of emails and phone numbers for verifying MFA

refresh_token

string

User-specific refresh token for oauth (expires after 10 uses)

Login Object

Key
Type
Description

email

string

Login email

scope

string

Permissions granted to login credentials

Full Dehydrate Base Document Object

Key
Type
Description

address_city

string

City associated with the document owner, this can be home address of a person or business address of a corp

address_country_code

string

Country associated with the document owner, this can be home address of a person or business address of a corp. This value needs to be in ISO Alpha-2 (i.e. US)

address_postal_code

string

Postal code associated with the document owner, this can be home address of a person or business address of a corp

address_street

string

Street address associated with the document owner, this can be home address of a person or business address of a corp. Please include apartment suite or unit numbers

address_subdivision

string

State abbreviation associated with the document owner. This value needs to be in ISO Alpha-2 (i.e. CA) for US states

alias

string

Alias of the document owner (this can be the name or in case of businesses it can be the DBA entry)

day

string

In case of a person this is day of birth. In case of business entity, this is day of organization

email

string

Email associated with the document

entity_scope

string

See Base Documents for more information

entity_type

string

See Base Documents for more information

id

string

Base document ID

ip

string

IP of where the document is being submitted from

month

string

In case of a person this is month of birth. In case of business entity, this is month of organization

name

string

Name of the document owner

permission_scope

string

See Base Documents Intro for more information

phone_number

string

Phone number associated with the document

physical_docs

array of objects

screening_results

array of objects

List of screening tests and results. If MATCH user may require further investigation

social_docs

array of objects

virtual_docs

array of objects

Full Dehydrate Sub-Document Object

Key
Type
Description

document_type

string

Type of sub-document (EMAIL, PHONE_NUMBER, AOI, etc.)

document_value

string

Value of sub-document (may be hashed depending on the type of document)

id

string

ID of the sub-document

last_updated

string

Date sub-document was last updated (in Unix Time)

meta.matches.address

string

Address match

meta.matches.dob

string

Date of birth match

meta.matches.identification

string

Identification match

GET /v3.1/users/594e0fa2838454002ea317a0?full_dehydrate=yes HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_6zZVr8biuqGkyo9IxMO5jY2QlSp0nmD4EBAgKcJW
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”
queryParams := "full_dehydrate=yes"

user, err := client.GetUser(userID, queryParams)
A binary file was returned

You couldn't be authenticated

{
  "_id": "594e0fa2838454002ea317a0",
  "_links": {
    "self": {
      "href": "https://uat-api.synapsefi.com/v3.1/users/594e0fa2838454002ea317a0"
    }
  },
  "_v": 2,
  "client": {
    "id": "589acd9ecb3cd400fa75ac06",
    "name": "SynapseFI"
  },
  "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",
      "id_score": 0.95,
      "ip": "::1",
      "month": 5,
      "name": "Test User",
      "permission_scope": "SEND|RECEIVE|TIER|1",
      "phone_number": "901.111.1111",
      "physical_docs": [
        {
          "document_type": "GOVT_ID_BACK",
          "document_value": "https://cdn.synapsepay.com/uploads/2019/09/06/x05PvNUbO2VX98rTnJQzaAwiuF7KCgy41ljEeh6HYWkqZd3pRG.gif",
          "id": "07520abc16d0fa4224af7e53d6f57b69080c531a176dcfa249ec570f9192e09e",
          "last_updated": 1498288034877,
          "meta": {
            "matches": {
              "address": "not_found",
              "dob": "not_found",
              "identification": "not_found"
            },
            "retry_count": 1
          },
          "status": "SUBMITTED|VALID"
        },
        {
          "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"
            },
            "retry_count": 1
          },
          "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"
            },
            "retry_count": 1
          },
          "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"
            },
            "retry_count": 1
          },
          "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"
            },
            "retry_count": 1
          },
          "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"
            },
            "retry_count": 1
          },
          "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"
            },
            "retry_count": 2
          },
          "status": "SUBMITTED|VALID"
        }
      ],
      "watchlists": "NO_MATCH",
      "year": 1989
    }
  ],
  "emails": [],
  "extra": {
    "cip_tag": 1,
    "date_joined": 1498288029784,
    "extra_security": false,
    "is_business": false,
    "is_trusted": true,
    "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",
  "watchlists": "NO_MATCH"  
}
{
  "error": {
    "en": "Unable to locate object. Unable to locate user object with filter {'_id': ObjectId('594e0fa2838454002ea317a0')}"
  },
  "error_code": "404",
  "http_code": "404",
  "success": false
}
 
Suggest Edits

Create User w/ KYC

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

Request Body

Key
Type
Description

logins[]

array of objects

[Required] List of login credentials

phone_numbers

array of strings

[Required] All the phone numbers you wish to register with this account

legal_names

array of strings

[Required] All the legal names you wish to register with this account

documents[]

array of objects

List of user KYC documents. See Base Documents for more information

extra.cip_tag

integer

CIP tag associated with the account

extra.extra_security

boolean

If you wish for the user to get a 2FA code every time they OAuth or Login themselves, set this to true

extra.note

string

Any note that you wish to supply to Synapse about the user (not returned with user object)

extra.public_note

string

Any note that you wish to attach to the user (returned with user object)

extra.is_business

boolean

Set to true if business account

extra.supp_id

string

[Max Characters: 250] Additional ID to assign to the node

User Login Credentials Object

Key
Type
Description

email

string

[Required] Login email

password

string

[Required] Must be at least 8 characters long and include a combination of the following: a lowercase letter, an uppercase letter, a number, and a special character

Not Sure What to Do Next?

Check out our Quickstart guide

POST /v3.1/users HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_6zZVr8biuqGkyo9IxMO5jY2QlSp0nmD4EBAgKcJW
X-SP-USER-IP: 127.0.0.1
X-SP-USER: |e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

{
  "logins": [
    {
      "email": "[email protected]"
    }
  ],
  "phone_numbers": [
    "901.111.1111",
    "[email protected]"
  ],
  "legal_names": [
    "Test User"
  ],
  "documents": [
    {
      "email": "[email protected]",
      "phone_number": "901.111.1111",
      "ip": "::1",
      "name": "",
      "alias": "",
      "entity_type": "LLC",
      "entity_scope": "Arts & Entertainment",
      "day": 2,
      "month": 5,
      "year": 1989,
      "address_street": "1 Market St.",
      "address_city": "SF",
      "address_subdivision": "CA",
      "address_postal_code": "94105",
      "address_country_code": "US",
      "virtual_docs": [],
      "physical_docs": [],
      "social_docs": []
    }
  ],
  "extra": {
    "supp_id": "122eddfgbeafrfvbbb",
    "cip_tag": 1,
    "is_business": true
  }
}
body = {
  "logins": [
    {
      "email": "[email protected]"
    }
  ],
  "phone_numbers": [
    "901.111.1111",
    "[email protected]"
  ],
  "legal_names": [
    "Test User"
  ],
  ...
}

client.create_user(body)
client.createUser({
  logins: [
    {
      email: '[email protected]'
    }
  ],
  phone_numbers: [
    '901.111.1111',
    '[email protected]'
  ],
  legal_names: [
    'Test User'
  ],
  ...
});
body = {
  "logins": [
    {
      "email": "[email protected]"
    }
  ],
  "phone_numbers": [
    "901.111.1111",
    "[email protected]"
  ],
  "legal_names": [
    "Test User"
  ],
  ...
}

client.create_user(payload: body)
$logins_object = (object) [
  'email' => '[email protected]'
];
$legalnames_array = array();
$legalnames_array[] = 'test';

$phoneNumbers_array = array();
$phoneNumbers_array[] = '901.111.1111';

$logins_array = array();
$logins_array[] = $logins_object;
$body = (object) [
  'login_obj' => $logins_obj
  'legal_names' => '$legal_names',
  'phone_number' => '$phone_number'
];

$newuser = $client->create_user($body);
body = `{
  "logins": [
    {
      "email": "[email protected]"
    }
  ],
  "phone_numbers": [
    "901.111.1111",
    "[email protected]"
  ],
  "legal_names": [
    "Test User"
  ],
  ...
}`

data, err := client.CreateUser(body)
A binary file was returned

You couldn't be authenticated

{
  "_id": "5c8aa575eaf3f300689a49dd",
  "_links": {
    "self": {
      "href": "https://uat-api.synapsefi.com/v3.1/users/5c8aa575eaf3f300689a49dd"
    }
  },
  "client": {
    "id": "5beb506f6d7ceb002490631d",
    "name": "SynapseFI"
  },
  "documents": [
    {
      "entity_scope": "Arts & Entertainment",
      "entity_type": "LLC",
      "id": "90ef29abef3019223ae06c46d775fb47c37b635ded928b8f3bb5270760a45aad",
      "id_score": 0.95,
      "name": "",
      "permission_scope": "UNVERIFIED",
      "physical_docs": [],
      "social_docs": [
        {
          "document_type": "EMAIL",
          "id": "5525ec87ba67bf30171955a04964c5632e273758e696bd0511d65d804b32189e",
          "last_updated": 1552590195485,
          "status": "SUBMITTED|REVIEWING"
        },
        {
          "document_type": "PHONE_NUMBER",
          "id": "fda60784d6375bc44edafaaeae149626c4c13dcb92e85a2a7a00eec2cdfd2b6f",
          "last_updated": 1552590195490,
          "status": "SUBMITTED|REVIEWING"
        },
        {
          "document_type": "IP",
          "id": "28d9177b22c127d9a51d8903893864accf6e553ac326704a4c0d585eaad2516a",
          "last_updated": 1552590195642,
          "status": "SUBMITTED|REVIEWING"
        },
        {
          "document_type": "DATE",
          "id": "2b52edae636ca2fbe12ab1b08a344d381dabc3d2b92844cf7a8d8b6052b26d8e",
          "last_updated": 1552590195779,
          "status": "SUBMITTED|REVIEWING"
        },
        {
          "document_type": "ADDRESS",
          "id": "c615c761d68c578a98fde8e73c490df405ff5d5e34fc11f029660d7e9743df21",
          "last_updated": 1552590195699,
          "status": "SUBMITTED|REVIEWING"
        }
      ],
      "virtual_docs": [],
      "watchlists": "PENDING"

    }
  ],
  "emails": [],
  "extra": {
    "cip_tag": 1,
    "date_joined": 1552590194140,
    "extra_security": false,
    "is_business": true,
    "is_trusted": true,
    "last_updated": 1552590194140,
    "public_note": null,
    "supp_id": "122eddfgbeafrfvbbb"
  },
  "is_hidden": false,
  "legal_names": [
    "Test User"
  ],
  "logins": [
    {
      "email": "[email protected]",
      "scope": "READ_AND_WRITE"
    }
  ],
  "permission": "UNVERIFIED",
  "phone_numbers": [
    "901.111.1111",
    "[email protected]"
  ],
  "photos": [],
  "refresh_token": "refresh_BIZcntlaEiquKpJy0mdvHf3QPYGsjMg8bCFwLNke",
  "watchlists": "PENDING"
}
 
Suggest Edits

Create User w/o KYC

 
posthttps://uat-api.synapsefi.com/v3.1/users#

Request Body

Key
Type
Description

logins[]

array of objects

[Required] List of login credentials

phone_numbers

array of strings

[Required] All the phone numbers you wish to register with this account

legal_names

array of strings

[Required] All the legal names you wish to register with this account

documents[]

array of objects

User KYC documents

extra.cip_tag

integer

CIP tag associated with the account

extra.extra_security

boolean

If you wish for the user to get a 2FA code every time they OAuth or Login themselves, set this to true

extra.note

string

Any note that you wish to supply to Synapse about the user (not returned with user object)

extra.public_note

string

Any note that you wish to attach to the user (returned with user object)

extra.is_business

boolean

Set to true if business account

extra.supp_id

string

Additional ID to assign to node

User Login Credentials Object

Key
Type
Description

email

string

[Required] Login email

password

string

[Required] Must be at least 8 characters long and include a combination of the following: a lowercase letter, an uppercase letter, a number, and a special character

Not Sure What to Do Next?

Check out our Quickstart guide

POST /v3.1/users HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_6zZVr8biuqGkyo9IxMO5jY2QlSp0nmD4EBAgKcJW
X-SP-USER-IP: 127.0.0.1
X-SP-USER: |e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

{
  "logins": [
    {
      "email": "[email protected]"
    }
  ],
  "phone_numbers": [
    "901.111.1111",
    "[email protected]"
  ],
  "legal_names": [
	  "Test User"	
  ],
  "documents":[],
  "extra": {
    "supp_id": "122eddfgbeafrfvbbb",
    "cip_tag":1,
    "is_business": false
  }
}
A binary file was returned

You couldn't be authenticated

{
  "_id": "5c8aa2e2eaf3f300689a4588",
  "_links": {
    "self": {
      "href": "https://uat-api.synapsefi.com/v3.1/users/5c8aa2e2eaf3f300689a4588"
    }
  },
  "client": {
    "id": "5beb506f6d7ceb002490631d",
    "name": "SynapseFI"
  },
  "documents": [],
  "emails": [],
  "extra": {
    "cip_tag": 1,
    "date_joined": 1552589537830,
    "extra_security": false,
    "is_business": false,
    "is_trusted": true,
    "last_updated": 1552589537830,
    "public_note": null,
    "supp_id": "122eddfgbeafrfvbbb"
  },
  "is_hidden": false,
  "legal_names": [
    "Test User"
  ],
  "logins": [
    {
      "email": "[email protected]",
      "scope": "READ_AND_WRITE"
    }
  ],
  "permission": "UNVERIFIED",
  "phone_numbers": [
    "901.111.1111",
    "[email protected]"
  ],
  "photos": [],
  "refresh_token": "refresh_gxQw9MsVblGiJTyZrPUNkWhjqz2m68R7c5D30ufL",
  "watchlists": "PENDING"
}
 
Suggest Edits

Update User Status

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

Path Params

user_id
string
required

Object ID of user

Request Body

Key
Type
Description

permission

string

User permission status. See Users Intro for more information

PATCH /v3.1/users/594e0fa2838454002ea317a0 HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_6zZVr8biuqGkyo9IxMO5jY2QlSp0nmD4EBAgKcJW
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_GXAMgwobNa0J9ziqW2hnfBycU0m7RTFS5sEeP1l8|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

{
  "permission":"MAKE-IT-GO-AWAY"
}
body = {
  "permission":"MAKE-IT-GO-AWAY"
}

user.update_info(body)
const body = {
  permission:"MAKE-IT-GO-AWAY"
}
user.updateUser(body);
body = {
  "permission":"MAKE-IT-GO-AWAY"
}

user.user_update(payload: body)
$body = array (
  'documents' =>
  array (
    array (
      'permission' => 'MAKE-IT-GO-AWAY`
    )
  )
);

$client->update_info($body);
body := `{
  "permission":"MAKE-IT-GO-AWAY"
}`

data, err := user.Update(body)
A binary file was returned

You couldn't be authenticated

{
  "_id": "5bb155ddaadcf02b6d902620",
  "_links": {
    "self": {
      "href": "https://uat-api.synapsefi.com/v3.1/users/5bb155ddaadcf02b6d902620"
    }
  },
  "client": {
    "id": "5ade26b4567a900029e2afd2",
    "name": "Synapsefi"
  },

  "documents": [
    {
      "entity_scope": "Arts & Entertainment",
      "entity_type": "LLC",
      "id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
      "id_score": 0.95,
      "name": "Test User",
      "permission_scope": "SEND|RECEIVE",
      "physical_docs": [
        {
          "document_type": "GOVT_ID",
          "id": "67ebd5ba7ca3c6b4857710d51a9399794c5958bb9c27bd54a3212179a48f7e84",
          "last_updated": 1538348584971,
          "status": "SUBMITTED|VALID"
        }
      ],
      "social_docs": [
        {
          "document_type": "EMAIL",
          "id": "2c45158f6431ca874bbe82f63d5905567854dde4d8b81539944e5779e5eee741",
          "last_updated": 1538348584986,
          "status": "SUBMITTED|VALID"
        },
        {
          "document_type": "DATE",
          "id": "2b52edae636ca2fbe12ab1b08a344d381dabc3d2b92844cf7a8d8b6052b26d8e",
          "last_updated": 1538348584986,
          "status": "SUBMITTED"
        },
        {
          "document_type": "IP",
          "id": "28d9177b22c127d9a51d8903893864accf6e553ac326704a4c0d585eaad2516a",
          "last_updated": 1538348584986,
          "status": "SUBMITTED|VALID"
        },
        {
          "document_type": "PHONE_NUMBER",
          "id": "fda60784d6375bc44edafaaeae149626c4c13dcb92e85a2a7a00eec2cdfd2b6f",
          "last_updated": 1538348584987,
          "status": "SUBMITTED|VALID"
        },
        {
          "document_type": "FACEBOOK",
          "id": "8f314a6a53f36ee569455761e49a2a7fe790d251c5611c65255befdb303602b7",
          "last_updated": 1538348584987,
          "status": "SUBMITTED|VALID"
        },
        {
          "document_type": "ADDRESS",
          "id": "90913d23fbdf3603e5747036e03c5998874b465aa78e7dc7dfc87a901f50891c",
          "last_updated": 1538348584987,
          "status": "SUBMITTED"
        }
      ],
      "virtual_docs": [
        {
          "document_type": "SSN",
          "id": "7cb85697d26e2c1010266fd64a22afd396167ca630a4bad21a9e8fcff865bb1c",
          "last_updated": 1538348584948,
          "status": "SUBMITTED|VALID"
        }
      ]
      "watchlists": "PENDING"
    }
  ],
  "emails": [],
  "extra": {
    "cip_tag": 1,
    "date_joined": 1538348500635,
    "extra_security": false,
    "is_business": false,
    "is_trusted": true,
    "last_updated": 1538367080540,
    "public_note": null,
    "supp_id": "my_user_id"
  },
  "is_hidden": false,
  "legal_names": [
    "Test User"
  ],
  "logins": [
    {
      "email": "[email protected]",
      "scope": "READ_AND_WRITE"
    }
  ],
  "permission": "MAKE-IT-GO-AWAY",
  "phone_numbers": [
    "901.111.1111",
    "[email protected]"
  ],
  "photos": [],
  "refresh_token": "refresh_hqbzjWQnuo1dMJA2a0O0Nx6Em7tIGSXk9Z8vfFyi",
  "watchlists": "PENDING"
}
 
Suggest Edits

Remove User Information

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

Path Params

user_id
string
required

Object ID of user

Request Body

Remove Login Object

Key
Type
Description

update.remove_login.email

string

Login email to remove

Remove Phone Number

Key
Type
Description

update.remove_phone_number

string

Phone number or email to remove from phone_numbers

Removing Last Base Document

Any attempt to remove a user's only base document will be unsuccessful. If you wish to remove the user's base document, please add a new base document to the user's account

PATCH /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: oauth_1mtgLwhYHDVKop04XOEjyWJSsnQqZbGkfRF5ux9v|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

{
  "update": {
    "remove_login": {
      "email": "[email protected]"
    }
  }
}
body = {
  "update": {
    "remove_login": {
      "email": "[email protected]"
    }
  }
}

user.update_info(body)
const body = {
  "update": {
    "remove_login": {
      "email": "[email protected]"
    }
  }
};

user.updateUser(body);
body = {
  "update": {
    "remove_login": {
      "email": "[email protected]"
    }
  }
}

user.user_update(payload: body)
$removephone = (object)[
  "remove_phone_number" => "777.111.1111"
];
$updateuser = (object)[
  "update" => $removephone
];
$user->update_info($updateuser);
body := `{
  "update": {
    "remove_login": {
      "email": "[email protected]"
    }
  }
}`

data, err := user.Update(body)
A binary file was returned

You couldn't be authenticated

{
  "_id": "5c8aa9687d093e00686b7331",
  "_links": {
    "self": {
      "href": "https://uat-api.synapsefi.com/v3.1/users/5c8aa9687d093e00686b7331"
    }
  },
  "client": {
    "id": "589acd9ecb3cd400fa75ac06",
    "name": "SynapseFI"
  },
  "documents": [],
  "emails": [],
  "extra": {
    "cip_tag": 1,
    "date_joined": 1552591205225,
    "extra_security": false,
    "is_business": true,
    "is_trusted": true,
    "last_updated": 1552595038091,
    "public_note": null,
    "supp_id": "122eddfgbeafrfvbbb"
  },
  "is_hidden": false,
  "legal_names": [
    "Test User"
  ],
  "logins": [],
  "permission": "SEND-AND-RECEIVE",
  "phone_numbers": [
    "[email protected]"
  ],
  "photos": [],
  "refresh_token": "refresh_dX9ZSf47vNiIyH13ajxEkTQVP68qr0KuMlRLo5Wg",
  "watchlists": "PENDING"
}
 
Suggest Edits

Base Documents

 

Base Document Object

Key
Type
Description

entity_scope

string

Industry in which the document owner operates. In case of an individual it can be their field of profession; in case of a corp this can be their line of business. Can be hard-coded as NOT_KNOWN.

entity_type

string

Entity type of the document owner, this can be gender in case of an individual or DBA in case of a business. Can be hard-coded as Not Known (e.g. if platform doesn't ask individual end-users to specify gender).

id

string

ID of the base document

id_score

string

Based on documents submitted for user and can be found in the base document. If the ID score is above an agreed-upon threshold, user will be SEND-AND-RECEIVE. If the score is below a certain threshold, user will be UNVERIFIED and additional KYC will be required.

name

string

Name of the base document owner

permission_scope

string

physical_docs[]

array of objects

See Sub-Document Object for more information

social_docs[]

array of objects

See Sub-Document Object for more information

virtual_docs[]

array of objects

See Sub-Document Object for more information

watchlists

string

Flag to indicate if any documents triggered a MATCH in watchlists / sanctions lists checks performed by Synapse's KYC verification system. See Sanctions Tiers and Watchlists Explained for more information.

 
Suggest Edits

Add Base Documents

Add another set of base documents to the user

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

Path Params

user_id
string
required

Object ID of user

Request Body

Key
Type
Description

name

string

[Required] Name of the document owner

alias

string

Alias of the document owner (this can be the name or in case of businesses it can be the DBA entry)

email

string

[Required] Email associated with the document

phone_number

string

[Required] Phone number associated with the document

ip

string

[Required] IP of where the document is being submitted from

entity_scope

string

[Required] See Base Documents for more information

entity_type

string

[Required] See Base Documents for more information

day

integer

[Required] In case of a person this is day of birth. In case of business entity, this is day of organization

month

integer

[Required] In case of a person this is month of birth. In case of business entity, this is month of organization

year

integer

[Required] In case of a person this is year of birth (must be over 18 unless account is a joint account with parent/legal guardian). In case of business entity, this is year of organization

address_street

string

[Required] Street address associated with the document owner, this can be home address of a person or business address of a corp. Please include apartment suite or unit numbers

address_city

string

[Required] City associated with the document owner, this can be home address of a person or business address of a corp

address_subdivision

string

[Required] State abbreviation associated with the document owner. This value needs to be in ISO Alpha-2 (i.e. CA)

address_postal_code

string

[Required] Postal code associated with the document owner, this can be home address of a person or business address of a corp

address_code_country

string

[Required] Country associated with the document owner, this can be home address of a person or business address of a corp. This value needs to be in ISO Alpha-2 (i.e. US)

physical_docs[]

array of objects

See Sub-Documents for more information

social_docs[]

array of objects

See Sub-Documents for more information

virtual_docs[]

array of objects

See Sub-Documents for more information

PATCH /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: oauth_1mtgLwhYHDVKop04XOEjyWJSsnQqZbGkfRF5ux9v|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

{
  "documents": [
    {
      "email": "[email protected]",
      "phone_number": "901.111.1111",
      "ip": "::1",
      "name": "New Test User",
      "alias": "Test",
      "entity_type": "M",
      "entity_scope": "Arts & Entertainment",
      "day": 2,
      "month": 5,
      "year": 1989,
      "address_street": "1 Market St.",
      "address_city": "SF",
      "address_subdivision": "CA",
      "address_postal_code": "94105",
      "address_country_code": "US",
      "virtual_docs": [
        {
          "document_value": "2222",
          "document_type": "SSN"
        }
      ],
      "physical_docs": [
        {
          "document_value": "data:image/gif;base64,SUQs==",
          "document_type": "GOVT_ID"
        }
      ],
      "social_docs": [
        {
          "document_value": "https://www.facebook.com/valid",
          "document_type": "FACEBOOK"
        }
      ]
    }
  ]
}
body = {
  "documents": [
    {
      "email": "[email protected]",
      "phone_number": "901.111.1111",
      "ip": "::1",
      "name": "New Test User",
      "alias": "Test",
      "entity_type": "M",
      "entity_scope": "Arts & Entertainment",
      "day": 2,
      "month": 5,
      "year": 1989,
      "address_street": "1 Market St.",
      "address_city": "SF",
      "address_subdivision": "CA",
      "address_postal_code": "94105",
      "address_country_code": "US",
      "virtual_docs": [
        {
          "document_value": "2222",
          "document_type": "SSN"
        }
      ],
      "physical_docs": [
        {
          "document_value": "data:image/gif;base64,SUQs==",
          "document_type": "GOVT_ID"
        }
      ],
      "social_docs": [
        {
          "document_value": "https://www.facebook.com/valid",
          "document_type": "FACEBOOK"
        }
      ]
    }
  ]
}

user.update_info(body)
const body = {
  "documents": [
    {
      "email": "[email protected]",
      "phone_number": "901.111.1111",
      "ip": "::1",
      "name": "New Test User",
      "alias": "Test",
      "entity_type": "M",
      "entity_scope": "Arts & Entertainment",
      "day": 2,
      "month": 5,
      "year": 1989,
      "address_street": "1 Market St.",
      "address_city": "SF",
      "address_subdivision": "CA",
      "address_postal_code": "94105",
      "address_country_code": "US",
      "virtual_docs": [
        {
          "document_value": "2222",
          "document_type": "SSN"
        }
      ],
      "physical_docs": [
        {
          "document_value": "data:image/gif;base64,SUQs==",
          "document_type": "GOVT_ID"
        }
      ],
      "social_docs": [
        {
          "document_value": "https://www.facebook.com/valid",
          "document_type": "FACEBOOK"
        }
      ]
    }
  ]
};

user.updateUser(body);
body = {
  "documents": [
    {
      "email": "[email protected]",
      "phone_number": "901.111.1111",
      "ip": "::1",
      "name": "New Test User",
      "alias": "Test",
      "entity_type": "M",
      "entity_scope": "Arts & Entertainment",
      "day": 2,
      "month": 5,
      "year": 1989,
      "address_street": "1 Market St.",
      "address_city": "SF",
      "address_subdivision": "CA",
      "address_postal_code": "94105",
      "address_country_code": "US",
      "virtual_docs": [
        {
          "document_value": "2222",
          "document_type": "SSN"
        }
      ],
      "physical_docs": [
        {
          "document_value": "data:image/gif;base64,SUQs==",
          "document_type": "GOVT_ID"
        }
      ],
      "social_docs": [
        {
          "document_value": "https://www.facebook.com/valid",
          "document_type": "FACEBOOK"
        }
      ]
    }
  ]
}

user.user_update(payload: body)
$body = array (
  'documents' =>
  array (
    array (
      'id' => '2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8',
      'email' => '[email protected]'
    )
  )
);

$client->update_info($body);
body := `{
  "documents": [
    {
      "email": "[email protected]",
      "phone_number": "901.111.1111",
      "ip": "::1",
      "name": "New Test User",
      "alias": "Test",
      "entity_type": "M",
      "entity_scope": "Arts & Entertainment",
      "day": 2,
      "month": 5,
      "year": 1989,
      "address_street": "1 Market St.",
      "address_city": "SF",
      "address_subdivision": "CA",
      "address_postal_code": "94105",
      "address_country_code": "US",
      "virtual_docs": [
        {
          "document_value": "2222",
          "document_type": "SSN"
        }
      ],
      "physical_docs": [
        {
          "document_value": "data:image/gif;base64,SUQs==",
          "document_type": "GOVT_ID"
        }
      ],
      "social_docs": [
        {
          "document_value": "https://www.facebook.com/valid",
          "document_type": "FACEBOOK"
        }
      ]
    }
  ]
}`

data, err := user.Update(body)
A binary file was returned

You couldn't be authenticated

{
  "_id": "5c8aa9687d093e00686b7331",
  "_links": {
    "self": {
      "href": "https://uat-api.synapsefi.com/v3.1/users/5c8aa9687d093e00686b7331"
    }
  },
  "client": {
    "id": "589acd9ecb3cd400fa75ac06",
    "name": "SynapseFI"
  },
  "documents": [
    {
      "entity_scope": "Education",
      "entity_type": "LLC",
      "id": "ab43a7aa8e7b4cc4b551f590afc43ffa6185693ed19a98ccf9ebe54c6e0b8efc",
      "id_score": null,
      "name": "Another Test Name",
      "permission_scope": "SEND|RECEIVE",
      "physical_docs": [],
      "social_docs": [
        {
          "document_type": "PHONE_NUMBER",
          "id": "fda60784d6375bc44edafaaeae149626c4c13dcb92e85a2a7a00eec2cdfd2b6f",
          "last_updated": 1552591927398,
          "status": "SUBMITTED|VALID"
        },
        {
          "document_type": "EMAIL",
          "id": "e42ade1108e478339c31c89d27bd69b414346633ff55db9b37c3e2e3d2281af9",
          "last_updated": 1552591927398,
          "status": "SUBMITTED|VALID"
        },
        {
          "document_type": "ADDRESS",
          "id": "c615c761d68c578a98fde8e73c490df405ff5d5e34fc11f029660d7e9743df21",
          "last_updated": 1552591927398,
          "status": "SUBMITTED"
        },
        {
          "document_type": "IP",
          "id": "28d9177b22c127d9a51d8903893864accf6e553ac326704a4c0d585eaad2516a",
          "last_updated": 1552591927398,
          "status": "SUBMITTED|VALID"
        },
        {
          "document_type": "DATE",
          "id": "2b52edae636ca2fbe12ab1b08a344d381dabc3d2b92844cf7a8d8b6052b26d8e",
          "last_updated": 1552591927398,
          "status": "SUBMITTED"
        }
      ],
      "virtual_docs": [
        {
          "document_type": "SSN",
          "id": "ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f",
          "last_updated": 1552591927398,
          "status": "SUBMITTED|VALID"
        }
      ]
    },
    {
      "entity_scope": "Arts & Entertainment",
      "entity_type": "M",
      "id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
      "name": "New Test User",
      "permission_scope": "UNVERIFIED",
      "physical_docs": [
        {
          "document_type": "GOVT_ID",
          "id": "9f28b5f32884b0413622a07edab8fc4cbb6b1d7c0463ffbb8b7b37fd4b06dbc6",
          "last_updated": 1552592280581,
          "status": "SUBMITTED|REVIEWING"
        }
      ],
      "social_docs": [
        {
          "document_type": "PHONE_NUMBER",
          "id": "fda60784d6375bc44edafaaeae149626c4c13dcb92e85a2a7a00eec2cdfd2b6f",
          "last_updated": 1552592280769,
          "status": "SUBMITTED|REVIEWING"
        },
        {
          "document_type": "DATE",
          "id": "2b52edae636ca2fbe12ab1b08a344d381dabc3d2b92844cf7a8d8b6052b26d8e",
          "last_updated": 1552592281377,
          "status": "SUBMITTED|REVIEWING"
        },
        {
          "document_type": "FACEBOOK",
          "id": "8f314a6a53f36ee569455761e49a2a7fe790d251c5611c65255befdb303602b7",
          "last_updated": 1552592280670,
          "status": "SUBMITTED|REVIEWING"
        },
        {
          "document_type": "EMAIL",
          "id": "2c45158f6431ca874bbe82f63d5905567854dde4d8b81539944e5779e5eee741",
          "last_updated": 1552592280759,
          "status": "SUBMITTED|REVIEWING"
        },
        {
          "document_type": "IP",
          "id": "28d9177b22c127d9a51d8903893864accf6e553ac326704a4c0d585eaad2516a",
          "last_updated": 1552592281129,
          "status": "SUBMITTED|REVIEWING"
        },
        {
          "document_type": "ADDRESS",
          "id": "1674a8d0b19d89a09f3138be55dd22295fc9dc91d7086ec4b9088b052e10939c",
          "last_updated": 1552592281230,
          "status": "SUBMITTED|REVIEWING"
        }
      ],
      "virtual_docs": [
        {
          "document_type": "SSN",
          "id": "ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f",
          "last_updated": 1552592280571,
          "status": "SUBMITTED|REVIEWING"
        }
      ],
      "watchlists": "PENDING"
    }
  ],
  "emails": [],
  "extra": {
    "cip_tag": 1,
    "date_joined": 1552591205225,
    "extra_security": false,
    "is_business": true,
    "is_trusted": true,
    "last_updated": 1552592279612,
    "public_note": null,
    "supp_id": "122eddfgbeafrfvbbb"
  },
  "is_hidden": false,
  "legal_names": [
    "Another Test Name"
  ],
  "logins": [
    {
      "email": "[email protected]",
      "scope": "READ_AND_WRITE"
    }
  ],
  "permission": "SEND-AND-RECEIVE",
  "phone_numbers": [
    "[email protected]"
  ],
  "photos": [],
  "refresh_token": "refresh_dX9ZSf47vNiIyH13ajxEkTQVP68qr0KuMlRLo5Wg",
  "watchlists": "PENDING"
}
 
Suggest Edits

Update Base Documents

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

Path Params

user_id
string
required

Object ID of user

Request Body

Key
Type
Description

documents[]

array of objects

[Required] List of base documents with IDs and fields you wish to update

Base Document Object

Key
Type
Description

id

string

[Required] Base document ID

email

string

Email associated with the document

name

string

Name of the document owner

entity_scope

string

Industry in which the document owner operates. In case of an individual it can be their field of profession, in case of a corp this can be their line of business

entity_type

string

Entity type of the document owner, this can be gender in case of an individual or DBA in case of a business

PATCH /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: oauth_1mtgLwhYHDVKop04XOEjyWJSsnQqZbGkfRF5ux9v|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

{
  "documents":[{
    "id":"ab43a7aa8e7b4cc4b551f590afc43ffa6185693ed19a98ccf9ebe54c6e0b8efc",
    "email":"[email protected]",
    "name": "Another Test Name",
    "entity_scope": "Education",
    "entity_type": "LLC"
  }]
}
body = {
  "documents":[{
    "id":"ab43a7aa8e7b4cc4b551f590afc43ffa6185693ed19a98ccf9ebe54c6e0b8efc",
    "email":"[email protected]",
    "name": "Another Test Name",
    "entity_scope": "Education",
    "entity_type": "LLC"
  }]
}

user.update_info(body)
const body = {
  documents: [{
    id: 'ab43a7aa8e7b4cc4b551f590afc43ffa6185693ed19a98ccf9ebe54c6e0b8efc',
    email: '[email protected]',
    name: 'Another Test Name',
    entity_scope: 'Education',
    entity_type: 'LLC'
  }]
};

user.updateUser(body);
body = {
  "documents":[{
    "id":"ab43a7aa8e7b4cc4b551f590afc43ffa6185693ed19a98ccf9ebe54c6e0b8efc",
    "email":"[email protected]",
    "name": "Another Test Name",
    "entity_scope": "Education",
    "entity_type": "LLC"
  }]
}

user.user_update(payload: body)
$body = array (
  'documents' =>
  array (
    array (
      'id' => 'ab43a7aa8e7b4cc4b551f590afc43ffa6185693ed19a98ccf9ebe54c6e0b8efc',
      'email' => '[email protected]'
    )
  )
);

$client->update_info($body);
body := `{
  "documents":[{
    "id":"ab43a7aa8e7b4cc4b551f590afc43ffa6185693ed19a98ccf9ebe54c6e0b8efc",
    "email":"[email protected]",
    "name": "Another Test Name",
    "entity_scope": "Education",
    "entity_type": "LLC"
  }]
}`

data, err := user.Update(body)
A binary file was returned

You couldn't be authenticated

{
  "_id": "5c8aa9687d093e00686b7331",
  "_links": {
    "self": {
      "href": "https://uat-api.synapsefi.com/v3.1/users/5c8aa9687d093e00686b7331"
    }
  },
  "client": {
    "id": "589acd9ecb3cd400fa75ac06",
    "name": "SynapseFI"
  },
  "documents": [
    {
      "entity_scope": "Education",
      "entity_type": "LLC",
      "id": "ab43a7aa8e7b4cc4b551f590afc43ffa6185693ed19a98ccf9ebe54c6e0b8efc",
      "id_score": null,
      "name": "Another Test Name",
      "permission_scope": "UNVERIFIED",
      "physical_docs": [],
      "social_docs": [
        {
          "document_type": "PHONE_NUMBER",
          "id": "fda60784d6375bc44edafaaeae149626c4c13dcb92e85a2a7a00eec2cdfd2b6f",
          "last_updated": 1552591727579,
          "status": "SUBMITTED|VALID"
        },
        {
          "document_type": "EMAIL",
          "id": "e42ade1108e478339c31c89d27bd69b414346633ff55db9b37c3e2e3d2281af9",
          "last_updated": 1552591778333,
          "status": "SUBMITTED|REVIEWING"
        },
        {
          "document_type": "ADDRESS",
          "id": "c615c761d68c578a98fde8e73c490df405ff5d5e34fc11f029660d7e9743df21",
          "last_updated": 1552591727579,
          "status": "SUBMITTED"
        },
        {
          "document_type": "IP",
          "id": "28d9177b22c127d9a51d8903893864accf6e553ac326704a4c0d585eaad2516a",
          "last_updated": 1552591727580,
          "status": "SUBMITTED|VALID"
        },
        {
          "document_type": "DATE",
          "id": "2b52edae636ca2fbe12ab1b08a344d381dabc3d2b92844cf7a8d8b6052b26d8e",
          "last_updated": 1552591727580,
          "status": "SUBMITTED"
        }
      ],
      "virtual_docs": [],
      "watchlists": "PENDING"
    }
  ],
  "emails": [],
  "extra": {
    "cip_tag": 1,
    "date_joined": 1552591205225,
    "extra_security": false,
    "is_business": true,
    "is_trusted": true,
    "last_updated": 1552591778244,
    "public_note": null,
    "supp_id": "122eddfgbeafrfvbbb"
  },
  "is_hidden": false,
  "legal_names": [
    "Another Test Name"
  ],
  "logins": [
    {
      "email": "[email protected]",
      "scope": "READ_AND_WRITE"
    }
  ],
  "permission": "UNVERIFIED",
  "phone_numbers": [
    "901.111.111",
    "[email protected]"
  ],
  "photos": [],
  "refresh_token": "refresh_dX9ZSf47vNiIyH13ajxEkTQVP68qr0KuMlRLo5Wg",
  "watchlists": "PENDING"
}
 
Suggest Edits

Remove Base Document

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

Path Params

user_id
string
required

Object ID of user

Request Body

Key
Type
Description

documents[]

array of objects

List of base documents with IDs and fields you wish to update

Base Document Object

Key
Type
Description

id

string

[Required] Base document ID

permission_scope

string

Set as DELETE_DOCUMENT

Removing Last Base Document

Any attempt to remove a user's only base document will be unsuccessful. If you wish to remove the user's base document, please add a new base document to the user's account

PATCH /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: oauth_1mtgLwhYHDVKop04XOEjyWJSsnQqZbGkfRF5ux9v|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

{
  "documents":[{
    "id":"ab43a7aa8e7b4cc4b551f590afc43ffa6185693ed19a98ccf9ebe54c6e0b8efc",
    "permission_scope":"DELETE_DOCUMENT"
  }]
}
body = {
  "documents":[{
    "id":"ab43a7aa8e7b4cc4b551f590afc43ffa6185693ed19a98ccf9ebe54c6e0b8efc",
    "permission_scope":"DELETE_DOCUMENT"
  }]
}

user.update_info(body)
const body = {
  documents: [{
    id:'ab43a7aa8e7b4cc4b551f590afc43ffa6185693ed19a98ccf9ebe54c6e0b8efc',
    permission_scope: 'DELETE_DOCUMENT'
  }]
};

user.updateUser(body);
body = {
  "documents":[{
    "id":"ab43a7aa8e7b4cc4b551f590afc43ffa6185693ed19a98ccf9ebe54c6e0b8efc",
    "permission_scope":"DELETE_DOCUMENT"
  }]
}

user.user_update(payload: body)
$body = array (
  'documents' =>
  array (
    array (
      'id' => 'ab43a7aa8e7b4cc4b551f590afc43ffa6185693ed19a98ccf9ebe54c6e0b8efc',
      'permission_scope' => 'DELETE_DOCUMENT'
    )
  )
);

$client->update_info($body);
body := `{
  "documents":[{
    "id":"ab43a7aa8e7b4cc4b551f590afc43ffa6185693ed19a98ccf9ebe54c6e0b8efc",
    "permission_scope":"DELETE_DOCUMENT"
  }]
}`

data, err := user.Update(body)
A binary file was returned

You couldn't be authenticated

{
  "_id": "5c8aa9687d093e00686b7331",
  "_links": {
    "self": {
      "href": "https://uat-api.synapsefi.com/v3.1/users/5c8aa9687d093e00686b7331"
    }
  },
  "client": {
    "id": "589acd9ecb3cd400fa75ac06",
    "name": "SynapseFI"
  },
  "documents": [],
  "emails": [],
  "extra": {
    "cip_tag": 1,
    "date_joined": 1552591205225,
    "extra_security": false,
    "is_business": true,
    "is_trusted": true,
    "last_updated": 1552595038091,
    "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]"
  ],
  "photos": [],
  "refresh_token": "refresh_dX9ZSf47vNiIyH13ajxEkTQVP68qr0KuMlRLo5Wg",
  "watchlists": "PENDING"  
}
 
Suggest Edits

Sub-Documents

 

Sub-Document Object

Key
Type
Description

document_type

string

Type of sub-document (EMAIL, PHONE_NUMBER, AOI, etc.)

id

string

ID of the sub-document

last_updated

integer

Date sub-document was last updated (in Unix Time)

status

string

Verification status of the document

 
Suggest Edits

Add Sub-Documents

Add sub documents to a user's base document

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

Path Params

user_id
string
required

Object ID of user

Request Body

Key
Type
Description

documents[]

array of objects

[Required] List of base documents with the sub-documents you would like to add

Base Document Object w/ Sub-Document Objects

Key
Table
Description

id

string

[Required] Base document ID

physical_docs[]

array of objects

List of physical documents you would like to add. See Sub-Documents for more information

social_docs[]

array of objects

List of social documents you would like to add. See Sub-Documents for more information

virtual_docs[]

array of objects

List of virtual documents you would like to add. See Sub-Documents for more information

PATCH /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: oauth_1mtgLwhYHDVKop04XOEjyWJSsnQqZbGkfRF5ux9v|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

{
  "documents": [
    {
      "id": "ab43a7aa8e7b4cc4b551f590afc43ffa6185693ed19a98ccf9ebe54c6e0b8efc",
      "virtual_docs": [
        {
          "document_value": "2222",
          "document_type": "SSN"
        }
      ]
    }
  ]
}
body = {
  "documents": [
    {
      "id": "ab43a7aa8e7b4cc4b551f590afc43ffa6185693ed19a98ccf9ebe54c6e0b8efc",
      "virtual_docs": [
        {
          "document_value": "2222",
          "document_type": "SSN"
        }
      ]
    }
  ]
}

user.update_info(body)
const body = {
  documents: [
    {
      id: "ab43a7aa8e7b4cc4b551f590afc43ffa6185693ed19a98ccf9ebe54c6e0b8efc",
      virtual_docs: [
        {
          document_value: "2222",
          document_type: "SSN"
        }
      ]
    }
  ]
};

user.updateUser(body);
body = {
  "documents": [
    {
      "id": "ab43a7aa8e7b4cc4b551f590afc43ffa6185693ed19a98ccf9ebe54c6e0b8efc",
      "virtual_docs": [
        {
          "document_value": "2222",
          "document_type": "SSN"
        }
      ]
    }
  ]
}

user.user_update(payload: body)
$body = array (
  'documents' =>
  array (
    array (
      'id' => '2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8',
      'email' => '[email protected]'
    )
  )
);

$client->update_info($body);
body := `{
  "documents": [
    {
      "id": "ab43a7aa8e7b4cc4b551f590afc43ffa6185693ed19a98ccf9ebe54c6e0b8efc",
      "virtual_docs": [
        {
          "document_value": "2222",
          "document_type": "SSN"
        }
      ]
    }
  ]
}`

data, err := user.Update(body)
A binary file was returned

You couldn't be authenticated

{
  "_id": "5c8aa9687d093e00686b7331",
  "_links": {
    "self": {
      "href": "https://uat-api.synapsefi.com/v3.1/users/5c8aa9687d093e00686b7331"
    }
  },
  "client": {
    "id": "589acd9ecb3cd400fa75ac06",
    "name": "SynapseFI"
  },
  "documents": [
    {
      "entity_scope": "Education",
      "entity_type": "LLC",
      "id": "ab43a7aa8e7b4cc4b551f590afc43ffa6185693ed19a98ccf9ebe54c6e0b8efc",
      "id_score": null,
      "name": "Another Test Name",
      "permission_scope": "SEND|RECEIVE",
      "physical_docs": [],
      "social_docs": [
        {
          "document_type": "PHONE_NUMBER",
          "id": "fda60784d6375bc44edafaaeae149626c4c13dcb92e85a2a7a00eec2cdfd2b6f",
          "last_updated": 1552592285422,
          "status": "SUBMITTED|VALID"
        },
        {
          "document_type": "EMAIL",
          "id": "e42ade1108e478339c31c89d27bd69b414346633ff55db9b37c3e2e3d2281af9",
          "last_updated": 1552592285422,
          "status": "SUBMITTED|VALID"
        },
        {
          "document_type": "ADDRESS",
          "id": "c615c761d68c578a98fde8e73c490df405ff5d5e34fc11f029660d7e9743df21",
          "last_updated": 1552592285422,
          "status": "SUBMITTED"
        },
        {
          "document_type": "IP",
          "id": "28d9177b22c127d9a51d8903893864accf6e553ac326704a4c0d585eaad2516a",
          "last_updated": 1552592285422,
          "status": "SUBMITTED|VALID"
        },
        {
          "document_type": "DATE",
          "id": "2b52edae636ca2fbe12ab1b08a344d381dabc3d2b92844cf7a8d8b6052b26d8e",
          "last_updated": 1552592285422,
          "status": "SUBMITTED"
        }
      ],
      "virtual_docs": [
        {
          "document_type": "SSN",
          "id": "ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f",
          "last_updated": 1552593584936,
          "status": "SUBMITTED|REVIEWING"
        }
      ],
      "watchlists": "PENDING"
    }
  ],
  "emails": [],
  "extra": {
    "cip_tag": 1,
    "date_joined": 1552591205225,
    "extra_security": false,
    "is_business": true,
    "is_trusted": true,
    "last_updated": 1552593584852,
    "public_note": null,
    "supp_id": "122eddfgbeafrfvbbb"
  },
  "is_hidden": false,
  "legal_names": [
    "Another Test Name"
  ],
  "logins": [
    {
      "email": "[email protected]",
      "scope": "READ_AND_WRITE"
    }
  ],
  "permission": "SEND-AND-RECEIVE",
  "phone_numbers": [
    "[email protected]"
  ],
  "photos": [],
  "refresh_token": "refresh_dX9ZSf47vNiIyH13ajxEkTQVP68qr0KuMlRLo5Wg",
  "watchlists": "PENDING"  
}
 
Suggest Edits

Update Sub-Documents

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

Path Params

user_id
string
required

Object ID of user

Request Body

Key
Type
Description

documents[]

array of objects

[Required] List of base documents with the sub-documents you would like to add

Base Document Object w/ Sub-Document Objects

Key
Type
Description

id

string

[Required] Base document ID

physical_docs[]

string

List of physical documents you would like to update

social_docs[]

string

List of social documents you would like to update

virtual_docs[]

string

List of virtual documents you would like to update

Sub-Document Object

Key
Type
Description

id

string

[Required] Sub-document ID

document_type

string

[Required] Type of sub-document

document_value

string

[Required] Updated value of sub-document

PATCH /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: oauth_1mtgLwhYHDVKop04XOEjyWJSsnQqZbGkfRF5ux9v|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

{
  "documents": [
    {
      "id": "ab43a7aa8e7b4cc4b551f590afc43ffa6185693ed19a98ccf9ebe54c6e0b8efc",
      "virtual_docs": [
        {
          "id": "ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f",
          "document_value": "111-11-2222",
          "document_type": "SSN"
        }
      ]
    }
  ]
}
body = {
  "documents": [
    {
      "id": "ab43a7aa8e7b4cc4b551f590afc43ffa6185693ed19a98ccf9ebe54c6e0b8efc",
      "virtual_docs": [
        {
          "id": "ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f",
          "document_value": "111-11-2222",
          "document_type": "SSN"
        }
      ]
    }
  ]
}

user.update_info(body)
const body = {
  documents: [
    {
      id: "ab43a7aa8e7b4cc4b551f590afc43ffa6185693ed19a98ccf9ebe54c6e0b8efc",
      virtual_docs: [
        {
          id: "ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f",
          document_value: "111-11-2222",
          document_type: "SSN"
        }
      ]
    }
  ]
};

user.updateUser(body);
body = {
  "documents": [
    {
      "id": "ab43a7aa8e7b4cc4b551f590afc43ffa6185693ed19a98ccf9ebe54c6e0b8efc",
      "virtual_docs": [
        {
          "id": "ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f",
          "document_value": "111-11-2222",
          "document_type": "SSN"
        }
      ]
    }
  ]
}

user.user_update(payload: body)
$body = array (
  'documents' =>
  array (
    array (
      'id' => '2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8',
      'email' => '[email protected]'
    )
  )
);

$client->update_info($body);
body := `{
  "documents": [
    {
      "id": "ab43a7aa8e7b4cc4b551f590afc43ffa6185693ed19a98ccf9ebe54c6e0b8efc",
      "virtual_docs": [
        {
          "id": "ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f",
          "document_value": "111-11-2222",
          "document_type": "SSN"
        }
      ]
    }
  ]
}`

data, err := user.Update(body)
A binary file was returned

You couldn't be authenticated

{
  "_id": "5c8aa9687d093e00686b7331",
  "_links": {
    "self": {
      "href": "https://uat-api.synapsefi.com/v3.1/users/5c8aa9687d093e00686b7331"
    }
  },
  "client": {
    "id": "589acd9ecb3cd400fa75ac06",
    "name": "SynapseFI"
  },
  "documents": [
    {
      "entity_scope": "Education",
      "entity_type": "LLC",
      "id": "ab43a7aa8e7b4cc4b551f590afc43ffa6185693ed19a98ccf9ebe54c6e0b8efc",
      "id_score": null,
      "name": "Another Test Name",
      "permission_scope": "UNVERIFIED",
      "physical_docs": [],
      "social_docs": [
        {
          "document_type": "PHONE_NUMBER",
          "id": "fda60784d6375bc44edafaaeae149626c4c13dcb92e85a2a7a00eec2cdfd2b6f",
          "last_updated": 1552591780229,
          "status": "SUBMITTED|VALID"
        },
        {
          "document_type": "EMAIL",
          "id": "e42ade1108e478339c31c89d27bd69b414346633ff55db9b37c3e2e3d2281af9",
          "last_updated": 1552591780229,
          "status": "SUBMITTED|VALID"
        },
        {
          "document_type": "ADDRESS",
          "id": "c615c761d68c578a98fde8e73c490df405ff5d5e34fc11f029660d7e9743df21",
          "last_updated": 1552591780229,
          "status": "SUBMITTED"
        },
        {
          "document_type": "IP",
          "id": "28d9177b22c127d9a51d8903893864accf6e553ac326704a4c0d585eaad2516a",
          "last_updated": 1552591780229,
          "status": "SUBMITTED|VALID"
        },
        {
          "document_type": "DATE",
          "id": "2b52edae636ca2fbe12ab1b08a344d381dabc3d2b92844cf7a8d8b6052b26d8e",
          "last_updated": 1552591780229,
          "status": "SUBMITTED"
        }
      ],
      "virtual_docs": [
        {
          "document_type": "SSN",
          "id": "ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f",
          "last_updated": 1552591926196,
          "status": "SUBMITTED|REVIEWING"
        }
      ],
      "watchlists": "PENDING"
    }
  ],
  "emails": [],
  "extra": {
    "cip_tag": 1,
    "date_joined": 1552591205225,
    "extra_security": false,
    "is_business": true,
    "is_trusted": true,
    "last_updated": 1552591926109,
    "public_note": null,
    "supp_id": "122eddfgbeafrfvbbb"
  },
  "is_hidden": false,
  "legal_names": [
    "Another Test Name"
  ],
  "logins": [
    {
      "email": "[email protected]",
      "scope": "READ_AND_WRITE"
    }
  ],
  "permission": "UNVERIFIED",
  "phone_numbers": [
    "[email protected]"
  ],
  "photos": [],
  "refresh_token": "refresh_dX9ZSf47vNiIyH13ajxEkTQVP68qr0KuMlRLo5Wg",
  "watchlists": "PENDING"  
}
 
Suggest Edits

Remove Sub-Document

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

Path Params

user_id
string
required

Object ID of user

Request Body

Key
Type
Description

documents[]

array of objects

[Required] List of base documents with the sub-documents you would like to remove

Base Document Object w/ Sub-Document Objects

Key
Type
Description

id

string

[Required] Base document ID

physical_docs[]

array of objects

List of physical documents you would like to remove

social_docs[]

array of objects

List of social documents you would like to remove

virtual_docs[]

array of objects

List of virtual documents you would like to remove

Sub-Document Object

Key
Type
Description

id

string

[Required] Sub-document ID

document_type

string

[Required] Set as DELETE_DOCUMENT

PATCH /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: oauth_1mtgLwhYHDVKop04XOEjyWJSsnQqZbGkfRF5ux9v|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

{
  "documents": [
    {
      "id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
      "physical_docs": [
        {
          "document_type": "DELETE_DOCUMENT",
          "document_value": "data:image/gif;base64,SUQs==",
          "id": "ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f"
        }
      ]
    }
  ]
}
body = {
  "documents": [
    {
      "id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
      "physical_docs": [
        {
          "document_type": "DELETE_DOCUMENT",
          "document_value": "data:image/gif;base64,SUQs==",
          "id": "ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f"
        }
      ]
    }
  ]
}

user.update_info(body)
const body = {
  documents: [
    {
      id: "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
      physical_docs: [
        {
          document_type: "DELETE_DOCUMENT",
          document_value: "data:image/gif;base64,SUQs==",
          id: "ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f"
        }
      ]
    }
  ]
};

user.updateUser(body);
body = {
  "documents": [
    {
      "id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
      "physical_docs": [
        {
          "document_type": "DELETE_DOCUMENT",
          "document_value": "data:image/gif;base64,SUQs==",
          "id": "ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f"
        }
      ]
    }
  ]
}

user.user_update(payload: body)
$body = array (
  'documents' =>
  array (
    array (
      'id' => '2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8',
      'email' => '[email protected]'
    )
  )
);

$client->update_info($body);
body := `{
  "documents": [
    {
      "id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
      "physical_docs": [
        {
          "document_type": "DELETE_DOCUMENT",
          "document_value": "data:image/gif;base64,SUQs==",
          "id": "ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f"
        }
      ]
    }
  ]
}`

data, err := user.Update(body)
A binary file was returned

You couldn't be authenticated

{
  "_id": "5c8aa9687d093e00686b7331",
  "_links": {
    "self": {
      "href": "https://uat-api.synapsefi.com/v3.1/users/5c8aa9687d093e00686b7331"
    }
  },
  "client": {
    "id": "589acd9ecb3cd400fa75ac06",
    "name": "SynapseFI"
  },
  "documents": [
    {
      "entity_scope": "Arts & Entertainment",
      "entity_type": "M",
      "id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
      "name": "New Test User",
      "permission_scope": "SEND|RECEIVE",
      "physical_docs": [],
      "social_docs": [
        {
          "document_type": "PHONE_NUMBER",
          "id": "fda60784d6375bc44edafaaeae149626c4c13dcb92e85a2a7a00eec2cdfd2b6f",
          "last_updated": 1552595380063,
          "status": "SUBMITTED|VALID"
        },
        {
          "document_type": "DATE",
          "id": "2b52edae636ca2fbe12ab1b08a344d381dabc3d2b92844cf7a8d8b6052b26d8e",
          "last_updated": 1552595380064,
          "status": "SUBMITTED"
        },
        {
          "document_type": "FACEBOOK",
          "id": "8f314a6a53f36ee569455761e49a2a7fe790d251c5611c65255befdb303602b7",
          "last_updated": 1552595380064,
          "status": "SUBMITTED|VALID"
        },
        {
          "document_type": "EMAIL",
          "id": "2c45158f6431ca874bbe82f63d5905567854dde4d8b81539944e5779e5eee741",
          "last_updated": 1552595380064,
          "status": "SUBMITTED|VALID"
        },
        {
          "document_type": "IP",
          "id": "28d9177b22c127d9a51d8903893864accf6e553ac326704a4c0d585eaad2516a",
          "last_updated": 1552595380064,
          "status": "SUBMITTED|VALID"
        },
        {
          "document_type": "ADDRESS",
          "id": "1674a8d0b19d89a09f3138be55dd22295fc9dc91d7086ec4b9088b052e10939c",
          "last_updated": 1552595380064,
          "status": "SUBMITTED"
        }
      ],
      "virtual_docs": [
        {
          "document_type": "SSN",
          "id": "ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f",
          "last_updated": 1552595380063,
          "status": "SUBMITTED|VALID"
        }
      ],
      "watchlists": "PENDING"
    }
  ],
  "emails": [],
  "extra": {
    "cip_tag": 1,
    "date_joined": 1552591205225,
    "extra_security": false,
    "is_business": true,
    "is_trusted": true,
    "last_updated": 1552595405790,
    "public_note": null,
    "supp_id": "122eddfgbeafrfvbbb"
  },
  "is_hidden": false,
  "legal_names": [
    "Another Test Name"
  ],
  "logins": [
    {
      "email": "[email protected]",
      "scope": "READ_AND_WRITE"
    }
  ],
  "permission": "SEND-AND-RECEIVE",
  "phone_numbers": [
    "[email protected]"
  ],
  "photos": [],
  "refresh_token": "refresh_dX9ZSf47vNiIyH13ajxEkTQVP68qr0KuMlRLo5Wg",
  "watchlists": "PENDING"  
}
 
Suggest Edits

Add 2FA Device

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

Path Params

user_id
string
required

Object ID of user

Request Body

Sandbox 2FA

Two-factor authentication pins will not be sent out in sandbox

Key
Type
Description

documents[ ]

array of objects

[Required] List of base documents objects with the social_docs and 2FA devices you wish to add to the user

Base Document Object

Key
Type
Description

id

string

[Required] Base document ID

social_docs[]

array of objects

[Required] List of social document objects you wish to add to the user

Social Document Object

Key
Type
Description

document_type

string

[Required] Set as PHONE_NUMBER_2FA or EMAIL_2FA

document_value

string

[Required] Email or Phone Number to send MFA pin

Additional Information

  • When a new device is registered to the user, an MFA pin will be sent to the email or phone number provided. To verify the device, the correct pin must be submitted to the API as the mfa_answer. See Verify 2FA Device for more information
PATCH /v3.1/users/5c2eaec9e4cf47006728fd29 HTTP/1.1
Host: https://uat-api.synapsefi.com
X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_6zZVr8biuqGkyo9IxMO5jY2QlSp0nmD4EBAgKcJW
X-SP-USER-IP: 255.127.79.76
X-SP-USER: oauth_TEQJHb801qI0jG7UZ2fzt9SKY5u4AWswBRmlDPO3|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

{
  "documents":[{
    "id":"26d63977a590d1794bc14ad7801cd733653db578f7450c7a283d42bac3179998",
    "social_docs":[{
      "document_type":"PHONE_NUMBER_2FA",
      "document_value":"901.111.1111"
    }]
  }]
}
body = {
  "documents":[{
    "id":"26d63977a590d1794bc14ad7801cd733653db578f7450c7a283d42bac3179998",
    "social_docs":[{
      "document_type":"PHONE_NUMBER_2FA",
      "document_value":"901.111.1111"
    }]
  }]
}

user.user_update(body)
const body = {
  "documents":[{
    "id":"26d63977a590d1794bc14ad7801cd733653db578f7450c7a283d42bac3179998",
    "social_docs":[{
      "document_type":"PHONE_NUMBER_2FA",
      "document_value":"901.111.1111"
    }]
  }]
}

user.updateUser(body);
body = {
  "documents":[{
    "id":"26d63977a590d1794bc14ad7801cd733653db578f7450c7a283d42bac3179998",
    "social_docs":[{
      "document_type":"PHONE_NUMBER_2FA",
      "document_value":"901.111.1111"
    }]
  }]
}

user.user_update(payload: body)
$body = array (
  'documents' =>
  array (
    array (
      'id' => '2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8',
      "social_docs":[{
      "document_type":"PHONE_NUMBER_2FA",
      "document_value":"901.111.1111"
    }]
    )
  )
);

$client->update_info($body);
body = `{
  "documents":[{
    "id":"26d63977a590d1794bc14ad7801cd733653db578f7450c7a283d42bac3179998",
    "social_docs":[{
      "document_type":"PHONE_NUMBER_2FA",
      "document_value":"901.111.1111"
    }]
  }]
}`

data, err := user.Update(body)
A binary file was returned

You couldn't be authenticated

{
  "_id": "5c2eaec9e4cf47006728fd29",
  "_links": {
    "self": {
      "href": "https://uat-api.synapsefi.com/v3.1/users/5c2eaec9e4cf47006728fd29"
    }
  },
  "client": {
    "id": "589acd9ecb3cd400fa75ac06",
    "name": "SynapseFI"
  },
  "documents": [
    {
      "entity_scope": "Arts & Entertainment",
      "entity_type": "M",
      "id": "26d63977a590d1794bc14ad7801cd733653db578f7450c7a283d42bac3179998",
      "id_score": null,
      "name": "Test User",
      "permission_scope": "SEND|RECEIVE",
      "physical_docs": [
        {
          "document_type": "GOVT_ID",
          "id": "160f760b57c303b473fee3f701376e12c55ea843810cf34deba8eb06f7030857",
          "last_updated": 1546563275725,
          "status": "SUBMITTED|VALID"
        }
      ],
      "social_docs": [
        {
          "document_type": "EMAIL",
          "id": "2c45158f6431ca874bbe82f63d5905567854dde4d8b81539944e5779e5eee741",
          "last_updated": 1546563275725,
          "status": "SUBMITTED|VALID"
        },
        {
          ...
        },
        {
          "document_type": "PHONE_NUMBER_2FA",
          "id": "6de32f3fee5263baf1558758e8afc9f44284de5d31dd4056fdd0e6bd835c5a38",
          "last_updated": 1546563606001,
          "status": "SUBMITTED|REVIEWING"
        }
      ],
      "virtual_docs": [
        {
          "document_type": "SSN",
          "id": "7cb85697d26e2c1010266fd64a22afd396167ca630a4bad21a9e8fcff865bb1c",
          "last_updated": 1546563275725,
          "status": "SUBMITTED|VALID"
        }
      ],
      "watchlists": "PENDING"
    }
  ],
  "emails": [],
  "extra": {
    "cip_tag": 1,
    "date_joined": 1546563269349,
    "extra_security": false,
    "is_business": false,
    "is_trusted": true,
    "last_updated": 1546563605868,
    "public_note": null,
    "supp_id": "my_user_id"
  },
  "is_hidden": false,
  "legal_names": [
    "Test User"
  ],
  "logins": [
    {
      "email": "[email protected]",
      "scope": "READ_AND_WRITE"
    }
  ],
  "permission": "SEND-AND-RECEIVE",
  "phone_numbers": [
    "901.111.4444"
  ],
  "photos": [],
  "refresh_token": "refresh_2SAzILKq90XN0mOhVbr7vE4R5pTQWfYktdHaleUg",
  "watchlists": "PENDING"  
}
 
Suggest Edits

Verify 2FA Device

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

Path Params

user_id
string
required

Object ID of user

Request Body

Key
Type
Description

documents[]

array of objects

[Required] List of base documents objects with the social_docs and 2FA devices you wish to add to the user

Base Document Object

Key
Type
Description

id

string

[Required] Base document ID

social_docs[]

array of objects

[Required] List of social document objects you wish to add to the user

Social Document Object

Key
Type
Description

document_type

string

[Required] Set as PHONE_NUMBER_2FA or EMAIL_2FA

document_value

string

[Required] Email or Phone Number to send MFA pin

mfa_answer

string

[Required] MFA pin sent to user's Email or Phone Number

Additional Information

  • The initial 2FA document status will be SUBMITTED|REVIEWING
  • If you View User before submitting the pin, the status will update to SUBMITTED|MFA_PENDING
  • When the pin is submitted successfully, the 2FA document status will update to SUBMITTED|VALID
  • When the pin is submitted unsuccessfully, the 2FA document status will update to SUBMITTED|INVALID
PATCH /v3.1/users/5c2eaec9e4cf47006728fd29 HTTP/1.1
Host: https://uat-api.synapsefi.com
X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_6zZVr8biuqGkyo9IxMO5jY2QlSp0nmD4EBAgKcJW
X-SP-USER-IP: 255.127.79.76
X-SP-USER: oauth_TEQJHb801qI0jG7UZ2fzt9SKY5u4AWswBRmlDPO3|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

{
  "documents":[{
    "id":"26d63977a590d1794bc14ad7801cd733653db578f7450c7a283d42bac3179998",
    "social_docs":[{
      "document_type":"PHONE_NUMBER_2FA",
      "document_value":"901.111.1111",
      "mfa_answer":"123456"
    }]
  }]
}
body = {
  "documents":[{
    "id":"26d63977a590d1794bc14ad7801cd733653db578f7450c7a283d42bac3179998",
    "social_docs":[{
      "document_type":"PHONE_NUMBER_2FA",
      "document_value":"901.111.1111",
      "mfa_answer":"123456"
    }]
  }]
}

user.user_update(body)
user.updateUser({
  documents: [{
    id: '<BASE_DOC_ID>',
    social_docs: [{
      id: '<SUB_DOC_ID>',
      document_value: '901.111.1111',
      document_type: 'PHONE_NUMBER_2FA',
      mfa_answer: '123456'
    }]
  }]
});
body = {
  "documents":[{
    "id":"26d63977a590d1794bc14ad7801cd733653db578f7450c7a283d42bac3179998",
    "social_docs":[{
      "document_type":"PHONE_NUMBER_2FA",
      "document_value":"901.111.1111",
      "mfa_answer":"123456"
    }]
  }]
}

user.user_update(payload: body)
$body = array (
  'documents' =>
  array (
    array (
      'id' => '2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8',
      "social_docs":[{
      "document_type":"PHONE_NUMBER_2FA",
      "document_value":"901.111.1111",
      "mfa_answer":"123456"
    }]
    )
  )
);

$user = $client->update_info($body);
body = `{
  "documents":[{
    "id":"26d63977a590d1794bc14ad7801cd733653db578f7450c7a283d42bac3179998",
    "social_docs":[{
      "document_type":"PHONE_NUMBER_2FA",
      "document_value":"901.111.1111",
      "mfa_answer":"123456"
    }]
  }]
}`

data, err := user.Update(body)
A binary file was returned

You couldn't be authenticated

{
  "_id": "5c2eaec9e4cf47006728fd29",
  "_links": {
    "self": {
      "href": "https://uat-api.synapsefi.com/v3.1/users/5c2eaec9e4cf47006728fd29"
    }
  },
  "client": {
    "id": "589acd9ecb3cd400fa75ac06",
    "name": "SynapseFI"
  },
  "documents": [
    {
      "entity_scope": "Arts & Entertainment",
      "entity_type": "M",
      "id": "26d63977a590d1794bc14ad7801cd733653db578f7450c7a283d42bac3179998",
      "id_score": null,
      "name": "Test User",
      "permission_scope": "SEND|RECEIVE",
      "physical_docs": [
        {
          "document_type": "GOVT_ID",
          "id": "160f760b57c303b473fee3f701376e12c55ea843810cf34deba8eb06f7030857",
          "last_updated": 1546563608496,
          "status": "SUBMITTED|VALID"
        }
      ],
      "social_docs": [
        {
          "document_type": "EMAIL",
          "id": "2c45158f6431ca874bbe82f63d5905567854dde4d8b81539944e5779e5eee741",
          "last_updated": 1546563608496,
          "status": "SUBMITTED|VALID"
        },
        {
          ...
        },
        {
          "document_type": "PHONE_NUMBER_2FA",
          "id": "6de32f3fee5263baf1558758e8afc9f44284de5d31dd4056fdd0e6bd835c5a38",
          "last_updated": 1546563798369,
          "status": "SUBMITTED|VALID"
        }
      ],
      "virtual_docs": [
        {
          "document_type": "SSN",
          "id": "7cb85697d26e2c1010266fd64a22afd396167ca630a4bad21a9e8fcff865bb1c",
          "last_updated": 1546563608496,
          "status": "SUBMITTED|VALID"
        }
      ],
      "watchlists": "NO_MATCH"
    }
  ],
  "emails": [],
  "extra": {
    "cip_tag": 1,
    "date_joined": 1546563269349,
    "extra_security": false,
    "is_business": false,
    "is_trusted": true,
    "last_updated": 1546563798273,
    "public_note": null,
    "supp_id": "my_user_id"
  },
  "is_hidden": false,
  "legal_names": [
    "Test User"
  ],
  "logins": [
    {
      "email": "[email protected]",
      "scope": "READ_AND_WRITE"
    }
  ],
  "permission": "SEND-AND-RECEIVE",
  "phone_numbers": [
    "901.111.4444"
  ],
  "photos": [],
  "refresh_token": "refresh_2SAzILKq90XN0mOhVbr7vE4R5pTQWfYktdHaleUg",
  "watchlists": "NO_MATCH"  
}
 
Suggest Edits

Generate UBO/Reg GG

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

Path Params

user_id
string
required

Object ID of user

Request Body

Unless specified, all of the following objects and associated fields are required to generate this document

Successful Response

If the response is successful, then the UBO/Reg GG form will be automatically uploaded it as a REG__GG as a physical document to the business user.

Key
Type
Description

compliance_contact

object

Contact information

entity_info

object

Information about the business

owners

object

Owner information

primary_controlling_contact

object

Primary Controlling Contact information

signer

object

Signer information

Compliance Contact Object

Key
Type
Description

document_id

string

Document ID of business’s compliance contact

relationship_to_entity

string

Compliance contact's title at the business

Entity Info Object

Key
Type
Description

document_id

string

Document ID of business opening account

cryptocurrency

boolean

Set as false if business is not involved with cryptocurrency

gambling

boolean

Set as false if business is not involved with the internet gambling business

majority_owned_by_listed

boolean

Set as false if business is not majority owned (50% or more) by a public company

msb.federal

boolean

Set as false if business does not have Money Transmission Licenses (MTL) in any states

msb.states

array of strings

List of states that business has Money Transmission Licenses (MTL) in

public_company

boolean

Set as false if business is not a public company

registered_sec

boolean

Set as false if business is not registered with U.S. Securities and Exchange Commission (SEC)

regulated_financial

boolean

Set as false if business is not a regulated financial company

Owners Object

Key
Type
Description

document_id

string

Document ID of beneficial owner

ownership

string

Optional Percentage of owner's ownership of the business ( only required if higher than 10%)

title

string

Owner's title in relation to business

Primary Controlling Contact Object

Key
Type
Description

document_id

string

Document ID of business’s primary controlling contact. This is typically an executive officer or senior manager (ex: CEO or CFO) OR an individual who regularly performs similar functions

relationship_to_entity

string

Primary controlling contact's title at the business

Signer Object

Key
Type
Description

document_id

string

Document ID of individual completing the form

relationship_to_entity

string

Signer's title at the business

PATCH /v3.1/users/5bda4a1314c7fa00a808f6a6/ubo 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: oauth_1mtgLwhYHDVKop04XOEjyWJSsnQqZbGkfRF5ux9v|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

{
  "entity_info": {
    "cryptocurrency": true,
    "msb": {
      "federal": true,
      "states": [
        "AL"
      ]
    },
    "public_company": false,
    "majority_owned_by_listed": false,
    "registered_SEC": false,
    "regulated_financial": false,
    "gambling": false,
    "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8"
  },
  "signer": {
    "document_id": "dd09124227effbeae576fb18ff7859e508a89e08d6789c275ce027349d51e0c7",
    "relationship_to_entity": "CEO"
  },
  "compliance_contact": {
    "document_id": "dd09124227effbeae576fb18ff7859e508a89e08d6789c275ce027349d51e0c7",
    "relationship_to_entity": "CEO"
  },
  "primary_controlling_contact": {
    "document_id": "dd09124227effbeae576fb18ff7859e508a89e08d6789c275ce027349d51e0c7",
    "relationship_to_entity": "CEO"
  },
  "owners": [
    {
      "document_id": "dd09124227effbeae576fb18ff7859e508a89e08d6789c275ce027349d51e0c7",
      "title": "CEO",
      "ownership": 95
    }
  ]
}
body = {
  "entity_info": {
    "cryptocurrency": true,
    "msb": {
      "federal": true,
      "states": [
        "AL"
      ]
    },
    "public_company": false,
    "majority_owned_by_listed": false,
    "registered_SEC": false,
    "regulated_financial": false,
    "gambling": false,
    "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8"
  },
  "signer": {
    "document_id": "dd09124227effbeae576fb18ff7859e508a89e08d6789c275ce027349d51e0c7",
    "relationship_to_entity": "CEO"
  },
  ...
}

user.create_ubo(body)
const body = {
  "entity_info": {
    "cryptocurrency": true,
    "msb": {
      "federal": true,
      "states": [
        "AL"
      ]
    },
    "public_company": false,
    "majority_owned_by_listed": false,
    "registered_SEC": false,
    "regulated_financial": false,
    "gambling": false,
    "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8"
  },
  "signer": {
    "document_id": "dd09124227effbeae576fb18ff7859e508a89e08d6789c275ce027349d51e0c7",
    "relationship_to_entity": "CEO"
  },
   ....
}

user.generateUboForm(body);
body = {
  "entity_info": {
    "cryptocurrency": true,
    "msb": {
      "federal": true,
      "states": [
        "AL"
      ]
    },
    "public_company": false,
    "majority_owned_by_listed": false,
    "registered_SEC": false,
    "regulated_financial": false,
    "gambling": false,
    "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8"
  },
  "signer": {
    "document_id": "dd09124227effbeae576fb18ff7859e508a89e08d6789c275ce027349d51e0c7",
    "relationship_to_entity": "CEO"
  },
   ....
}

user.create_ubo(payload: body)
$entity = (object) [
   "cryptocurrency" => True,
   "gambling" => False,
   "document_id" => "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8"
];

$client->create_ubo($entity);
body = `{
  "entity_info": {
    "cryptocurrency": true,
    "msb": {
      "federal": true,
      "states": [
        "AL"
      ]
    },
    "public_company": false,
    "majority_owned_by_listed": false,
    "registered_SEC": false,
    "regulated_financial": false,
    "gambling": false,
    "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8"
  },
  "signer": {
    "document_id": "dd09124227effbeae576fb18ff7859e508a89e08d6789c275ce027349d51e0c7",
    "relationship_to_entity": "CEO"
  },
	...
}`

data, err := user.CreateUBO(body)
A binary file was returned

You couldn't be authenticated

{
  "_id": {
    "$oid": "5bda4a1314c7fa00a808f6a6"
  },
  "client": {
    "id": "5a4d5a7805f18c00240bb488",
    "name": "Platform Name"
  },
  "documents": [
    {
      "entity_scope": "Arts & Entertainment",
      "entity_type": "M",
      "id": "dd09124227effbeae576fb18ff7859e508a89e08d6789c275ce027349d51e0c7",
      "id_score": null,
      "name": "John Smith",
      "permission_scope": "UNVERIFIED",
      "physical_docs": [
        {
          "document_type": "GOVT_ID",
          "id": "acd8420c558d8fb88062359263213784cf0bc88557895f93bf42d5897f5c4fe0",
          "last_updated": {
            "$date": 1541033002528
          },
          "status": "SUBMITTED|REVIEWING"
        }
      ],
      "social_docs": [
        {
          "document_type": "ADDRESS",
          "id": "c615c761d68c578a98fde8e73c490df405ff5d5e34fc11f029660d7e9743df21",
          "last_updated": {
            "$date": 1541033003566
          },
          "status": "SUBMITTED|REVIEWING"
        },
        {
          "document_type": "EMAIL",
          "id": "ec1bd13f97d4dcfa7ae28a18150e325f867d901f89545e0c0a257a532b106a27",
          "last_updated": {
            "$date": 1541033003479
          },
          "status": "SUBMITTED|REVIEWING"
        },
        {
          "document_type": "DATE",
          "id": "2b52edae636ca2fbe12ab1b08a344d381dabc3d2b92844cf7a8d8b6052b26d8e",
          "last_updated": {
            "$date": 1541033003675
          },
          "status": "SUBMITTED|REVIEWING"
        },
        {
          "document_type": "PHONE_NUMBER",
          "id": "b4eee6916fa7bca402af00e6b16e3c8d50737a7189dd81d4fd46ae2c2c0e1b36",
          "last_updated": {
            "$date": 1541033003533
          },
          "status": "SUBMITTED|REVIEWING"
        }
      ],
      "virtual_docs": [
        {
          "document_type": "SSN",
          "id": "ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f",
          "last_updated": {
            "$date": 1541033001461
          },
          "status": "SUBMITTED|REVIEWING"
        }
      ]
    },
    {
      "entity_scope": "Arts & Entertainment",
      "entity_type": "LLC",
      "id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
      "name": "Fake Business",
      "permission_scope": "UNVERIFIED",
      "physical_docs": [
        {
          "document_type": "GOVT_ID",
          "id": "7840958571593e69a4727205be0e1a6d0cdb99656a8ed96e6802de46f3b740b5",
          "last_updated": {
            "$date": 1541032460556
          },
          "status": "SUBMITTED|REVIEWING"
        },
        {
          "document_type": "EIN_DOC",
          "id": "2a8bf6873eda6dc774747ac045f92408210211e388adf23faf38e254b1fa9c8c",
          "last_updated": {
            "$date": 1541032755544
          },
          "status": "SUBMITTED|REVIEWING"
        },
        {
          "document_type": "REG_GG",
          "id": "63f2650014448a3f81d316b21204bbe6960881be227e5760a6897542e15e4a1e",
          "last_updated": {
            "$date": 1541033341748
          },
          "status": "SUBMITTED"
        }
      ],
      "social_docs": [
        {
          "document_type": "PHONE_NUMBER",
          "id": "fda60784d6375bc44edafaaeae149626c4c13dcb92e85a2a7a00eec2cdfd2b6f",
          "last_updated": {
            "$date": 1541032756436
          },
          "status": "SUBMITTED|REVIEWING"
        },
        {
          "document_type": "ADDRESS",
          "id": "bce9d06d8d58a609c87a9cee2153e2cc1cee79d846121cd86907ba90433634ec",
          "last_updated": {
            "$date": 1541032756524
          },
          "status": "SUBMITTED|REVIEWING"
        },
        {
          "document_type": "EMAIL",
          "id": "2c45158f6431ca874bbe82f63d5905567854dde4d8b81539944e5779e5eee741",
          "last_updated": {
            "$date": 1541032756429
          },
          "status": "SUBMITTED|REVIEWING"
        },
        {
          "document_type": "DATE",
          "id": "b8e669e729f2dface01775c91668e35ed5b6340bcec291a6393b4ea8e6b0dfe9",
          "last_updated": {
            "$date": 1541032756584
          },
          "status": "SUBMITTED|REVIEWING"
        }
      ],
      "virtual_docs": [
        {
          "document_type": "SSN",
          "id": "7cb85697d26e2c1010266fd64a22afd396167ca630a4bad21a9e8fcff865bb1c",
          "last_updated": {
            "$date": 1541032459593
          },
          "status": "SUBMITTED|REVIEWING"
        },
        {
          "document_type": "TIN",
          "id": "a55cc12f46e8091f741b978d5fa556b2f8772a75007a82aae10a2fd810f644cb",
          "last_updated": {
            "$date": 1541032754521
          },
          "status": "SUBMITTED|REVIEWING"
        }
      ],
      "watchlists": "PENDING"
    }
  ],
  "extra": {
    "cip_tag": 1,
    "date_joined": {
      "$date": 1541032445648
    },
    "extra_security": false,
    "is_business": true,
    "is_trusted": true,
    "last_updated": {
      "$date": 1541033341412
    },
    "public_note": null,
    "supp_id": "my_user_id"
  },
  "is_hidden": false,
  "legal_names": [
    "Fake Business"
  ],
  "logins": [
    {
      "email": "[email protected]",
      "scope": "READ_AND_WRITE"
    }
  ],
  "permission": "UNVERIFIED",
  "phone_numbers": [
    "901.111.1111"
  ],
  "photos": [],
  "refresh_token": "refresh_2SAzILKq90XN0mOhVbr7vE4R5pTQWfYktdHaleUg",
  "watchlists": "PENDING"     
}
 
Suggest Edits

KYC Sandbox Test Values

 

Sandbox Test Values

Real Identities and Documents

You cannot verify real identities and document information in sandbox.

Base Documents

With the exception of addresses test base document requirements are unrigorous. Any value following the appropriate format for the specific document (Ex. [email protected], phone: 000.000.0000) will be accepted.

Addresses

Valid USPS mailable addresses are required

Value
Result

123 Fail Address, Fail City, FS 00000

Supplied address is invalid / Unable to verify address

1 Market Street, San Francisco, CA 94105

Validation is successful

Virtual Documents

Value
Result

2222

Validation Successful

Any other value

Validation Fails

Physical Documents

Format

The base64 you send via this API call should be padded. See below:

"data:text/csv;base64,<actual_file_data>

To be able to generate a sample base64 string, you can go to Base64 Image. They make it very easy to generate a padded base64 string for any image. You can then use that base64 string to test with our APIs.

Value
Result

data:image/invalid;base64,SUQs==

Validation Fails

Any other value

Validation Successful

Social Documents

Type
Value
Result

EMAIL_2FA and PHONE_NUMBER_2FA

123456

Validation Succesful

EMAIL

Validation Fails

IP

255.255.255.0

Validation Fails

FACEBOOK

https://www.facebook.com/invalid

Validation Fails

LINKEDIN

https://www.linkedin.com/invalid

Validation Fails

TWITTER

https://twitter.com/invalid

Validation Fails

PHONE_NUMBER

541-754-3010

Validation Fails

 
Suggest Edits

Register New Fingerprint

 
posthttps://uat-api.synapsefi.com/oauth/user_id/

Path Params

user_id
string
required

Object ID of user

Request Body

Key
Type
Description

refresh_token

string

[Required] User's refresh token. See View User for more information

Unique and Static Fingerprints

You can either submit unique device fingerprints for each user or a static fingerprints maintained by your platform

Sandbox Test Values

Fingerprint
Validation PIN

static_pin

123456

POST /v3.1/oauth/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: |e83cf6ddcf778e37bfe3d48fc78a6502062fcxx
Content-Type: application/json

{
  "refresh_token": "refresh_ehG7YBS8ZiD0sLa6PQHMUxryovVkJzElC5gWROXq"
}
client.update_headers(fingerprint='e83cf6ddcf778e37bfe3d48fc78a6502062fcxx')

user.oauth()
const newFingerprint = 'myNewFingerprint123';

user.registerNewFingerprint(newFingerprint);
fp = 'e83cf6ddcf778e37bfe3d48fc78a6502062fcxx'

client.update_headers(fingerprint: fp)

user.authenticate()
$body = (object) [
   "refresh_token" => "refresh_ehG7YBS8ZiD0sLa6PQHMUxryovVkJzElC5gWROXq"
];

$user->ouath($body);
data, err := user.RegisterFingerprint("e83cf6ddcf778e37bfe3d48fc78a6502062fcxx")
A binary file was returned

You couldn't be authenticated

{
  "error": {
    "en": "Fingerprint not registered. Please perform the MFA flow."
  },
  "error_code": "10",
  "http_code": "202",
  "phone_numbers": [
    "[email protected]",
    "901-111-2222"
  ],
  "success": false
}
 
Suggest Edits

Select 2FA Device

 
posthttps://uat-api.synapsefi.com/oauth/user_id

Path Params

user_id
string
required

Object ID of user

Request Body

Key
Type
Description

refresh_token

string

[Required] User's refresh token

phone_number

string

[Required] 2FA device to send verification PIN

2FA PIN Expiration

2FA codes expire after 15 minutes or 900 seconds. Remember to account for this when building out your application

POST /v3.1/oauth/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: |e83cf6ddcf778e37bfe3d48fc78a6502062fcxx
Content-Type: application/json

{
  "refresh_token": "refresh_ehG7YBS8ZiD0sLa6PQHMUxryovVkJzElC5gWROXq",
  "phone_number": "[email protected]"
}
user.select_2fa_device('[email protected]')
const newFingerprint = 'myNewFingerprint123';
const device2FA = '[email protected]';

user.supplyDevice2FA(newFingerprint, device2FA);
user.select_2fa_device(device: "[email protected]")
$body = (object) [
   "refresh_token" => "refresh_ehG7YBS8ZiD0sLa6PQHMUxryovVkJzElC5gWROXq",
   "phone_number":"[email protected]"
];

$oauthpayload = $user->select_2fa_device($body);
data, err := user.Select2FA("[email protected]")
A binary file was returned

You couldn't be authenticated

{
  "error_code": "10",
  "http_code": "202",
  "message": {
    "en": "MFA sent to [email protected]"
  },
  "success": true
}
 
Suggest Edits

Verify 2FA PIN

 
posthttps://uat-api.synapsefi.com/oauth/user_id

Path Params

user_id
string
required

Object ID of user

Request Body

Key
Type
Description

refresh_token

string

[Required] User's refresh token

validation_pin

string

[Required] Validation PIN submitted to 2FA device

POST /v3.1/oauth/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: |e83cf6ddcf778e37bfe3d48fc78a6502062fcxx
Content-Type: application/json

{
  "refresh_token": "refresh_ehG7YBS8ZiD0sLa6PQHMUxryovVkJzElC5gWROXq",
  "validation_pin": "123456"
}
user.confirm_2fa_pin('123456')
const newFingerprint = 'myNewFingerprint123';
const validationPin = '123456';

user.verifyFingerprint2FA(newFingerprint, validationPin);
user.confirm_2fa_pin(pin: "123456")
$body = (object) [
   "refresh_token" => "refresh_ehG7YBS8ZiD0sLa6PQHMUxryovVkJzElC5gWROXq",
   "pin":"123456"
];

$oauthpayload = $user->confirm_2fa_pin($body);
data, err := user.Verify2FA(“123456”)
A binary file was returned

You couldn't be authenticated

{
  "client_id": "589acd9ecb3cd400fa75ac06",
  "client_name": "SynapseFI",
  "expires_at": "1498297791",
  "expires_in": "7200",
  "oauth_key": "oauth_vxGS10t7OQzBoVJIM4Z0rbnjyXsc8lCigaH6ewRp",
  "refresh_expires_in": 6,
  "refresh_token": "refresh_ehG7YBS8ZiD0sLa6PQHMUxryovVkJzElC5gWROXq",
  "scope": [
    "USER|PATCH",
    "USER|GET",
    "NODES|POST",
    "NODES|GET",
    "NODE|GET",
    "NODE|PATCH",
    "NODE|DELETE",
    "TRANS|POST",
    "TRANS|GET",
    "TRAN|GET",
    "TRAN|PATCH",
    "TRAN|DELETE"
  ],
  "user_id": "594e0fa2838454002ea317a0"
}
 
Suggest Edits

Issue Public Key

 
gethttps://uat-api.synapsefi.com/v3.1/client?issue_public_key=YES&scope=scope_parameters

Query Params

issue_public_key
string
required

Set to YES

scope_parameters
string
required

Scopes that you wish to issue the public key for

Response Object

Key
Type
Description

client

object

Client details

public_key_obj.client_obj_id

string

Object ID of client

public_key_obj.expires_at

string

Expiration date (in Unix time)

public_key_obj.expires_in

string

How long key will be authorized (in milliseconds)

public_key_obj.scope

array of strings

List of scopes accessible with key. See Issue Public Key for more information

Available Scopes

Scope
Permission

OAUTH|POST

Allowed to authenticate users

USERS|POST

Allowed to create users

USERS|GET

Allowed to get list of users

USER|GET

Allowed to get a user

USER|PATCH

Allowed to update a user

SUBSCRIPTIONS|GET

Allowed to get list of subscriptions

SUBSCRIPTIONS|POST

Allowed to create subscriptions

SUBSCRIPTION|GET

Allowed to get a subscription

SUBSCRIPTIONS|PATCH

Allowed to update a subscription

CLIENT|REPORTS

Allowed to view client reports

CLIENT|CONTROLS

Allowed to view client controls

GET /v3.1/client?issue_public_key=YES&amp;scope=OAUTH|POST,USERS|POST,USERS|GET,USER|GET,USER|PATCH,SUBSCRIPTIONS|GET,SUBSCRIPTIONS|POST,SUBSCRIPTION|GET,SUBSCRIPTION|PATCH,CLIENT|REPORTS,CLIENT|CONTROLS HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_2bb1e714edd311e6bd04e285d6015267
Content-Type: application/json
scope = [
  "USERS|POST",
  "USER|PATCH",
  "NODES|POST",
  ...
]
pubkey = client.issue_public_key(scope)
client.issuePublicKey();
scope= "OAUTH|POST"

client.issue_public_key(scope: scope)
$scope = 'OAUTH|POST,USERS|POST,USERS|GET,USER|GET,USER|PATCH,SUBSCRIPTIONS|GET,SUBSCRIPTIONS|POST,SUBSCRIPTION|GET,SUBSCRIPTION|PATCH,CLIENT|REPORTS,CLIENT|CONTROLS';

$client->issue_public_key($scope);
scope := "OAUTH|POST,USERS|POST,USERS|GET,USER|GET,USER|PATCH,..."

data, err := client.GetPublicKey(scope)
A binary file was returned

You couldn't be authenticated

{
  "client": {
  	...
  },
  "public_key_obj": {
    "client_obj_id": "589acd9ecb3cd400fa75ac06",
    "expires_at": "1506039889",
    "expires_in": "900",
    "public_key": "public_key_SxfMV0uJ2qEXc5gjiCt4ebKnYIwDA3mURv7OrsTW",
    "scope": [
      "OAUTH|POST",
      "USERS|POST",
      "USERS|GET",
      "USER|GET",
      "USER|PATCH",
      "SUBSCRIPTIONS|GET",
      "SUBSCRIPTIONS|POST",
      "SUBSCRIPTION|GET",
      "SUBSCRIPTION|PATCH",
      "CLIENT|REPORTS",
      "CLIENT|CONTROLS"
    ]
  }
}
 
Suggest Edits

Issue OAuth Key

To perform an action for a user, you need to supply a valid OAuth Key in the header field of the API request

 
posthttps://uat-api.synapsefi.com/v3.1/oauth/user_ID

Path Params

user_ID
string
required

Object ID of user

Request Body

Key
Type
Description

refresh_token

string

[Required] User-specific refresh token for oauth (expires after 10 uses)

scope

array of strings

Defines the level of access a user's oauth_token provides. By default, the oauth_token provides access to all available scopes. To limit this, set scope in the request body.

OAuth Expiration

OAuth keys expire every two hours. Remember to account for this when building out your application

Available Scopes

Scope
Comment

USER|PATCH

OAuth can be used to update User document

USER|GET

OAuth can be used to get User

NODES|POST

OAuth can be used to add Nodes

NODES|GET

OAuth can be used to get Nodes

NODE|GET

OAuth can be used to get Node

NODE|PATCH

OAuth can be used to update Node

NODE|DELETE

OAuth can be used to delete Node

TRANS|POST

OAuth can be used to add Transaction

TRANS|GET

OAuth can be used to get Transaction

TRAN|GET

OAuth can be used to get Transaction

TRAN|PATCH

OAuth can be used to update Transaction

TRAN|DELETE

OAuth can be used to cancel Transaction

SUBNETS|POST

OAuth can be used to create Subnets

SUBNETS|GET

OAuth can be used to get Subnets

SUBNET|GET

OAuth can be used to get a Subnet

SUBNET|PATCH

OAuth can be used to update a Subnet

STATEMENTS|GET

OAuth can be used to get Statements

STATEMENT|GET

OAuth can be used to get a Statement

POST /v3.1/oauth/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

{
  "refresh_token": "refresh_mjNgn2w50pv03kxB6o1bHqOZVfJzYuTKW7PiChDe",
  "scope": [
    "USER|PATCH",
    "USER|GET",
    "NODES|POST",
    "NODES|GET",
    "NODE|GET",
    "NODE|PATCH",
    "NODE|DELETE",
    "TRANS|POST",
    "TRANS|GET",
    "TRAN|GET",
    "TRAN|PATCH",
    "TRAN|DELETE",
    "SUBNETS|GET",
    "SUBNETS|POST",
    "SUBNET|GET",
    "SUBNET|PATCH",
    "STATEMENTS|GET",
    "STATEMENT|GET"
  ]
}
A binary file was returned

You couldn't be authenticated

{
  "client_id": "5beb506f6d7ceb002490631f",
  "client_name": "Synapse Financial Tech",
  "expires_at": "1552594769",
  "expires_in": "7200",
  "oauth_key": "oauth_wAjQXY408UEN6Mv7SJsHZaKLzbBFirTloDp0uW53",
  "refresh_expires_in": 10,
  "refresh_token": "refresh_mjNgn2w50pv03kxB6o1bHqOZVfJzYuTKW7PiChDe",
  "scope": [
    "USER|PATCH",
    "USER|GET",
    "NODES|POST",
    "NODES|GET",
    "NODE|GET",
    "NODE|PATCH",
    "NODE|DELETE",
    "TRANS|POST",
    "TRANS|GET",
    "TRAN|GET",
    "TRAN|PATCH",
    "TRAN|DELETE",
    "SUBNETS|GET",
    "SUBNETS|POST",
    "SUBNET|GET",
    "SUBNET|PATCH",
    "STATEMENTS|GET",
    "STATEMENT|GET"
  ],
  "user_id": "594e0fa2838454002ea317a0"
}
 
Suggest Edits

View User Node

Get a user node by user ID and node ID

 
gethttps://uat-api.synapsefi.com/v3.1/users/user_id/nodes/node_id

Path Params

user_id
string
required

Object ID of user

node_id
string
required

Object ID of node

Query Params

force_refresh
string

[yes/no] Force a system check to retrieve most up-to-date balance information

full_dehydrate
string

[yes/no] return all available node information including decrypted account/routing number, transaction history, etc.

Node Object

Please note, loan nodes follow a different object structure. For more information please see View Loan Details.

Key
Type
Description

_id

string

Object ID of the node

_links.self.href

string

HAL-style link for the node

allowed

string

Denotes available actions for the node. See Node Permissions for more information

client.id

string

ID of the client associated with the node

client.name

string

Name of the client associated with the node

extra.note

string

Account notes

extra.other.updated_on

integer

Date of last update to node in Unix time

extra.supp_id

string

Supplementary ID provided on node creation

info.balance.amount

double

Current balance associated with the account

info.balance.currency

string

Currency of the node

info.balance.updated_on

integer

Date of last update to node balance in Unix time

info.document_id

string

Base document ID of user associated with the node

info.monthly_withdrawals_remaining

integer

Remaining withdrawals left for the month

info.name_on_account

string

Name of user associated with the account

info.nickname

string

Nickname of node

info.type

string

Type of account BUSINESS or PERSONAL

is_active

boolean

Denotes active status of node

timeline

array of objects

List of updates to the node. See Timeline Object for more information

type

string

Type of node. See Node Types for more information

user_id

string

User ID associate with node

Timeline Object

Key
Type
Description

date

integer

Date of update to node (in Unix time)

note

string

Note about the node update

Force Refresh

If force refresh is successful, the info.balance.updated_on timestamp will update to the most recent date and time of update

Type
Product

CARD-US

[Deprecated]

IB-DEPOSIT-US

IB-SUBACCOUNT-US

INTERCHANGE-US

RESERVE-US

For platform use

SUBCARD-US

[Deprecated]

SYNAPSE-US

[Deprecated]

TRIUMPH-SUBACCOUNT-US

[Deprecated]

Node Permissions

See below for all available node permissions

GET /v3.1/users/5bc305abd83c197a45848f88/nodes/5bd18a08f9bd8600bea124be HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 255.127.79.76
X-SP-USER: oauth_cJokUnXuK428GhZESHPMfltOQ0Crv1eF93yBxDa0|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json
node_id = '594e606212e17a002f2e3251'

node = user.get_node(node_id, full_dehydrate=True, force_refresh=True)
const nodeID = '594e606212e17a002f2e3251';

user.getNode(nodeID);
node_id = “5bd18a08f9bd8600bea124be”

user.get_user_node(node_id: node_id)
$nodeid = '5c3d416f7b08ab0066ee8cae';
$full_dehydrate=null;
$force_refresh = null;
$user->get_node($nodeid, $full_dehydrate, $force_refresh);
nodeID = '594e606212e17a002f2e3251'

data, err := user.GetNode(nodeID)
A binary file was returned

You couldn't be authenticated

{
  "_id": "5bd18a08f9bd8600bea124be",
  "_links": {
    "self": {
      "href": "https://uat-api.synapsefi.com/v3.1/users/5bc305abd83c197a45848f88/nodes/5bd18a08f9bd8600bea124be"
    }
  },
  "allowed": "CREDIT-AND-DEBIT",
  "client": {
    "id": "589acd9ecb3cd400fa75ac06",
    "name": "SynapseFI"
  },
  "extra": {
    "note": null,
    "other": {},
    "supp_id": ""
  },
  "info": {
    "balance": {
      "amount": 0,
      "currency": "USD"
    },
    "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
    "monthly_withdrawals_remaining": null,
    "name_on_account": " ",
    "nickname": "My Deposit Account"
  },
  "is_active": true,
  "timeline": [
    {
      "date": 1540459015761,
      "note": "Node created."
    }
  ],
  "type": "DEPOSIT-US",
  "user_id": "5bc305abd83c197a45848f88"
}
 
Suggest Edits

View All User Nodes

Get a list of all user nodes by user ID

 
gethttps://uat-api.synapsefi.com/v3.1/user_id/nodes

Path Params

user_id
string
required

Object ID of user

Query Params

filter
string

{"supp_id": "supp_1234"}

page
int32

Page number

per_page
int32

Number of nodes per page

type
string

Node type to search for

Nodes Object

Key
Type
Description

error_code

string

See Common Errors for more information

http_code

string

See Common Errors for more information

limit

integer

Number of nodes per page

node_count

integer

Total number of nodes

nodes[]

array of objects

List of node objects. See View User Node for more information

page

integer

Page number

page_count

integer

Number of pages

success

boolean

Request success

GET /v3.1/users/594e0fa2838454002ea317a0/nodes HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_auVIbQ8WXC0pnLU9ivEs4tcHDejqFJlwoNrZ3fO1|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json
user.get_all_nodes(page=4, per_page=10, type='DEPOSIT-US')
user.getAllUserNodes();
user.get_all_nodes()
$page = 1;
$per_page = 1;
$type = 'DEPOSIT-US';

$user->get_all_nodes($page , $per_page , $type);
data, err := user.GetNodes()
A binary file was returned

You couldn't be authenticated

{
  "error_code": "0",
  "http_code": "200",
  "limit": 20,
  "node_count": 2,
  "nodes": [
    {
      "_id": "5c8abccb4b7ba9102c674cdf",
      "_links": {
        "self": {
          "href": "https://uat-api.synapsefi.com/v3.1/users/5c8aa9687d093e00686b7331/nodes/5c8abccb4b7ba9102c674cdf"
        }
      },
      "allowed": "CREDIT-AND-DEBIT",
      "client": {
        "id": "589acd9ecb3cd400fa75ac06",
        "name": "SynapseFI"
      },
      "extra": {
        "note": null,
        "other": {
          "access_token": "5c8abcc99c4c720039579019",
          "updated_on": 1552610570000
        },
        "supp_id": ""
      },
      "info": {
        "account_num": "8902",
        "address": "PO BOX 85139, RICHMOND, VA, US",
        "balance": {
          "amount": "750.00",
          "currency": "USD",
          "updated_on": 1552610570000
        },
        "bank_logo": "https://cdn.synapsepay.com/bank_logos/new/co.png",
        "bank_long_name": "CAPITAL ONE N.A.",
        "bank_name": "CAPITAL ONE N.A.",
        "class": "SAVINGS",
        "match_info": {
          "email_match": "match",
          "name_match": "match",
          "phonenumber_match": "no_match"
        },
        "name_on_account": " ",
        "nickname": "SynapsePay Test Savings Account - 8902",
        "routing_num": "6110",
        "type": "PERSONAL"
      },
      "is_active": true,
      "timeline": [
        {
          "date": 1552596171282,
          "note": "Node created."
        },
        {
          "date": 1552596171764,
          "note": "Unable to send micro deposits as node allowed is not CREDIT."
        }
      ],
      "type": "ACH-US",
      "user_id": "5c8aa9687d093e00686b7331"
    },
    {
      "_id": "5c8abccb4b7ba9102a61010d",
      "_links": {
        "self": {
          "href": "https://uat-api.synapsefi.com/v3.1/users/5c8aa9687d093e00686b7331/nodes/5c8abccb4b7ba9102a61010d"
        }
      },
      "allowed": "CREDIT-AND-DEBIT",
      "client": {
        "id": "589acd9ecb3cd400fa75ac06",
        "name": "SynapseFI"
      },
      "extra": {
        "note": null,
        "other": {
          "access_token": "5c8abcc99c4c720039579019",
          "updated_on": 1552610570000
        },
        "supp_id": ""
      },
      "info": {
        "account_num": "8901",
        "address": "PO BOX 85139, RICHMOND, VA, US",
        "balance": {
          "amount": "800.00",
          "currency": "USD",
          "updated_on": 1552610570000
        },
        "bank_logo": "https://cdn.synapsepay.com/bank_logos/new/co.png",
        "bank_long_name": "CAPITAL ONE N.A.",
        "bank_name": "CAPITAL ONE N.A.",
        "class": "CHECKING",
        "match_info": {
          "email_match": "match",
          "name_match": "match",
          "phonenumber_match": "no_match"
        },
        "name_on_account": " ",
        "nickname": "SynapsePay Test Checking Account - 8901",
        "routing_num": "6110",
        "type": "BUSINESS"
      },
      "is_active": true,
      "timeline": [
        {
          "date": 1552596170782,
          "note": "Node created."
        },
        {
          "date": 1552596171279,
          "note": "Unable to send micro deposits as node allowed is not CREDIT."
        }
      ],
      "type": "ACH-US",
      "user_id": "5c8aa9687d093e00686b7331"
    }
  ],
  "page": 1,
  "page_count": 1,
  "success": true
}
 
Suggest Edits

View All Platform Nodes

Get a list of all platform nodes including nodes made by users

 
gethttps://uat-api.synapsefi.com/v3.1/nodes

Query Params

filter
string

{"supp_id": "supp_1234"}

page
int32

Page number

per_page
int32

Number of nodes returned per page

type
string

Node type to search for

Nodes Object

Key
Type
Description

error_code

string

See Common Errors for more information

http_code

string

See Common Errors for more information

limit

integer

Number of nodes per page

node_count

integer

Total number of nodes

nodes[]

array of objects

List of node objects. See View User Node for more information

page

integer

Page number

page_count

integer

Number of pages

success

boolean

Request success

GET /v3.1/nodes HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-GATEWAY: client_id_25BpgCAt3ymEJdkF8iwrKVlOqLZ071IehGTUaz6n|client_secret_bomP73QBiEHwJvO6tMCGXy8NUlgLj14xakzf50RK
Content-Type: application/json
client.get_all_nodes()
client.getPlatformNodes();
client.get_all_nodes()
$client->get_all_platform_nodes()
data, err := client.GetNodes()
A binary file was returned

You couldn't be authenticated

{
  "error_code": "0",
  "http_code": "200",
  "limit": 2,
  "node_count": 4362,
  "nodes": [
    {
      "_id": "5c898e67d23e5f45c2c36a8b",
      "_links": {
        "self": {
          "href": "https://uat-api.synapsefi.com/v3.1/users/5c898e427d093e0066629c02/nodes/5c898e67d23e5f45c2c36a8b"
        }
      },
      "allowed": "CREDIT-AND-DEBIT",
      "client": {
        "id": "589acd9ecb3cd400fa75ac06",
        "name": "SynapseFI"
      },
      "extra": {
        "note": null,
        "other": {
          "access_token": "5c898e656c4a18003995e751",
          "updated_on": 1552533158000
        },
        "supp_id": ""
      },
      "info": {
        "account_num": "8902",
        "address": "PO BOX 85139, RICHMOND, VA, US",
        "balance": {
          "amount": "750.00",
          "currency": "USD",
          "updated_on": 1552533158000
        },
        "bank_logo": "https://cdn.synapsepay.com/bank_logos/new/co.png",
        "bank_long_name": "CAPITAL ONE N.A.",
        "bank_name": "CAPITAL ONE N.A.",
        "class": "SAVINGS",
        "match_info": {
          "email_match": "no_match",
          "name_match": "no_match",
          "phonenumber_match": "no_match"
        },
        "name_on_account": " ",
        "nickname": "SynapsePay Test Savings Account - 8902",
        "routing_num": "6110",
        "type": "BUSINESS"
      },
      "is_active": true,
      "timeline": [
        {
          "date": 1552518759241,
          "note": "Node created."
        },
        {
          "date": 1552518759715,
          "note": "Unable to send micro deposits as node allowed is not CREDIT."
        }
      ],
      "type": "ACH-US",
      "user_id": "5c898e427d093e0066629c02"
    },
    {
      "_id": "5c898e67d23e5f45bfc3372a",
      "_links": {
        "self": {
          "href": "https://uat-api.synapsefi.com/v3.1/users/5c898e427d093e0066629c02/nodes/5c898e67d23e5f45bfc3372a"
        }
      },
      "allowed": "CREDIT-AND-DEBIT",
      "client": {
        "id": "589acd9ecb3cd400fa75ac06",
        "name": "SynapseFI"
      },
      "extra": {
        "note": null,
        "other": {
          "access_token": "5c898e656c4a18003995e751",
          "updated_on": 1552533158000
        },
        "supp_id": ""
      },
      "info": {
        "account_num": "8901",
        "address": "PO BOX 85139, RICHMOND, VA, US",
        "balance": {
          "amount": "800.00",
          "currency": "USD",
          "updated_on": 1552533158000
        },
        "bank_logo": "https://cdn.synapsepay.com/bank_logos/new/co.png",
        "bank_long_name": "CAPITAL ONE N.A.",
        "bank_name": "CAPITAL ONE N.A.",
        "class": "CHECKING",
        "match_info": {
          "email_match": "no_match",
          "name_match": "no_match",
          "phonenumber_match": "no_match"
        },
        "name_on_account": " ",
        "nickname": "SynapsePay Test Checking Account - 8901",
        "routing_num": "6110",
        "type": "PERSONAL"
      },
      "is_active": true,
      "timeline": [
        {
          "date": 1552518758734,
          "note": "Node created."
        },
        {
          "date": 1552518759260,
          "note": "Unable to send micro deposits as node allowed is not CREDIT."
        }
      ],
      "type": "ACH-US",
      "user_id": "5c898e427d093e0066629c02"
    }
  ],
  "page": 1,
  "page_count": 2181,
  "success": true
}
 
Suggest Edits

Create Node

Node creation template

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

Path Params

user_id
string
required

Object ID of user

Request Body

Key
Type
Description

type

string

[Required] Type of node. See Node Types for more information

info.document_id

string

[Required] Base document ID of the user. See Base Documents for more information

info.nickname

string

Nickname to assign to the node

extra.supp_id

string

[Max Characters: 250] Additional ID to assign to the node

Not Sure What to Do Next?

Check out our Quickstart guide

POST /v3.1/users/5ba52ec00abfb200a8a93e90/nodes HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_wBvo8QzEDZVkTWtG2yX6rn0dgRfJN1P0UjILxq4K|123456789
Content-Type: application/json

{
  "type": "DEPOSIT-US",
  "info": {
    "nickname": "My Deposit Account",
    "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8"
  }
}
body = {
  "type": "DEPOSIT-US",
  "info": {
    "nickname": "My Deposit Account",
    "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8"
  }
}

user.create_node(body, idempotency_key='123456')
const body = {
  "type": "DEPOSIT-US",
  "info": {
    "nickname": "My Deposit Account",
    "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8"
  }
};

user.createNode(body);
body = {
  "type": "DEPOSIT-US",
  "info": {
    "nickname": "My Deposit Account",
    "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8"
  }
}

user.create_node(payload: body)
$info= (object) [
   "nickname" => "My Deposit Account",
   "document_id" => "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8"
];
$body = (object) [
   'type' => 'DEPOSIT-US',
   'info' => $info
];

$user->create_node($body);
body := `{
  "type": "DEPOSIT-US",
  "info": {
    "nickname": "My Deposit Account",
    "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8"
  }
}`

data, err := user.CreateNode(body)
A binary file was returned

You couldn't be authenticated

{
  "error_code": "0",
  "http_code": "200",
  "limit": 20,
  "node_count": 1,
  "nodes": [
    {
      "_id": "5ba98a1c4d1d6200a4736e25",
      "_links": {
        "self": {
          "href": "https://uat-api.synapsefi.com/v3.1/users/5ba52ec00abfb200a8a93e90/nodes/5ba98a1c4d1d6200a4736e25"
        }
      },
      "allowed": "CREDIT-AND-DEBIT",
      "client": {
        "id": "5ade26b4567a900029e2afd2",
        "name": "YY Test Account"
      },
      "extra": {
        "note": null,
        "other": {},
        "supp_id": ""
      },
      "info": {
        "balance": {
          "amount": 0,
          "currency": "USD"
        },
        "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
        "monthly_withdrawals_remaining": null,
        "name_on_account": " ",
        "nickname": "My Deposit Account"
      },
      "is_active": true,
      "timeline": [
        {
          "date": 1537837596112,
          "note": "Node created."
        }
      ],
      "type": "DEPOSIT-US",
      "user_id": "5ba52ec00abfb200a8a93e90"
    }
  ],
  "page_count": 1,
  "success": true
}
 
Suggest Edits

Update Node

Update node values

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

Path Params

user_id
string
required

Object ID of user

Request Body

Set Nickname

Key
Type
Description

nickname

string

Nickname to assign to the node

Set Supplementary ID

Key
Type
Description

supp_id

string

[Max Characters: 250] Additional ID to assign to the node

Set Allowed Status

Key
Type
Description

allowed

string

Denotes available actions for the node. See permission table below for more information

Permission
Description

CREDIT-AND-DEBIT

Node can be credited and debited funds

INACTIVE

Node can only be credited funds

LOCKED

Node cannot be credited or debited funds.

POST /v3.1/users/5ba52ec00abfb200a8a93e90/nodes HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_wBvo8QzEDZVkTWtG2yX6rn0dgRfJN1P0UjILxq4K|123456789
Content-Type: application/json

{
  "supp_id":"new_supp_id_1234"
}
body = {
  "type": "DEPOSIT-US",
  "info": {
    "nickname": "My Deposit Account",
    "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8"
  }
}

user.create_node(body, idempotency_key='123456')
const body = {
  "type": "DEPOSIT-US",
  "info": {
    "nickname": "My Deposit Account",
    "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8"
  }
};

user.createNode(body);
body = {
  "type": "DEPOSIT-US",
  "info": {
    "nickname": "My Deposit Account",
    "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8"
  }
}

user.create_node(payload: body)
$info= (object) [
   "nickname" => "My Deposit Account",
   "document_id" => "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8"
];
$body = (object) [
   'type' => 'DEPOSIT-US',
   'info' => $info
];

$user->create_node($body);
body := `{
  "type": "DEPOSIT-US",
  "info": {
    "nickname": "My Deposit Account",
    "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8"
  }
}`

data, err := user.CreateNode(body)
A binary file was returned

You couldn't be authenticated

{
  "error_code": "0",
  "http_code": "200",
  "limit": 20,
  "node_count": 1,
  "nodes": [
    {
      "_id": "5ba98a1c4d1d6200a4736e25",
      "_links": {
        "self": {
          "href": "https://uat-api.synapsefi.com/v3.1/users/5ba52ec00abfb200a8a93e90/nodes/5ba98a1c4d1d6200a4736e25"
        }
      },
      "allowed": "CREDIT-AND-DEBIT",
      "client": {
        "id": "5ade26b4567a900029e2afd2",
        "name": "YY Test Account"
      },
      "extra": {
        "note": null,
        "other": {},
        "supp_id": "new_supp_id_1234"
      },
      "info": {
        "balance": {
          "amount": 0,
          "currency": "USD"
        },
        "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
        "monthly_withdrawals_remaining": null,
        "name_on_account": " ",
        "nickname": "My Deposit Account"
      },
      "is_active": true,
      "timeline": [
        {
          "date": 1537837596112,
          "note": "Node created."
        },
        {
          "date": 1556216986997,
          "note": "Node's 'supp_id' updated to new_supp_id_1234."
        }
      ],
      "type": "DEPOSIT-US",
      "user_id": "5ba52ec00abfb200a8a93e90"
    }
  ],
  "page_count": 1,
  "success": true
}
 
Suggest Edits

Delete Node

 
deletehttps://uat-api.synapsefi.com/v3.1/users/user_id/nodes/node_id

Path Params

user_id
string
required

Object ID of user

node_id
string
required

Object ID of node

Additional Information

Remaining Balance

Before deleting a node, please make sure that any remaining funds have been transferred out

DELETE /v3.1/users/5c8aa9687d093e00686b7331/nodes/5c8abccb4b7ba9102a61010d HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 255.127.79.76
X-SP-USER: oauth_kjqbGWY0wV53hN91ZgziaRP6lMop0cv4smdCxfF7|e88f41462eca394f6691da155d0cb73d
Content-Type: application/json
node_id = '5c8abccb4b7ba9102a61010d'
user.delete_node(node_id)
const nodeID = '5c8abccb4b7ba9102a61010d';
user.deleteNode(nodeID);
node_id = '5c8abccb4b7ba9102a61010d'
user.delete_node(node_id: node_id)
$nodeid = '5c8abccb4b7ba9102a61010d';
$user->delete_node($nodeid);
nodeID := "5c8abccb4b7ba9102a61010d"
data, err := user.DeleteNode(nodeID)
A binary file was returned

You couldn't be authenticated

{
  "_id": "5c8abccb4b7ba9102a61010d",
  "_links": {
    "self": {
      "href": "https://uat-api.synapsefi.com/v3.1/users/5c8aa9687d093e00686b7331/nodes/5c8abccb4b7ba9102a61010d"
    }
  },
  "allowed": "CREDIT-AND-DEBIT",
  "client": {
    "id": "589acd9ecb3cd400fa75ac06",
    "name": "SynapseFI"
  },
  "extra": {
    "note": null,
    "other": {
      "access_token": "5c8abcc99c4c720039579019",
      "updated_on": 1552610570000
    },
    "supp_id": ""
  },
  "info": {
    "account_num": "8901",
    "address": "PO BOX 85139, RICHMOND, VA, US",
    "balance": {
      "amount": "800.00",
      "currency": "USD",
      "updated_on": 1552610570000
    },
    "bank_logo": "https://cdn.synapsepay.com/bank_logos/new/co.png",
    "bank_long_name": "CAPITAL ONE N.A.",
    "bank_name": "CAPITAL ONE N.A.",
    "class": "CHECKING",
    "match_info": {
      "email_match": "match",
      "name_match": "match",
      "phonenumber_match": "no_match"
    },
    "name_on_account": " ",
    "nickname": "SynapsePay Test Checking Account - 8901",
    "routing_num": "6110",
    "type": "BUSINESS"
  },
  "is_active": false,
  "timeline": [
    {
      "date": 1552596170782,
      "note": "Node created."
    },
    {
      "date": 1552596171279,
      "note": "Unable to send micro deposits as node allowed is not CREDIT."
    },
    {
      "date": 1552597281077,
      "note": "Node's 'is_active' toggled to False."
    }
  ],
  "type": "ACH-US",
  "user_id": "5c8aa9687d093e00686b7331"
}
 
Suggest Edits

Node Types

List of all available node types

 

To view full list of available node types:
Node Types

 
Suggest Edits

Node Statuses

List of all available node permissions

 

These are all of the possible permission statuses our nodes can have:
Node Statuses

 
Suggest Edits

View User Subnets

View all Account/Routing Number and Debit Card Accounts for a user

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

Path Params

user_id
string
required

Object ID of user

Query Params

page
int32

Page number

per_page
int32

Number of subnets per page

Subnets Object

Key
Type
Description

error_code

string

See Common Errors for more information

http_code

string

See Common Errors for more information

limit

integer

Number of subnets per page

page

integer

Page number

page_count

integer

Number of pages

subnet_count

integer

Total number of subnets

subnets[]

array of objects

List of subnet objects. See View AC/RT Account or View Debit Card Account for more information

success

boolean

Request success

POST /v3.1/users/59c9f69a89ec34002e1b4b2e/subnets HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_xEyuYzmPN6Rp120Kg08Ma3SdO4w5c9ZFBnWfbJer|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json
node_id = "59c9b3b96d7d8a002f717c3c"

user.get_all_subnets(node_id)
const nodeID = '59c9b3b96d7d8a002f717c3c';

user.getAllSubnets(nodeID);
node_id= "59c9b3b96d7d8a002f717c3c"

user.get_all_subnets(node_id: node_id)
$nodeid = '59c9b3b96d7d8a002f717c3c';

$user->get_subnets($nodeid);
nodeID := "59c9b3b96d7d8a002f717c3c"

data, err := user.GetNodeSubnets(nodeID)
A binary file was returned

You couldn't be authenticated

{
  "error_code": "0",
  "http_code": "200",
  "limit": 20,
  "page": 1,
  "page_count": 1,
  "subnets": [
    {
      "_id": "5cb7cf26b34a6d004345ef3d",
      "_links": {
        "self": {
          "href": "https://uat-api.synapsefi.com/v3.1/users/5c64996c7f9c202542e96e09/nodes/5cb7aae388a3e200d87dde81/subnets/5cb7cf26b34a6d004345ef3d"
        }
      },
      "account_class": "CHECKING",
      "account_num": "9891213684",
      "client": {
        "id": "5beb506f6d7ceb002490631f",
        "name": "SynapseFI"
      },
      "created_on": 1555549989904,
      "nickname": "SynapseFI AC/RT",
      "node_id": "5cb7aae388a3e200d87dde81",
      "routing_num": {
        "ach": "084106768",
        "wire": "084106768"
      },
      "status": "INACTIVE",
      "supp_id": null,
      "user_id": "5c64996c7f9c202542e96e09"
    },
    {
      ...
    },
    {
      "_id": "5c77373831551b45f4bba72d",
      "_links": {
        "self": {
          "href": "https://uat-api.synapsefi.com/v3.1/users/5c64996c7f9c202542e96e09/nodes/5c649a1009309d3ec967a657/subnets/5c77373831551b45f4bba72d"
        }
      },
      "account_class": "CHECKING",
      "account_num": "9893500777",
      "client": {
        "id": "5beb506f6d7ceb002490631f",
        "name": "SynapseFI"
      },
      "nickname": "Test",
      "node_id": "5c649a1009309d3ec967a657",
      "routing_num": {
        "ach": "084106768",
        "wire": "084106768"
      },
      "status": "INACTIVE",
      "supp_id": null,
      "user_id": "5c64996c7f9c202542e96e09"
    }
  ],
  "subnets_count": 13,
  "success": true
}
 
Suggest Edits

View Node Subnets

View all Account/Routing Number and Debit Card Accounts for a node

 
gethttps://uat-api.synapsefi.com/v3.1/users/user_id/nodes/node_id/subnets

Path Params

user_id
string
required

Object ID of user

node_id
string
required

Object ID of node

Query Params

page
int32

Page number

per_page
int32

Number of subnets per page

Subnets Object

Key
Type
Description

error_code

string

See Common Errors for more information

http_code

string

See Common Errors for more information

limit

integer

Number of subnets per page

page

integer

Page number

page_count

integer

Number of pages

subnet_count

integer

Total number of subnets

subnets[]

array of objects

List of subnet objects. See View AC/RT Account or View Debit Card Account for more information

success

boolean

Request success

POST /v3.1/users/59c9f69a89ec34002e1b4b2e/nodes/59c9f6a66d7d8a002f71b191/subnets HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_xEyuYzmPN6Rp120Kg08Ma3SdO4w5c9ZFBnWfbJer|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json
node_id = "59c9b3b96d7d8a002f717c3c"

user.get_all_subnets(node_id)
const nodeID = '59c9b3b96d7d8a002f717c3c';

user.getAllSubnets(nodeID);
node_id= "59c9b3b96d7d8a002f717c3c"

user.get_all_subnets(node_id: node_id)
$nodeid = '59c9b3b96d7d8a002f717c3c';

$user->get_subnets($nodeid);
nodeID := "59c9b3b96d7d8a002f717c3c"

data, err := user.GetNodeSubnets(nodeID)
A binary file was returned

You couldn't be authenticated

{
  "error_code": "0",
  "http_code": "200",
  "limit": 20,
  "page": 1,
  "page_count": 1,
  "subnets": [
    {
      "_id": "59c9b3c3a82e520029a105a0",
      "_links": {
        "self": {
          "href": "https://uat-api.synapsefi.com/v3.1/users/59c9b3ae89ec34002e1b3c3f/nodes/59c9b3b96d7d8a002f717c3c/subnets/59c9b3c3a82e520029a105a0"
        }
      },
      "account_class": "CHECKING",
      "account_num": "902387862804533",
      "allowed": "CREDIT",
      "client": {
        "id": "589acd9ecb3cd400fa75ac06",
        "name": "SynapseFI"
      },
      "created_on": 1555549989904,
      "nickname": "Test AC/RT",
      "node_id": "59c9b3b96d7d8a002f717c3c",
      "routing_num": {
        "ach": "084106768",
        "wire": "084106768"
      },
      "status": "ACTIVE",
      "supp_id": null,
      "user_id": "59c9b3ae89ec34002e1b3c3f"
    },
    {
      ...
    }
  ],
  "subnets_count": 2,
  "success": true
}
 
Suggest Edits

Subnet Statuses

 
Key
Description

ACTIVE

Funds may pass through this subnet

INACTIVE

Funds may NOT pass through this subnet. Status may be updated to ACTIVE

TERMINATED

Funds may NOT pass through this subnet. Status may NOT be updated

 
Suggest Edits

View AC/RT Account

AC/RT accounts are subnets built on nodes

 
gethttps://uat-api.synapsefi.com/v3.1/users/user_id/nodes/node_id/subnets/subnet_id

Path Params

user_id
string
required

Object ID of user

node_id
string
required

Object ID of node

subnet_id
string
required

Object ID of subnet

Subnet Object

Key
Type
Description

_id

string

Object ID of subnet

_links.self.href

string

HAL-style link for the subnet object

account_class

string

Account class of subnet

account_num

string

Account number associated with subnet

client.id

string

ID of the client associated with the subnet

client.name

string

Name of the client associated with the subnet

created_on

integer

Date of subnet creation (in Unix time)

nickname

string

Nickname given to the AC/RT account

node_id

string

Node ID associated with the subnet. Funds will be credited to this node when credits arrive

routing_num.ach

string

Routing number for ACH transfers

routing_num.wire

string

Routing number fo wire transfers

status

string

Subnet status. See Update AC/RT Account for more information

supp_id

string

Additional ID supplied to subnet

user_id

string

User ID associate with the subnet

GET/v3.1/users/59c9f69a89ec34002e1b4b2e/nodes/59c9f6a66d7d8a002f71b191/subnets/59c9f77cd412960028b99d2b HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_xEyuYzmPN6Rp120Kg08Ma3SdO4w5c9ZFBnWfbJer|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json
node_id= "59c9f6a66d7d8a002f71b191"
subnet_id= "59c9f77cd412960028b99d2b"

user.get_subnet(node_id, subnet_id)
const nodeID = '59c9f6a66d7d8a002f71b191';
const subnetID = '59c9f77cd412960028b99d2b';

user.getSubnet(nodeID, subnetID);
node_id= "59c9f6a66d7d8a002f71b191"
subnet_id= "59c9f77cd412960028b99d2b"

user.get_subnet(node_id: node_id, subnet_id: subnet_id)
$nodeid = '59c9f6a66d7d8a002f71b191';
$subnetid = '59c9f77cd412960028b99d2b';

$user->get_subnet($nodeid, $subnetid);
nodeID := "594e606212e17a002f2e3251"
subnetID := "59c9f77cd412960028b99d2b"

data, err := user.GetSubnet(nodeID, subnetID)
A binary file was returned

You couldn't be authenticated

{
  "_id": "5cb7cf26b34a6d004345ef3d",
  "_links": {
    "self": {
      "href": "https://uat-api.synapsefi.com/v3.1/users/5c64996c7f9c202542e96e09/nodes/5cb7aae388a3e200d87dde81/subnets/5cb7cf26b34a6d004345ef3d"
    }
  },
  "account_class": "CHECKING",
  "account_num": "9891213684",
  "client": {
    "id": "5beb506f6d7ceb002490631f",
    "name": "SynapseFI"
  },
  "created_on": 1555549989904,
  "nickname": "My AC/RT",
  "node_id": "5cb7aae388a3e200d87dde81",
  "routing_num": {
    "ach": "084106768",
    "wire": "084106768"
  },
  "status": "ACTIVE",
  "supp_id": null,
  "user_id": "5c64996c7f9c202542e96e09"
}
 
Suggest Edits

Issue AC/RT Numbers

Create SUBNET

 
posthttps://uat-api.synapsefi.com/v3.1/users/user_id/nodes/node_id/subnets

Path Params

user_id
string
required

Object ID of user

node_id
string
required

Object ID of node

Request Body

Key
Type
Description

nickname

string

[Required] Nickname to assign to the node

supp_id

string

Additional ID to supply for the subnet

Sandbox Test Values

  • Any valid Routing Number and 5-digit Account Number will work in Sandbox (e.g. 322271627 - Chase California Routing Number)
POST /v3.1/users/59c9f69a89ec34002e1b4b2e/nodes/59c9f6a66d7d8a002f71b191/subnets HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_xEyuYzmPN6Rp120Kg08Ma3SdO4w5c9ZFBnWfbJer|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

{
  "nickname":"Test AC/RT"
}
node_id = "59c9f6a66d7d8a002f71b191"
body = {
  "nickname":"Test AC/RT"
}

user.create_subnet(node_id, body)
const nodeID = '59c9f6a66d7d8a002f71b191';
const body = {
  "nickname": "Test AC/RT"
};

user.createSubnet(nodeID, body);
node_id = "59c9f6a66d7d8a002f71b191"
body = {
  "nickname":"Test AC/RT"
}

user.create_subnet(node_id: node_id, payload: body)
$nodeid = '59c9f6a66d7d8a002f71b191';
$body = (object)[
   "nickname" => "Test AC/RT"
];
$user->create_subnet($nodeid, $body);
nodeID := "59c9f6a66d7d8a002f71b191"
body := `{
  "nickname":"Test AC/RT"
}`

data, err := user.CreateSubnet(nodeID, body)
A binary file was returned

You couldn't be authenticated

{
  "_id": "59c9f77cd412960028b99d2b",
  "_links": {
    "self": {
      "href": "https://uat-api.synapsefi.com/v3.1/users/59c9f69a89ec34002e1b4b2e/nodes/59c9f6a66d7d8a002f71b191/subnets/59c9f77cd412960028b99d2b"
    }
  },
  "account_class": "CHECKING",
  "account_num": "692069247603874",
  "client": {
    "id": "589acd9ecb3cd400fa75ac06",
    "name": "SynapseFI"
  },
  "created_on": 1555549989904,
  "nickname": "Test AC/RT",
  "node_id": "59c9f6a66d7d8a002f71b191",
  "routing_num": {
    "ach": "084106768",
    "wire": "084106768"
  },
  "status": "ACTIVE",
  "supp_id": null,
  "user_id": "59c9f69a89ec34002e1b4b2e"
}
 
Suggest Edits

Update AC/RT Account

 
patchhttps://uat-api.synapsefi.com/v3.1/users/user_id/nodes/node_id/subnets/subnet_id

Path Params

user_id
string
required

Object ID of user

node_id
string
required

Object ID of node

subnet_id
string
required

Object ID of subnet

Request Body

Key
Type
Description

status

string

Subnet status

supp_id

string

Additional ID supplied to subnet

PATCH /v3.1/users/59c9f69a89ec34002e1b4b2e/nodes/59c9f6a66d7d8a002f71b191/subnets/59c9f77cd412960028b99d2b HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_xEyuYzmPN6Rp120Kg08Ma3SdO4w5c9ZFBnWfbJer|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

{
  "status":"INACTIVE"
}
node_id = '594e606212e17a002f2e3251'
subn_id = '59c9f77cd412960028b99d2b'
body = {
  "status":"INACTIVE"
}

user.update_subnet(node_id, subn_id, body)
nodeID = "594e606212e17a002f2e3251";
subnetID = "59c9f77cd412960028b99d2b";
const body = {
  "status":"INACTIVE"
};

user.updateSubnet(nodeID, subnetID, body);
node_id = '594e606212e17a002f2e3251'
subnet_id = '59c9f77cd412960028b99d2b'
body = {
  "status":"INACTIVE"
}

user.update_subnet(node_id: node_id, payload: body, subnter_id: subnet_id)
$body= (object) [
  "status":"INACTIVE"
];

$node_id = '594e606212e17a002f2e3251';
$subnet_id = '59c9f77cd412960028b99d2b';
$user->update_subnet( $node_id, $subnet_id ,$body);
nodeID := "59c9f6a66d7d8a002f71b191"
subnetID := "5bc920f2fff373002bf0d51b"
body := `{
  "status":"INACTIVE"
}`

data, err := user.UpdateSubnet(nodeID, subnetID, body)
A binary file was returned

You couldn't be authenticated

{
  "_id": "59c9f77cd412960028b99d2b",
  "_links": {
    "self": {
      "href": "https://uat-api.synapsefi.com/v3.1/users/59c9f69a89ec34002e1b4b2e/nodes/59c9f6a66d7d8a002f71b191/subnets/59c9f77cd412960028b99d2b"
    }
  },
  "account_class": "CHECKING",
  "account_num": "692069247603874",
  "client": {
    "id": "589acd9ecb3cd400fa75ac06",
    "name": "SynapseFI"
  },
  "created_on": 1555549989904,
  "nickname": "Test AC/RT",
  "node_id": "59c9f6a66d7d8a002f71b191",
  "routing_num": {
    "ach": "084106768",
    "wire": "084106768"
  },
  "status": "INACTIVE",
  "user_id": "59c9f69a89ec34002e1b4b2e"
}
 
Suggest Edits

View Debit Card Account

View a SUBNET

 
gethttps://uat-api.synapsefi.com/v3.1/users/user_id/nodesnode_id/subnets/subnet_id

Path Params

user_id
string
required

Object ID of user

node_id
string
required

Object ID of node

subnet_id
string
required

Object ID of subnet

Query Params

full_dehydrate
string

[yes/no] Full Dehydrate yes will return back all the card info including the card number, and cvc.

Subnet Object

Key
Type
Description

_id

string

Object ID of subnet

_links.self.href

string

HAL-style link for the subnet object

access_token

string

Access token of subnet

account_class

string

Account class of subnet

account_num

string

Account number associated with subnet

card_hash

string

Card hash

card_style_id

string

Style ID of card

client.id

string

ID of the client associated with the subnet

client.name

string

Name of the client associated with the subnet

created_on

integer

Date of subnet creation (in Unix time)

cvc

string

[Hidden] CVC code

exp

string

Expiration date of card (in YYYY-MM-DD)

nickname

string

Nickname given to the AC/RT account

node_id

string

Node ID associated with the subnet. Funds will be credited to this node when credits arrive

preferences._daily_atm_withdrawal_limit

integer

preferences._daily_transaction_limit

integer

preferences.allow_foreign_transactions

boolean

Flag to allow foreign transactions

preferences.daily_atm_withdrawal_limit

integer

User max ATM withdrawal limit

preferences.daily_transaction_limit

integer

User max transaction limit

preferences.spending_limit

boolean

Flag for user spending limit

status

string

Subnet status. See Subnet Statuses for more information

supp_id

string

Additional ID supplied to subnet

user_id

string

User ID associated with the subnet

GET /v3.1/users/59c9f69a89ec34002e1b4b2e/nodes/59c9f6a66d7d8a002f71b191/subnets/59c9f77cd412960028b99d2b HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_xEyuYzmPN6Rp120Kg08Ma3SdO4w5c9ZFBnWfbJer|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json
node_id = '594e606212e17a002f2e3251'
subnet_id = '59c9f77cd412960028b99d2b'

user.get_subnet(node_id, subnet_id);
const nodeID = '594e606212e17a002f2e3251';
const subnetID = '59c9f77cd412960028b99d2b';

user.getSubnet(nodeID, subnetID);
node_id = '594e606212e17a002f2e3251'
subnet_id = '59c9f77cd412960028b99d2b'

user.get_subnet(node_id: node_id, subnet_id: subnet_id)
$nodeid = '594e606212e17a002f2e3251';
$subnetid = '59c9f77cd412960028b99d2b';

$user->get_subnet($nodeid, $subnetid);
nodeID := "594e606212e17a002f2e3251"
subID := "59c9f77cd412960028b99d2b"

data, err := user.GetSubnet(nodeID, subID)
A binary file was returned

You couldn't be authenticated

{
  "_id": "5cb7c99439f3ae003e4fb3c3",
  "_links": {
    "self": {
      "href": "https://uat-api.synapsefi.com/v3.1/users/5c64996c7f9c202542e96e09/nodes/5cb7aae388a3e200d87dde81/subnets/5cb7c99439f3ae003e4fb3c3"
    }
  },
  "access_token": "5cb7c9938fe0d6002c7b0685",
  "account_class": "DEBIT_CARD",
  "card_hash": "cf0a70f42c72ef5483f5b32bceb17d84a84e3f96ed4df86fd5f6a4f9eda41a1b",
  "card_number": "1171",
  "card_style_id": null,
  "client": {
    "id": "5beb506f6d7ceb002490631f",
    "name": "SynapseFI"
  },
  "created_on": 1555548562500,
  "cvc": "***",
  "exp": "2023-05-17",
  "nickname": "My Debit Card",
  "node_id": "5cb7aae388a3e200d87dde81",
  "preferences": {
    "_daily_atm_withdrawal_limit": 1500,
    "_daily_transaction_limit": 1500,
    "allow_foreign_transactions": true,
    "daily_atm_withdrawal_limit": 1000,
    "daily_transaction_limit": 1000,
    "spending_limit": false
  },
  "status": "INACTIVE",
  "supp_id": null,
  "user_id": "5c64996c7f9c202542e96e09"
}
 
Suggest Edits

Create Debit Card

Create a SUBNET

 
posthttps://uat-api.synapsefi.com/v3.1/users/user_id/nodes/node_id/subnets

Request Body

Key
Type
Description

account_class

string

[Required] Type of account. Set as DEBIT_CARD

nickname

string

Nickname to assign to the node

supp_id

string

Additional ID supplied to subnet

Additional Information

  • When creating Debit Cards, the subnet will have a status of PENDING while our system attempts to provision a card. If this is successful, the status will be updated to INACTIVE.
POST /v3.1/users/59c9f69a89ec34002e1b4b2e/nodes/59c9f6a66d7d8a002f71b191/subnets HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_xEyuYzmPN6Rp120Kg08Ma3SdO4w5c9ZFBnWfbJer|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

{
  "nickname":"My Debit Card",
  "account_class":"DEBIT_CARD"
}
node_id = "59c9f6a66d7d8a002f71b191"
body = {
	"nickname":"My Debit Card",
	"account_class":"DEBIT_CARD"
}

user.create_subnet(node_id, body)
const nodeID = '59c9f6a66d7d8a002f71b191';
const body = {
	"nickname":"My Debit Card",
	"account_class":"DEBIT_CARD"
};

user.createSubnet(nodeID, body);
node_id = "59c9f6a66d7d8a002f71b191"
body = {
	"nickname":"My Debit Card",
	"account_class":"DEBIT_CARD"
}

user.create_subnet(node_id: node_id, payload: body)
$nodeid = '59c9f6a66d7d8a002f71b191';
$body = (object)[
	"nickname" => "My Debit Card",
	"account_class" => "DEBIT_CARD"
];

$user->create_subnet($nodeid, $body);
nodeID := "59c9f6a66d7d8a002f71b191"
body := `{
	"nickname":"My Debit Card",
	"account_class":"DEBIT_CARD"
}`

data, err := user.CreateSubnet(nodeID, body)
A binary file was returned

You couldn't be authenticated

{
  "_id": "59c9f77cd412960028b99d2b",
  "_links": {
    "self": {
      "href": "https://uat-api.synapsefi.com/v3.1/users/59c9f69a89ec34002e1b4b2e/nodes/59c9f6a66d7d8a002f71b191/subnets/59c9f77cd412960028b99d2b"
    }
  },
  "access_token": "5bc920f2fff373002bf0d51b",
  "account_class": "DEBIT_CARD",
  "card_hash": "78eb685b26d99d32538feb97cfd1274f994bdde48fa75471f22ba3029cbbc4e0",
  "card_number": "5431",
  "card_style_id": null,
  "client": {
    "id": "59c9f77cd412960028b99d2b",
    "name": "SynapseFI"
  },
  "created_on": 1555549989904,
  "cvc": "***",
  "exp": "2022-11-17",
  "nickname": "My Debit Card",
  "node_id": "59c9f6a66d7d8a002f71b191",
  "preferences": {
    "allow_foreign_transactions": false,
    "daily_atm_withdrawal_limit": 100,
    "daily_transaction_limit": 1000,
    "spending_limit": false
  },
  "status": "PENDING",
  "user_id": "59c9f69a89ec34002e1b4b2e"
}
 
 
patchhttps://uat-api.synapsefi.com/v3.1/users/user_id/nodes/node_id/subnets/subnet_id

Path Params

user_id
string
required

Object ID of user

node_id
string
required

Object ID of node

subnet_id
string
required

Object ID of subnet

Request Body

Key
Type
Description

card_pin

string

Encrypted card pin. See Encrypting Data for more information

PATCH /v3.1/users/5bb29f48520da000a38cb107/nodes/5bb29f5471fd1b0091317410/subnets/5bc920f2fff373002bf0d51b HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_NhFV8tDKOMms2j5I4lzxJXUQY9BH6abycdnpTCA3|J6fhD7DNd238
Content-Type: application/json

{
  "card_pin": "mlMKMv5+ekyw9M5AtqUBZxgdzj+GEjzddp93qSPw6uRXGpdNiNulVZxcbH1gGGiwEU9UeOwGmgiMaQsDkpbuh3SWY6IxSiPNHI9ryY8z/z+d8MXockQxsKnl1B+ekcLAXx9s2RZM7T6Nfoa+ABGwRV7aFGt91NYaolA0tfU1981J9juB/iljm9cz5JUKDPCxZbn+LW1f4O/5Pt3fDX9Nrre/HsuHtgc7OIu6XTvg1FCm+ds3AkFdHA0dw1aW4j5biXWVEkNpb01PIicANYXtO/AusqH8udBLh0GIU/xNSTzipk/M2hUqoTZdOo7Hu8UZgLbWUEpv7hAAY2tfu/ymsA=="
}
node_id = '594e606212e17a002f2e3251'
subnet_id = '59c9f77cd412960028b99d2b'

body = {
  "card_pin": "mlMKMv5+ekyw9M5AtqUBZxgdzj+GEjzddp93qSPw6uRXGpdNiNulVZxcbH1gGGiwEU9UeOwGmgiMaQsDkpbuh3SWY6IxSiPNHI9ryY8z/z+d8MXockQxsKnl1B+ekcLAXx9s2RZM7T6Nfoa+ABGwRV7aFGt91NYaolA0tfU1981J9juB/iljm9cz5JUKDPCxZbn+LW1f4O/5Pt3fDX9Nrre/HsuHtgc7OIu6XTvg1FCm+ds3AkFdHA0dw1aW4j5biXWVEkNpb01PIicANYXtO/AusqH8udBLh0GIU/xNSTzipk/M2hUqoTZdOo7Hu8UZgLbWUEpv7hAAY2tfu/ymsA=="
}

user.update_subnet(node_id, subnet_id, body)
const nodeID = '594e606212e17a002f2e3251';
const subnetID = '59c9f77cd412960028b99d2b';
const body = {
  "card_pin": "mlMKMv5+ekyw9M5AtqUBZxgdzj+GEjzddp93qSPw6uRXGpdNiNulVZxcbH1gGGiwEU9UeOwGmgiMaQsDkpbuh3SWY6IxSiPNHI9ryY8z/z+d8MXockQxsKnl1B+ekcLAXx9s2RZM7T6Nfoa+ABGwRV7aFGt91NYaolA0tfU1981J9juB/iljm9cz5JUKDPCxZbn+LW1f4O/5Pt3fDX9Nrre/HsuHtgc7OIu6XTvg1FCm+ds3AkFdHA0dw1aW4j5biXWVEkNpb01PIicANYXtO/AusqH8udBLh0GIU/xNSTzipk/M2hUqoTZdOo7Hu8UZgLbWUEpv7hAAY2tfu/ymsA=="
};

 user.updateSubnet(nodeID, subnetID, body);
node_id = '594e606212e17a002f2e3251'
subnet_id = '59c9f77cd412960028b99d2b'

body =  {
  "card_pin": "mlMKMv5+ekyw9M5AtqUBZxgdzj+GEjzddp93qSPw6uRXGpdNiNulVZxcbH1gGGiwEU9UeOwGmgiMaQsDkpbuh3SWY6IxSiPNHI9ryY8z/z+d8MXockQxsKnl1B+ekcLAXx9s2RZM7T6Nfoa+ABGwRV7aFGt91NYaolA0tfU1981J9juB/iljm9cz5JUKDPCxZbn+LW1f4O/5Pt3fDX9Nrre/HsuHtgc7OIu6XTvg1FCm+ds3AkFdHA0dw1aW4j5biXWVEkNpb01PIicANYXtO/AusqH8udBLh0GIU/xNSTzipk/M2hUqoTZdOo7Hu8UZgLbWUEpv7hAAY2tfu/ymsA=="
}

user.update_subnet(node_id: node_id, payload: body, subnter_id: subnet_id)
$body = (object)[
  "card_pin" => "mlMKMv5+ekyw9M5AtqUBZxgdzj+GEjzddp93qSPw6uRXGpdNiNulVZxcbH1gGGiwEU9UeOwGmgiMaQsDkpbuh3SWY6IxSiPNHI9ryY8z/z+d8MXockQxsKnl1B+ekcLAXx9s2RZM7T6Nfoa+ABGwRV7aFGt91NYaolA0tfU1981J9juB/iljm9cz5JUKDPCxZbn+LW1f4O/5Pt3fDX9Nrre/HsuHtgc7OIu6XTvg1FCm+ds3AkFdHA0dw1aW4j5biXWVEkNpb01PIicANYXtO/AusqH8udBLh0GIU/xNSTzipk/M2hUqoTZdOo7Hu8UZgLbWUEpv7hAAY2tfu/ymsA=="
];

node_id = '594e606212e17a002f2e3251'
subnet_id = '59c9f77cd412960028b99d2b'

$user->update_subnet(node_id, subnet_id, $body);
nodeID := "594e606212e17a002f2e3251"
subnetID := "5bc920f2fff373002bf0d51b"
body := `{
  "card_pin": "mlMKMv5+ekyw9M5AtqUBZxgdzj+GEjzddp93qSPw6uRXGpdNiNulVZxcbH1gGGiwEU9UeOwGmgiMaQsDkpbuh3SWY6IxSiPNHI9ryY8z/z+d8MXockQxsKnl1B+ekcLAXx9s2RZM7T6Nfoa+ABGwRV7aFGt91NYaolA0tfU1981J9juB/iljm9cz5JUKDPCxZbn+LW1f4O/5Pt3fDX9Nrre/HsuHtgc7OIu6XTvg1FCm+ds3AkFdHA0dw1aW4j5biXWVEkNpb01PIicANYXtO/AusqH8udBLh0GIU/xNSTzipk/M2hUqoTZdOo7Hu8UZgLbWUEpv7hAAY2tfu/ymsA=="
}`

data, err := user.UpdateSubnet(nodeID, subnetID, body)
A binary file was returned

You couldn't be authenticated

{
  "_id": "5bc920f2fff373002bf0d51b",
  "_links": {
    "self": {
      "href": "https://uat-api.synapsefi.com/v3.1/users/5bb29f48520da000a38cb107/nodes/5bb29f5471fd1b0091317410/subnets/5bc920f2fff373002bf0d51b"
    }
  },
  "access_token": "5bc920f9a5061e002681c89f",
  "account_class": "DEBIT_CARD",
  "card_hash": "78eb685b26d99d32538feb97cfd1274f994bdde48fa75471f22ba3029cbbc4e0",
  "card_number": "5431",
  "card_style_id": null,
  "client": {
    "id": "5b0da0f66e990e001f0c5f54",
    "name": "YY Test Account"
  },
  "created_on": 1555549989904,
  "cvc": "***",
  "exp": "2022-11-17",
  "nickname": "My Debit Card",
  "node_id": "5bb29f5471fd1b0091317410",
  "preferences": {
    "allow_foreign_transactions": true,
    "daily_atm_withdrawal_limit": 10,
    "daily_transaction_limit": 1000,
    "spending_limit": false
  },
  "status": "ACTIVE",
  "supp_id": null,
  "user_id": "5bb29f48520da000a38cb107"
}
 
Suggest Edits

Ship Debit Card

 
patchhttps://uat-api.synapsefi.com/v3.1/users/user_id/nodes/node_id/subnets/subnet_id/ship

Path Params

user_id
string
required

Object ID of user

node_id
string
required

Object ID of node

subnet_id
string
required

Object ID of subnet

Request Body

Key
Type
Description

fee_node_id

string

Object ID of node to deduct fee from

expedite

boolean

Flag to expedite shipping speed of card. Extra fees apply

card_style_id

string

Style ID of card

cardholder_name

string

Name to be printed on card

Additional Information

  • Cards may only be shipped twice every 6 months
PATCH /v3.1/users/5bb6ab05472e2500adffad5a/nodes/5bbadc6f7b11c3008d045add/ship HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_46jGbL5oIhAHtTuQVfYDpcqmedZBP9Xa0Owrnv7F|n38dj3h8NE393bv24ovoRY34kd62
Content-Type: application/json

{
  "fee_node_id":"5bba781485411800991b606b",
  "expedite":false,
  "card_style_id": "555",
  "cardholder_name": "Cardholder Name"
}
node_id = '594e606212e17a002f2e3251'
subn_id = '59c9f77cd412960028b99d2b'
body = {
  "fee_node_id":"5bba781485411800991b606b",
  "expedite":False,
  "card_style_id": "555",
  "cardholder_name": "Cardholder Name"
}

user.ship_card(node_id, subn_id, body)
const nodeID = '594e606212e17a002f2e3251'
const subnetID = '59c9f77cd412960028b99d2b'
const body = {
  "fee_node_id":"5bba781485411800991b606b",
  "expedite":false,
  "card_style_id": "555",
  "cardholder_name": "Cardholder Name"
}

user.shipCard(nodeID, subnetID, body);
node_id = "5bbadc6f7b11c3008d045add"
subnet_id = “5bc920f2fff373002bf0d51b”
body= {
  "fee_node_id":"5bba781485411800991b606b",
  "expedite":false,
  "card_style_id": "555",
  "cardholder_name": "Cardholder Name"
}

user.ship_card(node_id: node_id, payload: body)
$body = (object) [
   "fee_node_id" => "5ba05e7920b3aa006482c5ad",
   "expedite" => false,
   "card_style_id" => "555",
   "cardholder_name" => "Cardholder Name"
];
$nodeid = '5bbadc6f7b11c3008d045add'
$subnetid = '5bc920f2fff373002bf0d51b'

$user->ship_card_subnet($nodeid , $subnetid , $body);
nodeID := "594e606212e17a002f2e3251"
subnetID := "5bc920f2fff373002bf0d51b"
body := `{
  "fee_node_id":"5bba781485411800991b606b",
  "expedite":false,
  "card_style_id": "555",
  "cardholder_name": "Cardholder Name"
}`

data, err := user.ShipCard(nodeID, subnetID, body)
A binary file was returned

You couldn't be authenticated

{
  "node_id": "5bc920e27eb7c500972c7e33",
  "subnet_id": "5bc920f9a5061e002681c89f",
  "transaction_id": "5bcf7c59c39fa85af5729653"
}
 
Suggest Edits

Update Status

 
patchhttps://uat-api.synapsefi.com/v3.1/users/user_id/nodes/node_id/subnets/subnet_id#

Path Params

user_id
string
required

Object ID of user

node_id
string
required

Object ID of node

subnet_id
string
required

Object ID of subnet

Request Body

Key
Type
Description

status

string

Status of the card

Statuses

Note on Subnet Rate Limit

Cards subnets (and legacy CARD-US nodes) can now only be set to ACTIVE status a maximum of 10 times per week. This is intended to prevent unintended or non-standard use of our Update Card Status API call.

Please note that performing an Update Status API call to set a card to ACTIVE status when the card is already in ACTIVE status will still count against the weekly subnet rate limit referenced above.

Key
Description

ACTIVE

Enables the card to be used for sending and receiving funds

INACTIVE

Disables debits on the node

TERMINATED

Disables the card number and blocks all transactions. This is sometimes used when an account is fraudulent

PATCH /v3.1/users/5bb29f48520da000a38cb107/nodes/5bb29f5471fd1b0091317410/subnets/5bc920f2fff373002bf0d51b HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_NhFV8tDKOMms2j5I4lzxJXUQY9BH6abycdnpTCA3|J6fhD7DNd238
Content-Type: application/json

{
  "status": "ACTIVE"
}
node_id = '594e606212e17a002f2e3251'
subnet_id = '59c9f77cd412960028b99d2b'

body = {
  "status": "ACTIVE"
}

user.update_subnet(node_id, subnet_id, body)
const nodeID = '594e606212e17a002f2e3251';
const subnetID = '59c9f77cd412960028b99d2b';
const body = {
  "status": "ACTIVE"
};

user.updateSubnet(nodeID, subnetID, body);
node_id = '594e606212e17a002f2e3251'
subnet_id = '59c9f77cd412960028b99d2b'

body = {
  "status": "ACTIVE"
}

user.update_subnet(node_id: node_id, payload: body, subnter_id: subnet_id)
$body = (object)[
  "status" => "ACTIVE"
];

node_id = '594e606212e17a002f2e3251'
subnet_id = '59c9f77cd412960028b99d2b'

$user->update_subnet(node_id, subnet_id, $body);
nodeID := "59c9f6a66d7d8a002f71b191"
subnetID := "5bc920f2fff373002bf0d51b"
body := `{
  "status": "ACTIVE"
}`

data, err := user.UpdateSubnet(nodeID, subnetID, body)
A binary file was returned

You couldn't be authenticated

{
  "_id": "5bc920f2fff373002bf0d51b",
  "_links": {
    "self": {
      "href": "https://uat-api.synapsefi.com/v3.1/users/5bb29f48520da000a38cb107/nodes/5bb29f5471fd1b0091317410/subnets/5bc920f2fff373002bf0d51b"
    }
  },
  "access_token": "5bc920f9a5061e002681c89f",
  "account_class": "DEBIT_CARD",
  "card_hash": "78eb685b26d99d32538feb97cfd1274f994bdde48fa75471f22ba3029cbbc4e0",
  "card_number": "5431",
  "card_style_id": null,
  "client": {
    "id": "5b0da0f66e990e001f0c5f54",
    "name": "YY Test Account"
  },
  "created_on": 1555549989904,
  "cvc": "***",
  "exp": "2022-11-17",
  "nickname": "My Debit Card",
  "node_id": "5bb29f5471fd1b0091317410",
  "preferences": {
    "allow_foreign_transactions": true,
    "daily_atm_withdrawal_limit": 10,
    "daily_transaction_limit": 1000
  },
  "status": "ACTIVE",
  "supp_id": null,
  "user_id": "5bb29f48520da000a38cb107"
}
 
Suggest Edits

Update Preferences

 
patchhttps://uat-api.synapsefi.com/v3.1/users/user_id/nodes/node_id/subnets/subnet_id

Path Params

user_id
string
required

Object ID of user

node_id
string
required

Object ID of node

subnet_id
string
required

Object ID of subnet

Request Body

Key
Type
Description

preferences.allow_foreign_transactions

boolean

Allow non-US transactions on card

preferences.atm_withdrawal_limit

integer

Max ATM withdrawal limit for debit card

preferences.max_pin_attempts

integer

Max pin attempts for debit card

preferences.pos_withdrawal_limits

integer

Max POS withdrawal limits for debit card

preferences.security_alerts

boolean

Flag for sending security alerts when suspicious activity is detected on debit card

PATCH /v3.1/users/5bb29f48520da000a38cb107/nodes/5bb29f5471fd1b0091317410/subnets/5bc920f2fff373002bf0d51b HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_NhFV8tDKOMms2j5I4lzxJXUQY9BH6abycdnpTCA3|J6fhD7DNd238
Content-Type: application/json

{
  "preferences":{
    "allow_foreign_transactions": true,
    "atm_withdrawal_limit": 5000,
    "max_pin_attempts": 3,
    "pos_withdrawal_limit": 1000,
    "security_alerts": true
  }
}
node_id = '594e606212e17a002f2e3251'
subnet_id = '59c9f77cd412960028b99d2b'
body = {
  "preferences": {
    "allow_foreign_transactions":true,
    "daily_atm_withdrawal_limit":5,
    "daily_transaction_limit":500
  }
}

user.update_subnet(node_id, subnet_id, body)
const nodeID = '594e606212e17a002f2e3251';
const subnetID = '59c9f77cd412960028b99d2b';
const body = {
  "preferences": {
    "allow_foreign_transactions":true,
    "daily_atm_withdrawal_limit":5,
    "daily_transaction_limit":500
  }
};

user.updateSubnet(nodeID, subnetID, body);
node_id = '594e606212e17a002f2e3251'
subnet_id = '59c9f77cd412960028b99d2b'
body = {
  "preferences": {
    "allow_foreign_transactions":true,
    "daily_atm_withdrawal_limit":5,
    "daily_transaction_limit":500
  }
}

user.update_subnet(node_id: node_id, payload: body, subnter_id: subnet_id)
$preferences = (object)[
     "allow_foreign_transactions" => true,
     "daily_atm_withdrawal_limit" => 5,
     "daily_transaction_limit" => 500
];
$body = (object)[
 "preferences" => $preferences
];

node_id = '594e606212e17a002f2e3251'
subnet_id = '59c9f77cd412960028b99d2b'

$user->update_subnet(node_id, subnet_id, $body);
nodeID := "594e606212e17a002f2e3251"
subnetID := "5bc920f2fff373002bf0d51b"
body := `{
  "preferences": {
    "allow_foreign_transactions":true,
    "daily_atm_withdrawal_limit":5,
    "daily_transaction_limit":500
  }
}`

data, err := user.UpdateSubnet(nodeID, subnetID, body)
A binary file was returned

You couldn't be authenticated

{
  "_id": "5bc920f2fff373002bf0d51b",
  "_links": {
    "self": {
      "href": "https://uat-api.synapsefi.com/v3.1/users/5bb29f48520da000a38cb107/nodes/5bb29f5471fd1b0091317410/subnets/5bc920f2fff373002bf0d51b"
    }
  },
  "access_token": "5bc920f9a5061e002681c89f",
  "account_class": "DEBIT_CARD",
  "card_hash": "78eb685b26d99d32538feb97cfd1274f994bdde48fa75471f22ba3029cbbc4e0",
  "card_number": "5431",
  "card_style_id": null,
  "client": {
    "id": "5b0da0f66e990e001f0c5f54",
    "name": "YY Test Account"
  },
  "created_on": 1555549989904,
  "cvc": "***",
  "exp": "2022-11-17",
  "nickname": "My Debit Card",
  "node_id": "5bb29f5471fd1b0091317410",
  "preferences": {
    "allow_foreign_transactions": true,
    "daily_atm_withdrawal_limit": 5,
    "daily_transaction_limit": 500
  },
  "status": "ACTIVE",
  "supp_id": null,
  "user_id": "5bb29f48520da000a38cb107"
}
 
Suggest Edits

Dispute Transaction

 
patchhttps://uat-api.synapsefi.com/v3.1/users/user_id/nodes/node_id/trans/trans_id/dispute

Path Params

user_id
string
required

Object ID of user

node_id
string
required

Object ID of node

trans_id
string
required

Object ID of transaction

Request Body

Key
Type
Description

dispute_reason

string

Reason you are disputing the transaction. See the list of dispute reasons below for more information

dispute_meta.amount_received

integer

Required for INCORRECT_AMOUNT|ATM

dispute_meta.lost_date

integer

Required for UNAUTHORIZED|CARD_LOST (Unix Time)

Dispute Reasons

Value
Description

CHARGE_BACK

Request to credit funds to user

CHARGED_TWICE

Card charged a second time for the same transaction

INCORRECT_AMOUNT

Card charged the incorrect amount

INCORRECT_AMOUNT|ATM

User attempted to withdraw money from ATM and received incorrect amount

UNAUTHORIZED|CARD_IN_HAND

Unauthorized transaction made while user has card in their possession

UNAUTHORIZED|CARD_LOST

Unauthorized transaction made and user has reported a lost or stolen card

PATCH /v3.1//users/594e0fa2838454002ea317a0/nodes/5bdb96d0389f2400afb06fe6/trans/5bdb9baed5faec00e4e9933e/dispute 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: oauth_1mtgLwhYHDVKop04XOEjyWJSsnQqZbGkfRF5ux9v|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

// Basic Request Body

{
  "dispute_reason": "CHARGE_BACK",
  "dispute_meta": {
    "type_of_merchandise_or_service": "groceries",
    "merchant_contacted": true,
    "contact_method": "phone",
    "contact_date": 1563474864000
  }
}

// Incorrect Amount Request Body

{
  "dispute_reason":"INCORRECT_AMOUNT|ATM"
  "dispute_meta": {
  	"amount_received": 2000
  }
}

// Unauthorized - Lost Card Request Body

{
  "dispute_reason":"UNAUTHORIZED|LOST_CARD"
  "dispute_meta": {
    "lost_date": 1538447536000
  }
}
node_id = '594e606212e17a002f2e3251'
trans_id = '594e72124599e8002fe62e4f'
dispute_reason = 'CHARGE_BACK'

user.cancel_trans(node_id, trans_id, dispute_reason)
const nodeID = '594e606212e17a002f2e3251';
const trxnID = '594e72124599e8002fe62e4f';
const body = {
	"dispute_reason":"CHARGE_BACK"
};

user.disputeCardTransaction(nodeID, trxnID, body);
card_id = "5bdb96d0389f2400afb06fe6"
transaction_id = "5bdb9baed5faec00e4e9933e"
body = {
	"dispute_reason":"CHARGE_BACK"
}

user.dispute_card_transactions(node_id: card_id, trans_id: transaction_id, payload: body)
$nodeid = '5bdb96d0389f2400afb06fe6';
$transid = '5bdb9baed5faec00e4e9933e';
$body = (object)[
   "dispute_reason" => "CHARGE_BACK"
];

$user->comment_trans( $nodeid, $transid, $body );
nodeID := "594e606212e17a002f2e3251"
transactionID := "594e72124599e8002fe62e4f"
body := `{
  "dispute_reason": "CHARGE_BACK"
}`

data, err := user.DisputeTransaction(nodeID, transactionID, body)
A binary file was returned

You couldn't be authenticated

{
  "dispute_form": "https://cdn.synapsepay.com/uploads/2018/10/25/z4owXU1l0xFkJ9CbtWfV7Zu53gBryLEpsKjcdPDI2qTMQ68eGO.pdf",
  "provisional_credit_tran": "5bd20bd12073c800fe748fe9",
  "success": true
}
 
Suggest Edits

Delete Debit Card

 
patchhttps://uat-api.synapsefi.com/v3.1/users/user_id/nodes/node_id/subnets/subnet_id###
 
PATCH /v3.1/users/59c9f69a89ec34002e1b4b2e/nodes/59c9f6a66d7d8a002f71b191/subnets/59c9f77cd412960028b99d2b HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_xEyuYzmPN6Rp120Kg08Ma3SdO4w5c9ZFBnWfbJer|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

{
  "status": "TERMINATED"
}
node_id = '594e606212e17a002f2e3251'
subn_id = '59c9f77cd412960028b99d2b'
body = {
  "status":"TERMINATED"
}

user.update_subnet(node_id, subn_id, body)
nodeID = "594e606212e17a002f2e3251";
subnetID = "59c9f77cd412960028b99d2b";
const body = {
  "status":"TERMINATED"
};

user.updateSubnet(nodeID, subnetID, body);
node_id = '594e606212e17a002f2e3251'
subnet_id = '59c9f77cd412960028b99d2b'
body = {
  "status":"TERMINATED"
}

user.update_subnet(node_id: node_id, payload: body, subnter_id: subnet_id)
$body= (object) [
  "status":"TERMINATED"
];

$node_id = '594e606212e17a002f2e3251';
$subnet_id = '59c9f77cd412960028b99d2b';
$user->update_subnet( $node_id, $subnet_id ,$body);
nodeID := "59c9f6a66d7d8a002f71b191"
subnetID := "5bc920f2fff373002bf0d51b"
body := `{
  "status":"TERMINATED"
}`

data, err := user.UpdateSubnet(nodeID, subnetID, body)
A binary file was returned

You couldn't be authenticated

{
  "_id": "5d6ff580a866b5583c947d9b",
  "_links": {
    "self": {
      "href": "https://uat-api.synapsefi.com/v3.1/users/5d6ee2b8c166ac007451dc91/nodes/5d6ff577d0ff336520f59169/subnets/5d6ff580a866b5583c947d9b"
    }
  },
  "access_token": "5d6ff5811d856d002c8bd2ee",
  "account_class": "CARD",
  "card_hash": "72c219c82bce62b546f3adc2683398541487c5b37be0f9b57a9bf199c16a58de",
  "card_number": "0539",
  "card_style_id": null,
  "client": {
    "id": "5cacf0f332c5d500256ee252",
    "name": "Mohammed Omar"
  },
  "created_on": 1567618432212,
  "cvc": "***",
  "exp": "2023-10-03",
  "nickname": "My Card",
  "node_id": "5d6ff577d0ff336520f59169",
  "preferences": {
    "allow_foreign_transactions": true,
  },
  "status": "TERMINATED",
  "supp_id": null,
  "user_id": "5d6ee2b8c166ac007451dc91"
}
 
Suggest Edits

Find ATM Locations

 
gethttps://uat-api.synapsefi.com/v3.1/nodes/atms

Query Params

zip
string

Zip code to search for ATMs

lat
string

Latitude coordinate to search

lon
string

Longitude coordinate to search

radius
string

Radius to search (miles)

page
string

Page number

per_page
string

Number of ATMs per page

 
GET /v3.1/nodes/atms?zip=94114&radius=5 HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_auVIbQ8WXC0pnLU9ivEs4tcHDejqFJlwoNrZ3fO1|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json
zip_code = "94114"
radius = "5"

client.locate_atms(zip='94114', lat=None, rad=None, page=None, per_page=None)
client.locateAtms({
  zip: '94114',
  radius: '5'
});
zip_code = "941114"
radius = "5"

client.locate_atm(zip: zip_code, radius: radius)
$zip = 94114;
$lat = null;
$lon = null;
$radius = 5;
$page = 1;
$per_page = 1;

$client->locate_atms($zip , $lat , $lon , $radius , $page , $per_page );
data, err := client.LocateATMs("zip=94114&radius=5")
A binary file was returned

You couldn't be authenticated

{
  "error_code": "0",
  "http_code": "200",
  "limit": 20,
  "atm_count": 50,
  "atms": [
    {
      "atmLocation": {
        "address": {
          "city": "SAN FRANCISCO",
          "country": "USA",
          "postalCode": "94114",
          "state": "CA",
          "street": "443 CASTRO STREET"
        },
        "coordinates": {
          "latitude": 37.761746,
          "longitude": -122.435024
        },
        "id": "398744",
        "isAvailable24Hours": true,
        "isDepositAvailable": true,
        "isHandicappedAccessible": false,
        "isOffPremise": false,
        "isSeasonal": false,
        "languageType": null,
        "locationDescription": "US BANK CASTRO",
        "logoName": "PAS",
        "name": "U.S. Bank Castro"
      },
      "distance": 0.12729728274872307
    },
    {
      ...
    }
  ],
  "page": 1,
  "page_count": 3,
  "success": true
}
 
Suggest Edits

View Card

View a SUBNET

 
gethttps://uat-api.synapsefi.com/v3.1/users/user_id/nodesnode_id/subnets/subnet_id#

Path Params

user_id
string
required

Object ID of user

node_id
string
required

Object ID of node

subnet_id
string
required

Object ID of subnet

Query Params

full_dehydrate
string

[yes/no] Full Dehydrate yes will return back all the card info including the card number, and cvc.

Card Subnet Object

Key
Type
Description

_id

string

Object ID of subnet

_links.self.href

string

HAL-style link for the subnet object

access_token

string

Access token of subnet

account_class

string

Account class of subnet

account_num

string

Account number associated with subnet

card_hash

string

Card hash

card_style_id

string

Style ID of card

client.id

string

ID of the client associated with the subnet

client.name

string

Name of the client associated with the subnet

created_on

integer

Date of subnet creation (in Unix time)

cvc

string

[Hidden] CVC code

exp

string

Expiration date of card (in YYYY-MM-DD)

nickname

string

Nickname given to the card.

node_id

string

Node ID associated with the subnet. Funds will be credited to this node when credits arrive

preferences.allow_foreign_transactions

boolean

Flag to allow foreign transactions

status

string

Subnet status. See Subnet Statuses for more information

supp_id

string

Additional ID supplied to subnet

user_id

string

User ID associated with the subnet

GET /v3.1/users/59c9f69a89ec34002e1b4b2e/nodes/59c9f6a66d7d8a002f71b191/subnets/59c9f77cd412960028b99d2b HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_xEyuYzmPN6Rp120Kg08Ma3SdO4w5c9ZFBnWfbJer|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json
node_id = '594e606212e17a002f2e3251'
subnet_id = '59c9f77cd412960028b99d2b'

user.get_subnet(node_id, subnet_id);
const nodeID = '594e606212e17a002f2e3251';
const subnetID = '59c9f77cd412960028b99d2b';

user.getSubnet(nodeID, subnetID);
node_id = '594e606212e17a002f2e3251'
subnet_id = '59c9f77cd412960028b99d2b'

user.get_subnet(node_id: node_id, subnet_id: subnet_id)
$nodeid = '594e606212e17a002f2e3251';
$subnetid = '59c9f77cd412960028b99d2b';

$user->get_subnet($nodeid, $subnetid);
nodeID := "594e606212e17a002f2e3251"
subID := "59c9f77cd412960028b99d2b"

data, err := user.GetSubnet(nodeID, subID)
A binary file was returned

You couldn't be authenticated

{
  "_id": "5cb7c99439f3ae003e4fb3c3",
  "_links": {
    "self": {
      "href": "https://uat-api.synapsefi.com/v3.1/users/5c64996c7f9c202542e96e09/nodes/5cb7aae388a3e200d87dde81/subnets/5cb7c99439f3ae003e4fb3c3"
    }
  },
  "access_token": "5cb7c9938fe0d6002c7b0685",
  "account_class": "CARD",
  "card_hash": "cf0a70f42c72ef5483f5b32bceb17d84a84e3f96ed4df86fd5f6a4f9eda41a1b",
  "card_number": "1171",
  "card_style_id": null,
  "client": {
    "id": "5beb506f6d7ceb002490631f",
    "name": "SynapseFI"
  },
  "created_on": 1555548562500,
  "cvc": "***",
  "exp": "2023-05-17",
  "nickname": "My Card",
  "node_id": "5cb7aae388a3e200d87dde81",
  "preferences": {
    "allow_foreign_transactions": true,
  },
  "status": "INACTIVE",
  "supp_id": null,
  "user_id": "5c64996c7f9c202542e96e09"
}
 
Suggest Edits

Create Card

 
posthttps://uat-api.synapsefi.com/v3.1/users/user_id/nodes/node_id/subnets/#

Request Body

Key
Type
Description

account_class

string

[Required] Type of account. Set as CARD

nickname

string

Nickname to assign to the node

supp_id

string

Additional ID supplied to subnet

POST /v3.1/users/59c9f69a89ec34002e1b4b2e/nodes/59c9f6a66d7d8a002f71b191/subnets HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_xEyuYzmPN6Rp120Kg08Ma3SdO4w5c9ZFBnWfbJer|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

{
  "nickname":"My Card",
  "account_class":"CARD"
}
node_id = "59c9f6a66d7d8a002f71b191"
body = {
	"nickname":"My Debit Card",
	"account_class":"DEBIT_CARD"
}

user.create_subnet(node_id, body)
const nodeID = '59c9f6a66d7d8a002f71b191';
const body = {
	"nickname":"My Debit Card",
	"account_class":"DEBIT_CARD"
};

user.createSubnet(nodeID, body);
node_id = "59c9f6a66d7d8a002f71b191"
body = {
	"nickname":"My Debit Card",
	"account_class":"DEBIT_CARD"
}

user.create_subnet(node_id: node_id, payload: body)
$nodeid = '59c9f6a66d7d8a002f71b191';
$body = (object)[
	"nickname" => "My Debit Card",
	"account_class" => "DEBIT_CARD"
];

$user->create_subnet($nodeid, $body);
nodeID := "59c9f6a66d7d8a002f71b191"
body := `{
	"nickname":"My Debit Card",
	"account_class":"DEBIT_CARD"
}`

data, err := user.CreateSubnet(nodeID, body)
A binary file was returned

You couldn't be authenticated

{
  "_id": "59c9f77cd412960028b99d2b",
  "_links": {
    "self": {
      "href": "https://uat-api.synapsefi.com/v3.1/users/59c9f69a89ec34002e1b4b2e/nodes/59c9f6a66d7d8a002f71b191/subnets/59c9f77cd412960028b99d2b"
    }
  },
  "access_token": "5bc920f2fff373002bf0d51b",
  "account_class": "CARD",
  "card_hash": "78eb685b26d99d32538feb97cfd1274f994bdde48fa75471f22ba3029cbbc4e0",
  "card_number": "5431",
  "card_style_id": null,
  "client": {
    "id": "59c9f77cd412960028b99d2b",
    "name": "SynapseFI"
  },
  "created_on": 1555549989904,
  "cvc": "***",
  "exp": "2022-11-17",
  "nickname": "My Card",
  "node_id": "59c9f6a66d7d8a002f71b191",
  "preferences": {
    "allow_foreign_transactions": false,
  },
  "status": "INACTIVE",
  "user_id": "59c9f69a89ec34002e1b4b2e"
}
 
 
patchhttps://uat-api.synapsefi.com/v3.1/users/user_id/nodes/node_id/subnets/subnet_id##

Path Params

user_id
string
required

Object ID of user

node_id
string
required

Object ID of node

subnet_id
string
required

Object ID of subnet

Request Body

Key
Type
Description

card_pin

string

Encrypted card pin. See Encrypting Data for more information

Sandbox Set PIN Public Key

-----BEGIN PUBLIC KEY-----

MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEApxPCzjKUcjktcu6DTVvw
WtDymXCJOdBaMCFejObzTgQVYWgaR2WgO0DJ8guAK02tB3yKHu+RjygAcI9GTrtR
MkJzgGA0iZ+QktiCS0ooH115TvIiPKDh9aQVqFNx7FFuji4c+KpSiHHzLnpxcUFB
7U7rq8GIqP3SkDPSFQAWwM+lANAJIzNRJx1I56odTZ1zSgsXtwH9SHjg34Ptdeu/
RjX759oWTcUdMmnHtpLOPe1co89dEpJ6QqPyo7IUHdnRfMiu63XgDUEzsaTQEevy
LeWj+VDH86y0uJbWu6CVMdEkBnNkTZDGiAmdeI0Q8LdinLUHX3j+5tzxj36iOQQi
NQIDAQAB

-----END PUBLIC KEY-----

Production Set PIN Public Key

-----BEGIN PUBLIC KEY-----

MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0b1tpW5s6k/d7thDpmup
TlNMva9h+QQn17c0ypo2uzWM+zpj5OAXwkjz7TmmMl/Uiu1Wm7WThIcMBQ+KLzm4
590UXxSTWxzOSQXWWAEzp4YkpxICYsNHA1GpLtqdA+rGQcyx3TJkdh1+5SWRCcRJ
QikUa5wcApEs+L/NBm8AeKy/rqtDjb0BjAqZvoVPe4J2zJlPwwbxrIspuSCQmxle
bIHti97+maflGuy/9XV8aw1FhKbM5oeQxs9M0J49x1a7aqpIEuW3Z224UQwuGzRo
0vN3pP3YGS5cfFjVjlaQFX0Ezavl4G7u9G2IpmPky/A1eDWyC50K/F0NRCtYb4Uk
wwIDAQAB

-----END PUBLIC KEY-----
PATCH /v3.1/users/5bb29f48520da000a38cb107/nodes/5bb29f5471fd1b0091317410/subnets/5bc920f2fff373002bf0d51b HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_NhFV8tDKOMms2j5I4lzxJXUQY9BH6abycdnpTCA3|J6fhD7DNd238
Content-Type: application/json
node_id = '594e606212e17a002f2e3251'
subnet_id = '59c9f77cd412960028b99d2b'

body = {
  "card_pin": "mlMKMv5+ekyw9M5AtqUBZxgdzj+GEjzddp93qSPw6uRXGpdNiNulVZxcbH1gGGiwEU9UeOwGmgiMaQsDkpbuh3SWY6IxSiPNHI9ryY8z/z+d8MXockQxsKnl1B+ekcLAXx9s2RZM7T6Nfoa+ABGwRV7aFGt91NYaolA0tfU1981J9juB/iljm9cz5JUKDPCxZbn+LW1f4O/5Pt3fDX9Nrre/HsuHtgc7OIu6XTvg1FCm+ds3AkFdHA0dw1aW4j5biXWVEkNpb01PIicANYXtO/AusqH8udBLh0GIU/xNSTzipk/M2hUqoTZdOo7Hu8UZgLbWUEpv7hAAY2tfu/ymsA=="
}

user.update_subnet(node_id, subnet_id, body)
const nodeID = '594e606212e17a002f2e3251';
const subnetID = '59c9f77cd412960028b99d2b';
const body = {
  "card_pin": "mlMKMv5+ekyw9M5AtqUBZxgdzj+GEjzddp93qSPw6uRXGpdNiNulVZxcbH1gGGiwEU9UeOwGmgiMaQsDkpbuh3SWY6IxSiPNHI9ryY8z/z+d8MXockQxsKnl1B+ekcLAXx9s2RZM7T6Nfoa+ABGwRV7aFGt91NYaolA0tfU1981J9juB/iljm9cz5JUKDPCxZbn+LW1f4O/5Pt3fDX9Nrre/HsuHtgc7OIu6XTvg1FCm+ds3AkFdHA0dw1aW4j5biXWVEkNpb01PIicANYXtO/AusqH8udBLh0GIU/xNSTzipk/M2hUqoTZdOo7Hu8UZgLbWUEpv7hAAY2tfu/ymsA=="
};

 user.updateSubnet(nodeID, subnetID, body);
node_id = '594e606212e17a002f2e3251'
subnet_id = '59c9f77cd412960028b99d2b'

body =  {
  "card_pin": "mlMKMv5+ekyw9M5AtqUBZxgdzj+GEjzddp93qSPw6uRXGpdNiNulVZxcbH1gGGiwEU9UeOwGmgiMaQsDkpbuh3SWY6IxSiPNHI9ryY8z/z+d8MXockQxsKnl1B+ekcLAXx9s2RZM7T6Nfoa+ABGwRV7aFGt91NYaolA0tfU1981J9juB/iljm9cz5JUKDPCxZbn+LW1f4O/5Pt3fDX9Nrre/HsuHtgc7OIu6XTvg1FCm+ds3AkFdHA0dw1aW4j5biXWVEkNpb01PIicANYXtO/AusqH8udBLh0GIU/xNSTzipk/M2hUqoTZdOo7Hu8UZgLbWUEpv7hAAY2tfu/ymsA=="
}

user.update_subnet(node_id: node_id, payload: body, subnter_id: subnet_id)
$body = (object)[
  "card_pin" => "mlMKMv5+ekyw9M5AtqUBZxgdzj+GEjzddp93qSPw6uRXGpdNiNulVZxcbH1gGGiwEU9UeOwGmgiMaQsDkpbuh3SWY6IxSiPNHI9ryY8z/z+d8MXockQxsKnl1B+ekcLAXx9s2RZM7T6Nfoa+ABGwRV7aFGt91NYaolA0tfU1981J9juB/iljm9cz5JUKDPCxZbn+LW1f4O/5Pt3fDX9Nrre/HsuHtgc7OIu6XTvg1FCm+ds3AkFdHA0dw1aW4j5biXWVEkNpb01PIicANYXtO/AusqH8udBLh0GIU/xNSTzipk/M2hUqoTZdOo7Hu8UZgLbWUEpv7hAAY2tfu/ymsA=="
];

node_id = '594e606212e17a002f2e3251'
subnet_id = '59c9f77cd412960028b99d2b'

$user->update_subnet(node_id, subnet_id, $body);
nodeID := "594e606212e17a002f2e3251"
subnetID := "5bc920f2fff373002bf0d51b"
body := `{
  "card_pin": "mlMKMv5+ekyw9M5AtqUBZxgdzj+GEjzddp93qSPw6uRXGpdNiNulVZxcbH1gGGiwEU9UeOwGmgiMaQsDkpbuh3SWY6IxSiPNHI9ryY8z/z+d8MXockQxsKnl1B+ekcLAXx9s2RZM7T6Nfoa+ABGwRV7aFGt91NYaolA0tfU1981J9juB/iljm9cz5JUKDPCxZbn+LW1f4O/5Pt3fDX9Nrre/HsuHtgc7OIu6XTvg1FCm+ds3AkFdHA0dw1aW4j5biXWVEkNpb01PIicANYXtO/AusqH8udBLh0GIU/xNSTzipk/M2hUqoTZdOo7Hu8UZgLbWUEpv7hAAY2tfu/ymsA=="
}`

data, err := user.UpdateSubnet(nodeID, subnetID, body)
A binary file was returned

You couldn't be authenticated

{
  "_id": "5bc920f2fff373002bf0d51b",
  "_links": {
    "self": {
      "href": "https://uat-api.synapsefi.com/v3.1/users/5bb29f48520da000a38cb107/nodes/5bb29f5471fd1b0091317410/subnets/5bc920f2fff373002bf0d51b"
    }
  },
  "access_token": "5bc920f9a5061e002681c89f",
  "account_class": "CARD",
  "card_hash": "78eb685b26d99d32538feb97cfd1274f994bdde48fa75471f22ba3029cbbc4e0",
  "card_number": "5431",
  "card_style_id": null,
  "client": {
    "id": "5b0da0f66e990e001f0c5f54",
    "name": "YY Test Account"
  },
  "created_on": 1555549989904,
  "cvc": "***",
  "exp": "2022-11-17",
  "nickname": "My Card",
  "node_id": "5bb29f5471fd1b0091317410",
  "preferences": {
    "allow_foreign_transactions": true
  },
  "status": "ACTIVE",
  "supp_id": null,
  "user_id": "5bb29f48520da000a38cb107"
}
 
Suggest Edits

Ship Card

 
patchhttps://uat-api.synapsefi.com/v3.1/users/user_id/nodes/node_id/subnets/subnet_id/ship/#

Path Params

user_id
string
required

Object ID of user

node_id
string
required

Object ID of node

subnet_id
string
required

Object ID of subnet

Request Body

Key
Type
Description

fee_node_id

string

Object ID of node to deduct fee from

expedite

boolean

Flag to expedite shipping speed of card. Extra fees apply

card_style_id

string

Style ID of card

cardholder_name

string

Name to be printed on card

Additional Information

  • Cards may only be shipped twice every 6 months
PATCH /v3.1/users/5bb6ab05472e2500adffad5a/nodes/5bbadc6f7b11c3008d045add/ship HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_46jGbL5oIhAHtTuQVfYDpcqmedZBP9Xa0Owrnv7F|n38dj3h8NE393bv24ovoRY34kd62
Content-Type: application/json

{
  "fee_node_id":"5bba781485411800991b606b",
  "expedite":false,
  "card_style_id": "555",
  "cardholder_name": "Cardholder Name"
}
node_id = '594e606212e17a002f2e3251'
subn_id = '59c9f77cd412960028b99d2b'
body = {
  "fee_node_id":"5bba781485411800991b606b",
  "expedite":False,
  "card_style_id": "555",
  "cardholder_name": "Cardholder Name"
}

user.ship_card(node_id, subn_id, body)
const nodeID = '594e606212e17a002f2e3251'
const subnetID = '59c9f77cd412960028b99d2b'
const body = {
  "fee_node_id":"5bba781485411800991b606b",
  "expedite":false,
  "card_style_id": "555",
  "cardholder_name": "Cardholder Name"
}

user.shipCard(nodeID, subnetID, body);
node_id = "5bbadc6f7b11c3008d045add"
subnet_id = “5bc920f2fff373002bf0d51b”
body= {
  "fee_node_id":"5bba781485411800991b606b",
  "expedite":false,
  "card_style_id": "555",
  "cardholder_name": "Cardholder Name"
}

user.ship_card(node_id: node_id, payload: body)
$body = (object) [
   "fee_node_id" => "5ba05e7920b3aa006482c5ad",
   "expedite" => false,
   "card_style_id" => "555",
   "cardholder_name" => "Cardholder Name"
];
$nodeid = '5bbadc6f7b11c3008d045add'
$subnetid = '5bc920f2fff373002bf0d51b'

$user->ship_card_subnet($nodeid , $subnetid , $body);
nodeID := "594e606212e17a002f2e3251"
subnetID := "5bc920f2fff373002bf0d51b"
body := `{
  "fee_node_id":"5bba781485411800991b606b",
  "expedite":false,
  "card_style_id": "555",
  "cardholder_name": "Cardholder Name"
}`

data, err := user.ShipCard(nodeID, subnetID, body)
A binary file was returned

You couldn't be authenticated

{
  "node_id": "5bc920e27eb7c500972c7e33",
  "subnet_id": "5bc920f9a5061e002681c89f",
  "transaction_id": "5bcf7c59c39fa85af5729653"
}
 
Suggest Edits

Update Card Status

 
patchhttps://uat-api.synapsefi.com/v3.1/users/user_id/nodes/node_id/subnets/subnet_id/##

Path Params

user_id
string
required

Object ID of user

node_id
string
required

Object ID of node

subnet_id
string
required

Object ID of subnet

Request Body

Key
Type
Description

status

string

Status of the card

Statuses

Key
Description

ACTIVE

Enables the card to be used for sending and receiving funds

INACTIVE

Disables debits on the node

TERMINATED

Disables the card number and blocks all transactions. This is sometimes used when an account is fraudulent

Unlike our legacy card issuance, our native card issuance has no update status limits.

PATCH /v3.1/users/5bb29f48520da000a38cb107/nodes/5bb29f5471fd1b0091317410/subnets/5bc920f2fff373002bf0d51b HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_NhFV8tDKOMms2j5I4lzxJXUQY9BH6abycdnpTCA3|J6fhD7DNd238
Content-Type: application/json

{
  "status": "ACTIVE"
}
node_id = '594e606212e17a002f2e3251'
subnet_id = '59c9f77cd412960028b99d2b'

body = {
  "status": "ACTIVE"
}

user.update_subnet(node_id, subnet_id, body)
const nodeID = '594e606212e17a002f2e3251';
const subnetID = '59c9f77cd412960028b99d2b';
const body = {
  "status": "ACTIVE"
};

user.updateSubnet(nodeID, subnetID, body);
node_id = '594e606212e17a002f2e3251'
subnet_id = '59c9f77cd412960028b99d2b'

body = {
  "status": "ACTIVE"
}

user.update_subnet(node_id: node_id, payload: body, subnter_id: subnet_id)
$body = (object)[
  "status" => "ACTIVE"
];

node_id = '594e606212e17a002f2e3251'
subnet_id = '59c9f77cd412960028b99d2b'

$user->update_subnet(node_id, subnet_id, $body);
nodeID := "59c9f6a66d7d8a002f71b191"
subnetID := "5bc920f2fff373002bf0d51b"
body := `{
  "status": "ACTIVE"
}`

data, err := user.UpdateSubnet(nodeID, subnetID, body)
A binary file was returned

You couldn't be authenticated

{
  "_id": "5bc920f2fff373002bf0d51b",
  "_links": {
    "self": {
      "href": "https://uat-api.synapsefi.com/v3.1/users/5bb29f48520da000a38cb107/nodes/5bb29f5471fd1b0091317410/subnets/5bc920f2fff373002bf0d51b"
    }
  },
  "access_token": "5bc920f9a5061e002681c89f",
  "account_class": "CARD",
  "card_hash": "78eb685b26d99d32538feb97cfd1274f994bdde48fa75471f22ba3029cbbc4e0",
  "card_number": "5431",
  "card_style_id": null,
  "client": {
    "id": "5b0da0f66e990e001f0c5f54",
    "name": "YY Test Account"
  },
  "created_on": 1555549989904,
  "cvc": "***",
  "exp": "2022-11-17",
  "nickname": "My Card",
  "node_id": "5bb29f5471fd1b0091317410",
  "preferences": {
    "allow_foreign_transactions": true
  },
  "status": "ACTIVE",
  "supp_id": null,
  "user_id": "5bb29f48520da000a38cb107"
}
 
Suggest Edits

Allow Foreign Transactions

 
patchhttps://uat-api.synapsefi.com/v3.1/users/user_id/nodes/node_id/subnets/subnet_id/###

Path Params

user_id
string
required

Object ID of user

node_id
string
required

Object ID of node

subnet_id
string
required

Object ID of subnet

Request Body

Key
Type
Description

preferences.allow_foreign_transactions

boolean

Allow non-US transactions on card

PATCH /v3.1/users/5bb29f48520da000a38cb107/nodes/5bb29f5471fd1b0091317410/subnets/5bc920f2fff373002bf0d51b HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_NhFV8tDKOMms2j5I4lzxJXUQY9BH6abycdnpTCA3|J6fhD7DNd238
Content-Type: application/json

{
  "preferences":{
    "allow_foreign_transactions": true,
  }
}
node_id = '594e606212e17a002f2e3251'
subnet_id = '59c9f77cd412960028b99d2b'
body = {
  "preferences": {
    "allow_foreign_transactions":true,
    "daily_atm_withdrawal_limit":5,
    "daily_transaction_limit":500
  }
}

user.update_subnet(node_id, subnet_id, body)
const nodeID = '594e606212e17a002f2e3251';
const subnetID = '59c9f77cd412960028b99d2b';
const body = {
  "preferences": {
    "allow_foreign_transactions":true,
    "daily_atm_withdrawal_limit":5,
    "daily_transaction_limit":500
  }
};

user.updateSubnet(nodeID, subnetID, body);
node_id = '594e606212e17a002f2e3251'
subnet_id = '59c9f77cd412960028b99d2b'
body = {
  "preferences": {
    "allow_foreign_transactions":true,
    "daily_atm_withdrawal_limit":5,
    "daily_transaction_limit":500
  }
}

user.update_subnet(node_id: node_id, payload: body, subnter_id: subnet_id)
$preferences = (object)[
     "allow_foreign_transactions" => true,
     "daily_atm_withdrawal_limit" => 5,
     "daily_transaction_limit" => 500
];
$body = (object)[
 "preferences" => $preferences
];

node_id = '594e606212e17a002f2e3251'
subnet_id = '59c9f77cd412960028b99d2b'

$user->update_subnet(node_id, subnet_id, $body);
nodeID := "594e606212e17a002f2e3251"
subnetID := "5bc920f2fff373002bf0d51b"
body := `{
  "preferences": {
    "allow_foreign_transactions":true,
    "daily_atm_withdrawal_limit":5,
    "daily_transaction_limit":500
  }
}`

data, err := user.UpdateSubnet(nodeID, subnetID, body)
A binary file was returned

You couldn't be authenticated

{
  "_id": "5bc920f2fff373002bf0d51b",
  "_links": {
    "self": {
      "href": "https://uat-api.synapsefi.com/v3.1/users/5bb29f48520da000a38cb107/nodes/5bb29f5471fd1b0091317410/subnets/5bc920f2fff373002bf0d51b"
    }
  },
  "access_token": "5bc920f9a5061e002681c89f",
  "account_class": "CARD",
  "card_hash": "78eb685b26d99d32538feb97cfd1274f994bdde48fa75471f22ba3029cbbc4e0",
  "card_number": "5431",
  "card_style_id": null,
  "client": {
    "id": "5b0da0f66e990e001f0c5f54",
    "name": "YY Test Account"
  },
  "created_on": 1555549989904,
  "cvc": "***",
  "exp": "2022-11-17",
  "nickname": "My Card",
  "node_id": "5bb29f5471fd1b0091317410",
  "preferences": {
    "allow_foreign_transactions": true,
  },
  "status": "ACTIVE",
  "supp_id": null,
  "user_id": "5bb29f48520da000a38cb107"
}
 
Suggest Edits

Dispute Transaction

 
patchhttps://uat-api.synapsefi.com/v3.1/users/user_id/nodes/node_id/trans/trans_id/dispute/#

Path Params

user_id
string
required

Object ID of user

node_id
string
required

Object ID of node

trans_id
string
required

Object ID of transaction

Request Body

Key
Type
Description

dispute_reason

string

Reason you are disputing the transaction. See the list of dispute reasons below for more information

dispute_meta.amount_received

integer

Required for INCORRECT_AMOUNT|ATM

dispute_meta.lost_date

integer

Required for UNAUTHORIZED|CARD_LOST (Unix Time)

Dispute Reasons

Value
Description

CHARGE_BACK

Request to credit funds to user

CHARGED_TWICE

Card charged a second time for the same transaction

INCORRECT_AMOUNT

Card charged the incorrect amount

INCORRECT_AMOUNT|ATM

User attempted to withdraw money from ATM and received incorrect amount

UNAUTHORIZED|CARD_IN_HAND

Unauthorized transaction made while user has card in their possession

UNAUTHORIZED|CARD_LOST

Unauthorized transaction made and user has reported a lost or stolen card

PATCH /v3.1//users/594e0fa2838454002ea317a0/nodes/5bdb96d0389f2400afb06fe6/trans/5bdb9baed5faec00e4e9933e/dispute 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: oauth_1mtgLwhYHDVKop04XOEjyWJSsnQqZbGkfRF5ux9v|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

// Basic Request Body

{
  "dispute_reason": "CHARGE_BACK",
  "dispute_meta": {
    "type_of_merchandise_or_service": "groceries",
    "merchant_contacted": true,
    "contact_method": "phone",
    "contact_date": 1563474864000
  }
}

// Incorrect Amount Request Body

{
  "dispute_reason":"INCORRECT_AMOUNT|ATM"
  "dispute_meta": {
  	"amount_received": 2000
  }
}

// Unauthorized - Lost Card Request Body

{
  "dispute_reason":"UNAUTHORIZED|LOST_CARD"
  "dispute_meta": {
    "lost_date": 1538447536000
  }
}
node_id = '594e606212e17a002f2e3251'
trans_id = '594e72124599e8002fe62e4f'
dispute_reason = 'CHARGE_BACK'

user.cancel_trans(node_id, trans_id, dispute_reason)
const nodeID = '594e606212e17a002f2e3251';
const trxnID = '594e72124599e8002fe62e4f';
const body = {
	"dispute_reason":"CHARGE_BACK"
};

user.disputeCardTransaction(nodeID, trxnID, body);
card_id = "5bdb96d0389f2400afb06fe6"
transaction_id = "5bdb9baed5faec00e4e9933e"
body = {
	"dispute_reason":"CHARGE_BACK"
}

user.dispute_card_transactions(node_id: card_id, trans_id: transaction_id, payload: body)
$nodeid = '5bdb96d0389f2400afb06fe6';
$transid = '5bdb9baed5faec00e4e9933e';
$body = (object)[
   "dispute_reason" => "CHARGE_BACK"
];

$user->comment_trans( $nodeid, $transid, $body );
nodeID := "594e606212e17a002f2e3251"
transactionID := "594e72124599e8002fe62e4f"
body := `{
  "dispute_reason": "CHARGE_BACK"
}`

data, err := user.DisputeTransaction(nodeID, transactionID, body)
A binary file was returned

You couldn't be authenticated

{
  "dispute_form": "https://cdn.synapsepay.com/uploads/2018/10/25/z4owXU1l0xFkJ9CbtWfV7Zu53gBryLEpsKjcdPDI2qTMQ68eGO.pdf",
  "provisional_credit_tran": "5bd20bd12073c800fe748fe9",
  "success": true
}
 
Suggest Edits

Delete Card

 
patchhttps://uat-api.synapsefi.com/v3.1/users/user_id/nodes/node_id/subnets/subnet_id/####
 
PATCH /v3.1/users/59c9f69a89ec34002e1b4b2e/nodes/59c9f6a66d7d8a002f71b191/subnets/59c9f77cd412960028b99d2b HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_xEyuYzmPN6Rp120Kg08Ma3SdO4w5c9ZFBnWfbJer|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

{
  "status": "TERMINATED"
}
node_id = '594e606212e17a002f2e3251'
subn_id = '59c9f77cd412960028b99d2b'
body = {
  "status":"TERMINATED"
}

user.update_subnet(node_id, subn_id, body)
nodeID = "594e606212e17a002f2e3251";
subnetID = "59c9f77cd412960028b99d2b";
const body = {
  "status":"TERMINATED"
};

user.updateSubnet(nodeID, subnetID, body);
node_id = '594e606212e17a002f2e3251'
subnet_id = '59c9f77cd412960028b99d2b'
body = {
  "status":"TERMINATED"
}

user.update_subnet(node_id: node_id, payload: body, subnter_id: subnet_id)
$body= (object) [
  "status":"TERMINATED"
];

$node_id = '594e606212e17a002f2e3251';
$subnet_id = '59c9f77cd412960028b99d2b';
$user->update_subnet( $node_id, $subnet_id ,$body);
nodeID := "59c9f6a66d7d8a002f71b191"
subnetID := "5bc920f2fff373002bf0d51b"
body := `{
  "status":"TERMINATED"
}`

data, err := user.UpdateSubnet(nodeID, subnetID, body)
A binary file was returned

You couldn't be authenticated

{
  "_id": "5d6ff580a866b5583c947d9b",
  "_links": {
    "self": {
      "href": "https://uat-api.synapsefi.com/v3.1/users/5d6ee2b8c166ac007451dc91/nodes/5d6ff577d0ff336520f59169/subnets/5d6ff580a866b5583c947d9b"
    }
  },
  "access_token": "5d6ff5811d856d002c8bd2ee",
  "account_class": "CARD",
  "card_hash": "72c219c82bce62b546f3adc2683398541487c5b37be0f9b57a9bf199c16a58de",
  "card_number": "0539",
  "card_style_id": null,
  "client": {
    "id": "5cacf0f332c5d500256ee252",
    "name": "Mohammed Omar"
  },
  "created_on": 1567618432212,
  "cvc": "***",
  "exp": "2023-10-03",
  "nickname": "My Card",
  "node_id": "5d6ff577d0ff336520f59169",
  "preferences": {
    "allow_foreign_transactions": true,
  },
  "status": "TERMINATED",
  "supp_id": null,
  "user_id": "5d6ee2b8c166ac007451dc91"
}
 
Suggest Edits

Find ATM Locations

 
gethttps://uat-api.synapsefi.com/v3.1/nodes/atms/#

Query Params

zip
string

Zip code to search for ATMs

lat
string

Latitude coordinate to search

lon
string

Longitude coordinate to search

radius
string

Radius to search (miles)

page
string

Page number

per_page
string

Number of ATMs per page

 
GET /v3.1/nodes/atms?zip=94114&radius=5 HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_auVIbQ8WXC0pnLU9ivEs4tcHDejqFJlwoNrZ3fO1|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json
zip_code = "94114"
radius = "5"

client.locate_atms(zip='94114', lat=None, rad=None, page=None, per_page=None)
client.locateAtms({
  zip: '94114',
  radius: '5'
});
zip_code = "941114"
radius = "5"

client.locate_atm(zip: zip_code, radius: radius)
$zip = 94114;
$lat = null;
$lon = null;
$radius = 5;
$page = 1;
$per_page = 1;

$client->locate_atms($zip , $lat , $lon , $radius , $page , $per_page );
data, err := client.LocateATMs("zip=94114&radius=5")
A binary file was returned

You couldn't be authenticated

{
  "error_code": "0",
  "http_code": "200",
  "limit": 20,
  "atm_count": 50,
  "atms": [
    {
      "atmLocation": {
        "address": {
          "city": "SAN FRANCISCO",
          "country": "USA",
          "postalCode": "94114",
          "state": "CA",
          "street": "443 CASTRO STREET"
        },
        "coordinates": {
          "latitude": 37.761746,
          "longitude": -122.435024
        },
        "id": "398744",
        "isAvailable24Hours": true,
        "isDepositAvailable": true,
        "isHandicappedAccessible": false,
        "isOffPremise": false,
        "isSeasonal": false,
        "languageType": null,
        "locationDescription": "US BANK CASTRO",
        "logoName": "PAS",
        "name": "U.S. Bank Castro"
      },
      "distance": 0.12729728274872307
    },
    {
      ...
    }
  ],
  "page": 1,
  "page_count": 3,
  "success": true
}
 
Suggest Edits

View Transaction

 
gethttps://uat-api.synapsefi.com/v3.1/users/user_id/nodes/node_id/trans/trans_id/#

Path Params

user_id
string
required

Object ID of user

node_id
string
required

Object ID of node

trans_id
string
required

Object ID of transaction

Transaction Statuses

Please refer to Transaction Status Codes and Native Card Issuance Transaction Types & MCC Codes.

Transaction Object

General & Miscellaneous

Key
Type
Description

_id

string

Object ID of transaction

_links.self.href

string

HAL-style link for the object

_v

integer

Style version

amount

double

Amount user wishes to send

currency

string

Currency of the transaction amount

client.id

string

Object ID of client

client.name

string

Name of the client

fees[]

array of objects

List of fees and fee nodes associated with transaction

extra

Key
Type
Description

extra.**created_on**

integer

Date transaction was created (in Unix time)

extra.ip

string

Sender's IP address

extra.note

string

Memo tagged with the transaction

extra.other.attachments[]

array of strings

[Deprecated]

extra.other.dispute_form

string

Dispute form link for debit card transactions

extra.other.disputed

boolean

Flag for disputed transactions

extra.process_on

integer

Date to process transaction (in Unix time)

extra.supp_id

string

Additional ID supplied to transaction

extra.tracking_number

string

Tracking number provided to transaction

recent_status

Key
Type
Description

recent_status.date

integer

Date of most recent update (in Unix time)

recent_status.note

string

Additional notes about transaction

recent_status.status

string

Status of transaction

recent_status.status_id

string

Status ID of transaction

from

Key
Type
Description

from.nickname

string

Nickname of sending node

from.type

string

Type of transaction

from.user._id

string

Object ID of sending user

from.user.legal_names

array of strings

List of sending user legal names

timeline

Key
Type
Description

date

integer

Date of timeline update (in Unix time)

note

string

Additional notes about transaction status update

status

string

Status of transaction update

status_id

staring

Status ID of transaction update

to.meta

Key
Type
Description

conversion_meta

object

Describes applicable currency conversions from the transaction.

foreign_transaction

boolean

Informs if the transaction occurred in a foreign merchant.

mcc

string

MCC code of merchant.
learn more here.

merchant_x

string

Part of our data enrichment service. Self-explanatory.

mid

string

Unique ID of Merchant

partial_approval_allowed

boolean

Notifies if partial approval is allowed for the transaction.

rebates

array

Functionality being developed. Reference page will updated when rebates are launched.

revenues

array

Interchange revenues from the transaction. Due to limitations by the card networks revenues will take up to 48 hours to fill in the JSON.

subnet_id

string

ID of the card (subnet)

type

string

Type of transaction. Learn more here

to (not including to.meta)

Key
Type
Description

to.id

string

Object ID of receiving node

to.nickname

string

Nickname of receiving node

to.type

string

Type of receiving node.

to.user.id

string

Object ID of receiving user

to.user.legal

array of strings

List of receiving user legal names

GET /v3.1/users/56f99b9386c2730f8d3de4d3/nodes/5c5e11c0f41098006870e848/trans/5c5e1807f41098006870ee0d HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_BcV9rmzTRKvDix8Ge32uN1qdkhfblgo7CtXQnJsZ|n38dj3h8NE393bv24ovoRY34kd62
Content-Type: application/json
node_id = '594e606212e17a002f2e3251'
trans_id = '594e72124599e8002fe62e4f'

user.get_trans(node_id, trans_id)
const nodeID = '594e606212e17a002f2e3251';
const trxnID = '594e72124599e8002fe62e4f';

user.getTransaction(nodeID, trxnID);
node_id = '594e606212e17a002f2e3251'
trans_id = '594e72124599e8002fe62e4f'

transaction = user.get_node_transaction(node_id: node_id, trans_id: trans_id)
$nodeid = 'your_node_id';
$transid = 'your_trans_id';

$usertrans = $user->get_trans( $nodeid, $transid );
nodeID := "594e606212e17a002f2e3251"
transID := "594e72124599e8002fe62e4f"

data, err := user.GetTransaction(nodeID, transID)
A binary file was returned

You couldn't be authenticated

{
  "_id": "5d6ea59a35a3b5c352ca4346",
  "_links": {
    "self": {
      "href": "https://uat-api.synapsefi.com/v3.1/users/5d6ea4638843a63b20549c69/nodes/5d6ea4bdda6a7f5a8456c1f5/trans/5d6ea59a35a3b5c352ca4346"
    }
  },
  "_v": 2,
  "amount": {
    "amount": 100,
    "currency": "USD"
  },
  "client": {
    "id": "5cacf0f332c5d500256ee252",
    "name": "* Mohammed Omar"
  },
  "extra": {
    "asset": null,
    "created_on": 1567532441764,
    "group_id": null,
    "ip": "192.168.0.1",
    "latlon": "unknown,unknown",
    "location": {
      "address_city": null,
      "address_country_code": null,
      "address_postal_code": null,
      "address_subdivision": null,
      "lat": 0,
      "lon": 0
    },
    "note": "",
    "other": {
      "attachments": [],
      "dispute_form": null,
      "disputed": false
    },
    "process_on": 1567532441764,
    "same_day": false,
    "settlement_delay": 0,
    "supp_id": "",
    "tracking_number": null
  },
  "fees": [
    {
      "fee": 0,
      "note": "Facilitator Fee",
      "to": {
        "id": "None"
      }
    }
  ],
  "from": {
    "id": "5d6ea4bdda6a7f5a8456c1f5",
    "nickname": null,
    "type": "DEPOSIT-US",
    "user": {
      "_id": "5d6ea4638843a63b20549c69",
      "legal_names": [
        "Test User"
      ]
    }
  },
  "recent_status": {
    "date": 1567532441764,
    "note": "Transaction Created.",
    "status": "CREATED",
    "status_id": "1"
  },
  "timeline": [
    {
      "date": 1567532441764,
      "note": "Transaction Created.",
      "status": "CREATED",
      "status_id": "1"
    }
  ],
  "to": {
    "id": null,
    "meta": {
      "address": {
        "city": "gosq.com     ",
        "country": "US",
        "state": "CA",
        "street": "SQ          *SQ *SYNAP "
      },
      "conversion_meta": {
        "settlement_currency": "USD",
        "settlement_currency_conversion_rate": "1",
        "transaction_currency": "USD"
      },
      "fees": [],
      "foreign_transaction": false,
      "is_recurring": true,
      "mcc": "7929",
      "merchant_category": "digital_payment",
      "merchant_id": "5bde7b198ddd931c7ee7d0e2",
      "merchant_logo": "https://cdn4.synapsefi.com/uploads/2018/12/04/oza7VG9TbkpUIKPRheLDBrlX8yFHfiusE3Y02CN4QqOZJ1Ax05.jpeg",
      "merchant_name": "Square * Synap Synap",
      "merchant_official_page": "https://squareup.com/",
      "merchant_phone_number": "(855) 700-6000",
      "merchant_subcategory": "discretionary_spending",
      "mid": "1000003286",
      "partial_approval_allowed": false,
      "rebates": [],
      "revenues": [],
      "sub_amounts": [],
      "subnet_id": "5d52362a36d6c4c147fdb667",
      "type": "PURCHASE"
    },
    "nickname": "",
    "type": "EXTERNAL-US",
    "user": {
      "_id": "",
      "legal_names": [
        "Synapse"
      ]
    }
  }
}
 
Suggest Edits

View Transaction

 
gethttps://uat-api.synapsefi.com/v3.1/users/user_id/nodes/node_id/trans/trans_id

Path Params

user_id
string
required

Object ID of user

node_id
string
required

Object ID of node

trans_id
string
required

Object ID of transaction

Transaction Statuses

Status
Status ID
Comment

QUEUED-BY-SYNAPSE

-1

Transaction queued by Synapse

QUEUED-BY-RECEIVER

0

Transaction queued by Client

CREATED

1

Transaction created

PROCESSING-DEBIT

2

Processing debit

PROCESSING-CREDIT

3

Processing credit

SETTLED

4

Transaction settled

CANCELED

5

Transaction canceled

RETURNED

6

Transaction returned

Transaction Object

Key
Type
Description

_id

string

Object ID of transaction

_links.self.href

string

HAL-style link for the object

_v

integer

Style version

amount

double

Amount user wishes to send

currency

string

Currency of the transaction amount

client.id

string

Object ID of client

client.name

string

Name of the client

extra.asset

string

Asset being sold

extra.created_on

integer

Date transaction was created (in Unix time)

extra.group_id

string

Additional group ID assigned to transaction

extra.ip

string

Sender's IP address

extra.location.address_city

string

Sender's city

extra.location.address_country_code

string

Sender's country code

extra.location.address_postal_code

string

Sender's postal code

extra.location.address_subdivision

string

Sender's state

extra.location.lat

string

Sender's latitude coordinate

extra.location.lon

string

Sender's longitude coordinate

extra.note

string

Memo tagged with the transaction

extra.other.attachments[]

array of strings

[Deprecated]

extra.other.dispute_form

string

Dispute form link for debit card transactions

extra.other.disputed

boolean

Flag for disputed transactions

extra.process_on

integer

Date to process transaction (in Unix time)

extra.same_day

boolean

Flag for processing transactions with same day preferences

extra.settlement_delay

integer

Amount of time to delay transaction (in days)

extra.supp_id

string

Additional ID supplied to transaction

extra.tracking_number

string

Tracking number provided to transaction

fees[]

array of objects

List of fees and fee nodes associated with transaction

from.id

string

Object ID of sending user

from.meta.account_num

string

Account number of sending node

from.meta.addenda

string

Addenda attached to from node

from.meta.company_id

string

Account ID of company sending transaction

from.meta.company_name

string

Name of company sending transaction

from.meta.entry_class

string

Class type representing how transaction was submitted

from.meta.monitoring_class

string

Class type representing how transaction is being monitored

from.meta.name

string

Name of user sending transaction

from.meta.posting_data

string

Posting data for transaction

from.meta.routing_num

string

Routing number of sending node

from.meta.subnet_id

string

Subnet ID of sending node

from.meta.tracking_id

string

Tracking number provided to transaction

from.meta.type

string

Meta type of transaction

from.nickname

string

Nickname of sending node

from.type

string

Type of transaction

from.user._id

string

Object ID of sending user

from.user.legal_names

array of strings

List of sending user legal names

recent_status.date

integer

Date of most recent update (in Unix time)

recent_status.note

string

Additional notes about transaction

recent_status.status

string

Status of transaction

recent_status.status_id

string

Status ID of transaction

timeline[]

array of objects

List of timeline objects

to.id

string

Object ID of receiving node

to.nickname

string

Nickname of receiving node

to.type

string

Typo of receiving node

to.user._id

string

Object ID of receiving user

to.user.legal_names[]

array of strings

List of receiving user legal names

Timeline Object

Key
Type
Description

date

integer

Date of timeline update (in Unix time)

note

string

Additional notes about transaction status update

status

string

Status of transaction update

status_id

staring

Status ID of transaction update

GET /v3.1/users/56f99b9386c2730f8d3de4d3/nodes/5c5e11c0f41098006870e848/trans/5c5e1807f41098006870ee0d HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_BcV9rmzTRKvDix8Ge32uN1qdkhfblgo7CtXQnJsZ|n38dj3h8NE393bv24ovoRY34kd62
Content-Type: application/json
node_id = '594e606212e17a002f2e3251'
trans_id = '594e72124599e8002fe62e4f'

user.get_trans(node_id, trans_id)
const nodeID = '594e606212e17a002f2e3251';
const trxnID = '594e72124599e8002fe62e4f';

user.getTransaction(nodeID, trxnID);
node_id = '594e606212e17a002f2e3251'
trans_id = '594e72124599e8002fe62e4f'

transaction = user.get_node_transaction(node_id: node_id, trans_id: trans_id