{"_id":"59c6d042f2e040001abe13fa","project":"54e405191e51932d006abc39","version":{"_id":"55fa37c88065a10d004e5bb6","project":"54e405191e51932d006abc39","__v":11,"createdAt":"2015-09-17T03:47:20.956Z","releaseDate":"2015-09-17T03:47:20.956Z","categories":["55fa37ca8065a10d004e5bb7","55fa37ca8065a10d004e5bb8","55fa37ca8065a10d004e5bb9","55fa37ca8065a10d004e5bba","55fca6bf34ae7c0d00ab8ea0","55ff80fd9e7ccf0d000a1d93","560220af7435de0d00fabd0d","56107f21bb9d920d00303e70","563e184077681a0d00d96a02","56fafc6596ec7e0e002ac85f","5915e54f7c2c552d008b8549","59499fcd64b5f5002690bbc1","59c451b7772699001c0f1df1","59c9b42dec84880010c1f348"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"REST V3","version_clean":"3.1.0","version":"3.1"},"category":{"_id":"55fca6bf34ae7c0d00ab8ea0","version":"55fa37c88065a10d004e5bb6","pages":["55ff4f549f5a880d00a6c32b","55ff52fa9f5a880d00a6c32d","55ff54365c67200d00fa2fb6","55ff57305c67200d00fa2fc0","55ff583f948a830d0023a64a","55ff5a11948a830d0023a659","55ff6162feaf310d007dd66a","55ff62289e7ccf0d000a1d7a","55ff6455feaf310d007dd66b","55ff71436932a00d00ba7a3b","55ff814c8c0c9d0d00dcac33","55ff81ecfeaf310d007dd67f","55ff890a8c0c9d0d00dcac51","55ff89778c0c9d0d00dcac52","55ff8e50feaf310d007dd68d","55ff8edd0e2b090d00863365"],"project":"54e405191e51932d006abc39","__v":16,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-09-19T00:05:19.904Z","from_sync":false,"order":5,"slug":"nodes","title":"Nodes"},"user":"54e4044e8ef7552300409dcb","__v":7,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-23T21:21:06.921Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"error_code\": \"0\",\n    \"http_code\": \"200\",\n    \"limit\": 20,\n    \"node_count\": 1,\n    \"nodes\": [\n        {\n            \"_id\": \"594e21fc4d1d62002f17e37d\",\n            \"_links\": {\n                \"self\": {\n                    \"href\": \"https://uat-api.synapsefi.com/v3.1/users/594e0fa2838454002ea317a0/nodes/594e21fc4d1d62002f17e37d\"\n                }\n            },\n            \"allowed\": \"CREDIT\",\n            \"client\": {\n                \"id\": \"589acd9ecb3cd400fa75ac06\",\n                \"name\": \"SynapseFI\"\n            },\n            \"extra\": {\n                \"other\": {},\n                \"supp_id\": null,\n              \t\"note\": null\n            },\n            \"info\": {\n                \"name_on_account\": \" \",\n                \"nickname\": \"My Checking\",\n                \"payee_address\": {\n                    \"address_city\": \"SAN FRANCISCO\",\n                    \"address_country_code\": \"US\",\n                    \"address_postal_code\": \"94105\",\n                    \"address_street\": \"1 MARKET ST\",\n                    \"address_subdivision\": \"CA\"\n                },\n                \"payee_name\": \"Some Name\"\n            },\n            \"is_active\": true,\n            \"timeline\": [\n                {\n                    \"date\": 1498292731835,\n                    \"note\": \"Node created.\"\n                }\n            ],\n            \"type\": \"CHECK-US\",\n            \"user_id\": \"594e0fa2838454002ea317a0\"\n        }\n    ],\n    \"page_count\": 1,\n    \"success\": true\n}","name":""}]},"method":"post","examples":{"codes":[{"language":"http","code":"POST /v3.1/users/594e0fa2838454002ea317a0/nodes HTTP/1.1\nHost: uat-api.synapsefi.com\nX-SP-USER-IP: 127.0.0.1\nX-SP-USER: oauth_auVIbQ8WXC0pnLU9ivEs4tcHDejqFJlwoNrZ3fO1|e83cf6ddcf778e37bfe3d48fc78a6502062fc\nContent-Type: application/json\n\n{\n  \"type\": \"CHECK-US\",\n  \"info\":{\n      \"nickname\":\"My Checking\",\n      \"payee_name\":\"Some Name\",\n      \"payee_address\":{\n      \t\"address_street\":\"1 Market St\",\n      \t\"address_city\":\"San Francisco\",\n      \t\"address_subdivision\":\"CA\",\n      \t\"address_country_code\":\"US\",\n      \t\"address_postal_code\":\"94105\"\n      }\n  }\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"58fe92f443708d1900c36463","ref":"","in":"path","required":true,"desc":"The user ID of the user you wish to add the CHECK-US node under","default":"","type":"string","name":"user_id"},{"_id":"5573b11e91ce6e190023b76a","ref":"","in":"body","required":true,"desc":"Type of node you wish to add","default":"","type":"string","name":"type"},{"_id":"55fa4d6f764f5021009506c9","ref":"","in":"body","required":true,"desc":"Nickname for the node","default":"","type":"string","name":"info.nickname"},{"_id":"55ff5907748eb30d008a1ed7","ref":"","in":"body","required":false,"desc":"Any ID you wish to register to the node","default":"","type":"string","name":"extra.supp_id"},{"_id":"598a5a244390aa000f078fd8","ref":"","in":"body","required":false,"desc":"Memo tagged with the node","default":"","type":"string","name":"extra.note"},{"_id":"594e62ba57b2c60061f147ff","ref":"","in":"body","required":false,"desc":"If the node is indexed or marked deleted.","default":"","type":"boolean","name":"is_active"},{"_id":"59c6d14ecbb8ea00108fe58c","ref":"","in":"body","required":true,"desc":"Name of the payee","default":"","type":"string","name":"info.payee_name"},{"_id":"59c6d14ecbb8ea00108fe58b","ref":"","in":"body","required":true,"desc":"Address of the payee, this can be home address of a person or business address of a corp.","default":"","type":"string","name":"info.payee_address.address_street"},{"_id":"59c6d14ecbb8ea00108fe58a","ref":"","in":"body","required":true,"desc":"Address of the payee, this can be home address of a person or business address of a corp.","default":"","type":"string","name":"info.payee_address.address_city"},{"_id":"59c6d14ecbb8ea00108fe589","ref":"","in":"body","required":true,"desc":"Address of the payee, this can be home address of a person or business address of a corp.","default":"","type":"string","name":"info.payee_address.address_subdivision"},{"_id":"59c6d14ecbb8ea00108fe588","ref":"","in":"body","required":true,"desc":"Address of the payee, this can be home address of a person or business address of a corp.","default":"","type":"string","name":"info.payee_address.address_country_code"},{"_id":"59c6d14ecbb8ea00108fe587","ref":"","in":"body","required":true,"desc":"Address of the payee, this can be home address of a person or business address of a corp.","default":"","type":"string","name":"info.payee_address.address_postal_code"}],"url":"/v3.1/users/:user_id/nodes"},"isReference":true,"order":13,"body":"","excerpt":"Create an CHECK-US node","slug":"check-us","type":"endpoint","title":"CHECK-US"}

postCHECK-US

Create an CHECK-US node

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

user_id:
required
string
The user ID of the user you wish to add the CHECK-US node under

Body Params

type:
required
string
Type of node you wish to add
info.nickname:
required
string
Nickname for the node
extra.supp_id:
string
Any ID you wish to register to the node
extra.note:
string
Memo tagged with the node
is_active:
boolean
If the node is indexed or marked deleted.
info.payee_name:
required
string
Name of the payee
info.payee_address.address_street:
required
string
Address of the payee, this can be home address of a person or business address of a corp.
info.payee_address.address_city:
required
string
Address of the payee, this can be home address of a person or business address of a corp.
info.payee_address.address_subdivision:
required
string
Address of the payee, this can be home address of a person or business address of a corp.
info.payee_address.address_country_code:
required
string
Address of the payee, this can be home address of a person or business address of a corp.
info.payee_address.address_postal_code:
required
string
Address of the payee, this can be home address of a person or business address of a corp.

Examples


Result Format