CINXE.COM
<!DOCTYPE html><html lang="en" xmlns="http://www.w3.org/1999/xhtml" xmlns:fb="https://www.facebook.com/2008/fbml" itemscope="itemscope" itemtype="http://schema.org/Product"><head><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"><meta name="readme-deploy" content="5.246.0"><script src="https://browser.sentry-cdn.com/6.19.7/bundle.tracing.min.js" integrity="sha384-lEBvyPG01tsv1WahtwAQevkCCh3NjqUNlz93IATGFmFuVbVyx6dReoQ035OOjNsM" crossorigin="anonymous"></script><script>Sentry.init({ dsn: "https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166", environment: "production", release: "5.246.0", tracesSampleRate: 0, initialScope: { tags: { 'readme-component': 'dash' } } }); </script><title ng-bind="Title.get()">ReadMe</title><meta http-equiv="Content-type" content="text/html;charset=UTF-8"><meta name="keywords" content="readme,developer hub,documentation"><meta name="description" content="Create beautiful product and API documentation with our developer friendly platform."><link rel="stylesheet" href="https://use.typekit.net/xxi6uhs.css"><link rel="shortcut icon" href="https://cdn.readme.io/public/img/favicon.ico?1734018047721" type="image/x-icon"><meta property="fb:app_id" content="293989217296609"><meta property="og:title" content="ReadMe"><meta property="og:description" content="Create beautiful product and API documentation with our developer friendly platform."><meta property="og:url" content="http://readme.io"><meta property="og:image" content="http://readme.io/img/image.png"><meta property="og:site_name" content="ReadMe"><meta property="fb:admins" content="1037213945"><meta name="slack-app-id" content="AQBR3NZUY"><meta name="csrf-token" content="undefined"><meta id="domain" content="readme.io"><link rel="stylesheet" href="https://cdn.readme.io/public/css/bundle-dash.css?1734018047721"><link data-chunk="routes-Dash-Onboarding" rel="preload" as="style" href="/public/dash/web/routes-Dash-Onboarding.ed6cd5957a0d4d344e39.css"> <link data-chunk="main" rel="preload" as="style" href="/public/dash/web/main.f102426426c51e0cffc9.css"> <link data-chunk="main" rel="preload" as="style" href="/public/dash/web/ui-styles.008862dd92b87d8119d0.css"> <link data-chunk="main" rel="preload" as="script" href="/public/dash/web/main.c0776c790d1f0d346e03.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/3766.5b33aec47565911e9ac6.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/7397.113781fd2f766bf29b1f.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/4241.8f70a87077f703b6e567.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/7672.b15199bc5637e5078c79.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/4772.3d5273c326fd08aad7f9.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/6651.45fe9e34f086e2e558a1.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/7436.42f081c3e0533b19adc6.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/9355.a266f6393358a73bd778.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/7449.8f1c293d3bb2ff027872.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/74.7e46ff08b9929e95159b.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/9503.e0ec95bcb299b55bd0f1.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/8993.769cf94cf07610467b08.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/8742.aa20e35679b26c7f5e77.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/3460.484efd4e741825dcf249.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/9723.d86d4fcc5bf11bab70e4.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/routes-Dash-Onboarding.23ba7ce891c116c69437.js"> <link data-chunk="core-icons-arrow-right-svg" rel="preload" as="script" href="/public/dash/web/core-icons-arrow-right-svg.33683bb9528fcbb0553f.js"> <link data-chunk="core-icons-upload-svg" rel="preload" as="script" href="/public/dash/web/core-icons-upload-svg.97db1bf07878f1e70221.js"> <link data-chunk="main" rel="stylesheet" href="/public/dash/web/ui-styles.008862dd92b87d8119d0.css"> <link data-chunk="main" rel="stylesheet" href="/public/dash/web/main.f102426426c51e0cffc9.css"> <link data-chunk="routes-Dash-Onboarding" rel="stylesheet" href="/public/dash/web/routes-Dash-Onboarding.ed6cd5957a0d4d344e39.css"><!--if lt IE 9script(src="http://html5shim.googlecode.com/svn/trunk/html5.js") --><script type="text/javascript">window.FS = { identify: () => {} }; </script><script>(function(){var w=window;var ic=w.Intercom;if(typeof ic==="function"){ic('reattach_activator');ic('update',intercomSettings);}else{var d=document;var i=function(){i.c(arguments)};i.q=[];i.c=function(args){i.q.push(args)};w.Intercom=i;function l(){var s=d.createElement('script');s.type='text/javascript';s.async=true;s.src='https://widget.intercom.io/widget/m6855w1q';var x=d.getElementsByTagName('script')[0];x.parentNode.insertBefore(s,x);}if(w.attachEvent){w.attachEvent('onload',l);}else{w.addEventListener('load',l,false);}}})() </script></head><body><div class="ng-non-bindable"><script id="dashReact-props" data-initial-props="{"baseUrl":"/to/feefo/?redirect=%2F%2F","context":{"labs":{},"user":{},"terms":[],"variables":{"user":{},"defaults":[]},"project":{"_id":"56d59dbef612b80b00fb69a7","appearance":{"changelog":{"layoutExpanded":false,"showAuthor":true,"showExactDate":false},"rdmd":{"callouts":{"useIconFont":false},"theme":{"background":"","border":"","markdownEdge":"","markdownFont":"","markdownFontSize":"","markdownLineHeight":"","markdownRadius":"","markdownText":"","markdownTitle":"","markdownTitleFont":"","mdCodeBackground":"","mdCodeFont":"","mdCodeRadius":"","mdCodeTabs":"","mdCodeText":"","tableEdges":"","tableHead":"","tableHeadText":"","tableRow":"","tableStripe":"","tableText":"","text":"","title":""}},"main_body":{"type":"links"},"colors":{"highlight":"","main":"#fdd100","main_alt":"","header_text":"","body_highlight":"#1b2cf8","custom_login_link_color":""},"typography":{"headline":"Open+Sans:400:sans-serif","body":"Open+Sans:400:sans-serif","typekit":false,"tk_key":"","tk_headline":"","tk_body":""},"header":{"style":"overlay","img":["https://files.readme.io/8bd1e15-Feefo_banner_new.png","8bd1e15-Feefo_banner_new.png",1080,300,"#000000","65fd818258be01007535e394"],"img_size":"cover","img_pos":"cr"},"body":{"style":"none"},"global_landing_page":{"html":"","redirect":""},"allowApiExplorerJsonEditor":false,"referenceSimpleMode":true,"referenceLayout":"row","link_logo_to_url":false,"theme":"solid","colorScheme":"light","overlay":"circuits","landing":true,"sticky":false,"hide_logo":true,"childrenAsPills":false,"subheaderStyle":"dropdown","splitReferenceDocs":false,"showMetricsInReference":true,"logo":["https://files.readme.io/e01f0ec-small-Feefo_logo_white.png","e01f0ec-small-Feefo_logo_white.png",344,80,"#ffffff","https://files.readme.io/dffbe2d-Feefo_logo_white.png","64cb76870731e60035f5d9ea"],"loginLogo":[],"logo_white":["https://files.readme.io/4cac3a4-small-Feefo_logo_colour.png","4cac3a4-small-Feefo_logo_colour.png",344,80,"#000000","https://files.readme.io/d9884c6-Feefo_logo_colour.png","65fd8114fdf8c6004bd98d2f"],"logo_white_use":true,"logo_large":true,"favicon":["https://files.readme.io/ldWWBKRDRmuxX4MgeGKd_favicon.ico","favicon.ico","32","32","#fce757",""],"stylesheet":"","stylesheet_hub2":"","stylesheet_hub3":"","javascript":"","javascript_hub2":"","html_promo":"","html_body":"","html_footer":"","html_head":"","html_footer_meta":"","html_hidelinks":false,"showVersion":true,"hideTableOfContents":false,"nextStepsLabel":"","promos":[{"extras":{"type":"search","buttonPrimary":"","buttonSecondary":""},"title":"Feefo Developer Hub","text":"Welcome to the Feefo developer hub. You'll find comprehensive guides and documentation to help you start working with Feefo as quickly as possible, as well as support if you get stuck. Let's jump right in!","_id":"56d59dbef612b80b00fb69a8"}]},"currentOnboardingStep":5,"custom_domain":"","childrenProjects":[],"derivedPlan":"business","description":"Explore Feefo's developer knowledge base for expert insights, tutorials, and resources to empower your integration projects. Unlock the potential of Feefo's advanced APIs and tools with our comprehensive developer documentation.","error404":"","experiments":[],"first_page":"landing","flags":{"allowReusableOTPs":false,"alwaysShowDocPublishStatus":false,"allowUnsafeCustomHtmlSuggestionsFromNonAdmins":false,"allowXFrame":false,"apiAccessRevoked":false,"bidiSync":false,"changelogRssAlwaysPublic":false,"correctnewlines":false,"customComponents":false,"dashReact":false,"disablePasswordlessLogin":false,"directGoogleToStableVersion":false,"disableAnonForum":false,"disableAutoTranslate":false,"disableSignups":false,"enableOidc":false,"enterprise":false,"graphql":false,"hideEnforceSSO":false,"mdx":false,"newEditorDash":true,"oauth":false,"passwordlessLogin":"default","owlbotAi":false,"rdmdCompatibilityMode":false,"reviewWorkflow":true,"singleProjectEnterprise":false,"star":false,"staging":false,"superHub":false,"apiDesigner":false,"superHubMigrationSelfServeFlow":false,"translation":false,"disableDiscussionSpamRecaptchaBypass":false},"fullBaseUrl":"https://feefo.readme.io/","git":{"sync":{"connectedRepository":{},"github":[]}},"glossaryTerms":[],"graphqlSchema":"","gracePeriod":{"enabled":false,"endsAt":null},"shouldGateDash":false,"hasOneChild":false,"healthCheck":{"provider":""},"intercom_secure_emailonly":false,"intercom":"zzfy861q","is_active":true,"internal":"","jwtExpirationTime":0,"landing_bottom":[{"type":"docs","alignment":"left","pageType":"Documentation"},{"type":"docs","alignment":"left","pageType":"Reference"}],"mdxMigrationStatus":"rdmd","metrics":{"monthlyLimit":0,"monthlyPurchaseLimit":0,"thumbsEnabled":true},"modules":{"landing":true,"docs":true,"examples":true,"reference":true,"graphql":false,"changelog":true,"discuss":false,"suggested_edits":true,"custompages":false,"tutorials":true},"name":"Feefo","nav_names":{"docs":"","reference":"","changelog":"","discuss":"","recipes":"","tutorials":""},"oauth_url":"","onboardingCompleted":{"api":true,"appearance":true,"documentation":true,"domain":true,"jwt":true,"logs":false,"metricsSDK":true},"owlbot":{"copilot":{"enabled":false,"hasBeenUsed":false,"installedCustomPage":""},"customization":{"tone":"neutral","customTone":"","answerLength":"long","forbiddenWords":"","defaultAnswer":""},"enabled":false,"isPaying":false},"owner":{"id":"56d59d94f612b80b00fb69a5","email":"steve@feefo.com","name":"Steve Powell"},"plan":"business","planOverride":"business","planSchedule":{"stripeScheduleId":null,"changeDate":null,"nextPlan":null},"planStatus":"active","planTrial":"business","readmeScore":{"components":{"newDesign":{"enabled":true,"points":25},"reference":{"enabled":true,"points":50},"tryItNow":{"enabled":true,"points":35},"syncingOAS":{"enabled":false,"points":10},"customLogin":{"enabled":false,"points":25},"metrics":{"enabled":false,"points":40},"recipes":{"enabled":true,"points":15},"pageVoting":{"enabled":true,"points":1},"suggestedEdits":{"enabled":false,"points":10},"support":{"enabled":true,"points":5},"htmlLanding":{"enabled":false,"points":5},"guides":{"enabled":true,"points":10},"changelog":{"enabled":true,"points":5},"glossary":{"enabled":false,"points":1},"variables":{"enabled":false,"points":1},"integrations":{"enabled":true,"points":2}},"totalScore":148},"reCaptchaSiteKey":"","reference":{"alwaysUseDefaults":true,"defaultExpandResponseExample":true,"defaultExpandResponseSchema":true,"enableOAuthFlows":false},"seo":{"overwrite_title_tag":false},"stable":{"version":"2.0","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["56d59dbff612b80b00fb69ab","56d5a28ac8c687150071f0e8","56d811e37a04df0b00ddf00d","6376bc8c127d99000313bf86","64ccfc0d6bcd390052462445","64ccfeb975e28e0046189243","65e8695b5d430c004d9dfb4f","65e872b54a57c2001f2c249b","65e87d576608e60011e36525","65e87d8a635bb000180122b9","65e891b45d430c004d9e7e90","65e89212495dd0002be76ad7","65e8924d7bd9d9001bba1021","65e8925ddf8d5f005863411d","65e892634d97af005abc968d","65e8926d1c491800575585bf","65e89307d046d10030fa2a1c","65e8974500881e0012c1867d","65e89c015c54b500479e189b","65e97d7c36776a00307387f3","65e97e9646e21d002e6a654b","65e97fba46e21d002e6a65d5"],"pdfStatus":"","_id":"56d59dbff612b80b00fb69aa","__v":3,"project":"56d59dbef612b80b00fb69a7","releaseDate":"2016-03-01T13:48:47.363Z","createdAt":"2016-03-01T13:48:47.363Z","updatedAt":"2024-03-07T08:50:02.831Z"},"subdomain":"feefo","subpath":"","superHubWaitlist":false,"topnav":{"left":[{"type":"search"},{"type":"reference"},{"type":"url","text":"Support","url":"https://support.feefo.com"}],"right":[{"type":"user"}],"bottom":[],"edited":true},"trial":{"trialDeadlineEnabled":false,"trialEndsAt":"2021-12-02T00:31:50.338Z"},"translate":{"provider":"transifex","show_widget":false,"key_public":"","org_name":"","project_name":"","languages":[]},"url":"https://www.feefo.com","versions":[{"version":"2.0","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"pdfStatus":"","_id":"56d59dbff612b80b00fb69aa","releaseDate":"2016-03-01T13:48:47.363Z"}],"variableDefaults":[],"webhookEnabled":false},"version":{"version":"2.0","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["56d59dbff612b80b00fb69ab","56d5a28ac8c687150071f0e8","56d811e37a04df0b00ddf00d","6376bc8c127d99000313bf86","64ccfc0d6bcd390052462445","64ccfeb975e28e0046189243","65e8695b5d430c004d9dfb4f","65e872b54a57c2001f2c249b","65e87d576608e60011e36525","65e87d8a635bb000180122b9","65e891b45d430c004d9e7e90","65e89212495dd0002be76ad7","65e8924d7bd9d9001bba1021","65e8925ddf8d5f005863411d","65e892634d97af005abc968d","65e8926d1c491800575585bf","65e89307d046d10030fa2a1c","65e8974500881e0012c1867d","65e89c015c54b500479e189b","65e97d7c36776a00307387f3","65e97e9646e21d002e6a654b","65e97fba46e21d002e6a65d5"],"pdfStatus":"","_id":"56d59dbff612b80b00fb69aa","__v":3,"project":"56d59dbef612b80b00fb69a7","releaseDate":"2016-03-01T13:48:47.363Z","createdAt":"2016-03-01T13:48:47.363Z","updatedAt":"2024-03-07T08:50:02.831Z"}},"apiBaseUrl":"/","config":{"algoliaIndex":"readme_search_v2","amplitude":{"apiKey":"dc8065a65ef83d6ad23e37aaf014fc84","enabled":true},"asset_url":"https://cdn.readme.io","domain":"readme.io","domainFull":"https://dash.readme.com","encryptedLocalStorageKey":"ekfls-2024-05","fullstory":{"enabled":true,"orgId":"FSV9A"},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.246.0","sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true,"tracesSampleRate":0},"shMigration":{"promoVideo":"https://www.youtube.com/embed/CIhJ1uWyLhk?si=qEeH4oqdT_ncz10p&start=300","forceWaitlist":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}},"location":"/to/feefo?redirect=%2F%2F","isOnboardingRoute":false,"shMigrationLock":false}"></script></div><div id="dashReact"><div class="App ThemeContext ThemeContext_dark " style="--color-primary:#333388;--color-primary-inverse:#fff;--color-primary-alt:#161659;--color-primary-darken-10:#252563;--color-primary-darken-20:#17173e;--color-primary-alpha-25:rgba(51, 51, 136, 0.25);--color-link-primary:#333388;--color-link-primary-darken-5:#2c2c75;--color-link-primary-darken-10:#252563;--color-link-primary-darken-20:#17173e;--color-link-primary-alpha-50:rgba(51, 51, 136, 0.5);--color-link-primary-alpha-25:rgba(51, 51, 136, 0.25);--color-link-background:rgba(51, 51, 136, 0.09);--color-link-text:#fff;--color-login-link:#018ef5;--color-login-link-text:#fff;--color-login-link-darken-10:#0171c2;--color-login-link-primary-alpha-50:rgba(1, 142, 245, 0.5)"></div><div class="ModalWrapper" id="modal-target"></div></div><div id="dashReact-end"><script id="__LOADABLE_REQUIRED_CHUNKS__" type="application/json">[3766,7397,4241,7672,4772,6651,7436,9355,7449,74,9503,8993,8742,3460,9723,7196,9575,2310]</script><script id="__LOADABLE_REQUIRED_CHUNKS___ext" type="application/json">{"namedChunks":["routes-Dash-Onboarding","core-icons-arrow-right-svg","core-icons-upload-svg"]}</script> <script async data-chunk="main" src="/public/dash/web/main.c0776c790d1f0d346e03.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/3766.5b33aec47565911e9ac6.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/7397.113781fd2f766bf29b1f.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/4241.8f70a87077f703b6e567.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/7672.b15199bc5637e5078c79.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/4772.3d5273c326fd08aad7f9.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/6651.45fe9e34f086e2e558a1.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/7436.42f081c3e0533b19adc6.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/9355.a266f6393358a73bd778.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/7449.8f1c293d3bb2ff027872.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/74.7e46ff08b9929e95159b.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/9503.e0ec95bcb299b55bd0f1.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/8993.769cf94cf07610467b08.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/8742.aa20e35679b26c7f5e77.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/3460.484efd4e741825dcf249.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/9723.d86d4fcc5bf11bab70e4.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/routes-Dash-Onboarding.23ba7ce891c116c69437.js"></script> <script async data-chunk="core-icons-arrow-right-svg" src="/public/dash/web/core-icons-arrow-right-svg.33683bb9528fcbb0553f.js"></script> <script async data-chunk="core-icons-upload-svg" src="/public/dash/web/core-icons-upload-svg.97db1bf07878f1e70221.js"></script></div></body><script>var is_hub = false; var is_hub_edit = false; var is_hub2 = false; </script><script src="https://cdn.readme.io/public/js/bundle-dash.js?1734018047721"></script></html>