{"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":"enable-multi-factor-authentication","__idx":0},"children":["Enable multi-factor authentication"]},{"$$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":"li","attributes":{},"children":["An active user account with a verified email address"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-mfa-works","__idx":2},"children":["How MFA works"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Paradise Gateway uses ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["email-based OTP"]}," for multi-factor authentication. When MFA is enabled for a user, the login flow adds a verification step."]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"---\nconfig:\n theme: 'neutral'\n---\nsequenceDiagram\n participant User\n participant App as Your App\n participant API as Paradise Gateway\n User->>App: Enter username + password\n App->>API: Authenticate (Basic Auth)\n API-->>App: Requires MFA\n App->>API: POST /v1/mfa/challenges (type: 2fa)\n API-->>User: OTP sent via email\n User->>App: Enter OTP\n App->>API: POST /v1/mfa/verifications\n API-->>App: 200 OK — session authenticated\n","diagramHtml":"Paradise GatewayYour AppUserParadise GatewayYour AppUserEnter username + passwordAuthenticate (Basic Auth)Requires MFAPOST /v1/mfa/challenges (type: 2fa)OTP sent via emailEnter OTPPOST /v1/mfa/verifications200 OK — session authenticated","diagramHtmlDark":"Paradise GatewayYour AppUserParadise GatewayYour AppUserEnter username + passwordAuthenticate (Basic Auth)Requires MFAPOST /v1/mfa/challenges (type: 2fa)OTP sent via emailEnter OTPPOST /v1/mfa/verifications200 OK — session authenticated"},"children":["---\nconfig:\n theme: 'neutral'\n---\nsequenceDiagram\n participant User\n participant App as Your App\n participant API as Paradise Gateway\n User->>App: Enter username + password\n App->>API: Authenticate (Basic Auth)\n API-->>App: Requires MFA\n App->>API: POST /v1/mfa/challenges (type: 2fa)\n API-->>User: OTP sent via email\n User->>App: Enter OTP\n App->>API: POST /v1/mfa/verifications\n API-->>App: 200 OK — session authenticated\n"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-1-request-an-otp-challenge","__idx":3},"children":["Step 1: Request an OTP challenge"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Send ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v1/mfa/challenges"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type: 2fa"]}," and the user's email."]},{"$$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 -X POST \\\n https://api.dev.paradisegateway.net/v1/mfa/challenges \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"user_name\": \"john.doe@example.com\",\n \"type\": \"2fa\"\n }'\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.post(\n \"https://api.dev.paradisegateway.net/v1/mfa/challenges\",\n headers={\"Content-Type\": \"application/json\"},\n json={\n \"user_name\": \"john.doe@example.com\",\n \"type\": \"2fa\",\n },\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 resp = await fetch(\n \"https://api.dev.paradisegateway.net/v1/mfa/challenges\",\n {\n method: \"POST\",\n headers: { \"Content-Type\": \"application/json\" },\n body: JSON.stringify({\n user_name: \"john.doe@example.com\",\n type: \"2fa\",\n }),\n }\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":"using var client = new HttpClient();\nvar payload = new\n{\n user_name = \"john.doe@example.com\",\n type = \"2fa\"\n};\nvar resp = await client.PostAsJsonAsync(\n \"https://api.dev.paradisegateway.net/v1/mfa/challenges\", payload);\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();\nString body = \"\"\"\n {\n \"user_name\": \"john.doe@example.com\",\n \"type\": \"2fa\"\n }\n \"\"\";\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.dev.paradisegateway.net/v1/mfa/challenges\"))\n .header(\"Content-Type\", \"application/json\")\n .POST(HttpRequest.BodyPublishers.ofString(body)).build();\nHttpResponse 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":"payload := strings.NewReader(`{\n \"user_name\": \"john.doe@example.com\",\n \"type\": \"2fa\"\n}`)\nreq, _ := http.NewRequest(\"POST\",\n \"https://api.dev.paradisegateway.net/v1/mfa/challenges\", payload)\nreq.Header.Set(\"Content-Type\", \"application/json\")\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/mfa/challenges\");\ncurl_setopt_array($ch, [\n CURLOPT_RETURNTRANSFER => true, CURLOPT_POST => true,\n CURLOPT_HTTPHEADER => [\"Content-Type: application/json\"],\n CURLOPT_POSTFIELDS => json_encode([\n \"user_name\" => \"john.doe@example.com\",\n \"type\" => \"2fa\",\n ]),\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\"; require \"json\"\nuri = URI(\"https://api.dev.paradisegateway.net/v1/mfa/challenges\")\nreq = Net::HTTP::Post.new(uri, { \"Content-Type\" => \"application/json\" })\nreq.body = { user_name: \"john.doe@example.com\", type: \"2fa\" }.to_json\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","__idx":4},"children":["Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," response confirms the OTP was sent."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"status\": true,\n \"correlation_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The user receives a 6-digit OTP at their registered email address."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-2-verify-the-otp","__idx":5},"children":["Step 2: Verify the OTP"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Send ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v1/mfa/verifications"]}," with the OTP the user received."]},{"$$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 -X POST \\\n https://api.dev.paradisegateway.net/v1/mfa/verifications \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"user_name\": \"john.doe@example.com\",\n \"one_time_password\": \"123456\",\n \"user_interface\": \"api\"\n }'\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":"resp = requests.post(\n \"https://api.dev.paradisegateway.net/v1/mfa/verifications\",\n headers={\"Content-Type\": \"application/json\"},\n json={\n \"user_name\": \"john.doe@example.com\",\n \"one_time_password\": \"123456\",\n \"user_interface\": \"api\",\n },\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 resp = await fetch(\n \"https://api.dev.paradisegateway.net/v1/mfa/verifications\",\n {\n method: \"POST\",\n headers: { \"Content-Type\": \"application/json\" },\n body: JSON.stringify({\n user_name: \"john.doe@example.com\",\n one_time_password: \"123456\",\n user_interface: \"api\",\n }),\n }\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 verifyPayload = new\n{\n user_name = \"john.doe@example.com\",\n one_time_password = \"123456\",\n user_interface = \"api\"\n};\nvar resp = await client.PostAsJsonAsync(\n \"https://api.dev.paradisegateway.net/v1/mfa/verifications\", verifyPayload);\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 verifyBody = \"\"\"\n {\n \"user_name\": \"john.doe@example.com\",\n \"one_time_password\": \"123456\",\n \"user_interface\": \"api\"\n }\n \"\"\";\nHttpRequest verifyReq = HttpRequest.newBuilder()\n .uri(URI.create(\n \"https://api.dev.paradisegateway.net/v1/mfa/verifications\"))\n .header(\"Content-Type\", \"application/json\")\n .POST(HttpRequest.BodyPublishers.ofString(verifyBody)).build();\nHttpResponse verifyResp = client.send(verifyReq,\n HttpResponse.BodyHandlers.ofString());\nSystem.out.println(verifyResp.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":"payload := strings.NewReader(`{\n \"user_name\": \"john.doe@example.com\",\n \"one_time_password\": \"123456\",\n \"user_interface\": \"api\"\n}`)\nreq, _ := http.NewRequest(\"POST\",\n \"https://api.dev.paradisegateway.net/v1/mfa/verifications\", payload)\nreq.Header.Set(\"Content-Type\", \"application/json\")\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/mfa/verifications\");\ncurl_setopt_array($ch, [\n CURLOPT_RETURNTRANSFER => true, CURLOPT_POST => true,\n CURLOPT_HTTPHEADER => [\"Content-Type: application/json\"],\n CURLOPT_POSTFIELDS => json_encode([\n \"user_name\" => \"john.doe@example.com\",\n \"one_time_password\" => \"123456\",\n \"user_interface\" => \"api\",\n ]),\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":"uri = URI(\"https://api.dev.paradisegateway.net/v1/mfa/verifications\")\nreq = Net::HTTP::Post.new(uri, { \"Content-Type\" => \"application/json\" })\nreq.body = {\n user_name: \"john.doe@example.com\",\n one_time_password: \"123456\", user_interface: \"api\",\n}.to_json\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":6},"children":["Response example"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," response confirms verification and returns the authenticated user and their associated clients."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"status\": true,\n \"is_client\": true,\n \"user\": {\n \"id\": \"USER-3MtwBwLkdIwHu7ix28a3tqPa\",\n \"object\": \"user\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@example.com\",\n \"is_mfa_active\": true,\n \"is_active\": true,\n \"is_locked\": false\n },\n \"clients\": [\n {\n \"id\": \"CLIENT-3MtwBwLkdIwHu7ix28a3tqPa\",\n \"name\": \"Acme Jewelry\",\n \"email\": \"john.doe@example.com\",\n \"role_id\": 1\n }\n ],\n \"correlation_id\": \"b2c3d4e5-f6a7-8901-bcde-f12345678901\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"checking-mfa-status","__idx":7},"children":["Checking MFA status"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieve a user to check whether MFA is enabled."]},{"$$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":"p","attributes":{},"children":["Look for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"is_mfa_active\": true"]}," in the response."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"otp-challenge-types","__idx":8},"children":["OTP challenge types"]},{"$$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":"center","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"center","data-label":"Purpose"},"children":["Purpose"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["2fa"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["Multi-factor authentication during login"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["forgot_password"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["Password reset — see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/how-tos/clients-users/reset-password"},"children":["Reset a user password"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":9},"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/reset-password"},"children":["Reset a user password"]}]},{"$$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/concepts/security-compliance/data-protection"},"children":["About data protection"]}]}]}]},"headings":[{"value":"Enable multi-factor authentication","id":"enable-multi-factor-authentication","depth":1},{"value":"Prerequisites","id":"prerequisites","depth":2},{"value":"How MFA works","id":"how-mfa-works","depth":2},{"value":"Step 1: Request an OTP challenge","id":"step-1-request-an-otp-challenge","depth":2},{"value":"Response","id":"response","depth":3},{"value":"Step 2: Verify the OTP","id":"step-2-verify-the-otp","depth":2},{"value":"Response example","id":"response-example","depth":3},{"value":"Checking MFA status","id":"checking-mfa-status","depth":2},{"value":"OTP challenge types","id":"otp-challenge-types","depth":2},{"value":"Next steps","id":"next-steps","depth":2}],"frontmatter":{"title":"Enable multi-factor authentication","shortTitle":"Enable MFA","intro":"Add an extra layer of security by enabling email-based multi-factor authentication (MFA) for user accounts. When MFA is active, users must verify a one-time password (OTP) sent to their email during login.","type":"how-to","seo":{"title":""}},"lastModified":"2026-06-05T02:46:44.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/how-tos/clients-users/enable-mfa","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}