{"_id":"5c12a4e186cd39000e95603f","project":"550f74bb6fc8130d0038aad3","version":{"_id":"550f75de61d9d30d00af9e01","__v":17,"project":"550f74bb6fc8130d0038aad3","forked_from":"550f74bb6fc8130d0038aad6","createdAt":"2015-03-23T02:09:34.221Z","releaseDate":"2015-03-23T02:09:34.221Z","categories":["550f75de61d9d30d00af9e02","551027e38579861900a86698","551029e08579861900a8669a","551029e7498062190006328a","5bc633a722d682005c9ad9e4","5bc633b08c4b0b000d6a7eaa","5bc633b48f3ff600626e3e18","5bc63538e5a6ba000d22ee6d","5bc63587a18a6b000decd295","5bc635c0937fcb0056223d9c","5bc6360f42f41800319aeaa6","5be5d13ff1d319002baca9ce","5be5d2287cd14d00291fbfdb","5be8b3b09f7cb70023c56a39","5be8b3cbb910100044e20206","5c1d769a4f6aed001fe527f0","5c402942010f0d001496dded"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3"},"category":{"_id":"5bc63538e5a6ba000d22ee6d","project":"550f74bb6fc8130d0038aad3","version":"550f75de61d9d30d00af9e01","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2018-10-16T19:00:08.331Z","from_sync":false,"order":1,"slug":"wyre-sdk","title":"Widget"},"user":"54eb8076867e1917009b7160","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-12-13T18:28:49.349Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"apiSetting":null,"auth":"required","params":[],"url":""},"isReference":true,"order":0,"body":"The Wyre Widget is an easy-to-embed web module aimed to handle on-boarding for you and provide fiat on-ramps and off-ramps for your customers via ACH processing payments or debit card payments. Its aim is to provide an optimal UX that we’re constantly iterating. We’ve tried to keep things as simple/lightweight as possible.\n[block:api-header]\n{\n  \"title\": \"Parties Involved\"\n}\n[/block]\n**Wyre** - Wyre is a service provider to you, our partner. We verify Users off-chain. We serve liquidity to partners verified by Wyre, and only serve liquidity to verified users. We do not disclose their personal information unless in the event of a regulatory intervention as requested (e.g. subpoena, etc...). \n\n**Partners** - DEX, Dapps, etc. Likely this is you. You have users that need to be verified to transact on your d/app. \n\n**Users** - DEX, Dapp end users. They are the ones getting verified and getting the experience from you. Wyre's part in this is purely to onboard them, and facilitate on/off ramps into your application for them. \n[block:api-header]\n{\n  \"title\": \"User Flow\"\n}\n[/block]\n1. The user will first login to the DEX or dApp. When they first land here they will be exposed to limited functionality, based on what they can do without being KYC/AML verified\n2. The user will click on the \"Get Verified\" button which will open the Wyre KYC/AML compliance module\n3. The verification module will guide the user to fill out their KYC information which automatically gets sent to Wyre (See animation below)\n4. User will go through different on-boarding flows depending on either using the ACH or Debit Card processing payment flow.\n5. For ACH flows, once completed, our compliance team will review the KYC information and determine the eligibility of the user's account. Debit card transfer flows are instant.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/fa34811-userFlow.gif\",\n        \"userFlow.gif\",\n        417,\n        593,\n        \"#8f9093\"\n      ],\n      \"border\": false,\n      \"sizing\": \"original\",\n      \"caption\": \"This is an example of an out of the box ACH payment processor flow.\\n\\nNo bank log in information is shown because the person recording it seemed to think it shouldn't be public knowledge on what his bank credentials are.\"\n    }\n  ]\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/2f002c2-ezgif.com-optimize_1.gif\",\n        \"ezgif.com-optimize_1.gif\",\n        1024,\n        1400,\n        \"#8a8b8b\"\n      ],\n      \"caption\": \"This is an example of an out of the box debit card flow.\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Ad Blockers\"\n}\n[/block]\nIf there are any ad blockers install on your machine or a customers machine, please inform your users to disable any ad blocking services before proceeding with using the Wyre widget.\n\nExamples: Before sending clients to the Wyre widget flow, you could ask customers via a pop up window to disable any ad blocking services.","excerpt":"Why we built it, and who should use it!","slug":"widget-getting-started","type":"basic","title":"Getting Started"}

Getting Started

Why we built it, and who should use it!

The Wyre Widget is an easy-to-embed web module aimed to handle on-boarding for you and provide fiat on-ramps and off-ramps for your customers via ACH processing payments or debit card payments. Its aim is to provide an optimal UX that we’re constantly iterating. We’ve tried to keep things as simple/lightweight as possible. [block:api-header] { "title": "Parties Involved" } [/block] **Wyre** - Wyre is a service provider to you, our partner. We verify Users off-chain. We serve liquidity to partners verified by Wyre, and only serve liquidity to verified users. We do not disclose their personal information unless in the event of a regulatory intervention as requested (e.g. subpoena, etc...). **Partners** - DEX, Dapps, etc. Likely this is you. You have users that need to be verified to transact on your d/app. **Users** - DEX, Dapp end users. They are the ones getting verified and getting the experience from you. Wyre's part in this is purely to onboard them, and facilitate on/off ramps into your application for them. [block:api-header] { "title": "User Flow" } [/block] 1. The user will first login to the DEX or dApp. When they first land here they will be exposed to limited functionality, based on what they can do without being KYC/AML verified 2. The user will click on the "Get Verified" button which will open the Wyre KYC/AML compliance module 3. The verification module will guide the user to fill out their KYC information which automatically gets sent to Wyre (See animation below) 4. User will go through different on-boarding flows depending on either using the ACH or Debit Card processing payment flow. 5. For ACH flows, once completed, our compliance team will review the KYC information and determine the eligibility of the user's account. Debit card transfer flows are instant. [block:image] { "images": [ { "image": [ "https://files.readme.io/fa34811-userFlow.gif", "userFlow.gif", 417, 593, "#8f9093" ], "border": false, "sizing": "original", "caption": "This is an example of an out of the box ACH payment processor flow.\n\nNo bank log in information is shown because the person recording it seemed to think it shouldn't be public knowledge on what his bank credentials are." } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/2f002c2-ezgif.com-optimize_1.gif", "ezgif.com-optimize_1.gif", 1024, 1400, "#8a8b8b" ], "caption": "This is an example of an out of the box debit card flow." } ] } [/block] [block:api-header] { "title": "Ad Blockers" } [/block] If there are any ad blockers install on your machine or a customers machine, please inform your users to disable any ad blocking services before proceeding with using the Wyre widget. Examples: Before sending clients to the Wyre widget flow, you could ask customers via a pop up window to disable any ad blocking services.