{"_id":"55fa37ca8065a10d004e5bbb","user":"54e4044e8ef7552300409dcb","parentDoc":null,"__v":14,"project":"54e405191e51932d006abc39","version":{"_id":"55fa37c88065a10d004e5bb6","project":"54e405191e51932d006abc39","__v":9,"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"],"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":"55fa37ca8065a10d004e5bb7","__v":7,"project":"54e405191e51932d006abc39","version":"55fa37c88065a10d004e5bb6","pages":["55fa37ca8065a10d004e5bbb","55fa37ca8065a10d004e5bbc","55fa37ca8065a10d004e5bbd","55fa37ca8065a10d004e5bbe","55fa37ca8065a10d004e5bbf","55fa37ca8065a10d004e5bc0","55fa3a948065a10d004e5bd5","55fa3c3ba663c00d00773dce","55fa4b8eaba81f0d00a115e4","56733ae758c4890d00bb548a","56734f9c4b2a680d00524e09","569d8eae3dbdc20d005feee8"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-02-18T03:20:58.779Z","from_sync":false,"order":0,"slug":"introduction","title":"Introduction"},"updates":["5577148c07e7110d00104398","55cbac9f4153080d004468b0","560714f3bc4e580d0033a942","57c93be8860b1f0e008791fa"],"next":{"pages":[],"description":""},"createdAt":"2015-02-18T06:41:32.555Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"Welcome to the API documentation of Synapse V3.1. The API provides access to Synapse endpoints to help you onboard users, add nodes (eg. bank account, Synapse deposit account or domestic/international wire sources) or create transactions.\n\nThis version of the API is architected around [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) using standard HTTP verbs to communicate and HTTP response codes to indicate status and errors. All responses come in standard JSON (unless the application is down).\n\nClient Libraries: [Python](https://github.com/synapsepay/SynapsePayRest-Python) | [Ruby](https://github.com/synapsepay/SynapsePayRest-Ruby) | [PHP](https://github.com/synapsepay/synapse-pay-rest) | [Node.js](https://github.com/synapsepayments/SynapsePay-Node) | [![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/902889549d9c28db6f4f#?env%5BUAT.CORE.API%5D=W3siZW5hYmxlZCI6dHJ1ZSwia2V5IjoiaG9zdCIsInZhbHVlIjoiaHR0cHM6Ly91YXQtYXBpLnN5bmFwc2VmaS5jb20iLCJ0eXBlIjoidGV4dCJ9LHsiZW5hYmxlZCI6dHJ1ZSwia2V5IjoiY2xpZW50X2lkIiwidmFsdWUiOiJjbGllbnRfaWRfMmJiMWU0MTJlZGQzMTFlNmJkMDRlMjg1ZDYwMTUyNjciLCJ0eXBlIjoidGV4dCJ9LHsiZW5hYmxlZCI6dHJ1ZSwia2V5IjoiY2xpZW50X3NlY3JldCIsInZhbHVlIjoiY2xpZW50X3NlY3JldF8yYmIxZTcxNGVkZDMxMWU2YmQwNGUyODVkNjAxNTI2NyIsInR5cGUiOiJ0ZXh0In0seyJlbmFibGVkIjp0cnVlLCJrZXkiOiJvYXV0aF9rZXkiLCJ2YWx1ZSI6Im9hdXRoXzMyMWNpQVFPUFVackM3RGF5b0pleGxMNnZHNTBzVldGTmRJa1lqSHoiLCJ0eXBlIjoidGV4dCJ9LHsiZW5hYmxlZCI6dHJ1ZSwia2V5IjoicmVmcmVzaF90b2tlbiIsInZhbHVlIjoicmVmcmVzaF9KQTdLemYxTHA4c2JXVjlFM1l4MkhrcWdDRjBYVG55R293RFFJbHJPIiwidHlwZSI6InRleHQifSx7ImVuYWJsZWQiOnRydWUsImtleSI6InVzZXJfaWQiLCJ2YWx1ZSI6IjU5NDg2ODY0ODM4NDU0MDAyZWY3YThhZSIsInR5cGUiOiJ0ZXh0In0seyJlbmFibGVkIjp0cnVlLCJrZXkiOiJub2RlX2lkIiwidmFsdWUiOiI1OTQ4Njc0MzRkMWQ2MjAwMzYwZjZhZjEiLCJ0eXBlIjoidGV4dCJ9LHsiZW5hYmxlZCI6dHJ1ZSwia2V5IjoidHJhbnNhY3Rpb25faWQiLCJ2YWx1ZSI6IjU5NDg2ODI2MmY4ODk2MDAyZTEwZGM0NCIsInR5cGUiOiJ0ZXh0In0seyJlbmFibGVkIjp0cnVlLCJrZXkiOiJzdWJzY3JpcHRpb25faWQiLCJ2YWx1ZSI6IjU4OWI2YWRlYzgzZTE3MDAyMTIyMTk2YyIsInR5cGUiOiJ0ZXh0In0seyJlbmFibGVkIjp0cnVlLCJrZXkiOiJzZXNzaW9uX2lkIiwidmFsdWUiOiI1ODk1MTY3ZDU2MDllZjAwMjA1ZjY1NWQiLCJ0eXBlIjoidGV4dCJ9LHsiZW5hYmxlZCI6dHJ1ZSwia2V5IjoiZnAiLCJ2YWx1ZSI6ImU4M2NmNmRkY2Y3NzhlMzdiZmUzZDQ4ZmM3OGE2NTAyMDYyZmMxMDMwNDQ5NjI4YzY5OWVmM2M0ZmZhNmY5YTIwMDBiOGFjYzNjNGMwYWRkZDgwMTMyODViYjUyYzg5ZTUyNjdiNjI4Y2EwMmZhODRhNmQ3MWZlMTg2YjdjZDVkIiwidHlwZSI6InRleHQifSx7ImVuYWJsZWQiOnRydWUsImtleSI6ImlwIiwidmFsdWUiOiIxMjcuMC4wLjEiLCJ0eXBlIjoidGV4dCJ9LHsiZW5hYmxlZCI6dHJ1ZSwia2V5IjoiaWRfa2V5IiwidmFsdWUiOiJhOTM4YjcwODMyNTM5NzI1NTRjZThlOWRkNWViNGU4NmUyNzFiMmEzNDZkNTJhZDEzNmVjY2QyMTYwNmQ2MjE1IiwidHlwZSI6InRleHQifSx7ImVuYWJsZWQiOnRydWUsImtleSI6Im1mYV9hY2Nlc3NfdG9rZW4iLCJ2YWx1ZSI6ImZha2VfY2Q2MDY4MGI5YWRkYzAxM2NhN2ZiMjViMmI3MDRiZTMyNGQwMjk1YjM0YTZlM2QxNDQ3M2UzY2M2NWFhODJkMyIsInR5cGUiOiJ0ZXh0In0seyJlbmFibGVkIjp0cnVlLCJrZXkiOiJjbGllbnRfcHVibGljX2tleSIsInZhbHVlIjoicHVibGljX2tleV9PRVlzcHdIbVJWcTM1SldyY1pTUHVpUTRoTjAwbEx4QVR0MWF5Qmp6IiwidHlwZSI6InRleHQifV0=)","excerpt":"Getting Started with Synapse","slug":"getting-started","type":"basic","title":"Getting Started"}

Getting Started

Getting Started with Synapse

Welcome to the API documentation of Synapse V3.1. The API provides access to Synapse endpoints to help you onboard users, add nodes (eg. bank account, Synapse deposit account or domestic/international wire sources) or create transactions. This version of the API is architected around [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) using standard HTTP verbs to communicate and HTTP response codes to indicate status and errors. All responses come in standard JSON (unless the application is down). Client Libraries: [Python](https://github.com/synapsepay/SynapsePayRest-Python) | [Ruby](https://github.com/synapsepay/SynapsePayRest-Ruby) | [PHP](https://github.com/synapsepay/synapse-pay-rest) | [Node.js](https://github.com/synapsepayments/SynapsePay-Node) | [![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/902889549d9c28db6f4f#?env%5BUAT.CORE.API%5D=W3siZW5hYmxlZCI6dHJ1ZSwia2V5IjoiaG9zdCIsInZhbHVlIjoiaHR0cHM6Ly91YXQtYXBpLnN5bmFwc2VmaS5jb20iLCJ0eXBlIjoidGV4dCJ9LHsiZW5hYmxlZCI6dHJ1ZSwia2V5IjoiY2xpZW50X2lkIiwidmFsdWUiOiJjbGllbnRfaWRfMmJiMWU0MTJlZGQzMTFlNmJkMDRlMjg1ZDYwMTUyNjciLCJ0eXBlIjoidGV4dCJ9LHsiZW5hYmxlZCI6dHJ1ZSwia2V5IjoiY2xpZW50X3NlY3JldCIsInZhbHVlIjoiY2xpZW50X3NlY3JldF8yYmIxZTcxNGVkZDMxMWU2YmQwNGUyODVkNjAxNTI2NyIsInR5cGUiOiJ0ZXh0In0seyJlbmFibGVkIjp0cnVlLCJrZXkiOiJvYXV0aF9rZXkiLCJ2YWx1ZSI6Im9hdXRoXzMyMWNpQVFPUFVackM3RGF5b0pleGxMNnZHNTBzVldGTmRJa1lqSHoiLCJ0eXBlIjoidGV4dCJ9LHsiZW5hYmxlZCI6dHJ1ZSwia2V5IjoicmVmcmVzaF90b2tlbiIsInZhbHVlIjoicmVmcmVzaF9KQTdLemYxTHA4c2JXVjlFM1l4MkhrcWdDRjBYVG55R293RFFJbHJPIiwidHlwZSI6InRleHQifSx7ImVuYWJsZWQiOnRydWUsImtleSI6InVzZXJfaWQiLCJ2YWx1ZSI6IjU5NDg2ODY0ODM4NDU0MDAyZWY3YThhZSIsInR5cGUiOiJ0ZXh0In0seyJlbmFibGVkIjp0cnVlLCJrZXkiOiJub2RlX2lkIiwidmFsdWUiOiI1OTQ4Njc0MzRkMWQ2MjAwMzYwZjZhZjEiLCJ0eXBlIjoidGV4dCJ9LHsiZW5hYmxlZCI6dHJ1ZSwia2V5IjoidHJhbnNhY3Rpb25faWQiLCJ2YWx1ZSI6IjU5NDg2ODI2MmY4ODk2MDAyZTEwZGM0NCIsInR5cGUiOiJ0ZXh0In0seyJlbmFibGVkIjp0cnVlLCJrZXkiOiJzdWJzY3JpcHRpb25faWQiLCJ2YWx1ZSI6IjU4OWI2YWRlYzgzZTE3MDAyMTIyMTk2YyIsInR5cGUiOiJ0ZXh0In0seyJlbmFibGVkIjp0cnVlLCJrZXkiOiJzZXNzaW9uX2lkIiwidmFsdWUiOiI1ODk1MTY3ZDU2MDllZjAwMjA1ZjY1NWQiLCJ0eXBlIjoidGV4dCJ9LHsiZW5hYmxlZCI6dHJ1ZSwia2V5IjoiZnAiLCJ2YWx1ZSI6ImU4M2NmNmRkY2Y3NzhlMzdiZmUzZDQ4ZmM3OGE2NTAyMDYyZmMxMDMwNDQ5NjI4YzY5OWVmM2M0ZmZhNmY5YTIwMDBiOGFjYzNjNGMwYWRkZDgwMTMyODViYjUyYzg5ZTUyNjdiNjI4Y2EwMmZhODRhNmQ3MWZlMTg2YjdjZDVkIiwidHlwZSI6InRleHQifSx7ImVuYWJsZWQiOnRydWUsImtleSI6ImlwIiwidmFsdWUiOiIxMjcuMC4wLjEiLCJ0eXBlIjoidGV4dCJ9LHsiZW5hYmxlZCI6dHJ1ZSwia2V5IjoiaWRfa2V5IiwidmFsdWUiOiJhOTM4YjcwODMyNTM5NzI1NTRjZThlOWRkNWViNGU4NmUyNzFiMmEzNDZkNTJhZDEzNmVjY2QyMTYwNmQ2MjE1IiwidHlwZSI6InRleHQifSx7ImVuYWJsZWQiOnRydWUsImtleSI6Im1mYV9hY2Nlc3NfdG9rZW4iLCJ2YWx1ZSI6ImZha2VfY2Q2MDY4MGI5YWRkYzAxM2NhN2ZiMjViMmI3MDRiZTMyNGQwMjk1YjM0YTZlM2QxNDQ3M2UzY2M2NWFhODJkMyIsInR5cGUiOiJ0ZXh0In0seyJlbmFibGVkIjp0cnVlLCJrZXkiOiJjbGllbnRfcHVibGljX2tleSIsInZhbHVlIjoicHVibGljX2tleV9PRVlzcHdIbVJWcTM1SldyY1pTUHVpUTRoTjAwbEx4QVR0MWF5Qmp6IiwidHlwZSI6InRleHQifV0=)