{"templateId":"markdown","sharedDataIds":{},"props":{"metadata":{"markdoc":{"tagList":["tabs","tab"]},"type":"markdown"},"seo":{"title":"Reefpay Docs","description":"Reefpay is the groundbreaking payment gateway that lets you integrate with the future of payments.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"generate-a-user-report","__idx":0},"children":["Generate a user report"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"prerequisites","__idx":1},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A valid API key — see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/how-tos/setup/obtain-credentials"},"children":["Obtain API credentials"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"user-reporting-endpoints","__idx":2},"children":["User reporting endpoints"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/users"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["List all users on the authenticated client account"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/users/{id}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Retrieve details for a specific user"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"option-a-list-all-users","__idx":3},"children":["Option A: List all users"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Send ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v1/users"]}," to retrieve every user associated with the client account linked to your API key."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"curl","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"shell","header":{"controls":{"copy":{}}},"source":"curl https://api.dev.paradisegateway.net/v1/users \\\n  -H \"APIKEY: YOUR-API-KEY\"\n","lang":"shell"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Python","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"python","header":{"controls":{"copy":{}}},"source":"import requests\n\nresp = requests.get(\n    \"https://api.dev.paradisegateway.net/v1/users\",\n    headers={\"APIKEY\": \"YOUR-API-KEY\"},\n)\nusers = resp.json()\nfor u in users:\n    status = \"active\" if u[\"is_active\"] else \"inactive\"\n    mfa = \"MFA on\" if u[\"is_mfa_active\"] else \"MFA off\"\n    print(f\"{u['id']} — {u['first_name']} {u['last_name']} ({status}, {mfa})\")\n","lang":"python"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"JavaScript","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"const resp = await fetch(\n  \"https://api.dev.paradisegateway.net/v1/users\",\n  { headers: { \"APIKEY\": \"YOUR-API-KEY\" } }\n);\nconst users = await resp.json();\nusers.forEach((u) => {\n  const status = u.is_active ? \"active\" : \"inactive\";\n  const mfa = u.is_mfa_active ? \"MFA on\" : \"MFA off\";\n  console.log(`${u.id} — ${u.first_name} ${u.last_name} (${status}, ${mfa})`);\n});\n","lang":"javascript"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"C#","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"csharp","header":{"controls":{"copy":{}}},"source":"using var client = new HttpClient();\nclient.DefaultRequestHeaders.Add(\"APIKEY\", \"YOUR-API-KEY\");\nvar resp = await client.GetAsync(\n    \"https://api.dev.paradisegateway.net/v1/users\");\nConsole.WriteLine(await resp.Content.ReadAsStringAsync());\n","lang":"csharp"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Java","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"java","header":{"controls":{"copy":{}}},"source":"HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n    .uri(URI.create(\"https://api.dev.paradisegateway.net/v1/users\"))\n    .header(\"APIKEY\", \"YOUR-API-KEY\")\n    .GET().build();\nHttpResponse<String> resp = client.send(request,\n    HttpResponse.BodyHandlers.ofString());\nSystem.out.println(resp.body());\n","lang":"java"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Go","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"go","header":{"controls":{"copy":{}}},"source":"req, _ := http.NewRequest(\"GET\",\n    \"https://api.dev.paradisegateway.net/v1/users\", nil)\nreq.Header.Set(\"APIKEY\", \"YOUR-API-KEY\")\nresp, _ := http.DefaultClient.Do(req)\ndefer resp.Body.Close()\nbody, _ := io.ReadAll(resp.Body)\nfmt.Println(string(body))\n","lang":"go"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"PHP","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"$ch = curl_init(\"https://api.dev.paradisegateway.net/v1/users\");\ncurl_setopt_array($ch, [\n    CURLOPT_RETURNTRANSFER => true,\n    CURLOPT_HTTPHEADER => [\"APIKEY: YOUR-API-KEY\"],\n]);\necho curl_exec($ch); curl_close($ch);\n","lang":"php"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Ruby","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"ruby","header":{"controls":{"copy":{}}},"source":"require \"net/http\"\nuri = URI(\"https://api.dev.paradisegateway.net/v1/users\")\nreq = Net::HTTP::Get.new(uri, { \"APIKEY\" => \"YOUR-API-KEY\" })\nresp = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }\nputs resp.body\n","lang":"ruby"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response-example","__idx":4},"children":["Response example"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response is an array of user objects."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"[\n  {\n    \"id\": \"USER-3MtwBwLkdIwHu7ix28a3tqPa\",\n    \"object\": \"user\",\n    \"first_name\": \"John\",\n    \"last_name\": \"Doe\",\n    \"email\": \"john.doe@example.com\",\n    \"phone\": \"+15551234567\",\n    \"time_zone\": \"America/New_York\",\n    \"is_mfa_active\": true,\n    \"is_active\": true,\n    \"is_locked\": false,\n    \"correlation_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\"\n  },\n  {\n    \"id\": \"USER-5NvxCyMmeKxIv8jz39b4urQb\",\n    \"object\": \"user\",\n    \"first_name\": \"Jane\",\n    \"last_name\": \"Smith\",\n    \"email\": \"jane.smith@example.com\",\n    \"phone\": \"+15559876543\",\n    \"time_zone\": \"America/Chicago\",\n    \"is_mfa_active\": false,\n    \"is_active\": true,\n    \"is_locked\": false,\n    \"correlation_id\": \"b2c3d4e5-f6a7-8901-bcde-f12345678901\"\n  }\n]\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"option-b-retrieve-a-specific-user","__idx":5},"children":["Option B: Retrieve a specific user"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Send ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v1/users/{id}"]}," to get the full details of a single user."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"curl","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"shell","header":{"controls":{"copy":{}}},"source":"curl https://api.dev.paradisegateway.net/v1/users/USER-3MtwBwLkdIwHu7ix28a3tqPa \\\n  -H \"APIKEY: YOUR-API-KEY\"\n","lang":"shell"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Python","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"python","header":{"controls":{"copy":{}}},"source":"user_id = \"USER-3MtwBwLkdIwHu7ix28a3tqPa\"\nresp = requests.get(\n    f\"https://api.dev.paradisegateway.net/v1/users/{user_id}\",\n    headers={\"APIKEY\": \"YOUR-API-KEY\"},\n)\nprint(resp.json())\n","lang":"python"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"JavaScript","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"const userId = \"USER-3MtwBwLkdIwHu7ix28a3tqPa\";\nconst resp = await fetch(\n  `https://api.dev.paradisegateway.net/v1/users/${userId}`,\n  { headers: { \"APIKEY\": \"YOUR-API-KEY\" } }\n);\nconsole.log(await resp.json());\n","lang":"javascript"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"C#","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"csharp","header":{"controls":{"copy":{}}},"source":"var userId = \"USER-3MtwBwLkdIwHu7ix28a3tqPa\";\nvar resp = await client.GetAsync(\n    $\"https://api.dev.paradisegateway.net/v1/users/{userId}\");\nConsole.WriteLine(await resp.Content.ReadAsStringAsync());\n","lang":"csharp"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Java","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"java","header":{"controls":{"copy":{}}},"source":"String userId = \"USER-3MtwBwLkdIwHu7ix28a3tqPa\";\nHttpRequest request = HttpRequest.newBuilder()\n    .uri(URI.create(\n        \"https://api.dev.paradisegateway.net/v1/users/\" + userId))\n    .header(\"APIKEY\", \"YOUR-API-KEY\")\n    .GET().build();\nHttpResponse<String> resp = client.send(request,\n    HttpResponse.BodyHandlers.ofString());\nSystem.out.println(resp.body());\n","lang":"java"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Go","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"go","header":{"controls":{"copy":{}}},"source":"userId := \"USER-3MtwBwLkdIwHu7ix28a3tqPa\"\nreq, _ := http.NewRequest(\"GET\",\n    \"https://api.dev.paradisegateway.net/v1/users/\"+userId, nil)\nreq.Header.Set(\"APIKEY\", \"YOUR-API-KEY\")\nresp, _ := http.DefaultClient.Do(req)\ndefer resp.Body.Close()\nbody, _ := io.ReadAll(resp.Body)\nfmt.Println(string(body))\n","lang":"go"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"PHP","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"$userId = \"USER-3MtwBwLkdIwHu7ix28a3tqPa\";\n$ch = curl_init(\"https://api.dev.paradisegateway.net/v1/users/$userId\");\ncurl_setopt_array($ch, [\n    CURLOPT_RETURNTRANSFER => true,\n    CURLOPT_HTTPHEADER => [\"APIKEY: YOUR-API-KEY\"],\n]);\necho curl_exec($ch); curl_close($ch);\n","lang":"php"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Ruby","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"ruby","header":{"controls":{"copy":{}}},"source":"user_id = \"USER-3MtwBwLkdIwHu7ix28a3tqPa\"\nuri = URI(\"https://api.dev.paradisegateway.net/v1/users/#{user_id}\")\nreq = Net::HTTP::Get.new(uri, { \"APIKEY\" => \"YOUR-API-KEY\" })\nresp = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }\nputs resp.body\n","lang":"ruby"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"key-user-fields","__idx":6},"children":["Key user fields"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Unique user identifier"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["email"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Email address (also the login username)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["is_active"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Whether the user can log in"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["is_locked"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Whether the account is locked (too many failed logins)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["is_mfa_active"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Whether multi-factor authentication is enabled"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["time_zone"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["User's configured time zone"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"common-reporting-use-cases","__idx":7},"children":["Common reporting use cases"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Goal"},"children":["Goal"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Approach"},"children":["Approach"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Audit active users"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["List all users, filter for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["is_active: true"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Find locked accounts"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["List all users, filter for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["is_locked: true"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["MFA compliance check"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["List all users, identify those with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["is_mfa_active: false"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["User lookup by email"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Retrieve the full list and search client-side, or use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v1/users/{id}"]}," if the ID is known"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":8},"children":["Next steps"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/how-tos/clients-users/add-users-client"},"children":["Add users to a client"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/how-tos/clients-users/update-user"},"children":["Update a user profile"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/concepts/account-hierarchy/users-and-roles"},"children":["About users and roles"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/how-tos/reports/client-reports"},"children":["Generate a client report"]}]}]}]},"headings":[{"value":"Generate a user report","id":"generate-a-user-report","depth":1},{"value":"Prerequisites","id":"prerequisites","depth":2},{"value":"User reporting endpoints","id":"user-reporting-endpoints","depth":2},{"value":"Option A: List all users","id":"option-a-list-all-users","depth":2},{"value":"Response example","id":"response-example","depth":3},{"value":"Option B: Retrieve a specific user","id":"option-b-retrieve-a-specific-user","depth":2},{"value":"Key user fields","id":"key-user-fields","depth":3},{"value":"Common reporting use cases","id":"common-reporting-use-cases","depth":2},{"value":"Next steps","id":"next-steps","depth":2}],"frontmatter":{"title":"Generate a user report","shortTitle":"User reports","intro":"Retrieve a summary list of all users on a client account or the full details of a specific user using the Users API.","type":"how-to","seo":{"title":""}},"lastModified":"2026-06-05T02:46:44.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/how-tos/reports/user-reports","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}