---
title: Enum reference
---

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.

## AttestationDefinitionType {% #attestationdefinitiontype %}

```
enum AttestationDefinitionType {
    LO_RECEIVED_BORROWER_INFO,
    LO_ANALYZED_INCOME,
    LO_EDUCATED_BORROWER,
    LO_UPLOADED_DOCUMENTS,
    LO_AGREED_WITH_SIGNATURE,
}
```

## CoDeedStatusType {% #codeedstatustype %}

```
enum CoDeedStatusType {
    INITIAL,
    IN_PROGRESS,
    COMPLETE,
}
```

## CostType {% #costtype %}

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

## EmploymentType {% #employmenttype %}

```
enum EmploymentType {
    OTHER,
    SELF_EMPLOYED,
    FULL_TIME,
    PART_TIME,
    RETIRED,
    UNEMPLOYED,
    ALIMONY,
    CHILD_SUPPORT,
    PUBLIC_ASSISTANCE_PROGRAM,
    SEPARATE_MAINTENANCE_PAYMENTS,
}
```

## EntityType {% #entitytype %}

```
enum EntityType {
    SOLE_PROPRIETORSHIP,
    SINGLE_OWNER_LLC,
    PARTNERSHIP,
    MULTI_OWNER_LLC,
    S_CORP
}
```

## EthnicityOriginType {% #ethnicityorigintype %}

```
enum EthnicityOriginType {
  CUBAN,
  MEXICAN,
  PUERTO_RICAN,
  OTHER
}
```

## FinancingPurposeType {% #financingpurposetype %}

```
enum FinancingPurposeType {
    UNKNOWN,
    DEBT_CONSOLIDATION,
    HOME_IMPROVEMENT,
    MAJOR_PURCHASE,
    TRAVEL,
    EDUCATION,
    HEALTH_MEDICAL,
    CARING_FOR_FAMILY,
    RETIREMENT,
    SMALL_BUSINESS,
    HOME_IMPROVEMENT_SMALL_BUSINESS,
    SOLAR_ENERGY_EFFICIENT_INSTALLATION,
    OTHER,
}
```

## FundingTransactionStatusType {% #fundingtransactionstatustype %}

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

## GenderType {% #gendertype %}

```
enum GenderType {
  BOTH_MALE_AND_FEMALE,
  FEMALE,
  MALE
}
```

## LiabilitySubType {% #liabilitysubtype %}

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

## LiabilityType {% #liabilitytype %}

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

## LicenseHolderType {% #licenseholdertype %}

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

## LicenseStateType {% #licensestatetype %}

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

## NextInquiryStepType {% #nextinquirysteptype %}

```
enum NextInquiryStepType {
    UNKNOWN,
    NO_OFFERS,
    OFFERS_AVAILABLE,
    OFFER_SELECTION_PENDING, // An offer selection is being recalculated; no webhook is sent when this step begins, so poll details until it changes. Reverts to OFFERS_AVAILABLE on failure
    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
}
```

## NotaryType {% #notarytype %}

```
enum NotaryType {
    NOT_APPLICABLE,
    ELECTRONIC,
    MANUAL,
}
```

## OfferRateType {% #offerratetype %}

```
enum OfferRateType {
    UNKNOWN,
    FIXED,
    VARIABLE,
}
```

## OwnershipType {% #ownershiptype %}

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

## PayOffStatusType {% #payoffstatustype %}

```
enum PayOffStatusType {
  MARKED_FOR_PAYOFF,
  PAID_OFF,
  PAYOFF_REQUESTED,
  PAYOFF_FAILED,
  PAYOFF_REVERSAL,
  PAYOFF_REVERSAL_PROCESSING,
}
```

## PaymentRailType {% #paymentrailtype %}

```
enum PaymentRailType {
  ACH,
  WIRE,
}
```

## PropertyType {% #propertytype %}

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

## RaceDesignationType {% #racedesignationtype %}

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

## RaceType {% #racetype %}

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

## RateType {% #ratetype %}

```
enum RateType {
  VARIABLE,
  FIXED,
}
```

## SuffixType {% #suffixtype %}

```
enum SuffixType {
    I,
    II,
    III,
    IV,
    V,
    JR,
    SR,
}
```

## UnavailableReason {% #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,
}
```

## UnderwritingCreditProvider {% #underwritingcreditprovider %}

```
enum UnderwritingCreditProvider {
    EXPERIAN,
    TRANS_UNION,
}
```