{"_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. 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\nThis document is an implementation example for developers to understand end-users' on-boarding flow through the widget, as well as a smart contract components to check whether or not a customer's KYC is compliant by Wyre, who is a regulated Money Services Business.\n\nThe premise is that there is a limited feature set, whether that be liquidity or other service offerings such as cashout or bank deposits, for non-KYC'd users as compared to verified users.\n\nThis guide involves some interaction with Ethereum smart contracts. We include a manual walk-through to understand the step by step process that may help you get a feel for things if it's your first rodeo. This documentation will show you how to interact with the on chain KYC smart contract. \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 and maintain the status of their on-chain Compliance Tokens. We serve liquidity to partners verified by Wyre, and only serve liquidity to users that are verified token holders. 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, some of which are verified via Wyre, some of which are not. It is your job to check the verification status of your users on-chain and enable or disable different features depending on their status. Verified users may be able to access features such as: Bank Deposit, Cashout, Bitcoin, etc.\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. We currently use [Plaid](https://www.plaid.com) to fund the Ethereum wallet via ACH transfer. In the test environment, the user can select any bank vendor. For username, type in `user_good` and for password, type in `pass_good` which are the Plaid test credentials\n5. Our compliance team will review the KYC information and issue a Compliance Token once approved\n6. When the user visits the DEX/dApp again, there will be additional functionality enabled, based on the existence of the Compliance Token\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 example is the out of the box user-flow. \\n\\nIt's dropped the bank login, 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]","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. Its aim is to provide an optimal UX that we’re constantly iterating. We’ve tried to keep things as simple/lightweight as possible. This document is an implementation example for developers to understand end-users' on-boarding flow through the widget, as well as a smart contract components to check whether or not a customer's KYC is compliant by Wyre, who is a regulated Money Services Business. The premise is that there is a limited feature set, whether that be liquidity or other service offerings such as cashout or bank deposits, for non-KYC'd users as compared to verified users. This guide involves some interaction with Ethereum smart contracts. We include a manual walk-through to understand the step by step process that may help you get a feel for things if it's your first rodeo. This documentation will show you how to interact with the on chain KYC smart contract. [block:api-header] { "title": "Parties involved" } [/block] **Wyre** - Wyre is a service provider to you, our partner. We verify Users off-chain and maintain the status of their on-chain Compliance Tokens. We serve liquidity to partners verified by Wyre, and only serve liquidity to users that are verified token holders. 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, some of which are verified via Wyre, some of which are not. It is your job to check the verification status of your users on-chain and enable or disable different features depending on their status. Verified users may be able to access features such as: Bank Deposit, Cashout, Bitcoin, etc. **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. We currently use [Plaid](https://www.plaid.com) to fund the Ethereum wallet via ACH transfer. In the test environment, the user can select any bank vendor. For username, type in `user_good` and for password, type in `pass_good` which are the Plaid test credentials 5. Our compliance team will review the KYC information and issue a Compliance Token once approved 6. When the user visits the DEX/dApp again, there will be additional functionality enabled, based on the existence of the Compliance Token [block:image] { "images": [ { "image": [ "https://files.readme.io/fa34811-userFlow.gif", "userFlow.gif", 417, 593, "#8f9093" ], "border": false, "sizing": "original", "caption": "This example is the out of the box user-flow. \n\nIt's dropped the bank login, because the person recording it seemed to think it shouldn't be public knowledge on what his bank credentials are." } ] } [/block]