Get Package Config

Retrieve a single matching package config by ID, including its document-type slots, presence rules, and pass criteria.

Retrieve a single matching package config by its UUID. The response is the full config: its name, the document-type slots with their matching config IDs and presence rules, the pass criteria, and resource links. The config must belong to your organization.

Use this endpoint to inspect a config before triggering a run, to confirm the document types and presence rules are what you expect, or to hydrate a config editor. The links.runs URL points at the run list filtered to this config so you can jump straight to its run history.

Lookups are tenant-scoped. A config that does not exist, or that belongs to another organization, returns 404 not_found rather than leaking its existence. Pass the id exactly as returned by the create or list endpoints.

Response

{
  "id": "pkg_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Shipment bundle",
  "document_type_configs": [
    { "document_type": "invoice", "matching_config_id": "mc_uuid_1", "presence": "required" },
    { "document_type": "delivery_note", "matching_config_id": "mc_uuid_2", "presence": "expected" },
    { "document_type": "contract", "matching_config_id": "mc_uuid_3", "presence": "optional" }
  ],
  "pass_criteria": {
    "all_required_matched": true,
    "min_confidence": 0.8,
    "allow_review_on_expected": true
  },
  "created_at": "2024-09-14T10:32:00.000Z",
  "updated_at": "2024-09-14T10:32:00.000Z",
  "links": {
    "self": "/v1/matching/packages/configs/pkg_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "runs": "/v1/matching/packages/runs?package_config_id=pkg_a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
}

Errors