Read one product version in the Corgi BIAN 14 directory profile

GET/products/{code}/versions/{version}/directory

Path parameters

codestringRequired

versionstringRequired

Returns

200 OK

ProductobjectRequired

5 child attributes

ProductIdentificationobjectRequired

2 child attributes

ProductIdentificationobjectRequired

1 child attribute

IdentifierValuestringRequired

ProductIdentificationTypestringRequired

ProductLifecycleStatusobjectRequired

1 child attribute

ProductStatusTypestringRequired

ProductNameobjectRequired

1 child attribute

NamestringRequired

ProductTypestringRequired

ProductVersionstringRequired

ProductDirectoryEntryobjectRequired

1 child attribute

ProductVersionstringRequired

bian_versionstringRequired

profilestringRequired

x-corgi-termsobjectRequired

Product is one version of a product definition.

24 child attributes

allow_negativebooleanRequired

analysisobject or nullOptional

Business analysis checking: earnings credit against fees

2 child attributes

earnings_credit_bpsintegerRequired

per_item_fee_minorintegerRequired

codestringRequired

currencystringRequired

customer_typestringRequired

familystringRequired

feesarray of objectsRequired

5 child attributes

amount_minorintegerRequired

kindstringRequired

triggerstringRequired

Monthly, or per_event_* (assessed by the service that sees the event)

waiver_methodstringOptional

How the minimum balance is measured, as disclosed under Reg DD 1030.4(b)(4)(ii): daily (every day of the cycle) or average_daily

waiver_min_balance_minorintegerRequired

gl_codestringRequired

interestobject or nullOptional

Interest terms of a deposit product.

6 child attributes

accrualstringRequired

annual_rate_bpsintegerRequired

day_countstringRequired

postingstringRequired

tieringobject or nullOptional

2 child attributes

methodstringRequired

Whole_balance (Reg DD method A) or marginal (method B)

tiersarray of objectsRequired

variablebooleanRequired

kindstringRequired

ledger_namespacestringRequired

lendingobject or nullOptional

Lending terms of a loan product.

15 child attributes

allowanceobject or nullOptional

The CECL loss-rate table

5 child attributes

30_59_bpsintegerRequired

60_89_bpsintegerRequired

90_plus_bpsintegerRequired

current_bpsintegerRequired

nonaccrual_bpsintegerRequired

charge_off_daysintegerRequired

Days past due at which the balance is charged off against the allowance (120 for closed-end consumer credit)

escrowbooleanOptional

The instalment carries an escrow for taxes and insurance (mortgages)

facilityobject or nullOptional

A credit facility rather than an instalment loan

21 child attributes

advance_bpsintegerOptional

Factoring, floor plan, warehouse: advance against the item's face

borrowing_basebooleanOptional

Availability is the lesser of the limit and the certified base

converts_to_product_codestringOptional

Construction: the permanent loan product

curtailment_bpsintegerOptional

Floor plan: share of the advance due at each curtailment

curtailment_daysintegerOptional

Floor plan: days until the first principal curtailment

draw_period_monthsintegerOptional

Revolving: draws allowed for this long; 0 is open-ended

expiry_monthsintegerOptional

Letters of credit

factor_rate_bpsintegerOptional

Merchant cash advance: owed = purchase × factor

fee_bpsintegerOptional

Letters of credit: annual fee; factoring: per invoice

holdback_bpsintegerOptional

Merchant cash advance: share of card receipts remitted

interest_onlybooleanOptional

inventory_advance_bpsintegerOptional

max_days_on_lineintegerOptional

Factoring, floor plan, warehouse: an item outstanding longer is past due

min_payment_bpsintegerOptional

Revolving: the principal share of the minimum payment

min_payment_floor_minorintegerOptional

Revolving: the minimum payment floor

payment_due_daysintegerOptional

Days after the statement the payment is due (the CARD Act's 21-day floor)

receivables_advance_bpsintegerOptional

recoursebooleanOptional

Factoring: the client stands behind uncollected invoices

repayment_monthsintegerOptional

Revolving: the amortising period after the draw period

secured_bystringOptional

typestringRequired

Revolving, construction, letter_of_credit, factoring, floor_plan, merchant_cash_advance, warehouse

grace_daysintegerRequired

guaranteeobject or nullOptional

A government guarantee on the loan (SBA 7(a), 504, USDA)

2 child attributes

guaranteed_bpsintegerRequired

programstringRequired

Sba_7a, sba_504, usda

late_fee_minorintegerRequired

max_dti_bpsintegerRequired

max_principal_minorintegerRequired

max_term_monthsintegerRequired

min_credit_scoreintegerRequired

min_principal_minorintegerRequired

min_term_monthsintegerRequired

nonaccrual_daysintegerRequired

Days past due at which accrual stops and uncollected interest is reversed (90 is the general trigger)

origination_fee_bpsintegerRequired

limitsobjectRequired

Limits on money movement for the product.

2 child attributes

daily_minorintegerRequired

per_transaction_minorintegerRequired

namestringRequired

now_notice_daysintegerOptional

posting_policyobject or nullOptional

PostingPolicy describes the order the running ledger actually enforces. New ordering mechanisms require an engine change; arbitrary amount sorting is not a supported setting.

2 child attributes

orderstringRequired

versionintegerRequired

regulatoryobject or nullOptional

Where the product's balances report: Call Report items and the FR 2900 class

7 child attributes

fr2900_classstringOptional

Deposits: transaction, savings (money market included) or time

interest_bearingbooleanOptional

Deposits: RC 13.a.(2) when true, 13.a.(1) when not

rc_c_itemstringOptional

Loans: the Schedule RC-C loan category, 4.a commercial and industrial, 6.c other consumer

rc_e_columnstringOptional

Deposits: transaction or nontransaction (Schedule RC-E columns)

rc_e_itemstringOptional

Deposits: the RC-E depositor line, 1 for individuals, partnerships and corporations

rc_n_categorystringOptional

Loans: the Schedule RC-N line, the same category as RC-C unless the schedule splits it

ri_itemstringOptional

The Schedule RI income or expense item the product's interest reports on

sourcestringRequired

statement_cyclestringRequired

statusstringRequired

termobject or nullOptional

Certificates of deposit: the term, penalty and what happens at maturity

9 child attributes

at_maturitystringRequired

Rollover or pay_out

brokerstringOptional

The deposit broker of record

brokeredbooleanRequired

Deposits taken through an intermediary (RC-E memoranda)

early_withdrawal_penaltystringRequired

Days_of_interest

grace_daysintegerRequired

Days after maturity to withdraw without penalty

minimum_deposit_minorintegerOptional

The smallest opening deposit, in minor units; 0 means none. Enforced by accounts at funding

monthsintegerRequired

penalty_daysintegerRequired

Days of simple interest forfeited on early withdrawal

rollover_product_codestringRequired

The product the balance rolls into (often itself)

transfer_limitobject or nullOptional

Money market and savings: the convenient-transfer limit, when the bank keeps one

3 child attributes

enforcementstringRequired

Refuse or fee

excess_fee_minorintegerRequired

per_statement_cycleintegerRequired

0 means no limit

typestringOptional

Deposit products: checking, now, savings, money_market, certificate

versionintegerRequired

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503