This is the ONLY field that a merchant needs to use to make decision on fraud. This field is set by our rules and the main rule is the rule using our "customer score" model.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Sardine Payments","colors":{"primary":"#2D29D7","light":"#A09EED","dark":"#2D29D7"},"favicon":"https://mintcdn.com/sardine-payments/xaOaWQltc1g9zE_Z/favicon.svg?fit=max\u0026auto=format\u0026n=xaOaWQltc1g9zE_Z\u0026q=85\u0026s=fed6c9309f39bc0ac5929a9ba82977fa","logo":{"light":"https://mintcdn.com/sardine-payments/xaOaWQltc1g9zE_Z/logo/light.svg?fit=max\u0026auto=format\u0026n=xaOaWQltc1g9zE_Z\u0026q=85\u0026s=0f19e6244a4ae82cd0f46baf0fe1fe76","dark":"https://mintcdn.com/sardine-payments/xaOaWQltc1g9zE_Z/logo/dark.svg?fit=max\u0026auto=format\u0026n=xaOaWQltc1g9zE_Z\u0026q=85\u0026s=50ef9fd772da513ce447cc0ea28a85c6"},"appearance":{"default":"light","strict":null},"background":{"decoration":null,"color":{"light":null,"dark":"#0B0C0E"}},"navbar":{"primary":{"type":"button","label":"Get Started","href":"https://www.sardine.ai/contact"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Security Portal","href":"https://security.sardine.ai","icon":{"name":"shield-halved","style":"light"}},{"anchor":"Contact Us","href":"https://www.sardine.ai/contact","icon":{"name":"envelope","style":"light"}}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"sardine-payments","hasAudioNarration":false,"actualSubdomain":"sardine-payments","customDomains":["docs.payments.sardine.ai"],"gitSource":{"type":"github","owner":"sardine-ai","repo":"payment-doc","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a7f5f2ff52eb3400ddd6800","collectionId":"e8cafca8-631a-4c66-910f-2660fbf04056","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6a7f5f2ff52eb3400ddd6800"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6a7f5f2ff52eb3400ddd6800:success","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"Integration Guides","count":16},{"language":"default","tag":"API Reference (Onramp/Offramp)","count":16},{"language":"default","tag":"API Reference (NFT)","count":15},{"language":"default","tag":"Getting Started","count":11},{"language":"default","tag":"API Reference","count":8},{"language":"default","tag":"Coverage","count":7},{"language":"default","tag":"On/Off Ramps","count":7},{"language":"default","tag":"Payment Method","count":5},{"language":"default","tag":"Identity","count":4},{"language":"default","tag":"Products","count":4}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api_reference/onramp/user-onboarding/get-customers","slug":"/api_reference/onramp/user-onboarding/get-customers","pageMetadata":{"title":"Get Customers","description":"Fetches list of all customers. Can be filtered by passing `customerId`","deprecated":null,"version":null,"openapi":"/api_reference/onramp.yaml get /customers","href":"/api_reference/onramp/user-onboarding/get-customers","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Fetches list of all customers. Can be filtered by passing \", _jsx(_components.code, {\n children: \"customerId\"\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get Customers","description":"Fetches list of all customers. Can be filtered by passing `customerId`","deprecated":null,"version":null,"openapi":"/api_reference/onramp.yaml get /customers","href":"/api_reference/onramp/user-onboarding/get-customers","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["User Onboarding"],"summary":"Get Customers","description":"Fetches list of all customers. Can be filtered by passing `customerId`","operationId":"get-customers","parameters":["fe24ea2f-b6b3-466f-8226-bccb375959fc"],"responses":{"200":"b9bb9770-d0b5-4620-9bff-290a1e95aeb9"},"security":["d04a3723-295b-4c1f-8eec-a40a9c51da65"],"servers":["a3492086-1d4c-4f3f-bce3-1a55c1e956b0","d7b960ad-f2fe-48d2-a78c-4734ad7b61ad"],"x-internal":true,"x-stoplight":{"id":"v1djgmo1t2c00"},"method":"get","type":"path","path":"/customers","baseUrlOptions":["https://api.sandbox.sardine.ai/v1","https://api.sardine.ai/v1"],"title":"Get Customers","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"fe24ea2f-b6b3-466f-8226-bccb375959fc":{"name":"customer_id","in":"query","description":"ID of Customer","schema":{"type":"string","description":"ID of Customer","uniqueKey":"","typeLabel":"string"}}},"responses":{"b9bb9770-d0b5-4620-9bff-290a1e95aeb9":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","title":"Customer","properties":{"sessionKey":{"type":"string","minLength":1,"uniqueKey":"items.[INDEX].sessionKey","typeLabel":"string"},"level":{"type":"string","enum":["low","medium","high","very_high"],"description":"This is the ONLY field that a merchant needs to use to make decision on fraud. This field is set by our rules and the main rule is the rule using our \"customer score\" model.","minLength":1,"uniqueKey":"items.[INDEX].level","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["Success","Failure"],"minLength":1,"uniqueKey":"items.[INDEX].status","typeLabel":"enum\u003cstring>"},"customer":{"type":"object","properties":{"score":{"type":"number","description":"ML Risk Score for the current customer session. The ML model used to predict the score is trained on velocity and aggregation features, phone, email, bank, tax, card, IP, location, device and behavior intelligence signals. The score can be used once feedback for historical transactions has been provided.","uniqueKey":"items.[INDEX].customer.score","typeLabel":"number"},"level":{"type":"string","enum":["low","medium","high","very_high"],"description":"This field is based on the signals sent in the response.","minLength":1,"uniqueKey":"items.[INDEX].customer.level","typeLabel":"enum\u003cstring>"},"signals":{"type":"array","description":"See https://docs.sardine.ai/api/reference/operation/v1-customers/","minItems":1,"uniqueItems":true,"items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"uniqueKey":"items.[INDEX].customer.signals.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","minLength":1,"uniqueKey":"items.[INDEX].customer.signals.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"items.[INDEX].customer.signals.items.[INDEX]","typeLabel":"object"},"uniqueKey":"items.[INDEX].customer.signals","typeLabel":"object[]"}},"uniqueKey":"items.[INDEX].customer","typeLabel":"object"},"transaction":{"type":"object","properties":{"level":{"type":"string","enum":["low","medium","high"],"description":"transaction risk level","minLength":1,"uniqueKey":"items.[INDEX].transaction.level","typeLabel":"enum\u003cstring>"},"amlLevel":{"type":"string","enum":["low","medium","high"],"description":"aml risk level","minLength":1,"uniqueKey":"items.[INDEX].transaction.amlLevel","typeLabel":"enum\u003cstring>"},"indemnification":{"type":"object","properties":{"decision":{"type":"string","enum":["approved","conditionally_approved","rejected","unknown"],"minLength":1,"uniqueKey":"items.[INDEX].transaction.indemnification.decision","typeLabel":"enum\u003cstring>"},"instantLimit":{"type":"number","description":"This is the withdrawal amount in cents that is immediately available to the end-user. The remaining hold amount should be kept on hold on your side until the time specified by holdTime parameter below.","uniqueKey":"items.[INDEX].transaction.indemnification.instantLimit","typeLabel":"number"},"holdAmount":{"type":"number","description":"This is the remaining amount in cents that is available after the hold time is over. The hold time + instantLimit is the total deposit amount.","uniqueKey":"items.[INDEX].transaction.indemnification.holdAmount","typeLabel":"number"},"verificationCode":{"type":"string","minLength":1,"uniqueKey":"items.[INDEX].transaction.indemnification.verificationCode","typeLabel":"string"},"holdTime":{"type":"string","description":"UNIX timestamp that represents time until you which should hold part of fund","format":"time","uniqueKey":"items.[INDEX].transaction.indemnification.holdTime","typeLabel":"string\u003ctime>"}},"uniqueKey":"items.[INDEX].transaction.indemnification","typeLabel":"object"}},"uniqueKey":"items.[INDEX].transaction","typeLabel":"object"}},"x-examples":{"example-1":{"sessionKey":"string","level":"string","status":"string","customer":{"score":0,"level":"string","signals":[{"key":"string","value":"string"}]},"transaction":{"level":"string","amlLevel":"string","indemnification":{"decision":"string","instantLimit":0,"holdAmount":0,"verificationCode":"string"}},"checkpoints":{"customer":{"customerPurchaseLevel":{"value":"string","ruleIds":[{}]},"emailLevel":{"value":"string","ruleIds":[{}]},"historicalLevel":{"value":"string","ruleIds":[{}]},"riskLevel":{"value":"string","ruleIds":[{}]}}}}},"uniqueKey":"items.[INDEX]","typeLabel":"Customer · object"},"uniqueKey":"","typeLabel":"Customer · object[]"},"examples":{"Example":{"title":"Example","value":[{"sessionKey":"\u003cstring>","level":"low","status":"Success","customer":{"score":123,"level":"low","signals":[{"key":"\u003cstring>","value":"\u003cstring>"}]},"transaction":{"level":"low","amlLevel":"low","indemnification":{"decision":"approved","instantLimit":123,"holdAmount":123,"verificationCode":"\u003cstring>","holdTime":"\u003cstring>"}}}]}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"d04a3723-295b-4c1f-8eec-a40a9c51da65":{"ClientToken":{"type":"http","scheme":"basic","scopes":[]}}},"servers":{"a3492086-1d4c-4f3f-bce3-1a55c1e956b0":{"url":"https://api.sandbox.sardine.ai/v1","description":"Sandbox"},"d7b960ad-f2fe-48d2-a78c-4734ad7b61ad":{"url":"https://api.sardine.ai/v1","description":"Prod Server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"basic","scopes":[]},"schema":{"title":"Basic Auth","type":"object","description":"Basic authentication header of the form `Basic \u003cencoded-value>`, where `\u003cencoded-value>` is the base64-encoded string `username:password`.","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"ClientToken","name":"Authorization"}],"title":"ClientToken"}]},"originalFileLocation":"api_reference/onramp.yaml"},"subdomain":"sardine-payments","siteName":"Sardine Payments","title":"Get Customers - Sardine Payments","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"api_reference/onramp/user-onboarding/get-customers.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Fetches list of all customers. Can be filtered by passing customerId\">\u003cmeta data-mint-head name=\"application-name\" content=\"Sardine Payments\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sardine-payments/cONXdfsFZR7DqgZ5/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/sardine-payments/cONXdfsFZR7DqgZ5/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sardine-payments/cONXdfsFZR7DqgZ5/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/sardine-payments/cONXdfsFZR7DqgZ5/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/sardine-payments/cONXdfsFZR7DqgZ5/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sardine-payments/cONXdfsFZR7DqgZ5/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sardine-payments/cONXdfsFZR7DqgZ5/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/sardine-payments/cONXdfsFZR7DqgZ5/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/sardine-payments/cONXdfsFZR7DqgZ5/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Customers - Sardine Payments\">\u003cmeta data-mint-head property=\"og:description\" content=\"Fetches list of all customers. Can be filtered by passing customerId\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Sardine Payments\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.payments.sardine.ai/api_reference/onramp/user-onboarding/get-customers\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://sardine-payments.mintlify.app/_mintlify/api/og/v2?division=User+Onboarding\u0026amp;title=Get+Customers\u0026amp;description=Fetches+list+of+all+customers.+Can+be+filtered+by+passing+%60customerId%60\u0026amp;theme=afc8939af6e2d78a57ff9fb2\u0026amp;signature=cd2300df2f55a94ccd17aef421910041a2b9809feb22d9e1c5fec074f77d130d\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get Customers - Sardine Payments\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Fetches list of all customers. Can be filtered by passing customerId\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://sardine-payments.mintlify.app/_mintlify/api/og/v2?division=User+Onboarding\u0026amp;title=Get+Customers\u0026amp;description=Fetches+list+of+all+customers.+Can+be+filtered+by+passing+%60customerId%60\u0026amp;theme=afc8939af6e2d78a57ff9fb2\u0026amp;signature=cd2300df2f55a94ccd17aef421910041a2b9809feb22d9e1c5fec074f77d130d\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/sardine-payments/cONXdfsFZR7DqgZ5/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Sardine Payments\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2D29D7\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.payments.sardine.ai/api_reference/onramp/user-onboarding/get-customers\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api_reference/onramp/user-onboarding/get-customers.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.payments.sardine.ai/#organization\",\"name\":\"Sardine Payments\",\"url\":\"https://docs.payments.sardine.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/sardine-payments/xaOaWQltc1g9zE_Z/logo/light.svg?fit=max\u0026auto=format\u0026n=xaOaWQltc1g9zE_Z\u0026q=85\u0026s=0f19e6244a4ae82cd0f46baf0fe1fe76\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.payments.sardine.ai#website\",\"name\":\"Sardine Payments\",\"url\":\"https://docs.payments.sardine.ai\",\"publisher\":{\"@id\":\"https://docs.payments.sardine.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.payments.sardine.ai/api_reference/onramp/user-onboarding/get-customers#webpage\",\"url\":\"https://docs.payments.sardine.ai/api_reference/onramp/user-onboarding/get-customers\",\"name\":\"Get Customers\",\"description\":\"Fetches list of all customers. Can be filtered by passing customerId\",\"isPartOf\":{\"@id\":\"https://docs.payments.sardine.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.payments.sardine.ai/api_reference/onramp/user-onboarding/get-customers#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.payments.sardine.ai/api_reference/onramp/user-onboarding/get-customers#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"User Onboarding\",\"item\":\"https://docs.payments.sardine.ai/api_reference/onramp/user-onboarding/get-client-token\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Customers\",\"item\":\"https://docs.payments.sardine.ai/api_reference/onramp/user-onboarding/get-customers\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.payments.sardine.ai/api_reference/onramp/user-onboarding/get-customers#apireference\",\"headline\":\"Get Customers\",\"name\":\"Get Customers\",\"description\":\"Fetches list of all customers. Can be filtered by passing customerId\",\"url\":\"https://docs.payments.sardine.ai/api_reference/onramp/user-onboarding/get-customers\",\"mainEntityOfPage\":{\"@id\":\"https://docs.payments.sardine.ai/api_reference/onramp/user-onboarding/get-customers#webpage\"},\"publisher\":{\"@id\":\"https://docs.payments.sardine.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.payments.sardine.ai#website\"}}]}\u003c/script>","siteName":"Sardine Payments","nav":{"global":{"anchors":[{"anchor":"Security Portal","href":"https://security.sardine.ai","icon":{"name":"shield-halved","style":"light"}},{"anchor":"Contact Us","href":"https://www.sardine.ai/contact","icon":{"name":"envelope","style":"light"}}]},"tabs":[{"tab":"Getting Started","pages":[{"title":"Getting Started","href":"/overview/intro"}]},{"tab":"Integration Guides","pages":[{"title":"Integration Guides","href":"/integration_guides/onboarding_and_testing/client_onboarding"}]},{"tab":"API Reference (Onramp/Offramp)","groups":[{"group":"User Onboarding","pages":[{"title":"Get Client Token","description":"Exchange your `clientId` and `clientSecret` for a `clientToken` that can be be used in frontend code. `clientToken` will be unusable after the `expiresAt` time, which will normally be after 30 min. \n\n\nTo try the request in the mock server on the right, substitute username for clientId and password for clientSecret. \n\nIf `reference_id` is passed, it will be passed to the Order object upon when the transaction happens. It can then be used as a filter in the /orders endpoint","deprecated":null,"version":null,"openapi":"/api_reference/onramp.yaml post /auth/client-tokens","href":"/api_reference/onramp/user-onboarding/get-client-token"},{"title":"Get Customers","deprecated":null,"version":null,"openapi":"/api_reference/onramp.yaml get /customers","href":"/api_reference/onramp/user-onboarding/get-customers"},{"title":"Post Customer Information","description":"Send User information to Sardine to store theie information and create a risk profile","deprecated":null,"version":null,"openapi":"/api_reference/onramp.yaml post /customers","href":"/api_reference/onramp/user-onboarding/post-customer-information"},{"title":"Get KYC Widget URL","deprecated":null,"version":null,"openapi":"/api_reference/onramp.yaml get /kyc/widgetUrl","href":"/api_reference/onramp/user-onboarding/get-kyc-widget-url"}]},{"group":"Quote","pages":[{"title":"Get Quote","deprecated":null,"version":null,"openapi":"/api_reference/onramp.yaml get /quotes","href":"/api_reference/onramp/quote/get-quote"}]},{"group":"Coverage","pages":[{"title":"Get Supported Tokens","deprecated":null,"version":null,"openapi":"/api_reference/onramp.yaml get /supported-tokens","href":"/api_reference/onramp/coverage/get-supported-tokens"},{"title":"Get Enabled Tokens","deprecated":null,"version":null,"openapi":"/api_reference/onramp.yaml get /enabled-tokens","href":"/api_reference/onramp/coverage/get-enabled-tokens"},{"title":"Get Geocoverage","deprecated":null,"version":null,"openapi":"/api_reference/onramp.yaml get /geo-coverage","href":"/api_reference/onramp/coverage/get-geocoverage"},{"title":"Get Fiat Currencies","deprecated":null,"version":null,"openapi":"/api_reference/onramp.yaml get /fiat-currencies","href":"/api_reference/onramp/coverage/get-fiat-currencies"}]},{"group":"Payment Method","pages":[{"title":"Get Payment Method information","deprecated":null,"version":null,"openapi":"/api_reference/onramp.yaml get /payment-methods","href":"/api_reference/onramp/payment-method/get-payment-method-information"},{"title":"Get Add Fiat Account Widget URL","deprecated":null,"version":null,"openapi":"/api_reference/onramp.yaml get /payment-methods/widgetUrl","href":"/api_reference/onramp/payment-method/get-add-fiat-account-widget-url"}]},{"group":"Order","pages":[{"title":"Get an Order by ID","deprecated":null,"version":null,"openapi":"/api_reference/onramp.yaml get /orders/{orderId}","href":"/api_reference/onramp/order/get-an-order-by-id"},{"title":"Get User Orders","deprecated":null,"version":null,"openapi":"/api_reference/onramp.yaml get /orders","href":"/api_reference/onramp/order/get-user-orders"}]},{"group":"Support","pages":[{"title":"Create Support Ticket","deprecated":null,"version":null,"openapi":"/api_reference/onramp.yaml post /supportTickets","href":"/api_reference/onramp/support/create-support-ticket"}]},{"group":"Order Execution","pages":[{"title":"Create Onramp Order","deprecated":null,"version":null,"openapi":"/api_reference/onramp.yaml post /onramp","href":"/api_reference/onramp/order-execution/create-onramp-order"},{"title":"Create Offramp Order","deprecated":null,"version":null,"openapi":"/api_reference/onramp.yaml post /offramp","href":"/api_reference/onramp/order-execution/create-offramp-order"}]}]},{"tab":"API Reference (NFT)","pages":[{"title":"API Reference (NFT)","href":"/api_reference/nft/post-client-token"}]},{"tab":"API Reference (Identity)","pages":[{"title":"API Reference (Identity)","href":"/api_reference/identity/customer-management/create-customer"}]}]},"basePath":"","title":"Get Customers - Sardine Payments","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}