Reference Data Endpoints

Many Biz Core integrations require enumerated reference values — countries, genders, loan products, frequencies, and so on. Rather than hard-coding these or duplicating them across your codebase, fetch them at runtime from the resource endpoints below and cache the results locally.

---

When You'll Need These

• Building customer intake forms (lead capture, loan application).
• Validating user input before submission.
• Populating dropdowns and selectors in your UI.
• Mapping internal codes to Biz Core identifiers during data import or sync.

---

Caching Strategy

Reference data updates infrequently but is not static. Recommended approach:

• Fetch on application startup and cache in memory or a fast key-value store.
• Refresh on a schedule (e.g. daily) or via TTL (e.g. 24 hours).
• For values that change more often — loan products in particular, as products may be added or repriced — consider a shorter refresh interval, and revalidate on-demand before critical workflows such as loan creation.

ℹ️ Note: Updates to reference data are not pushed via webhooks. Your refresh strategy is the only mechanism to stay current.

---

Endpoints by Category

Geography

• Get Countries — All supported countries.
• Get States by Country — States or territories within a given country.

Customer Demographics

• Get Genders — Gender options.
• Get Marital Statuses — Marital status options.

Contact Details

• Get Phone Types — Phone type categories (mobile, residential, business).

Employment & Income

• Get All Frequencies — Payment, income, and expense frequencies (used across employment, additional income, rent, and living expense fields).

Loan Origination

• Get Loan Reasons — Valid loan purposes.
• Get Loan Products Basic Details — Available loan products with terms, limits, and fees.
• Get Loan Product Risk Categories — Risk classifications associated with each loan product.

Assets & Security

• Get Vehicle Types — Supported vehicle types.
• Get Property Types — Supported property types.

Payments

• Get All Transaction Source Types — Supported transaction source types (bank account, card, PayID).
• Get PayID Types — Supported PayID identifier types.

---

Usage Pattern

flowchart LR
    A[Application<br/>startup] --> B[Call resource<br/>endpoints]
    B --> C[Cache results<br/>locally]
    C --> D[Use cached<br/>values in workflows]
    D --> E{Refresh<br/>due?}
    E -->|Yes| B
    E -->|No| D

    style A fill:#e6f1fb,stroke:#185fa5,color:#0c447c
    style C fill:#eaf3de,stroke:#3b6d11,color:#173404

---

Where These Are Used

---

Record Reference Prefixes

Every record created in Biz Core is assigned a unique reference number prefixed by its record type. These references appear throughout API payloads and webhooks as customerRef, leadRef, loanApplicationRef, loanRef, and so on.

Records are linked — a single Customer can have Leads, Applications, Loans, and Agreements associated with them. For status reference and transition rules, see Records & Statuses in the user knowledge base.