833 Mortgage Credit Report Order (004020)

This is the standard X12 004020 spec, with 17 loops and 79 segment positions, as OpenEDI JSON, an ediFabric C# template and an ediFabric Native model. To change it for a trading partner, customize it in the EDI Spec Builder.

Loading the spec…

The spec as an OpenAPI 3 schema with x-openedi-* extensions, for ediFabric Native, ediFabric Cloud and the EDI Spec Builder. Download OpenEDI (128 KB) Generate classes

The ediFabric .NET template, class TS833. It needs the common segments, composites and codes of X12 004020, one download for every transaction in the version. Download C# (1 KB) Common files (254 KB)

The intermediary model ediFabric Native loads with set_map. Download Native (96 KB)

Use the 833 spec in your code

ediFabric .NET

Add the C# template and its common files to your project, or reference the template NuGet package, and read 833 files into TS833 objects. See ediFabric .NET.

ediFabric Native

Map version 004020 to the Native model with set_map, then parse 833 files to JSON from Python, Java, C or C#. See Convert between EDI and JSON.

OpenEDI

Select Customize in Spec Builder to copy the spec under your own name, change it for your partner, and parse files against it in EdiNation, ediFabric Native or ediFabric Cloud. Read about OpenEDI.

Generate 833 classes in Python, Java, Node.js, Go, Rust or C

ediFabric Native returns each 833 as JSON, with the property names of the OpenEDI schema. To work with that JSON as typed objects, generate classes from the OpenEDI file in your language and deserialize the JSON into TS833. Serialize the objects back to JSON to build EDI with ediFabric Native. The classes keep the loops, segments, lengths and code lists, but not the EDI data formats, so validate files with ediFabric Native. Read more in Generate a class from OpenEDI.

Python: datamodel-code-generator. Node.js: openapi-typescript. Java, Go, Rust and C: OpenAPI Generator.

833 structure

Loops and segments of the standard 833, with their usage and maximum repeats.

ID	Name	Usage	Max use
ST	Transaction Set Header	Optional	1
BGN	Beginning Segment	Mandatory	1
Loop N1	Name	Mandatory	100
N1	Name	Mandatory	1
N2	Additional Name Information	Optional	2
REF	Reference Identification	Optional	12
PER	Administrative Communications Contact	Optional	3
Loop N4	Geographic Location	Optional	5
N4	Geographic Location	Mandatory	1
N3	Address Information	Optional	2
Loop CRO	Credit Report Order Details	Mandatory	200
CRO	Credit Report Order Details	Mandatory	1
REF	Reference Identification	Optional	>1
PER	Administrative Communications Contact	Optional	3
K2	Administrative Message	Optional	10
LRQ	Mortgage Characteristics Requested	Optional	1
DTP	Date or Time or Period	Optional	1
Loop N1	Name	Optional	20
N1	Name	Mandatory	1
N2	Additional Name Information	Optional	2
N3	Address Information	Optional	2
N4	Geographic Location	Optional	1
REF	Reference Identification	Optional	12
PER	Administrative Communications Contact	Optional	3
PWK	Paperwork	Optional	1
Loop NX1	Property or Entity Identification	Optional	20
NX1	Property or Entity Identification	Mandatory	1
NX2	Location ID Component	Optional	10
DTP	Date or Time or Period	Optional	1
QTY	Quantity	Optional	1
Loop LX	Assigned Number	Mandatory	2
LX	Assigned Number	Mandatory	1
REF	Reference Identification	Optional	12
PER	Administrative Communications Contact	Optional	3
AIN	Income	Optional	10
PPY	Personal Property Description	Optional	10
CAI	Civil Action Income	Optional	20
CIV	Civil Action Liability	Optional	20
YNQ	Yes/No Question	Optional	12
DTP	Date or Time or Period	Optional	1
QTY	Quantity	Optional	20
Loop AMT	Monetary Amount	Optional	10
AMT	Monetary Amount	Mandatory	1
MSG	Message Text	Optional	1
Loop REA	Real Estate Property Information	Optional	20
REA	Real Estate Property Information	Mandatory	1
FPT	Financial Participation	Optional	1
AMT	Monetary Amount	Optional	6
NX1	Property or Entity Identification	Optional	1
NX2	Location ID Component	Optional	30
Loop IN1	Individual Identification	Mandatory	30
IN1	Individual Identification	Mandatory	1
IN2	Individual Name Structure Components	Optional	10
DMG	Demographic Information	Optional	1
N10	Quantity and Description	Optional	1
ACT	Account Identification	Optional	1
Loop NX1	Property or Entity Identification	Mandatory	10
NX1	Property or Entity Identification	Mandatory	1
NX2	Location ID Component	Mandatory	30
ARS	Applicant Residence Specifics	Optional	1
DTP	Date or Time or Period	Optional	1
N10	Quantity and Description	Optional	1
Loop N1	Name	Optional	500
N1	Name	Mandatory	1
N2	Additional Name Information	Optional	2
N3	Address Information	Optional	2
N4	Geographic Location	Optional	1
REF	Reference Identification	Optional	12
PER	Administrative Communications Contact	Optional	3
YNQ	Yes/No Question	Optional	3
Loop EMP	Employer	Optional	20
EMP	Employer	Mandatory	1
DTP	Date or Time or Period	Optional	2
QTY	Quantity	Optional	2
Loop EMS	Employment Position	Optional	10
EMS	Employment Position	Mandatory	1
DTP	Date or Time or Period	Optional	1
QTY	Quantity	Optional	1
AIN	Income	Optional	10
Loop FAA	Financial Asset Account	Optional	100
FAA	Financial Asset Account	Mandatory	1
DTP	Date or Time or Period	Optional	1
AIN	Income	Optional	5
Loop IN1	Individual Identification	Optional	10
IN1	Individual Identification	Mandatory	1
IN2	Individual Name Structure Components	Optional	10
FPT	Financial Participation	Optional	1
Loop CDA	Consumer Credit Account	Optional	100
CDA	Consumer Credit Account	Mandatory	1
DTP	Date or Time or Period	Optional	1
PPY	Personal Property Description	Optional	5
Loop IN1	Individual Identification	Optional	10
IN1	Individual Identification	Mandatory	1
IN2	Individual Name Structure Components	Optional	10
FPT	Financial Participation	Optional	1
SE	Transaction Set Trailer	Optional	1