alpaca-py-nopandas 0.1.0__py3-none-any.whl

alpaca/broker/models/accounts.py

@@ -0,0 +1,347 @@
+from datetime import datetime
+from typing import Any, Dict, List, Optional
+from uuid import UUID
+
+from pydantic import TypeAdapter, ValidationInfo, field_validator, model_validator
+
+from alpaca.broker.enums import (
+    AgreementType,
+    ClearingBroker,
+    EmploymentStatus,
+    FundingSource,
+    TaxIdType,
+    VisaType,
+)
+from alpaca.broker.models.documents import AccountDocument
+from alpaca.common.models import ModelWithID
+from alpaca.common.models import ValidateBaseModel as BaseModel
+from alpaca.trading.enums import AccountStatus
+from alpaca.trading.models import TradeAccount as BaseTradeAccount
+
+
+class KycResults(BaseModel):
+    """
+    Hold information about the result of KYC.
+    ref. https://docs.alpaca.markets/reference/getaccount
+
+    Attributes:
+        reject (Optional[Dict[str, Any]]): The reason for the rejection
+        accept (Optional[Dict[str, Any]]): The reason for the acceptance
+        indeterminate (Optional[Dict[str, Any]]): The reason for the indeterminate result
+        additional_information (Optional[str]): Used to display a custom message
+        summary (Optional[str]): Either pass or fail. Used to indicate if KYC has completed and passed or not.
+    """
+
+    reject: Optional[Dict[str, Any]] = None
+    accept: Optional[Dict[str, Any]] = None
+    indeterminate: Optional[Dict[str, Any]] = None
+    additional_information: Optional[str] = None
+    summary: Optional[str] = None
+
+
+class Contact(BaseModel):
+    """User contact details within Account Model
+
+    see https://alpaca.markets/docs/broker/api-references/accounts/accounts/#the-account-model
+
+    Attributes:
+        email_address (str): The user's email address
+        phone_number (str): The user's phone number. It should include the country code.
+        street_address (List[str]): The user's street address lines.
+        unit (Optional[str]): The user's apartment unit, if any.
+        city (str): The city the user resides in.
+        state (Optional[str]): The state the user resides in. This is required if country is 'USA'.
+        postal_code (str): The user's postal
+        country (str): The country the user resides in. 3 letter country code is permissible.
+    """
+
+    email_address: str
+    phone_number: Optional[str] = None
+    street_address: List[str]
+    unit: Optional[str] = None
+    city: str
+    state: Optional[str] = None
+    postal_code: Optional[str] = None
+    country: Optional[str] = None
+
+    @field_validator("state")
+    def usa_state_has_value(cls, v: str, validation: ValidationInfo, **kwargs) -> str:
+        """Validates that the state has a value if the country is USA
+
+        Args:
+            v (str): The state field's value
+            values (dict): The values of each field
+
+        Raises:
+            ValueError: State is required for country USA
+
+        Returns:
+            str: The value of the state field
+        """
+        values: dict = validation.data
+        if "country" in values and values["country"] == "USA" and v is None:
+            raise ValueError("State is required for country USA.")
+        return v
+
+
+class Identity(BaseModel):
+    """User identity details within Account Model
+
+    see https://alpaca.markets/docs/broker/api-references/accounts/accounts/#the-account-model
+
+    Attributes:
+        given_name (str): The user's first name
+        middle_name (Optional[str]): The user's middle name, if any
+        family_name (str): The user's last name
+        date_of_birth (str): The user's date of birth
+        tax_id (Optional[str]): The user's country specific tax id, required if tax_id_type is provided
+        tax_id_type (Optional[TaxIdType]): The tax_id_type for the tax_id provided, required if tax_id provided
+        country_of_citizenship (Optional[str]): The country the user is a citizen
+        country_of_birth (Optional[str]): The country the user was born
+        country_of_tax_residence (str): The country the user files taxes
+        visa_type (Optional[VisaType]): Only used to collect visa types for users residing in the USA.
+        visa_expiration_date (Optional[str]): The date of expiration for visa, Required if visa_type is set.
+        date_of_departure_from_usa (Optional[str]): Required if visa_type = B1 or B2
+        permanent_resident (Optional[bool]): Only used to collect permanent residence status in the USA.
+        funding_source (Optional[List[FundingSource]]): How the user will fund their account
+        annual_income_min (Optional[float]): The minimum of the user's income range
+        annual_income_max (Optional[float]): The maximum of the user's income range
+        liquid_net_worth_min (Optional[float]): The minimum of the user's liquid net worth range
+        liquid_net_worth_max (Optional[float]): The maximum of the user's liquid net worth range
+        total_net_worth_min (Optional[float]): The minimum of the user's total net worth range
+        total_net_worth_max (Optional[float]): The maximum of the user's total net worth range
+    """
+
+    given_name: str
+    middle_name: Optional[str] = None
+    family_name: str
+    date_of_birth: Optional[str] = None
+    tax_id: Optional[str] = None
+    tax_id_type: Optional[TaxIdType] = None
+    country_of_citizenship: Optional[str] = None
+    country_of_birth: Optional[str] = None
+    country_of_tax_residence: str
+    visa_type: Optional[VisaType] = None
+    visa_expiration_date: Optional[str] = None
+    date_of_departure_from_usa: Optional[str] = None
+    permanent_resident: Optional[bool] = None
+    funding_source: Optional[List[FundingSource]] = None
+    annual_income_min: Optional[float] = None
+    annual_income_max: Optional[float] = None
+    liquid_net_worth_min: Optional[float] = None
+    liquid_net_worth_max: Optional[float] = None
+    total_net_worth_min: Optional[float] = None
+    total_net_worth_max: Optional[float] = None
+
+
+class Disclosures(BaseModel):
+    """User disclosures within Account Model
+
+    see https://alpaca.markets/docs/broker/api-references/accounts/accounts/#the-account-model
+
+    Attributes:
+        is_control_person (bool): Whether user holds a controlling position in a publicly traded company
+        is_affiliated_exchange_or_finra (bool): If user is affiliated with any exchanges or FINRA
+        is_politically_exposed (bool): If user is politically exposed
+        immediate_family_exposed (bool): If user’s immediate family member is either politically exposed or holds a control position.
+        employment_status (EmploymentStatus): The employment status of the user
+        employer_name (str): The user's employer's name, if any
+        employer_address (str): The user's employer's address, if any
+        employment_position (str): The user's employment position, if any
+    """
+
+    is_control_person: Optional[bool] = None
+    is_affiliated_exchange_or_finra: Optional[bool] = None
+    is_politically_exposed: Optional[bool] = None
+    immediate_family_exposed: bool
+    employment_status: Optional[EmploymentStatus] = None
+    employer_name: Optional[str] = None
+    employer_address: Optional[str] = None
+    employment_position: Optional[str] = None
+
+
+class Agreement(BaseModel):
+    """User agreements signed within Account Model
+
+    see https://alpaca.markets/docs/broker/api-references/accounts/accounts/#the-account-model
+
+    Attributes:
+        agreement (Agreement): The type of agreement signed by the user
+        signed_at (str): The timestamp the agreement was signed
+        ip_address (str): The ip_address the signed agreements were sent from by the user
+        revision (str): The revision date
+    """
+
+    agreement: AgreementType
+    signed_at: str
+    ip_address: str
+    revision: Optional[str] = None
+
+
+class TrustedContact(BaseModel):
+    """User's trusted contact details within Account Model
+
+    see https://alpaca.markets/docs/broker/api-references/accounts/accounts/#the-account-model
+
+    Attributes:given_name
+        given_name (str): The first name of the user's trusted contact
+        family_name (str): The last name of the user's trusted contact
+        email_address (Optional[str]): The email address of the user's trusted contact
+        phone_number (Optional[str]): The email address of the user's trusted contact
+        city (Optional[str]): The email address of the user's trusted contact
+        state (Optional[str]): The email address of the user's trusted contact
+        postal_code (Optional[str]): The email address of the user's trusted contact
+        country (Optional[str]): The email address of the user's trusted contact
+    """
+
+    given_name: str
+    family_name: str
+    email_address: Optional[str] = None
+    phone_number: Optional[str] = None
+    street_address: Optional[str] = None
+    city: Optional[str] = None
+    state: Optional[str] = None
+    postal_code: Optional[str] = None
+    country: Optional[str] = None
+
+    @model_validator(mode="before")
+    def root_validator(cls, values: dict) -> dict:
+        has_phone_number = (
+            "phone_number" in values and values["phone_number"] is not None
+        )
+        has_street_address = (
+            "street_address" in values and values["street_address"] is not None
+        )
+        has_email_address = (
+            "email_address" in values and values["email_address"] is not None
+        )
+
+        if has_phone_number or has_street_address or has_email_address:
+            return values
+
+        raise ValueError("At least one method of contact required for trusted contact")
+
+
+class Account(ModelWithID):
+    """Contains information pertaining to a specific brokerage account
+
+    see https://alpaca.markets/docs/broker/api-references/accounts/accounts/#the-account-model
+
+    The fields contact, identity, disclosures, agreements, documents, trusted_contact, and trading_configurations
+    are all optional and won't always be provided by the api depending on what endpoint you use and what options you
+    pass
+
+    Attributes:
+        id (str): The account uuid used to reference this account
+        account_number (str): A more human friendly identifier for this account
+        status (AccountStatus): The approval status of this account
+        crypto_status (Optional[AccountStatus]): The crypto trading status. Only present if crypto trading is enabled.
+        kyc_results (Optional[KycResult]): Hold information about the result of KYC.
+        currency (str): The currency the account's values are returned in
+        last_equity (str): The total equity value stored in the account
+        created_at (str): The timestamp when the account was created
+        contact (Optional[Contact]): The contact details for the account holder
+        identity (Optional[Identity]): The identity details for the account holder
+        disclosures (Optional[Disclosures]): The account holder's political disclosures
+        agreements (Optional[List[Agreement]]): The agreements the account holder has signed
+        documents (Optional[List[AccountDocument]]): The documents the account holder has submitted
+        trusted_contact (Optional[TrustedContact]): The account holder's trusted contact details
+    """
+
+    account_number: str
+    status: AccountStatus
+    crypto_status: Optional[AccountStatus] = None
+    kyc_results: Optional[KycResults] = None
+    currency: str
+    last_equity: str
+    created_at: str
+    contact: Optional[Contact] = None
+    identity: Optional[Identity] = None
+    disclosures: Optional[Disclosures] = None
+    agreements: Optional[List[Agreement]] = None
+    documents: Optional[List[AccountDocument]] = None
+    trusted_contact: Optional[TrustedContact] = None
+
+    def __init__(self, **response):
+        super().__init__(
+            id=(UUID(response["id"])),
+            account_number=(response["account_number"]),
+            status=(response["status"]),
+            crypto_status=(
+                response["crypto_status"] if "crypto_status" in response else None
+            ),
+            kyc_results=(
+                TypeAdapter(KycResults).validate_python(response["kyc_results"])
+                if "kyc_results" in response and response["kyc_results"] is not None
+                else None
+            ),
+            currency=(response["currency"]),
+            last_equity=(response["last_equity"]),
+            created_at=(response["created_at"]),
+            contact=(
+                TypeAdapter(Contact).validate_python(response["contact"])
+                if "contact" in response
+                else None
+            ),
+            identity=(
+                TypeAdapter(Identity).validate_python(response["identity"])
+                if "identity" in response
+                else None
+            ),
+            disclosures=(
+                TypeAdapter(Disclosures).validate_python(response["disclosures"])
+                if "disclosures" in response
+                else None
+            ),
+            agreements=(
+                TypeAdapter(List[Agreement]).validate_python(response["agreements"])
+                if "agreements" in response
+                else None
+            ),
+            documents=(
+                TypeAdapter(List[AccountDocument]).validate_python(
+                    response["documents"]
+                )
+                if "documents" in response
+                else None
+            ),
+            trusted_contact=(
+                TypeAdapter(TrustedContact).validate_python(response["trusted_contact"])
+                if "trusted_contact" in response
+                else None
+            ),
+        )
+
+
+class TradeAccount(BaseTradeAccount):
+    """
+    See Base TradeAccount model in common for full details on available fields.
+    Represents trading account information for an Account.
+
+    Attributes:
+        cash_withdrawable (Optional[str]): Cash available for withdrawal from the account
+        cash_transferable (Optional[str]): Cash available for transfer (JNLC) from the account
+        previous_close (Optional[datetime]): Previous sessions close time
+        last_long_market_value (Optional[str]): Value of all long positions as of previous trading day at 16:00:00 ET
+        last_short_market_value (Optional[str]): Value of all short positions as of previous trading day at 16:00:00 ET
+        last_cash (Optional[str]): Value of all cash as of previous trading day at 16:00:00 ET
+        last_initial_margin (Optional[str]): Value of initial_margin as of previous trading day at 16:00:00 ET
+        last_regt_buying_power (Optional[str]): Value of regt_buying_power as of previous trading day at 16:00:00 ET
+        last_daytrading_buying_power (Optional[str]): Value of daytrading_buying_power as of previous trading day at 16:00:00 ET
+        last_daytrade_count (Optional[int]): Value of daytrade_count as of previous trading day at 16:00:00 ET
+        last_buying_power (Optional[str]): Value of buying_power as of previous trading day at 16:00:00 ET
+        clearing_broker (Optional[ClearingBroker]): The Clearing broker for this account
+    """
+
+    cash_withdrawable: Optional[str]
+    cash_transferable: Optional[str]
+    previous_close: Optional[datetime]
+    last_long_market_value: Optional[str]
+    last_short_market_value: Optional[str]
+    last_cash: Optional[str]
+    last_initial_margin: Optional[str]
+    last_regt_buying_power: Optional[str]
+    last_daytrading_buying_power: Optional[str]
+    last_daytrade_count: Optional[int]
+    last_buying_power: Optional[str]
+    clearing_broker: Optional[ClearingBroker]

