{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Finogates API Documentation","colors":{"primary":"#0161EF","light":"#005FC8","dark":"#0161EF"},"logo":{"light":"https://mintcdn.com/finogates/XLUrxtJNLX8DNeIV/assets/logo/app-logo-dark.png?fit=max\u0026auto=format\u0026n=XLUrxtJNLX8DNeIV\u0026q=85\u0026s=e00390491535714f472eb3e4ec1edc84","dark":"https://mintcdn.com/finogates/XLUrxtJNLX8DNeIV/assets/logo/app-logo-light.png?fit=max\u0026auto=format\u0026n=XLUrxtJNLX8DNeIV\u0026q=85\u0026s=d3498e69f2963f42bbc431b5152a7906"},"favicon":"https://mintcdn.com/finogates/XLUrxtJNLX8DNeIV/favicon.ico?fit=max\u0026auto=format\u0026n=XLUrxtJNLX8DNeIV\u0026q=85\u0026s=5b975369622b0e780220864a3af0bd91","api":{"openapi":{"source":"https://api-sandbox.fg.wintpay.com/openapi-v1-platform.json","directory":"api-reference"}},"navbar":{"links":[{"href":"mailto:support@finogates.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.finogates.com"}},"seo":{"indexing":"all"},"fonts":{"family":"Inter","weight":400},"styling":{"eyebrows":"breadcrumbs","latex":false},"interaction":{"drilldown":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"finogates","hasAudioNarration":false,"actualSubdomain":"finogates","customDomains":["developer.finogates.com"],"gitSource":{"type":"github","owner":"paywint-developer","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6acdb33161144972c6aff215","collectionId":"071256f1-4b56-436f-b45e-c00a7f1caceb","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6acdb33161144972c6aff215"},"entitlements":{},"buildId":"6acdb33161144972c6aff215","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API Reference","count":172},{"language":"default","tag":"Payees","count":18},{"language":"default","tag":"Phone Numbers","count":18},{"language":"default","tag":"Webhooks","count":16},{"language":"default","tag":"Card Processing","count":15},{"language":"default","tag":"Wallets","count":14},{"language":"default","tag":"Bank Accounts","count":13},{"language":"default","tag":"Verification","count":13},{"language":"default","tag":"Digital Assets","count":9},{"language":"default","tag":"International","count":9}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/users/list-users","slug":"/api-reference/users/list-users","pageMetadata":{"title":"List Users","openapi":"GET /v1/platform/users","description":"Get the list of users (your customers) on your platform.\n\nThe newest users appear first, and the list is split into pages.","href":"/api-reference/users/list-users"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Get the list of users (your customers) on your platform.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"The newest users appear first, and the list is split into pages.\"\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":"List Users","openapi":"GET /v1/platform/users","description":"Get the list of users (your customers) on your platform.\n\nThe newest users appear first, and the list is split into pages.","href":"/api-reference/users/list-users"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["users"],"summary":"List Users","description":"Get the list of users (your customers) on your platform.\n\nThe newest users appear first, and the list is split into pages.","operationId":"list_users_v1_platform_users_get","security":["344f59d6-f33c-4e94-a6ab-2d566a7c55ad"],"parameters":["b7337954-3177-4493-8e4e-cef2d98bf301","ff99ea3c-1fa2-474b-9a15-7cb43fc15a3e"],"responses":{"200":"d06d16e6-aaeb-445d-adbf-0847b9a8eee9","422":"e7996ba5-216e-4805-b5d2-c7eee9b5fc9a"},"method":"get","type":"path","servers":["e8e3d206-dddf-4b3a-8686-a8bb8fdad22b","63fefe2c-7a97-42af-996c-e46a872cdae6"],"path":"/v1/platform/users","baseUrlOptions":["https://api-sandbox.finogates.com","https://api.finogates.com"],"title":"List Users","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"b7337954-3177-4493-8e4e-cef2d98bf301":{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"How many users to return per page (1 to 200).","examples":[50],"default":50,"title":"Limit","isRequired":false,"uniqueKey":"","typeLabel":"integer"},"description":"How many users to return per page (1 to 200)."},"ff99ea3c-1fa2-474b-9a15-7cb43fc15a3e":{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"How many users to skip before this page starts.","examples":[0],"default":0,"title":"Offset","isRequired":false,"uniqueKey":"","typeLabel":"integer"},"description":"How many users to skip before this page starts."}},"responses":{"d06d16e6-aaeb-445d-adbf-0847b9a8eee9":{"description":"A page of users.","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer","title":"Status Code","description":"HTTP status code for the response.","isRequired":true,"uniqueKey":"status_code","typeLabel":"integer"},"data":{"items":{"properties":{"user_id":{"type":"string","format":"uuid","title":"User Id","description":"Unique user identifier (UUID).","examples":["b3a9b622-cc63-4d3c-aad6-2d8e29e6f9d4"],"isRequired":true,"uniqueKey":"data.items.[INDEX].user_id","typeLabel":"string\u003cuuid>"},"email":{"type":"string","title":"Email","description":"User's email address.","examples":["john.doe@example.com"],"isRequired":true,"uniqueKey":"data.items.[INDEX].email","typeLabel":"string"},"is_active":{"type":"boolean","title":"Is Active","description":"Whether the user account is active.","examples":[true],"isRequired":true,"uniqueKey":"data.items.[INDEX].is_active","typeLabel":"boolean"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Account creation timestamp (UTC).","examples":["2025-06-10T18:10:42.000Z"],"isRequired":true,"uniqueKey":"data.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"first_name":{"oneOf":[{"type":"string","title":"First Name","description":"User's given name.","example":"John","uniqueKey":"data.items.[INDEX].first_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"First Name","description":"User's given name.","example":"John","uniqueKey":"data.items.[INDEX].first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","title":"Last Name","description":"User's family name.","example":"Doe","uniqueKey":"data.items.[INDEX].last_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Last Name","description":"User's family name.","example":"Doe","uniqueKey":"data.items.[INDEX].last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].last_name","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","title":"Name","description":"Display name — the business name for a business, otherwise the combined given + family name.","example":"John Doe","uniqueKey":"data.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","description":"Display name — the business name for a business, otherwise the combined given + family name.","example":"John Doe","uniqueKey":"data.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].name","typeLabel":"string | null"},"is_business_user":{"type":"boolean","title":"Is Business User","description":"Whether this user is a business/organization rather than an individual.","default":false,"examples":[false],"uniqueKey":"data.items.[INDEX].is_business_user","typeLabel":"boolean"},"business_name":{"oneOf":[{"type":"string","title":"Business Name","description":"Organization name — populated for a business, null for an individual.","example":null,"uniqueKey":"data.items.[INDEX].business_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Business Name","description":"Organization name — populated for a business, null for an individual.","example":null,"uniqueKey":"data.items.[INDEX].business_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].business_name","typeLabel":"string | null"},"kyc_status":{"oneOf":[{"type":"integer","title":"Kyc Status","description":"This user's own KYC status — a ``ComplianceCheckStatus`` code (1=pending, 2=in_review, 3=approved, 4=rejected). For the tenant's master user this is the platform's tenant-scope status; for an end user it is their individual verification. Null if no KYC check exists yet.","uniqueKey":"data.items.[INDEX].kyc_status.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Kyc Status","description":"This user's own KYC status — a ``ComplianceCheckStatus`` code (1=pending, 2=in_review, 3=approved, 4=rejected). For the tenant's master user this is the platform's tenant-scope status; for an end user it is their individual verification. Null if no KYC check exists yet.","uniqueKey":"data.items.[INDEX].kyc_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].kyc_status","typeLabel":"integer | null"},"kyb_status":{"oneOf":[{"type":"integer","title":"Kyb Status","description":"This user's own KYB status — a ``ComplianceCheckStatus`` code (1=pending, 2=in_review, 3=approved, 4=rejected). For the tenant's master user this is the platform's governing (onboarding-linked) KYB; for an end user it is their individual business verification. Null if no KYB check exists yet.","uniqueKey":"data.items.[INDEX].kyb_status.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Kyb Status","description":"This user's own KYB status — a ``ComplianceCheckStatus`` code (1=pending, 2=in_review, 3=approved, 4=rejected). For the tenant's master user this is the platform's governing (onboarding-linked) KYB; for an end user it is their individual business verification. Null if no KYB check exists yet.","uniqueKey":"data.items.[INDEX].kyb_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].kyb_status","typeLabel":"integer | null"},"mailing_line_1":{"oneOf":[{"type":"string","title":"Mailing Line 1","description":"Sender mailing address printed on the shipper/FROM block of a mailed-document (USPS/FedEx) shipping label. Used in place of your platform's default collection address once every `mailing_*` field below — including `mailing_phone` — is set. Manage it with `PATCH /v1/platform/users/{user_id}/mailing-address`.","uniqueKey":"data.items.[INDEX].mailing_line_1.oneOf.0","typeLabel":"string"},{"type":"null","title":"Mailing Line 1","description":"Sender mailing address printed on the shipper/FROM block of a mailed-document (USPS/FedEx) shipping label. Used in place of your platform's default collection address once every `mailing_*` field below — including `mailing_phone` — is set. Manage it with `PATCH /v1/platform/users/{user_id}/mailing-address`.","uniqueKey":"data.items.[INDEX].mailing_line_1.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].mailing_line_1","typeLabel":"string | null"},"mailing_line_2":{"oneOf":[{"type":"string","title":"Mailing Line 2","uniqueKey":"data.items.[INDEX].mailing_line_2.oneOf.0","typeLabel":"string"},{"type":"null","title":"Mailing Line 2","uniqueKey":"data.items.[INDEX].mailing_line_2.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].mailing_line_2","typeLabel":"string | null"},"mailing_city":{"oneOf":[{"type":"string","title":"Mailing City","uniqueKey":"data.items.[INDEX].mailing_city.oneOf.0","typeLabel":"string"},{"type":"null","title":"Mailing City","uniqueKey":"data.items.[INDEX].mailing_city.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].mailing_city","typeLabel":"string | null"},"mailing_state":{"oneOf":[{"type":"string","title":"Mailing State","uniqueKey":"data.items.[INDEX].mailing_state.oneOf.0","typeLabel":"string"},{"type":"null","title":"Mailing State","uniqueKey":"data.items.[INDEX].mailing_state.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].mailing_state","typeLabel":"string | null"},"mailing_zip_code":{"oneOf":[{"type":"string","title":"Mailing Zip Code","uniqueKey":"data.items.[INDEX].mailing_zip_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Mailing Zip Code","uniqueKey":"data.items.[INDEX].mailing_zip_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].mailing_zip_code","typeLabel":"string | null"},"mailing_country":{"oneOf":[{"type":"string","title":"Mailing Country","description":"ISO 3166-1 alpha-2 country code, e.g. `US`.","uniqueKey":"data.items.[INDEX].mailing_country.oneOf.0","typeLabel":"string"},{"type":"null","title":"Mailing Country","description":"ISO 3166-1 alpha-2 country code, e.g. `US`.","uniqueKey":"data.items.[INDEX].mailing_country.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].mailing_country","typeLabel":"string | null"},"mailing_phone":{"oneOf":[{"type":"string","title":"Mailing Phone","uniqueKey":"data.items.[INDEX].mailing_phone.oneOf.0","typeLabel":"string"},{"type":"null","title":"Mailing Phone","uniqueKey":"data.items.[INDEX].mailing_phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].mailing_phone","typeLabel":"string | null"}},"type":"object","required":["user_id","email","is_active","created_at"],"title":"PlatformUserRead","description":"User representation returned by the platform API.\n\nOnly public fields are included — no ``internal_id``,\n``hashed_password``, or ``tenant_internal_id``.","uniqueKey":"data.items.[INDEX]","typeLabel":"PlatformUserRead · object"},"type":"array","title":"Data","description":"Payload or error details.","isRequired":true,"uniqueKey":"data","typeLabel":"PlatformUserRead · object[]"},"query_generated_time":{"type":"integer","title":"Query Generated Time","description":"UTC timestamp (milliseconds since epoch) when response was generated.","isRequired":true,"uniqueKey":"query_generated_time","typeLabel":"integer"},"row_count":{"type":"integer","minimum":0,"title":"Row Count","description":"Total rows matching the request filters (not just this page).","isRequired":true,"uniqueKey":"row_count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","title":"Limit","description":"Page size used for this response. Null for cursor-paginated endpoints.","minimum":1,"uniqueKey":"limit.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Limit","description":"Page size used for this response. Null for cursor-paginated endpoints.","uniqueKey":"limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"limit","typeLabel":"integer | null"},"current_page":{"oneOf":[{"type":"integer","title":"Current Page","description":"1-indexed page number for this response. Null for cursor-paginated endpoints.","minimum":1,"uniqueKey":"current_page.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Current Page","description":"1-indexed page number for this response. Null for cursor-paginated endpoints.","uniqueKey":"current_page.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_page","typeLabel":"integer | null"},"total_page_number":{"oneOf":[{"type":"integer","title":"Total Page Number","description":"Total number of pages given the current limit. Null for cursor-paginated endpoints.","minimum":0,"uniqueKey":"total_page_number.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Total Page Number","description":"Total number of pages given the current limit. Null for cursor-paginated endpoints.","uniqueKey":"total_page_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"total_page_number","typeLabel":"integer | null"},"next_cursor":{"oneOf":[{"type":"string","title":"Next Cursor","description":"Cursor for the next page, if available.","uniqueKey":"next_cursor.oneOf.0","typeLabel":"string"},{"type":"null","title":"Next Cursor","description":"Cursor for the next page, if available.","uniqueKey":"next_cursor.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_cursor","typeLabel":"string | null"}},"type":"object","required":["status_code","data","query_generated_time","row_count"],"title":"ListResponse[list[PlatformUserRead]]","uniqueKey":"","typeLabel":"ListResponse[list[PlatformUserRead]] · object"},"example":{"status_code":200,"data":[{"user_id":"b3a9b622-cc63-4d3c-aad6-2d8e29e6f9d4","name":"John Doe","email":"john.doe@example.com","is_active":true,"created_at":"2025-06-10T18:10:42.000Z"},{"user_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","name":"Jane Smith","email":"jane.smith@example.com","is_active":true,"created_at":"2025-06-09T09:21:05.000Z"}],"row_count":2,"limit":50,"current_page":1,"total_page_number":1,"query_generated_time":1712847600000},"examples":{"Example":{"title":"Example","value":{"status_code":200,"data":[{"user_id":"b3a9b622-cc63-4d3c-aad6-2d8e29e6f9d4","name":"John Doe","email":"john.doe@example.com","is_active":true,"created_at":"2025-06-10T18:10:42.000Z"},{"user_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","name":"Jane Smith","email":"jane.smith@example.com","is_active":true,"created_at":"2025-06-09T09:21:05.000Z"}],"row_count":2,"limit":50,"current_page":1,"total_page_number":1,"query_generated_time":1712847600000}}},"exampleType":"examples"}},"exampleType":"examples"},"e7996ba5-216e-4805-b5d2-c7eee9b5fc9a":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"344f59d6-f33c-4e94-a6ab-2d566a7c55ad":{"_AuthenticatedBearer":{"type":"oauth2","flows":{"password":{"scopes":{},"tokenUrl":"/v1/platform/auth/token"}},"scopes":[]}}},"servers":{"e8e3d206-dddf-4b3a-8686-a8bb8fdad22b":{"url":"https://api-sandbox.finogates.com","description":"Sandbox"},"63fefe2c-7a97-42af-996c-e46a872cdae6":{"url":"https://api.finogates.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"oauth2","flows":{"password":{"scopes":{},"tokenUrl":"/v1/platform/auth/token"}},"scopes":[]},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"The access token received from the authorization server in the OAuth 2.0 flow.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"_AuthenticatedBearer","name":"Authorization"}],"title":"_AuthenticatedBearer"}]},"originalFileLocation":"open-api-collection-test.json"},"subdomain":"finogates","siteName":"Finogates API Documentation","title":"List Users - Finogates API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-05-21T06:14:04.688Z","originalFileLocation":"api-reference/users/list-users.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=\"system\"}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=\"Get the list of users (your customers) on your platform. The newest users appear first, and the list is split into pages.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Finogates API Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/finogates/7bjhnGVQOX1B_t94/_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/finogates/7bjhnGVQOX1B_t94/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/finogates/7bjhnGVQOX1B_t94/_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/finogates/7bjhnGVQOX1B_t94/_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/finogates/7bjhnGVQOX1B_t94/_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/finogates/7bjhnGVQOX1B_t94/_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/finogates/7bjhnGVQOX1B_t94/_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/finogates/7bjhnGVQOX1B_t94/_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/finogates/7bjhnGVQOX1B_t94/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List Users - Finogates API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get the list of users (your customers) on your platform. The newest users appear first, and the list is split into pages.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Finogates API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.finogates.com/api-reference/users/list-users\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://finogates.mintlify.app/_mintlify/api/og/v2?division=Users\u0026amp;title=List+Users\u0026amp;description=Get+the+list+of+users+%28your+customers%29+on+your+platform.%0A%0AThe+newest+users+appear+first%2C+and+the+list+is+split+into+pages.\u0026amp;theme=2379e31403c31344a7ae4b20\u0026amp;signature=5cf308e0bed25d7770b158c88c968fca4de6ab0478af7b92e46ebab0ccd66d0d\">\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=\"List Users - Finogates API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get the list of users (your customers) on your platform. The newest users appear first, and the list is split into pages.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://finogates.mintlify.app/_mintlify/api/og/v2?division=Users\u0026amp;title=List+Users\u0026amp;description=Get+the+list+of+users+%28your+customers%29+on+your+platform.%0A%0AThe+newest+users+appear+first%2C+and+the+list+is+split+into+pages.\u0026amp;theme=2379e31403c31344a7ae4b20\u0026amp;signature=5cf308e0bed25d7770b158c88c968fca4de6ab0478af7b92e46ebab0ccd66d0d\">\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/finogates/7bjhnGVQOX1B_t94/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Finogates API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0161EF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.finogates.com/api-reference/users/list-users\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/users/list-users.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.finogates.com/#organization\",\"name\":\"Finogates API Documentation\",\"url\":\"https://developer.finogates.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/finogates/XLUrxtJNLX8DNeIV/assets/logo/app-logo-dark.png?fit=max\u0026auto=format\u0026n=XLUrxtJNLX8DNeIV\u0026q=85\u0026s=e00390491535714f472eb3e4ec1edc84\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.finogates.com#website\",\"name\":\"Finogates API Documentation\",\"url\":\"https://developer.finogates.com\",\"publisher\":{\"@id\":\"https://developer.finogates.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.finogates.com/api-reference/users/list-users#webpage\",\"url\":\"https://developer.finogates.com/api-reference/users/list-users\",\"name\":\"List Users\",\"description\":\"Get the list of users (your customers) on your platform. The newest users appear first, and the list is split into pages.\",\"dateModified\":\"2026-05-21T06:14:04.688Z\",\"isPartOf\":{\"@id\":\"https://developer.finogates.com#website\"},\"breadcrumb\":{\"@id\":\"https://developer.finogates.com/api-reference/users/list-users#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.finogates.com/api-reference/users/list-users#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Users\",\"item\":\"https://developer.finogates.com/api-reference/users/create-user\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List Users\",\"item\":\"https://developer.finogates.com/api-reference/users/list-users\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.finogates.com/api-reference/users/list-users#apireference\",\"headline\":\"List Users\",\"name\":\"List Users\",\"description\":\"Get the list of users (your customers) on your platform. The newest users appear first, and the list is split into pages.\",\"url\":\"https://developer.finogates.com/api-reference/users/list-users\",\"mainEntityOfPage\":{\"@id\":\"https://developer.finogates.com/api-reference/users/list-users#webpage\"},\"dateModified\":\"2026-05-21T06:14:04.688Z\",\"publisher\":{\"@id\":\"https://developer.finogates.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.finogates.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Finogates API Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Finogates API Documentation","nav":{"global":null,"tabs":[{"tab":"Get Started","icon":"rocket","pages":[{"title":"Get Started","href":"/get-started/overview"}]},{"tab":"API Reference","icon":"square-terminal","groups":[{"group":"Auth","expanded":false,"pages":[{"title":"Exchange Client Token","openapi":"POST /v1/platform/auth/token","href":"/api-reference/auth/exchange-client-token"}]},{"group":"Users","expanded":false,"pages":[{"title":"Create User","openapi":"POST /v1/platform/users","description":"Create a new user (one of your customers) on your platform.\n\nWhen the user is created, a primary wallet in US dollars (USD) is\nautomatically set up for them so they can hold and move funds. You can view\nor manage that wallet later through the wallets endpoints.\n\nA name is required, plus an `email`, a `phone`, or both. The phone is in\ninternational (E.164) format, e.g. `+15551234567`. Each must be unique across\nyour platform.\n\nSome features need an email on file. If one of them is refused because the\nuser has no email, add it with **Update a User's Details** and retry.","href":"/api-reference/users/create-user"},{"title":"List Users","openapi":"GET /v1/platform/users","href":"/api-reference/users/list-users"},{"title":"Get User","openapi":"GET /v1/platform/users/{user_id}","description":"Get the details of a single user, looked up by their unique ID.\n\nThe user must belong to your platform.","href":"/api-reference/users/get-user"},{"title":"Activate or Deactivate a User","openapi":"PATCH /v1/platform/users/{user_id}","href":"/api-reference/users/activate-or-deactivate-user"},{"title":"Delete a User","openapi":"DELETE /v1/platform/users/{user_id}","href":"/api-reference/users/deactivate-user"},{"title":"Update a User's Details","openapi":"PATCH /v1/platform/users/{user_id}/details","href":"/api-reference/users/update-user-details"},{"title":"Set a User's Mailing Address","openapi":"PATCH /v1/platform/users/{user_id}/mailing-address","href":"/api-reference/users/set-user-mailing-address"}]},{"group":"Payees","expanded":false,"pages":[{"title":"Create Payee","openapi":"POST /v1/platform/payees","href":"/api-reference/payees/create-payee"},{"title":"List Payees","openapi":"GET /v1/platform/payees","href":"/api-reference/payees/list-payees"},{"title":"Get Payee","openapi":"GET /v1/platform/payees/{payee_id}","href":"/api-reference/payees/get-payee"},{"title":"Update Payee","openapi":"PATCH /v1/platform/payees/{payee_id}","href":"/api-reference/payees/update-payee"},{"title":"Archive Payee","openapi":"DELETE /v1/platform/payees/{payee_id}","href":"/api-reference/payees/archive-payee"},{"title":"Add a Bank Account to a Payee","openapi":"POST /v1/platform/payees/bank-accounts/{payee_id}","href":"/api-reference/payees/create-destination"},{"title":"List a Payee's Bank Accounts","openapi":"GET /v1/platform/payees/bank-accounts/{payee_id}","href":"/api-reference/payees/list-destinations"},{"title":"Delete a Payee's Bank Account","openapi":"DELETE /v1/platform/payees/bank-accounts/{payee_id}/{bank_account_id}","href":"/api-reference/payees/revoke-destination"},{"title":"Set Up a Bank for ACH Payouts (removed)","openapi":"POST /v1/platform/payees/destinations/ach-push","href":"/api-reference/payees/set-up-a-bank-for-ach-payouts-removed"},{"title":"Get ACH push status","openapi":"GET /v1/platform/payees/destinations/ach-push","href":"/api-reference/payees/get-ach-push-status"},{"title":"Disable ACH push","openapi":"DELETE /v1/platform/payees/destinations/ach-push","href":"/api-reference/payees/disable-ach-push"},{"title":"Update a Payee's Bank Account","openapi":"PATCH /v1/platform/payees/bank-accounts/{payee_id}/{bank_account_id}","href":"/api-reference/payees/update-payee-bank-account"},{"title":"Reveal a Payee Bank Account's Full Numbers","openapi":"GET /v1/platform/payees/bank-accounts/{payee_id}/{bank_account_id}/reveal","href":"/api-reference/payees/reveal-payee-bank-account"},{"title":"Add an Address to a Payee","openapi":"POST /v1/platform/payees/addresses/{payee_id}","href":"/api-reference/payees/create-payee-address"},{"title":"List a Payee's Addresses","openapi":"GET /v1/platform/payees/addresses/{payee_id}","href":"/api-reference/payees/list-payee-addresses"},{"title":"Get One of a Payee's Addresses","openapi":"GET /v1/platform/payees/addresses/{payee_id}/{address_id}","href":"/api-reference/payees/get-payee-address"},{"title":"Update a Payee's Address","openapi":"PATCH /v1/platform/payees/addresses/{payee_id}/{address_id}","href":"/api-reference/payees/update-payee-address"},{"title":"Delete a Payee's Address","openapi":"DELETE /v1/platform/payees/addresses/{payee_id}/{address_id}","href":"/api-reference/payees/delete-payee-address"}]},{"group":"Verification","expanded":false,"pages":[{"title":"Get Platform Verification","openapi":"GET /v1/platform/me/verification","href":"/api-reference/verification/get-platform-verification"},{"title":"List KYC Records","openapi":"GET /v1/platform/kyc-records","href":"/api-reference/verification/list-kyc-records"},{"title":"List KYB Records","openapi":"GET /v1/platform/kyb-records","href":"/api-reference/verification/list-kyb-records"},{"title":"Get Platform Verification (status only)","openapi":"GET /v1/platform/verification","href":"/api-reference/verification/get-platform-verification-status-only"},{"title":"Get User Verification Summary","openapi":"GET /v1/platform/users/verification-summary/{user_id}","href":"/api-reference/verification/get-user-verification-summary"},{"title":"Get User Verification","openapi":"GET /v1/platform/users/verification/{user_id}","href":"/api-reference/verification/get-user-verification"},{"title":"List User KYB Records","openapi":"GET /v1/platform/users/kyb-records/{user_id}","href":"/api-reference/verification/list-user-kyb-records"},{"title":"Start User KYC","openapi":"POST /v1/platform/users/kyc/start/{user_id}","href":"/api-reference/verification/start-user-kyc"},{"title":"Sync User KYC","openapi":"POST /v1/platform/users/kyc/sync/{user_id}","href":"/api-reference/verification/sync-user-kyc"},{"title":"Create User KYB Record","openapi":"POST /v1/platform/users/kyb/start/{user_id}","href":"/api-reference/verification/create-user-kyb-record"},{"title":"List Verification Document Requests","openapi":"GET /v1/platform/compliance/document-requests","href":"/api-reference/verification/list-document-requests"},{"title":"Get One Check's Document Requests","openapi":"GET /v1/platform/compliance/checks/{check_id}/document-requests","href":"/api-reference/verification/get-check-document-requests"},{"title":"Send Requested Verification Documents","openapi":"POST /v1/platform/compliance/checks/{check_id}/document-requests/{request_id}/submit","href":"/api-reference/verification/submit-document-request-response"}]},{"group":"Screening","expanded":false,"pages":[{"title":"Screen a Subject","openapi":"POST /v1/platform/screening/checks","href":"/api-reference/screening/create-screening-check"},{"title":"List Your Screening Checks","openapi":"GET /v1/platform/screening/checks","href":"/api-reference/screening/list-screening-checks"},{"title":"Get a Screening Check","openapi":"GET /v1/platform/screening/checks/{check_id}","href":"/api-reference/screening/get-screening-check"}]},{"group":"Bank Accounts","expanded":false,"pages":[{"title":"Add Bank Account","openapi":"POST /v1/platform/bank/add-bank-manually","href":"/api-reference/bank-accounts/add-bank-account"},{"title":"List Bank Accounts","openapi":"GET /v1/platform/bank-accounts/{user_id}","href":"/api-reference/bank-accounts/list-bank-accounts"},{"title":"Add account Instantly","openapi":"GET /v1/platform/bank/add-account-instantly/{user_id}","href":"/api-reference/bank-accounts/add-account-instantly"},{"title":"Add a Bank Account From an Existing Connection","openapi":"POST /v1/platform/bank/add-account-connected","href":"/api-reference/bank-accounts/add-account-from-connection"},{"title":"Get a Manual Bank Account's Details to Edit","openapi":"GET /v1/platform/bank/update/{bank_account_id}","href":"/api-reference/bank-accounts/get-manual-bank-account-for-edit"},{"title":"Edit a Manually Added Bank Account","openapi":"PATCH /v1/platform/bank/update/{bank_account_id}","href":"/api-reference/bank-accounts/edit-manual-bank-account"},{"title":"Remove Bank Account","openapi":"DELETE /v1/platform/bank/delete/{bank_account_id}","href":"/api-reference/bank-accounts/remove-bank-account"},{"title":"Apply for Virtual Bank Account","openapi":"POST /v1/platform/virtual-bank-accounts","href":"/api-reference/bank-accounts/apply-for-virtual-bank-account"},{"title":"List Virtual Bank Accounts","openapi":"GET /v1/platform/virtual-bank-accounts","href":"/api-reference/bank-accounts/list-virtual-bank-accounts"},{"title":"Refresh Virtual Bank Account Balance","openapi":"POST /v1/platform/virtual-bank-accounts/{account_id}/refresh-balance","href":"/api-reference/bank-accounts/refresh-virtual-bank-account-balance"},{"title":"Get Virtual Bank Account","openapi":"GET /v1/platform/virtual-bank-accounts/{account_id}","href":"/api-reference/bank-accounts/get-virtual-bank-account"},{"title":"List All Bank Accounts","openapi":"GET /v1/platform/bank-accounts","href":"/api-reference/bank-accounts/list-all-bank-accounts"},{"title":"Get a Bank Account Relink Link","openapi":"GET /v1/platform/bank/relink/{bank_account_id}","href":"/api-reference/bank-accounts/get-bank-account-relink-link"}]},{"group":"Card Processing","expanded":false,"pages":[{"title":"List Cards","openapi":"GET /v1/platform/card/cards/{user_id}","href":"/api-reference/card-processing/list-cards"},{"title":"Get One Card's Details","openapi":"GET /v1/platform/card/cards/{user_id}/{payment_method_id}","href":"/api-reference/card-processing/get-one-card-details"},{"title":"Add Card","openapi":"POST /v1/platform/card/add-card","href":"/api-reference/card-processing/add-card"},{"title":"Remove Card","openapi":"DELETE /v1/platform/card/delete/{card_id}","href":"/api-reference/card-processing/remove-card"},{"title":"Apply for Card Processing","openapi":"POST /v1/platform/card-processing","href":"/api-reference/card-processing/create-card-processing-application"},{"title":"Get a Link for the User to Pay by Card","openapi":"POST /v1/platform/card/payment-link","href":"/api-reference/card-processing/get-card-payment-link"},{"title":"Get Card Processing Record(s)","openapi":"GET /v1/platform/card-processing/users/{user_id}","href":"/api-reference/card-processing/get-card-processing-record-s"},{"title":"List All Cards","openapi":"GET /v1/platform/card/cards","href":"/api-reference/card-processing/list-all-cards"},{"title":"Verify an Already-Added Card","openapi":"GET /v1/platform/card/verify-card/{payment_method_id}","href":"/api-reference/card-processing/verify-card"},{"title":"Verify a Saved Card","openapi":"POST /v1/platform/card/verify-token/{payment_method_id}","href":"/api-reference/card-processing/verify-saved-card"},{"title":"Get Card Processing by KYB","openapi":"GET /v1/platform/card-processing/kybs/{kyb_id}","href":"/api-reference/card-processing/get-card-processing-by-kyb"},{"title":"Get Card Processing MID Config","openapi":"GET /v1/platform/card-processing/mid","href":"/api-reference/card-processing/get-card-processing-mid-config"},{"title":"Get a Card Processing Application","openapi":"GET /v1/platform/card-processing/{application_id}","href":"/api-reference/card-processing/get-card-processing-application"},{"title":"Get Card Processing Supporting Documents","openapi":"GET /v1/platform/card-processing/merchants/{card_acquiring_id}/merchant-info","href":"/api-reference/card-processing/get-card-processing-merchant-info"},{"title":"Submit Card Processing Supporting Documents","openapi":"PUT /v1/platform/card-processing/merchants/{card_acquiring_id}/merchant-info","href":"/api-reference/card-processing/submit-card-processing-merchant-info"}]},{"group":"Merchant Onboarding","expanded":false,"pages":[{"title":"Onboard a Merchant for Card Processing","openapi":"POST /v1/platform/merchant-onboarding","href":"/api-reference/merchant-onboarding/onboard-merchant"},{"title":"Update a Pending Card Processing Application","openapi":"PUT /v1/platform/merchant-onboarding","href":"/api-reference/merchant-onboarding/update-merchant-onboarding"}]},{"group":"Card Transfers","expanded":false,"pages":[{"title":"Card Transfers Overview","href":"/api-reference/card-transfers/overview"},{"title":"Enable a Card Transfer Direction","openapi":"POST /v1/platform/card-transfers/enable","href":"/api-reference/card-transfers/enable-card-transfer"},{"title":"Card Transfer Direction Status","openapi":"GET /v1/platform/card-transfers/enable","href":"/api-reference/card-transfers/get-card-transfer-status"},{"title":"Add a Card","openapi":"POST /v1/platform/card-transfers/cards","href":"/api-reference/card-transfers/add-transfer-card"},{"title":"Get a Card","openapi":"GET /v1/platform/card-transfers/cards/{card_id}","href":"/api-reference/card-transfers/get-transfer-card"},{"title":"List Cards","openapi":"GET /v1/platform/card-transfers/cards","href":"/api-reference/card-transfers/list-transfer-cards"}]},{"group":"Digital Assets","expanded":false,"pages":[{"title":"List Digital Asset Catalog","openapi":"GET /v1/platform/digital-assets/assets","href":"/api-reference/digital-assets/list-digital-asset-catalog"},{"title":"List Digital Asset Wallets","openapi":"GET /v1/platform/digital-assets/wallets","href":"/api-reference/digital-assets/list-digital-asset-wallets"},{"title":"Create Digital Asset Wallet","openapi":"POST /v1/platform/digital-assets/wallets","href":"/api-reference/digital-assets/create-digital-asset-wallet"},{"title":"List Digital Asset Balances","openapi":"GET /v1/platform/digital-assets/balances","href":"/api-reference/digital-assets/list-digital-asset-balances"},{"title":"Get Digital Asset Wallet","openapi":"GET /v1/platform/digital-assets/wallets/{wallet_id}","href":"/api-reference/digital-assets/get-digital-asset-wallet"},{"title":"Get Digital Asset Wallet Balance","openapi":"GET /v1/platform/digital-assets/wallets/{wallet_id}/balance","href":"/api-reference/digital-assets/get-digital-asset-wallet-balance"},{"title":"List Digital Asset Transactions","openapi":"GET /v1/platform/digital-assets/transactions","href":"/api-reference/digital-assets/list-digital-asset-transactions"},{"title":"List Digital Asset Vault Requests","openapi":"GET /v1/platform/digital-assets/vault-requests","href":"/api-reference/digital-assets/list-digital-asset-vault-requests"},{"title":"Get Digital Asset Vault Request","openapi":"GET /v1/platform/digital-assets/vault-requests/{request_id}","href":"/api-reference/digital-assets/get-digital-asset-vault-request"}]},{"group":"International","expanded":false,"pages":[{"title":"List Reference Data","openapi":"GET /v1/platform/international/catalogues","href":"/api-reference/international/list-reference-data"},{"title":"Payers","openapi":"GET /v1/platform/international/payers","href":"/api-reference/international/payers"},{"title":"Payer Rules","openapi":"GET /v1/platform/international/payer-rules","href":"/api-reference/international/payer-rules"},{"title":"Branches","openapi":"GET /v1/platform/international/branches","href":"/api-reference/international/branches"},{"title":"Rates","openapi":"GET /v1/platform/international/rates","href":"/api-reference/international/rates"},{"title":"Send an International Payout","openapi":"POST /v1/platform/international/payouts","href":"/api-reference/international/create-an-international-payout"},{"title":"Retry a Failed Payout","openapi":"POST /v1/platform/international/payouts/{intent_id}/retry","href":"/api-reference/international/platform-retry-payout"},{"title":"Platform Payout Status","openapi":"GET /v1/platform/international/payouts/status","href":"/api-reference/international/platform-payout-status"},{"title":"Send an International Payout (Full Payload)","openapi":"POST /v1/platform/international/payouts/global","href":"/api-reference/international/send-an-international-payout-full-payload"}]},{"group":"Pending Applications","expanded":false,"pages":[{"title":"List pending applications","openapi":"GET /v1/platform/pending-applications","href":"/api-reference/pending-applications/list-pending-applications"},{"title":"Get pending application","openapi":"GET /v1/platform/pending-applications/{application_id}","href":"/api-reference/pending-applications/get-pending-application"}]},{"group":"Wallets","expanded":false,"pages":[{"title":"List All Wallets","openapi":"GET /v1/platform/wallets","href":"/api-reference/wallets/list-all-wallets"},{"title":"Create a Wallet","openapi":"POST /v1/platform/wallets","href":"/api-reference/wallets/create-a-wallet"},{"title":"Get the Master Wallet","openapi":"GET /v1/platform/wallets/master","href":"/api-reference/wallets/get-the-master-wallet"},{"title":"List a User's Wallets","openapi":"GET /v1/platform/wallets/by-user/{user_id}","href":"/api-reference/wallets/list-user-wallets"},{"title":"Get a Wallet by ID","openapi":"GET /v1/platform/wallets/by-id/{wallet_id}","href":"/api-reference/wallets/get-wallet-by-id"},{"title":"Get a Wallet's Activity by ID","openapi":"GET /v1/platform/wallets/by-id/{wallet_id}/activity","href":"/api-reference/wallets/get-wallet-activity-by-id"},{"title":"List a Wallet's Incoming-Pending Transfers","openapi":"GET /v1/platform/wallets/by-id/{wallet_id}/pending-incoming","href":"/api-reference/wallets/list-wallet-pending-incoming-transfers"},{"title":"Rename or Promote a Wallet","openapi":"PATCH /v1/platform/wallets/{wallet_id}","href":"/api-reference/wallets/rename-or-promote-wallet"},{"title":"Close a Wallet","openapi":"DELETE /v1/platform/wallets/{wallet_id}","href":"/api-reference/wallets/close-wallet"},{"title":"Get a User's Wallet","openapi":"GET /v1/platform/wallets/{user_id}","href":"/api-reference/wallets/get-wallet"},{"title":"Get a User's Wallet Activity","openapi":"GET /v1/platform/wallets/{user_id}/activity","href":"/api-reference/wallets/get-wallet-activity"},{"title":"Freeze Funds in a Wallet","openapi":"POST /v1/platform/wallets/by-id/{wallet_id}/holds","href":"/api-reference/wallets/create-wallet-hold"},{"title":"List Wallet Holds","openapi":"GET /v1/platform/wallets/by-id/{wallet_id}/holds","href":"/api-reference/wallets/list-wallet-holds"},{"title":"Unfreeze Funds in a Wallet","openapi":"POST /v1/platform/wallets/by-id/{wallet_id}/holds/release","href":"/api-reference/wallets/release-wallet-hold"}]},{"group":"Payments","expanded":false,"pages":[{"title":"Request a Payment Payload","openapi":"POST /v1/platform/payments/request-payload","href":"/api-reference/payments/request-payment-payload"},{"title":"Get a Payment Request","openapi":"GET /v1/platform/payments/request-payload/{reference}","href":"/api-reference/payments/get-payment-request"},{"title":"Create a Payment from a Request","openapi":"POST /v1/platform/payments/create-transaction","href":"/api-reference/payments/create-payment-from-request"},{"title":"List Payments","openapi":"GET /v1/platform/payments","href":"/api-reference/payments/list-payments"},{"title":"Get Payment","openapi":"GET /v1/platform/payments/{payment_id}","href":"/api-reference/payments/get-payment"},{"title":"Cancel a Payment","openapi":"POST /v1/platform/payments/{payment_id}/cancel","href":"/api-reference/payments/cancel-payment"},{"title":"Get Payment Delivery Windows","openapi":"GET /v1/platform/payments/delivery-windows","href":"/api-reference/payments/get-payment-delivery-windows"},{"title":"Get Banking Calendar","openapi":"GET /v1/platform/payments/banking-calendar","href":"/api-reference/payments/get-banking-calendar"},{"title":"Get a Parked Payer-Authentication Attempt","openapi":"GET /v1/platform/payments/charge-attempts/{charge_attempt_id}","href":"/api-reference/payments/get-charge-attempt"}]},{"group":"Payments (Legacy)","expanded":false,"pages":[{"title":"Wallet to Bank (Payout)","openapi":"POST /v1/platform/payments/wallet-to-bank","tag":"LEGACY","href":"/api-reference/payments/submit-payment"},{"title":"Wallet to Wallet (Internal Transfer)","openapi":"POST /v1/platform/payments/wallet-to-wallet","tag":"LEGACY","href":"/api-reference/payments/wallet-to-wallet-internal-transfer"},{"title":"Charge a Saved Card into a Card-Acquiring Merchant","openapi":"POST /v1/platform/payments/card-to-merchant","tag":"LEGACY","href":"/api-reference/payments/card-to-merchant-payment"}]},{"group":"Document Mailing","expanded":false,"pages":[{"title":"Mail a Document to a Saved Payee","openapi":"POST /v1/platform/payments/document-mailing","href":"/api-reference/document-mailing/ship-document"},{"title":"List Mailed Documents","openapi":"GET /v1/platform/payments/document-mailing","href":"/api-reference/document-mailing/list-shipped-documents"},{"title":"Mail a Document (Full Payload)","openapi":"POST /v1/platform/payments/document-mailing/global","href":"/api-reference/document-mailing/ship-document-full-payload"},{"title":"List Document Mailing Services","openapi":"GET /v1/platform/payments/document-mailing/methods","href":"/api-reference/document-mailing/list-document-mailing-methods"},{"title":"Get a Mailed Document","openapi":"GET /v1/platform/payments/document-mailing/{payment_id}","href":"/api-reference/document-mailing/get-shipped-document"},{"title":"Track a Mailed Document","openapi":"GET /v1/platform/payments/document-mailing/{payment_id}/tracking","href":"/api-reference/document-mailing/track-shipped-document"},{"title":"Refresh a Mailed Document's Tracking","openapi":"POST /v1/platform/payments/document-mailing/{payment_id}/tracking/refresh","href":"/api-reference/document-mailing/refresh-shipped-document-tracking"},{"title":"Void a Mailed Document","openapi":"POST /v1/platform/payments/document-mailing/{payment_id}/void","href":"/api-reference/document-mailing/void-shipped-document"}]},{"group":"Fees","expanded":false,"pages":[{"title":"List Your Fee Schedule","openapi":"GET /v1/platform/fees/catalog","href":"/api-reference/fees/list-fee-catalog"},{"title":"Get One Fee by Code","openapi":"GET /v1/platform/fees/catalog/{fee_code}","href":"/api-reference/fees/get-fee-catalog-entry"},{"title":"Quote a Fee for an Amount","openapi":"POST /v1/platform/fees/quote","href":"/api-reference/fees/quote-fee"}]},{"group":"Catalog","expanded":false,"pages":[{"title":"List Products","openapi":"GET /v1/platform/catalog/products","href":"/api-reference/catalog/list-products"},{"title":"Get Product","openapi":"GET /v1/platform/catalog/products/{product_id}","href":"/api-reference/catalog/get-product"},{"title":"List Product Catalog","openapi":"GET /v1/platform/onboarding/products/catalog","href":"/api-reference/catalog/list-product-catalog"},{"title":"List Payment Categories","openapi":"GET /v1/platform/catalog/payment-categories","href":"/api-reference/catalog/list-payment-categories"}]},{"group":"Webhooks","expanded":false,"pages":[{"title":"List Webhook Event Types","openapi":"GET /v1/platform/webhooks/event-types","href":"/api-reference/webhooks/list-webhook-event-types"},{"title":"Create Webhook","openapi":"POST /v1/platform/webhooks","href":"/api-reference/webhooks/create-webhook"},{"title":"List Webhooks","openapi":"GET /v1/platform/webhooks","href":"/api-reference/webhooks/list-webhooks"},{"title":"Delete Webhook","openapi":"DELETE /v1/platform/webhooks/{webhook_id}","href":"/api-reference/webhooks/delete-webhook"},{"title":"Replay Failed Webhook Deliveries","openapi":"POST /v1/platform/webhooks/deliveries/replay-failed","href":"/api-reference/webhooks/replay-failed-webhook-deliveries"}]},{"group":"Phone Numbers","expanded":false,"pages":[{"title":"List All Phone Numbers","openapi":"GET /v1/platform/phone-numbers","href":"/api-reference/phone-numbers/list-all-phone-numbers"},{"title":"Issue Voice Access Token","openapi":"GET /v1/platform/phone-numbers/access-token","href":"/api-reference/phone-numbers/issue-voice-access-token"},{"title":"List Available Numbers","openapi":"GET /v1/platform/phone-numbers/available","href":"/api-reference/phone-numbers/list-available-numbers"},{"title":"Get User Phone Numbers","openapi":"GET /v1/platform/phone-numbers/users/{user_id}","href":"/api-reference/phone-numbers/get-user-phone-numbers"},{"title":"List a User's Devices","openapi":"GET /v1/platform/phone-numbers/users/{user_id}/devices","href":"/api-reference/phone-numbers/list-user-devices"},{"title":"Register a Device for Notifications","openapi":"POST /v1/platform/phone-numbers/users/{user_id}/devices","href":"/api-reference/phone-numbers/register-device-for-notifications"},{"title":"Remove a Device","openapi":"DELETE /v1/platform/phone-numbers/users/{user_id}/devices","href":"/api-reference/phone-numbers/remove-device"},{"title":"Request Phone Number For User","openapi":"POST /v1/platform/phone-numbers/users/{user_id}","href":"/api-reference/phone-numbers/request-phone-number-for-user"},{"title":"Issue Voice Access Token For User","openapi":"GET /v1/platform/phone-numbers/users/{user_id}/access-token","href":"/api-reference/phone-numbers/issue-voice-access-token-for-user"},{"title":"Get Call Status","openapi":"GET /v1/platform/phone-numbers/calls/{call_id}/status","href":"/api-reference/phone-numbers/get-call-status"},{"title":"Update Phone Number Status","openapi":"PUT /v1/platform/phone-numbers/users/{user_id}/{phone_number_id}","href":"/api-reference/phone-numbers/update-phone-number-status"},{"title":"Delete Phone Number","openapi":"DELETE /v1/platform/phone-numbers/users/{user_id}/{phone_number_id}","href":"/api-reference/phone-numbers/delete-phone-number"},{"title":"Turn a Device's Notifications On or Off","openapi":"PATCH /v1/platform/phone-numbers/devices/{device_id}","href":"/api-reference/phone-numbers/update-device-notifications"},{"title":"List Available Messaging Services","openapi":"GET /v1/platform/phone-numbers/messaging-services","href":"/api-reference/phone-numbers/list-messaging-services"},{"title":"List a Phone Number's Messaging Services","openapi":"GET /v1/platform/phone-numbers/{phone_number_id}/messaging-services","href":"/api-reference/phone-numbers/list-phone-number-messaging-services"},{"title":"Link a Phone Number to a Messaging Service","openapi":"POST /v1/platform/phone-numbers/{phone_number_id}/messaging-services","href":"/api-reference/phone-numbers/link-messaging-service"},{"title":"Request Removal of a Messaging Service","openapi":"POST /v1/platform/phone-numbers/{phone_number_id}/messaging-services/{link_id}/removal","href":"/api-reference/phone-numbers/request-messaging-service-removal"},{"title":"Switch a Phone Number's Messaging Service","openapi":"POST /v1/platform/phone-numbers/{phone_number_id}/messaging-services/{link_id}/update","href":"/api-reference/phone-numbers/update-messaging-service"}]},{"group":"Sms","expanded":false,"pages":[{"title":"Send SMS to Number","openapi":"POST /v1/platform/phone-numbers/sms/send-to-number","href":"/api-reference/sms/send-sms-to-number"},{"title":"List SMS Messages","openapi":"GET /v1/platform/phone-numbers/sms/messages","href":"/api-reference/sms/list-phone-sms-messages"},{"title":"List SMS Conversations","openapi":"GET /v1/platform/phone-numbers/sms/messages/conversations","href":"/api-reference/sms/list-sms-conversations"},{"title":"List SMS Thread","openapi":"GET /v1/platform/phone-numbers/sms/messages/thread","href":"/api-reference/sms/list-sms-thread"}]},{"group":"Calls","expanded":false,"pages":[{"title":"List Phone Calls","openapi":"GET /v1/platform/phone-numbers/calls","href":"/api-reference/calls/list-phone-calls"}]},{"group":"Listings","expanded":false,"pages":[{"title":"List Model","openapi":"POST /v1/platform/listings/{model_key}","href":"/api-reference/listings/list-model"}]},{"group":"Embed Tokens","expanded":false,"pages":[{"title":"Mint Embed Token","openapi":"POST /v1/platform/embed-tokens","href":"/api-reference/embed-tokens/mint-embed-token"}]},{"group":"File Scanning","expanded":false,"pages":[{"title":"Submit Files for Scanning","openapi":"POST /v1/platform/file-scans","href":"/api-reference/file-scans/submit-files-for-scanning"},{"title":"List Submitted Files","openapi":"GET /v1/platform/file-scans","href":"/api-reference/file-scans/list-submitted-files"},{"title":"Get a Submitted File","openapi":"GET /v1/platform/file-scans/{file_id}","href":"/api-reference/file-scans/get-submitted-file"}]}]},{"tab":"Webhooks","icon":"webhook","pages":[{"title":"Webhooks","href":"/webhooks/overview"}]},{"tab":"Guidelines","icon":"list-check","pages":[{"title":"Guidelines","href":"/guidelines/url-standards/overview"}]}]},"basePath":"","title":"List Users - Finogates API Documentation","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}