Skip to main content

Enum Types

A variety of enum types are specified in the payloads listed above. For simplification, all enum types are defined here.

Enum type definitions should be considered non-exhaustive and may be subject to extension.

EmploymentType​

enum EmploymentType {
    UNKNOWN,
    SELF_EMPLOYED,
    OTHER,
    FULL_TIME,
    PART_TIME,
    RETIRED,
    UNEMPLOYED,
    SEPARATE_MAINTENANCE_PAYMENTS,
}

OccupancyType​

enum OccupancyType {
    UNKNOWN,
    SOLD,
    PENDING_SALE,
    RENTAL,
    PRIMARY_RESIDENCE,
    SECONDARY_RESIDENCE,
    INVESTMENT,
    OTHER,
    RETAINED,
}

PropertyType​

enum PropertyType {
    UNKNOWN,
    PRIMARY,
    SECONDARY,
    INVESTMENT,
}

NextInquiryStepType​

enum NextInquiryStepType {
    UNKNOWN,
    NO_OFFERS,
    OFFERS_AVAILABLE,
    BORROWER_AUTH_REQUIRED, // The borrower needs to log into Figure
    BROKER_DOC_SIGNING_REQUIRED, // The borrower has logged into Figure but needs to sign broker docs agreement
    INQUIRY_COMPLETE,
    INQUIRY_CLOSED, // The inquiry has been closed through a manual action. e.g. cancellation
    INQUIRY_WITHDRAWN, // The inquiry is no longer active through an automated process. e.g. expired

    // Unhappy paths follow
    CREDIT_MATCH_REQUIRED,  // requires resolution or treat as NO_OFFERS
    MORE_ASSETS_REQUIRED,  // requires resolution or treat as NO_OFFERS
    LIEN_MATCHING_REQUIRED,  // requires resolution or treat as NO_OFFERS
    PROPERTY_VALUE_REQUIRED,  // requires resolution or treat as NO_OFFERS
    PAYOFF_REQUIRED, // requires resolution or treat as NO_OFFERS
    UNFREEZE_CREDIT, // requires resolution or treat as NO_OFFERS
    SELECT_PROPERTY, // requires resolution or treat as NO_OFFERS
}

OwnershipType​

enum OwnershipType {
    UNKNOWN,
    SOLE,
    JOINT,
    TRUST,
    LLC,
    OTHER,
}

FinancingPurposeType​

enum FinancingPurposeType {
    UNKNOWN,
    PERSONAL,
    BUSINESS_OR_COMMERCIAL,
}

OfferRateType​

enum OfferRateType {
    UNKNOWN,
    FIXED,
    VARIABLE,
}

LicenseHolderType​

enum LicenseHolderType {
    UNKNOWN,
    LENDER,
    BROKER,
    LOAN_OFFICER,
}

LicenseStateType​

enum LicenseStateType {
    UNKNOWN,
    UNSPECIFIED,
    FEDERAL_LICENSE,
    CA_RMLA_STATE_LICENSE,
    CA_CFL_STATE_LICENSE,
    CA_DRE_STATE_LICENSE,
}

CostType​

enum CostType {
        NOTARY_FEE,
        RECORDING_TAX,
        TITLE_FEE,
        BPO_FEE,
        DRIVE_BY_VALUATION_FEE,
        ONSITE_APPRAISAL_FEE,
    }

CoDeedStatusType​

enum CoDeedStatusType {
    INITIAL,
    IN_PROGRESS,
    COMPLETE,
}

UnderwritingCreditProvider​

enum UnderwritingCreditProvider {
    EXPERIAN,
    TRANS_UNION,
}

NotaryType​

enum NotaryType {
    NOT_APPLICABLE,
    ELECTRONIC,
    MANUAL,
}

PropertyType​

enum PropertyType {
  PRIMARY,
  SECONDARY,
  INVESTMENT,
}

PaymentRailType​

enum PaymentRailType {
  ACH,
  WIRE,
}

FundingTransactionStatusType​

enum FundingTransactionStatusType {
  PENDING,
  SENT,
  COMPLETE,
  CANCELLED,
  EXCEPTION,
  RETURNED,
  NOC,
  REQUIRES_APPROVAL,
}

EthnicityOriginType​

enum EthnicityOriginType {
  CUBAN,
  MEXICAN,
  PUERTO_RICAN,
  OTHER
}

GenderType​

enum GenderType {
  BOTH_MALE_AND_FEMALE,
  FEMALE,
  MALE
}

RaceType​

enum RaceType {
  AMERICAN_INDIAN_OR_ALASKA_NATIVE,
  ASIAN,
  BLACK_OR_AFRICAN_AMERICAN,
  NATIVE_HAWAIIAN_OR_OTHER_ISLANDER,
  WHITE
}

RaceDesignationType​

enum RaceDesignationType {
  ASIAN_INDIAN,
  CHINESE,
  FILIPINO,
  GUAMANIAN_OR_CHAMORRO,
  JAPANESE,
  KOREAN,
  NATIVE_HAWAIIAN,
  OTHER_ASIAN,
  OTHER_PACIFIC_ISLANDER,
  SAMOAN,
  VIETNAMESE
}

RateType​

enum RateType {
  VARIABLE,
  FIXED,
}

LiabilitySubType​

enum LiabilitySubType {
  LEASE,
  LOAN_SUB_TYPE,
  FEDERAL,
  PRIVATE,
  HELOC,
  LINE_OF_CREDIT,
  FLEXIBLE_SPENDING,
  CHARGE,
  SECURED,
  UNSECURED,
  PURCHASE,
  BUSINESS,
}

LiabilityType​

enum LiabilityType {
  AUTO,
  PERSONAL,
  FIGURE_SERVICING_HELOC,
  HOME_IMPROVEMENT,
  CREDIT_CARD,
  MORTGAGE,
  HELOC,
}

UnavailableReason​

enum UnavailableReason {
  NO_MATCHED_TRADELINE,
  NO_MATCHED_LIEN,
  NO_STATE_ELIGIBILITY,
  ABOVE_MAXIMUM_BALANCE,
  EXCLUDED_BY_CREDIT_SCORE,
  EXCLUDED_BY_CHARGED_OFF_ACCOUNT,
  EXCLUDED_BY_CREDIT_CARD_TOTAL_ACCOUNT_DTI,
  EXCLUDED_BY_NEXT_MIN_PAYMENT,
  EXCLUDED_BY_MONETARY_BALANCE,
  EXCLUDED_BY_MONETARY_ORIGINAL_LOAN_AMOUNT,
  EXCLUDED_BY_PAYMENT_CAPABILITY,
  EXCLUDED_BY_SUBSCRIPTION_CAPABILITY,
  EXCLUDED_BY_SENSITIVE_ACCOUNT_CAPABILITY,
  SEASONING_REQUIREMENTS_NOT_MET,
  OTHER,
}