alpaca/broker/models/cip.py

@@ -0,0 +1,265 @@
+from datetime import datetime
+from typing import List, Optional
+from uuid import UUID
+
+from alpaca.common.models import ModelWithID, ValidateBaseModel as BaseModel
+
+from alpaca.broker.enums import CIPApprovalStatus, CIPProvider, CIPResult, CIPStatus
+
+
+class CIPKYCInfo(BaseModel):
+    """
+    Represents Know Your Customer (KYC) info for a CIPInfo
+
+    Attributes:
+        id (str): Your internal ID of check
+        risk_score (Optional[int]): Overall risk score returned by KYC provider or assessed
+        risk_level (Optional[str]): Overall risk level returned by KYC provider or assessed
+        risk_categories (Optional[List[str]]): The list of risk categories returned by the KYC provider or assessed
+        applicant_name (Optional[str]): Given and family name of applicant
+        email_address (Optional[str]): email address of applicant
+        nationality (Optional[str]): nationality of applicant
+        date_of_birth (Optional[datetime]): DOB of applicant
+        address (Optional[str]): Concatenated street address, city, state and country of applicant
+        postal_code (Optional[str]): postal code for `address` field
+        country_of_residency (Optional[str]): country for `address` field
+        kyc_completed_at (Optional[datetime]): Datetime that KYC check was completed at
+        ip_address (Optional[str]): ip address of applicant at time of KYC check
+        check_initiated_at (Optional[datetime]): start datetime of KYC check
+        check_completed_at (Optional[datetime]): completion datetime of KYC check
+        approval_status (Optional[CIPApprovalStatus]): Approval status of KYC check
+        approved_by (Optional[str]): Identifier of who approved KYC check
+        approved_reason (Optional[str]): Reason for approving this KYC check
+        approved_at (Optional[datetime]): Datetime that this KYC check was approved
+    """
+
+    id: str
+    risk_score: Optional[int] = None
+    risk_level: Optional[str] = None
+    risk_categories: Optional[List[str]] = None
+    applicant_name: Optional[str] = None
+    email_address: Optional[str] = None
+    nationality: Optional[str] = None
+    date_of_birth: Optional[datetime] = None
+    address: Optional[str] = None
+    postal_code: Optional[str] = None
+    country_of_residency: Optional[str] = None
+    kyc_completed_at: Optional[datetime] = None
+    ip_address: Optional[str] = None
+    check_initiated_at: Optional[datetime] = None
+    check_completed_at: Optional[datetime] = None
+    approval_status: Optional[CIPApprovalStatus] = None
+    approved_by: Optional[str] = None
+    approved_reason: Optional[str] = None
+    approved_at: Optional[datetime] = None
+
+
+class CIPDocument(BaseModel):
+    """
+    Represents results of checking a document for CIPInfo
+
+    Attributes:
+        id (str): Your internal ID of check
+        result (Optional[CIPResult]): Overall result of specific check
+        status (Optional[CIPStatus]): Overall status of specific check
+        created_at (Optional[datetime]): Datetime for when this check was done
+        date_of_birth (Optional[datetime]): DOB for applicant if found on document
+        date_of_expiry (Optional[datetime]): date of expiry for the checked document
+        document_numbers (Optional[List[str]]): Number of the document that was checked
+        document_type (Optional[str]): Type of the document that was checked
+        first_name (Optional[str]): First name extracted from the document
+        last_name (Optional[str]): Last name extracted from the document
+        gender (Optional[str]): Gender info extracted from the document
+        issuing_country (Optional[str]): Country for which issued the document
+        nationality (Optional[str]): Nationality extracted from the document
+        age_validation (Optional[CIPResult]): Result of checks on whether the age calculated from the document’s date
+          of birth data point is greater than or equal to the minimum accepted age set at account level
+        compromised_document (Optional[CIPResult]): Result of check on whether the image of the document has been found
+          in our internal database of compromised documents
+        police_record (Optional[CIPStatus]): Result of check on whether the document has been identified as lost,
+          stolen or otherwise compromised
+        data_comparison (Optional[CIPResult]): Result of check on whether data on the document is consistent with data
+          provided when creating an applicant through the API
+        data_comparison_breakdown (Optional[str]): json object representing the results of the various sub-checks
+          done when calculating the result on `data_comparison`. Example: {“date_of_birth”: “clear”,
+          “date_of_expiry”: “clear” “document_numbers”: “clear”, “document_type”: “clear”, “first_name”: “clear”,
+          “gender”: “clear”, “issuing_country”: “clear”, “last_name”: “clear”}
+        image_integrity (Optional[CIPResult]): Result of checks on whether the document was of sufficient quality to
+          verify
+        image_integrity_breakdown (Optional[str]): json object representing the results of the various sub-checks done
+          when calculating the result on `image_integrity`. Example: example: {“colour_picture”: “clear”,
+          “conclusive_document_quality”: “clear”, “image_quality”: “clear”, “supported_document”: “clear”}
+        visual_authenticity (Optional[str]): json object representing the the various sub-checks done when determening
+          whether visual (non-textual) elements are correct given the document type. Example: {
+          “digital_tampering”: “clear”, “face_detection”: “clear”, “fonts”: “clear”, “original_document_present”:
+          “clear”, “picture_face_integrity”: “clear”, “security_features”: “clear”, “template”: “clear”}
+
+    """
+
+    id: str
+    result: Optional[CIPResult] = None
+    status: Optional[CIPStatus] = None
+    created_at: Optional[datetime] = None
+    date_of_birth: Optional[datetime] = None
+    date_of_expiry: Optional[datetime] = None
+    document_numbers: Optional[List[str]] = None
+    document_type: Optional[str] = None
+    first_name: Optional[str] = None
+    last_name: Optional[str] = None
+    gender: Optional[str] = None
+    issuing_country: Optional[str] = None
+    nationality: Optional[str] = None
+    age_validation: Optional[CIPResult] = None
+    compromised_document: Optional[CIPResult] = None
+    police_record: Optional[CIPStatus] = None
+    data_comparison: Optional[CIPResult] = None
+    data_comparison_breakdown: Optional[str] = None
+    image_integrity: Optional[CIPResult] = None
+    image_integrity_breakdown: Optional[str] = None
+    visual_authenticity: Optional[str] = None
+
+
+class CIPPhoto(BaseModel):
+    """
+    Represents the results of checking a Photo for CIPInfo
+
+    Attributes:
+        id (str): Your internal ID of check
+        result (Optional[CIPResult]): Overall result of check
+        status (Optional[CIPStatus]): Overall status of check
+        created_at (Optional[datetime]): datetime of when check happened
+        face_comparision (Optional[CIPResult]): Checks whether the face in the document matches the face in the
+          live photo
+        face_comparison_breakdown (Optional[str]): a json object representing the breakdown of sub-checks done in
+          `face_comparison`. Example: {“face_match”:{“result”: “clear”,“properties”:{“score”: “80”}}}
+        image_integrity (Optional[CIPResult]): Checks whether the quality and integrity of the uploaded files were
+          sufficient to perform a face comparison
+        image_integrity_breakdown (Optional[str]): a json object representing the breakdown of sub-checks done in
+          `image_integrity`. Example  {“face_detected”:{“result”: “clear”},“source_integrity”: {“result”: “clear”}}
+        visual_authenticity (Optional[CIPResult]): Checks whether the person in the live photo is real (not a spoof)
+        visual_authenticity_breakdown (Optional[str]): a json object representing the breakdown of sub-checks don in
+          `visual_authenticity`. Example {“spoofing_detection”: {“result”: “clear”,“properties”: {“score”: “26”}}}}
+    """
+
+    id: str
+    result: Optional[CIPResult] = None
+    status: Optional[CIPStatus] = None
+    created_at: Optional[datetime] = None
+    face_comparision: Optional[CIPResult] = None
+    face_comparison_breakdown: Optional[str] = None
+    image_integrity: Optional[CIPResult] = None
+    image_integrity_breakdown: Optional[str] = None
+    visual_authenticity: Optional[CIPResult] = None
+    visual_authenticity_breakdown: Optional[str] = None
+
+
+class CIPIdentity(BaseModel):
+    """
+    Represents the results of running an identity check for a CIPInfo
+
+    Attributes:
+        id (str): Your internal ID of check
+        result (Optional[CIPResult]): Overall result of check
+        status (Optional[CIPStatus]): Overall status of check
+        created_at (Optional[datetime]): datetime when identity check happened
+        matched_address (Optional[CIPResult]): Represents of the address matched for the applicant
+        matched_addresses (Optional[str]): a json object representing the results of the check done in `matched_address`
+          Example: [{“id”: “19099121”,“match_types”:[“credit_agencies”,“voting_register”]}]
+        sources (Optional[CIPResult]):  Shows the total number of sources found for applicant’s identity.
+          (TODO: What? This doesnt make any sense its a CIPResult not a number but that's whats in the docs)
+        sources_breakdown (Optional[str]): a json object representing the breakdown of `sources` field. For example:
+          {“total_sources”: {“result”: “clear”,“properties”: {“total_number_of_sources”: “3”}}}
+        address (Optional[CIPResult]): Result if it was cleared against a data source
+        address_breakdown (Optional[str]): a json object representing the breakdown of the `address` field. For example:
+          {“credit_agencies”: {“result”: “clear”,“properties”:{“number_of_matches”:“1”}}
+        date_of_birth (Optional[CIPResult]): Result if it was cleared against a data source
+        date_of_birth_breakdown (Optional[str]): a json object representing the breakdown of the `date_of_birth` field.
+          For example: example: {“credit_agencies”:{“result”: “clear”,“properties”: {“number_of_matches”: “1”}}
+        tax_id (Optional[CIPResult]): Result if it was cleared against a data source
+        tax_id_breakdown (Optional[str]): a json object representing the breakdown of the `tax_id` field
+    """
+
+    id: str
+    result: Optional[CIPResult] = None
+    status: Optional[CIPStatus] = None
+    created_at: Optional[datetime] = None
+    matched_address: Optional[CIPResult] = None
+    matched_addresses: Optional[str] = None
+    sources: Optional[CIPResult] = None
+    sources_breakdown: Optional[str] = None
+    address: Optional[CIPResult] = None
+    address_breakdown: Optional[str] = None
+    date_of_birth: Optional[CIPResult] = None
+    date_of_birth_breakdown: Optional[str] = None
+    tax_id: Optional[CIPResult] = None
+    tax_id_breakdown: Optional[str] = None
+
+
+class CIPWatchlist(BaseModel):
+    """
+    Represents the result of checking to see if the applicant is in any watchlists for a CIPInfo
+
+    TODO: We're missing almost entirely documentation in prod for this as well as even internal documentation
+      no clue what these fields are supposed to be or if they're even close to correct.
+
+    Attributes:
+        id (str): Your internal ID of check
+        result (Optional[CIPResult]): Overall result of specific check
+        status (Optional[CIPStatus]): Overall status of specific check
+        created_at (Optional[datetime]): datetime when check happened
+        records (Optional[str]): a json object. Example [{“text”: “Record info”}]
+        politically_exposed_person (Optional[CIPResult]): Result if it was cleared against a data source
+        sanction (Optional[CIPResult]): Result if it was cleared against a data source
+        adverse_media (Optional[CIPResult]): Result if it was cleared against a data source
+        monitored_lists (Optional[CIPResult]): Result if it was cleared against a data source
+    """
+
+    id: str
+    result: Optional[CIPResult] = None
+    status: Optional[CIPStatus] = None
+    created_at: Optional[datetime] = None
+    records: Optional[str] = None
+    politically_exposed_person: Optional[CIPResult] = None
+    sanction: Optional[CIPResult] = None
+    adverse_media: Optional[CIPResult] = None
+    monitored_lists: Optional[CIPResult] = None
+
+
+class CIPInfo(ModelWithID):
+    """
+    The Customer Identification Program (CIP) API allows you to submit the CIP results received from your KYC provider.
+
+    This model is how to represent that information when talking to Alpaca
+
+    Args:
+        id (UUID): ID of this CIPInfo
+        account_id (UUID): UUID of the Account instance this CIPInfo is for
+        provider_name (List[CIPProvider]): List of KYC providers this information came from
+        created_at (datetime): date and time this CIPInfo was first uploaded to Alpaca
+        updated_at (datetime): date and time that this CIPInfo was last update
+        kyc (Optional[CIPKYCInfo]): KYC info for this Account if any
+        document (Optional[CIPDocument]): Any CIP documents uploaded for this Account
+        photo (Optional[CIPPhoto]): Any photos attached for CIP
+        identity (Optional[CIPIdentity]): Any CIP Identity information
+        watchlist (Optional[CIPWatchlist]): Any CIP watchlist information
+    """
+
+    account_id: UUID
+    provider_name: List[CIPProvider]
+    created_at: datetime
+    updated_at: datetime
+    kyc: Optional[CIPKYCInfo] = None
+    document: Optional[CIPDocument] = None
+    photo: Optional[CIPPhoto] = None
+    identity: Optional[CIPIdentity] = None
+    watchlist: Optional[CIPWatchlist] = None
+
+    def __init__(self, *args, **kwargs):
+        # upcast into uuid
+        if "id" in kwargs and type(kwargs["id"]) == str:
+            kwargs["id"] = UUID(kwargs["id"])
+
+        if "account_id" in kwargs and type(kwargs["account_id"]) == str:
+            kwargs["account_id"] = UUID(kwargs["account_id"])
+
+        super().__init__(*args, **kwargs)