miralabs-backend/user-service/app/schema/personal_info.py

from pydantic import BaseModel, Field


class PersonalInfoSchema(BaseModel):
    firstName: str = Field(..., example="John", description="The first name of the user.")
    lastName: str = Field(..., example="Doe", description="The last name of the user.")
    phoneNumber: str = Field(
        ..., example="+15555555555", description="The phone number of the user in international format."
    )
    NMLS: str = Field(
        ..., example="123456", description="The National Mortgage Licensing System (NMLS) ID of the user."
    )
    isOrganization: bool = Field(
        ..., example=False, description="Indicates if the user is representing an organization."
    )
    organizationNMLS: str = Field(..., example="654321", description="The NMLS ID of the organization, if applicable.")
    userId: str = Field(..., example="user-001", description="The unique identifier of the user.")
    stateToken: str = Field(
        ..., example="state-token-abc", description="The state token for the user, used for verification purposes."
    )
    role: str = Field(
        ..., example="Loan Officer", description="The role of the user within the mortgage application process."
    )