Build a Metro 2 furnishing file for a reporting cycle

POST/lending-furnishing/packets

Dedicated lending:furnishing:write human staff authority (the furnishing_officer role) and authentication within five minutes required; lending:read/write and API keys are refused 403. Consumer identity is accepted on build, sealed at rest, and never returned on a packet read. Idempotent on the key. Each subject names exactly one of loan_id or facility_id. While an FCRA dispute is open the tradeline carries Metro 2 compliance condition code XB; a correction sets the Correction indicator.

Headers

Idempotency-KeystringRequired

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

cyclestringRequired

subjectsarray of objectsRequired

4 child attributes

consumerobjectRequired

Consumer is the confidential identity a tradeline is furnished under. It is accepted on build and sealed at rest; packet reads never return it.

11 child attributes

address_line1stringOptional

address_line2stringOptional

citystringOptional

ecoa_codestringOptional

first_namestringRequired

middle_namestringOptional

phonestringOptional

postal_codestringOptional

ssnstringOptional

statestringOptional

surnamestringRequired

facility_idstringOptional

loan_idstringOptional

Example loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm

original_creditorstringOptional

Returns

200 OK

The Credit Bureau Furnishing object.

Errors

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

400401403404409412413422424429500503