--- title: Using the Doshii Referral API description: Within the Doshii context a referral represents a request from a partner to get a merchant connected to Doshii to allow a direct API connection between the partners consumer facing App and the merchan --- [Skip to content](https://support.doshii.com/developer-support/hc/en-us/articles/20051326743449-using-the-doshii-referral-api#main-content) English Show submenu for translations Doshii Connect Pty Ltd Open main navigation Close main navigation - English Show submenu for translations - Go to Doshii Connect Pty Ltd Go to Doshii Connect Pty Ltd Help for Partners - There are no suggestions because the search field is empty. 1. [Help for Partners](https://support.doshii.com/developer-support?hsLang=en) 2. [Workflows](https://support.doshii.com/developer-support/workflows?hsLang=en) # Using the Doshii Referral API **Introduction** Within the Doshii context a referral represents a request from a partner to get a merchant connected to Doshii to allow a direct API connection between the partners consumer facing App and the merchant's Point of Sale (POS). This creates the most seamless experience for the merchant's onboarding process. **This document assumes [Subscription and Onboarding](https://support.doshii.io/hc/en-us/articles/360031292513) has been implemented as per requirements.** **Typical Referral Scenario** ![diagram.png](https://support.doshii.com/hubfs/Knowledge%20Base%20Import/20051340317593-1.png) **Referral Status Workflow** ![image\_\_2\_.png](https://support.doshii.com/hubfs/Knowledge%20Base%20Import/20051310778777-1.png)   Getting started Using Referrals Referrals are facilitated by the use of Doshii's **[referrals endpoint](https://dashboard.sandbox.doshii.io/docs/api/app#/Onboarding/createReferral).** ![Referral\_Sequence.png](https://support.doshii.com/hs-fs/hubfs/Knowledge%20Base%20Import/20051297139865-1.png?width=670&height=389&name=20051297139865-1.png)   ### Referral parameters   Example:  ``` POST https://sandbox.doshii.co/partner/v3/referrals ``` ``` {"merchantContactEmail": "user@host.com", "merchantContactFirstName": "Jim", "merchantContactLastName": "Belushi", "merchantPhone": "411000000", "merchantVenueName": "Belushi Sushi", "partnerLocationId": "string", "doshiiLocationId": "string", "doshiiOrganisationId": "string", "merchantAddress": { "line1": "string", "line2": "string", "city": "Sydney", "state": "NSW", "postalCode": "2000", "country": "AU", "latitude": 33.8688, "longitude": 151.2093 }, "referrerName": "string", "referrerEmail": "string", "doshiiVendorId": "string", "triggerMerchantEmail": true} ``` For all required fields refer to the swagger documentation [here](https://dashboard.sandbox.doshii.io/docs/api/app#/Onboarding/createReferral)   ### What happens after you submit a referral? When the referral is submitted via the api, the api response will include a referral url link. This link can either  1. Be passed on to Merchant via your own onboarding process or 2. Will be sent to the Merchant in an email sent by Doshii When the Merchant accesses the referral url link, the Doshii merchant platform uses the data included to auto populate the merchants onboarding experience to increase ease and reduce drop offs.   To understand the merchants onboarding process please **[view](https://www.figma.com/proto/sV33omYY6Ms7AEmUQzNfPD/AR---Shorts-for-Partners?page-id=1065%3A42985&node-id=2102%3A8870&viewport=524%2C445%2C0.02&scaling=min-zoom&starting-point-node-id=2102%3A8870&show-proto-sidebar=1)** this prototype.   ### Additional Benefit All referrals that are submitted to Doshii for a particular partner are visible within Doshii dashboard with functionality that indicates the referral status progression and venue onboarding progress so that your team can keep up to date on the closure of sales.   ### Simulating in the Sandbox Environment Before implementing referrals ensure you have done the following: - Update your app's service channels to accept referrals:   ![Screenshot\_2023-02-02\_at\_5.22.17\_pm.png](https://support.doshii.com/hs-fs/hubfs/Knowledge%20Base%20Import/20051340333337-1.png?width=475&height=36&name=20051340333337-1.png) - Activate the referrals API endpoint: ![Screenshot\_2023-02-02\_at\_5.23.47\_pm.png](https://support.doshii.com/hs-fs/hubfs/Knowledge%20Base%20Import/20051316438937-1.png?width=320&height=134&name=20051316438937-1.png) - Ensure the app has been connected to Doshii's sandbox marketplace - Check that you can see the referrals section (which was previously red) on the details page. ![Screenshot\_2023-02-02\_at\_5.32.48\_pm.png](https://support.doshii.com/hubfs/Knowledge%20Base%20Import/20051305071257-1.png) - Hit the '+' icon and find the venue you are looking to onboard. It is best practice to fill as much information for the merchant as possible. - Once you hit submit, the merchant will receive a referral url at the [designated email](https://www.figma.com/proto/sV33omYY6Ms7AEmUQzNfPD/AR---Shorts-for-Partners?page-id=1065%3A42985&node-id=2102%3A8870&viewport=524%2C445%2C0.02&scaling=min-zoom&starting-point-node-id=2102%3A8870&show-proto-sidebar=1). - Your referral table should now populate with a venue in status of **PENDING.** Other support - Contact Doshii support via *[support@doshii.io](mailto:support@doshii.io) *if you require any help. - **[Certify your App with Doshii](https://support.doshii.com/developer-support/hc/en-us/articles/360026554194-certifying-with-doshii?hsLang=en)** - [API concepts](https://support.doshii.com/developer-support/api-concepts?hsLang=en) - [Members](https://support.doshii.com/developer-support/members?hsLang=en) - [Model](https://support.doshii.com/developer-support/model?hsLang=en) - [FAQ - Developers](https://support.doshii.com/developer-support/faq-developers?hsLang=en) - [Resources](https://support.doshii.com/developer-support/resources?hsLang=en) - [Orders](https://support.doshii.com/developer-support/orders?hsLang=en) - [Rewards](https://support.doshii.com/developer-support/rewards?hsLang=en) - [Check-ins](https://support.doshii.com/developer-support/check-ins?hsLang=en) - [Getting started - App partners](https://support.doshii.com/developer-support/getting-started-app-partners?hsLang=en) - [Employees](https://support.doshii.com/developer-support/employees?hsLang=en) - [Getting started - Doshii Dashboard](https://support.doshii.com/developer-support/getting-started-doshii-dashboard?hsLang=en) - [Quick start for developers](https://support.doshii.com/developer-support/quick-start-for-developers?hsLang=en) - [Onboarding](https://support.doshii.com/developer-support/onboarding?hsLang=en) - [Location](https://support.doshii.com/developer-support/location?hsLang=en) - [All App Partners Event](https://support.doshii.com/developer-support/all-app-partners-event?hsLang=en) - [Menus](https://support.doshii.com/developer-support/menus?hsLang=en) - [Loyalty / Checkins](https://support.doshii.com/developer-support/loyalty-checkins?hsLang=en) - [WebSocket - App partners](https://support.doshii.com/developer-support/websocket-app-partners?hsLang=en) - [All POS vendor events](https://support.doshii.com/developer-support/all-pos-vendor-events?hsLang=en) - [Loyalty / Gift Cards](https://support.doshii.com/developer-support/loyalty-gift-cards?hsLang=en) - [Devices](https://support.doshii.com/developer-support/devices?hsLang=en) - [Tables](https://support.doshii.com/developer-support/tables?hsLang=en) - [Workflows](https://support.doshii.com/developer-support/workflows?hsLang=en) - [FAQ - Doshii Dashboard](https://support.doshii.com/developer-support/faq-doshii-dashboard?hsLang=en) - [Bookings](https://support.doshii.com/developer-support/bookings?hsLang=en) - [Transactions](https://support.doshii.com/developer-support/transactions?hsLang=en) - [Webhooks](https://support.doshii.com/developer-support/webhooks?hsLang=en#main-content) - [App Partners](https://support.doshii.com/developer-support/webhooks?hsLang=en#app-partners) - [POS Vendors](https://support.doshii.com/developer-support/webhooks?hsLang=en#pos-vendors) - [App Partner Guide](https://support.doshii.com/developer-support/app-partner-guide?hsLang=en) - [Authentication](https://support.doshii.com/developer-support/authentication?hsLang=en) - [Getting started - POS vendors](https://support.doshii.com/developer-support/getting-started-pos-vendors?hsLang=en) - [Ordering](https://support.doshii.com/developer-support/ordering?hsLang=en) - [Reservations](https://support.doshii.com/developer-support/reservations?hsLang=en) - [Pilot](https://support.doshii.com/developer-support/pilot?hsLang=en) - [Bulk data](https://support.doshii.com/developer-support/bulk-data?hsLang=en) - [Playbooks](https://support.doshii.com/developer-support/playbooks?hsLang=en) - [Rejection codes](https://support.doshii.com/developer-support/rejection-codes?hsLang=en) - [Getting started](https://support.doshii.com/developer-support/getting-started?hsLang=en) - [WebSocket - POS partners](https://support.doshii.com/developer-support/websocket-pos-partners?hsLang=en) - [Events - App partners](https://support.doshii.com/developer-support/events-app-partners?hsLang=en) - [Service channels](https://support.doshii.com/developer-support/service-channels?hsLang=en) - [Events](https://support.doshii.com/developer-support/events?hsLang=en) - [Concepts](https://support.doshii.com/developer-support/concepts?hsLang=en) - [Apps](https://support.doshii.com/developer-support/apps?hsLang=en) # Doshii Connect Pty Ltd Doshii Connect Pty Ltd Help Center Copyright © 2026, Doshii Connect Pty Ltd