Skip to content
HALOWERK

File Formats and Conversion

csv foreign key reference coverage

CSV reference validation returns the count and positions of records without a matching reference key. Use it when an agent needs to check referential integrity before file handoff.

POST https://format.halowerk.com/v1/csv-foreign-key-reference-coverage

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
csvstringYes
delimiterSee schemaNo
keystringYes
referencestringYes
ref_keystringYes
Show full input schema
{
  "type": "object",
  "properties": {
    "csv": {
      "type": "string",
      "maxLength": 12000,
      "minLength": 1
    },
    "delimiter": {
      "enum": [
        ",",
        ";",
        "\t"
      ]
    },
    "key": {
      "type": "string",
      "maxLength": 70,
      "minLength": 1
    },
    "reference": {
      "type": "string",
      "maxLength": 12000,
      "minLength": 1
    },
    "ref_key": {
      "type": "string",
      "maxLength": 70,
      "minLength": 1
    }
  },
  "required": [
    "csv",
    "key",
    "reference",
    "ref_key"
  ],
  "additionalProperties": false
}

Open original schema

Published input example

{
  "csv": "code,class\n200,2\n201,2\n404,4",
  "key": "class",
  "reference": "k\n2\n4",
  "ref_key": "k"
}

Result & documentation

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-19 UTC.

More endpoints in this hub

All endpoints in this hub โ†’