Edit Errors JSON schema

Error JSON

Specification

{
    "syntactical": {
        "identifier": {               // S100, etc
            "scope": "...",           // One of hmda, ts, lar
            "explanation": "...",
            "description": "...",
            "errors": [{
                "properties": {
                    "property": "value" // Property can be looked up via "scope" or be plain text for no lookup
                },
                "loanNumber": "...",  // If applicable (LAR)
                "lineNumber": "..."   // If applicable (TS/HMDA File)
            }]
        }
    },
    "validity": {
      
    },
    "quality": {
      
    },
    "macro": {
      
    },
    "special": {

    }
}

Originally defined here: https://gist.github.com/stevejameskent/87439cd3e2abfcec702e

Example

{
    "syntactical": {
        "S028": {
            "scope": "ts",
            "description": "Timestamp must be numeric and in ccyymmddhhmm format.",
            "explanation": "Timestamp is missing or nonnumeric (format = ccyymmddhhmm).",
            "errors": [
                {
                    "lineNumber": "1",
                    "properties": {
                        "timestamp": "cat"
                    }
                }
            ]
        }
    },
    "validity": {
        "V125": {
            "scope": "ts",
            "description": "Tax ID number must be in NN-NNNNNNN format and not = (99-9999999 or 00-0000000 or blank).",
            "explanation": "Tax ID number not in valid format or is missing.",
            "errors": [
                {
                    "lineNumber": "1",
                    "properties": {
                        "taxID": "99-9999999"
                    }
                }
            ]
        }
     },
    "quality": {
        "Q026": {
            "scope": "lar",
            "description": "If action taken type = 1-5, 7, or 8, and (application date ≥ 20040101 and not = NA), then applicant ethnicity, race and/or sex should not = 4, 7, or 4, respectively.",
            "explanation": "Applicant ethnicity, race and/or sex = 4, 7, or 4, respectively; Verify.",
            "errors": [
                {
                    "lineNumber": "2",
                    "properties": {
                        "applicantEthnicity": "4",
                        "applicantRace1": "7",
                        "applicantSex": "1",
                        "applicationReceivedDate": "20130117",
                        "actionTaken": "5"
                    },
                    "loanNumber": "ABCDEFGHIJKLMNOPQRSTUVWXY"
                },
                {
                    "lineNumber": "3",
                    "properties": {
                        "applicantEthnicity": "4",
                        "applicantRace1": "7",
                        "applicantSex": "1",
                        "applicationReceivedDate": "20130117",
                        "actionTaken": "5"
                    },
                    "loanNumber": "ABCDEFGHIJKLMNOPQRSTUVWXY"
                },
                {
                    "lineNumber": "4",
                    "properties": {
                        "applicantEthnicity": "4",
                        "applicantRace1": "7",
                        "applicantSex": "1",
                        "applicationReceivedDate": "20130117",
                        "actionTaken": "5"
                    },
                    "loanNumber": "ABCDEFGHIJKLMNOPQRSTUVWXY"
                }
            ]
        }
    },
    "macro": {
        "Q075": {
            "scope": "hmda",
            "description": "If 750 or greater loans are reported with purpose of loan = 1, action taken type = 1 or 6, property type = 1 or 2, then of these loans, the difference between the percentage of loans that are sold in the current year and the percentage of the same type of loans sold in the prior year should be less than (+ or -) 20%.",
            "explanation": "Action taken type = 1 or 6, loan purpose = 1, property type = 1 or 2. If 750 or greater loans of these loans are reported in the current year, then of these loans, the difference in the percentage of loans that are sold in the current year and the percentage of loans sold in the prior year should be less than (+ or -) 20%. Percent of government backed home purchases = # home purchase loans where loan type = 2 or 3 / # home purchase loans for the current year or previous year.",
            "errors": [
                {
                    "properties": {
                        "Total loans where loan purpose = 1, action taken = 1 or 6, and property type = 1 or 2": 1207,
                        "Previous Year Loans": 508,
                        "Previous Year Sold Loans": 288,
                        "Previous Year Percentage": "56.69",
                        "Current Year Loans": "1207",
                        "Current Year Sold Loans": "0",
                        "Current Year Percentage": "0.00",
                        "Percentage Difference": "-56.69"
                    }
                }
            ]
        }
    },
    "special" : {
        "Q595": {
            "scope": "hmda",
            "description": "If action taken type = 1-5, 7, or 8, then MSA/MD must = a corresponding respondent, MSA/MD combination on respondent panel, or NA.",
            "explanation": "MSA/MD not on respondent panel.",
            "errors": [
                {
                    "properties": {
                        "LAR Count": 2088,
                        "MSA/MD": "49740",
                        "MSA/MD name": "Yuma, AZ"
                    }
                }
            ]
        }
    }
}