{"__v":14,"_id":"55fa37ca8065a10d004e5bbb","category":{"__v":7,"_id":"55fa37ca8065a10d004e5bb7","pages":["55fa37ca8065a10d004e5bbb","55fa37ca8065a10d004e5bbc","55fa37ca8065a10d004e5bbd","55fa37ca8065a10d004e5bbe","55fa37ca8065a10d004e5bbf","55fa37ca8065a10d004e5bc0","55fa3a948065a10d004e5bd5","55fa3c3ba663c00d00773dce","55fa4b8eaba81f0d00a115e4","56733ae758c4890d00bb548a","56734f9c4b2a680d00524e09","569d8eae3dbdc20d005feee8"],"project":"54e405191e51932d006abc39","version":"55fa37c88065a10d004e5bb6","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-02-18T03:20:58.779Z","from_sync":false,"order":0,"slug":"introduction","title":"Introduction"},"parentDoc":null,"project":"54e405191e51932d006abc39","user":"54e4044e8ef7552300409dcb","version":{"__v":7,"_id":"55fa37c88065a10d004e5bb6","project":"54e405191e51932d006abc39","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"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"REST V3","version_clean":"3.1.0","version":"3.1"},"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":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"Welcome to the API documentation of Synapse's REST V3. The API provides **totally white-labeled** access to Synapse endpoints to help you onboard users, add nodes (eg. bank account, Synapse deposit account or domestic/international wire sources), store or move value, and do basically anything else that Synapse's branded products can do.\n\nThis 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.\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/b3ce578098c5a32c4ac1#?env%5BV3.1%5D=W3sia2V5IjoiaG9zdCIsInZhbHVlIjoiaHR0cHM6Ly9zYW5kYm94LnN5bmFwc2VwYXkuY29tL2FwaS8zIiwidHlwZSI6InRleHQiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6ImNsaWVudF9pZCIsInZhbHVlIjoiY2xpZW50X2lkXzJiYjFlNDEyZWRkMzExZTZiZDA0ZTI4NWQ2MDE1MjY3IiwidHlwZSI6InRleHQiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6ImNsaWVudF9zZWNyZXQiLCJ2YWx1ZSI6ImNsaWVudF9zZWNyZXRfMmJiMWU3MTRlZGQzMTFlNmJkMDRlMjg1ZDYwMTUyNjciLCJ0eXBlIjoidGV4dCIsImVuYWJsZWQiOnRydWV9LHsia2V5Ijoib2F1dGhfa2V5IiwidmFsdWUiOiJvYXV0aF80MGU2M2E2OGVmOWExMWU2ODM0ZjBhODFjMWFiODA0ZiIsInR5cGUiOiJ0ZXh0IiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJyZWZyZXNoX3Rva2VuIiwidmFsdWUiOiJyZWZyZXNoX2UzNmYyMDdhZWY5OTExZTZhYWM1OGExZmZjMzc1MTFmIiwidHlwZSI6InRleHQiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6InVzZXJfaWQiLCJ2YWx1ZSI6IjU4OWRjODgxNzU2Mjk2MDAyMGNiMDBjOSIsInR5cGUiOiJ0ZXh0IiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJub2RlX2lkIiwidmFsdWUiOiI1ODlkY2JkMjdlMDg4NzAwMWY5NDA2MTEiLCJ0eXBlIjoidGV4dCIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoidHJhbnNhY3Rpb25faWQiLCJ2YWx1ZSI6IjU4OWRjZWZhNzA0MDY4MDAxZjgwZmRiNCIsInR5cGUiOiJ0ZXh0IiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJzdWJzY3JpcHRpb25faWQiLCJ2YWx1ZSI6IjU4OWI2YWRlYzgzZTE3MDAyMTIyMTk2YyIsInR5cGUiOiJ0ZXh0IiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJzZXNzaW9uX2lkIiwidmFsdWUiOiI1ODk1MTY3ZDU2MDllZjAwMjA1ZjY1NWQiLCJ0eXBlIjoidGV4dCIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoiZnAiLCJ2YWx1ZSI6ImU3MTY5OTBlNTBiNjdhMTE3NzczNjk2MGI2MzU3NTI0YjIyMDkwY2NhYjA5M2QwNjhiM2Q3YTE4ZGJkZTNmNGMiLCJ0eXBlIjoidGV4dCIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoiaXAiLCJ2YWx1ZSI6IjEyNy4wLjAuMSIsInR5cGUiOiJ0ZXh0IiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJpZF9rZXkiLCJ2YWx1ZSI6ImE5MzhiNzA4MzI1Mzk3MjU1NGNlOGU5ZGQ1ZWI0ZTg2ZTI3MWIyYTM0NmQ1MmFkMTM2ZWNjZDIxNjA2ZDYyMTUiLCJ0eXBlIjoidGV4dCIsImVuYWJsZWQiOnRydWV9XQ==)","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's REST V3. The API provides **totally white-labeled** access to Synapse endpoints to help you onboard users, add nodes (eg. bank account, Synapse deposit account or domestic/international wire sources), store or move value, and do basically anything else that Synapse's branded products can do. 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. 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/b3ce578098c5a32c4ac1#?env%5BV3.1%5D=W3sia2V5IjoiaG9zdCIsInZhbHVlIjoiaHR0cHM6Ly9zYW5kYm94LnN5bmFwc2VwYXkuY29tL2FwaS8zIiwidHlwZSI6InRleHQiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6ImNsaWVudF9pZCIsInZhbHVlIjoiY2xpZW50X2lkXzJiYjFlNDEyZWRkMzExZTZiZDA0ZTI4NWQ2MDE1MjY3IiwidHlwZSI6InRleHQiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6ImNsaWVudF9zZWNyZXQiLCJ2YWx1ZSI6ImNsaWVudF9zZWNyZXRfMmJiMWU3MTRlZGQzMTFlNmJkMDRlMjg1ZDYwMTUyNjciLCJ0eXBlIjoidGV4dCIsImVuYWJsZWQiOnRydWV9LHsia2V5Ijoib2F1dGhfa2V5IiwidmFsdWUiOiJvYXV0aF80MGU2M2E2OGVmOWExMWU2ODM0ZjBhODFjMWFiODA0ZiIsInR5cGUiOiJ0ZXh0IiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJyZWZyZXNoX3Rva2VuIiwidmFsdWUiOiJyZWZyZXNoX2UzNmYyMDdhZWY5OTExZTZhYWM1OGExZmZjMzc1MTFmIiwidHlwZSI6InRleHQiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6InVzZXJfaWQiLCJ2YWx1ZSI6IjU4OWRjODgxNzU2Mjk2MDAyMGNiMDBjOSIsInR5cGUiOiJ0ZXh0IiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJub2RlX2lkIiwidmFsdWUiOiI1ODlkY2JkMjdlMDg4NzAwMWY5NDA2MTEiLCJ0eXBlIjoidGV4dCIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoidHJhbnNhY3Rpb25faWQiLCJ2YWx1ZSI6IjU4OWRjZWZhNzA0MDY4MDAxZjgwZmRiNCIsInR5cGUiOiJ0ZXh0IiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJzdWJzY3JpcHRpb25faWQiLCJ2YWx1ZSI6IjU4OWI2YWRlYzgzZTE3MDAyMTIyMTk2YyIsInR5cGUiOiJ0ZXh0IiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJzZXNzaW9uX2lkIiwidmFsdWUiOiI1ODk1MTY3ZDU2MDllZjAwMjA1ZjY1NWQiLCJ0eXBlIjoidGV4dCIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoiZnAiLCJ2YWx1ZSI6ImU3MTY5OTBlNTBiNjdhMTE3NzczNjk2MGI2MzU3NTI0YjIyMDkwY2NhYjA5M2QwNjhiM2Q3YTE4ZGJkZTNmNGMiLCJ0eXBlIjoidGV4dCIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoiaXAiLCJ2YWx1ZSI6IjEyNy4wLjAuMSIsInR5cGUiOiJ0ZXh0IiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJpZF9rZXkiLCJ2YWx1ZSI6ImE5MzhiNzA4MzI1Mzk3MjU1NGNlOGU5ZGQ1ZWI0ZTg2ZTI3MWIyYTM0NmQ1MmFkMTM2ZWNjZDIxNjA2ZDYyMTUiLCJ0eXBlIjoidGV4dCIsImVuYWJsZWQiOnRydWV9XQ==)