Add email_verification_id field to BaseRequestException

Fixes #309

When authenticate_with_password() raises an AuthorizationException for an
unverified email, the API response includes an email_verification_id field.
This field is now properly extracted and accessible on the exception object,
eliminating the need to manually parse the response JSON.

Co-Authored-By: Deep Singhvi <[email protected]>

Author: devin-ai-integration[bot]

tests/test_sync_http_client.py

@@ -263,6 +263,33 @@ def test_conflict_exception(self):
             assert str(ex) == "(message=No message, request_id=request-123)"
             assert ex.__class__ == ConflictException
 
+    def test_authorization_exception_includes_email_verification_id(self):
+        request_id = "request-123"
+        email_verification_id = "email_verification_01J6K4PMSWQXVFGF5ZQJXC6VC8"
+
+        self.http_client._client.request = MagicMock(
+            return_value=httpx.Response(
+                status_code=403,
+                json={
+                    "message": "Please verify your email to authenticate via password.",
+                    "code": "email_verification_required",
+                    "email_verification_id": email_verification_id,
+                },
+                headers={"X-Request-ID": request_id},
+            ),
+        )
+
+        try:
+            self.http_client.request("bad_place")
+        except AuthorizationException as ex:
+            assert (
+                ex.message == "Please verify your email to authenticate via password."
+            )
+            assert ex.code == "email_verification_required"
+            assert ex.email_verification_id == email_verification_id
+            assert ex.request_id == request_id
+            assert ex.__class__ == AuthorizationException
+
     def test_request_includes_base_headers(self, capture_and_mock_http_client_request):
         request_kwargs = capture_and_mock_http_client_request(self.http_client, {}, 200)
 

workos/exceptions.py

@@ -20,6 +20,9 @@ def __init__(
         self.errors = self.extract_from_json("errors", None)
         self.code = self.extract_from_json("code", None)
         self.error_description = self.extract_from_json("error_description", "Unknown")
+        self.email_verification_id = self.extract_from_json(
+            "email_verification_id", None
+        )
 
         self.request_id = response.headers.get("X-Request-ID")