Back to Home
Technical Reference

Documentation

Everything you need to integrate, validate, and distribute compliant metadata through the compliance engine.

Getting Started

Onboard your catalog and run your first validation in under five minutes.

Create an Account

Register your organization to access the compliance dashboard. Each organization can have multiple team members with role-based access (admin, validator, viewer).

Upload Your Metadata

Drop audio files, CSV exports, DDEX messages (ERN 3.8.2 / 4.1.1), or JSON payloads. The parser auto-detects format and maps over 2,400 fields to our internal schema.

Select Target Stores

Choose which DSPs to validate against. Each store has its own rule set — ISRC format, genre taxonomy, artwork specs, title constraints, and more.

Review Results

The engine returns a field-by-field validation matrix with pass, fail, and warning states. Drill into any rule to see the exact specification it references.

Supported Formats

The ingestion layer accepts the following input formats:

DDEX (ERN)

Electronic Release Notification messages — ERN 3.4.2, 3.8.2, and 4.1.1. Full support for NewReleaseMessage, PurgeReleaseMessage, and ActionNotificationMessage.

CSV / TSV

Tabular metadata exports from distribution platforms. Column mapping is auto-detected from headers; manual override available for non-standard schemas.

JSON

RESTful API payloads in our schema or any third-party schema. Provide a mapping document and we normalize to canonical fields.

Audio Files

MP3, FLAC, WAV, M4A. Embedded ID3v2.4, Vorbis comments, and MP4 atoms are parsed for embedded metadata cross-validation.

Validation Rules

Each store rule set is versioned and maintained alongside DSP API changelogs. Rule categories include:

Identifiers

ISRC (ISO 3901), UPC/EAN-13 with check digit verification, ISWC, ISNI. Collision detection across your catalog and against known registries.

Text & Encoding

Character encoding validation (UTF-8), prohibited special characters per store, max length enforcement, language code verification (ISO 639-1/639-2).

Taxonomy

Genre mapping to each store's proprietary taxonomy. Spotify has 5,000+ micro-genres; Apple uses a flat hierarchy; Deezer uses a nested 3-level system.

Artwork

Resolution minimums (3000×3000px for most stores), color space (RGB/sRGB), file format, file size, text overlay detection, and aspect ratio checks.

Rights & Credits

Copyright fields (P-line, C-line), contributor roles (Performer, Songwriter, Producer, Mixer), and display name formatting per store specification.

API Reference

Programmatic access to the compliance engine. All endpoints return JSON.

Authentication

Requests are authenticated via Bearer token. Obtain your API key from the dashboard under Settings → API Keys. Include it in the Authorization header: Bearer <your_key>.

POST /v1/validate

Submit metadata for validation. Accepts a JSON payload or multipart form data for file uploads. Returns a validation job ID. Poll GET /v1/jobs/{id} for results, or subscribe to the webhook callback.

GET /v1/jobs/{id}

Retrieve validation results. Response includes per-field status, rule references, suggested fixes, and a compliance score (0–100).

POST /v1/export

Generate a certified metadata package. Specify output format (DDEX, JSON, CSV) and target store. Returns a signed download URL valid for 24 hours.

GET /v1/stores

List all supported stores with their current rule set versions, last-updated timestamps, and field coverage counts.

Rate Limits

Standard tier: 100 requests/minute. Enterprise tier: 1,000 requests/minute with dedicated infrastructure. Rate limit headers included in every response.

DDEX Standards

We implement and validate against the following DDEX message standards:

ERN (Electronic Release Notification)

The core message for communicating release metadata. We support versions 3.4.2, 3.8.2, and 4.1.1, with automatic schema validation and cross-field consistency checks.

MEAD (Music Enrichment and Description)

Supplementary metadata for mood, tempo, instrumentation, and lyrical themes. MEAD messages are validated against the DDEX MEAD 1.2 schema.

DSP Profile Conformance

Each DSP publishes a profile (subset) of the full DDEX standard. We validate that your ERN message conforms to each target store's specific profile requirements.

CLI Usage

For batch processing and CI/CD integration, use the Compliance SDK CLI.

Installation

npm install -g @metadata-style-guidelines/cli

Validate a File

msg validate --input release.json --stores spotify,apple,amazon --format json

$ msg validate --input release.json --stores spotify,apple,amazon --format json

Export Certified Package

msg export --input release.json --store spotify --format ddex --output ./certified/

$ msg export --input release.json --store spotify --format ddex --output ./certified/

CI/CD Integration

The CLI exits with code 0 on full compliance, 1 on warnings, 2 on failures. Integrate into your build pipeline to block non-compliant releases before delivery.

$ The CLI exits with code 0 on full compliance, 1 on warnings, 2 on failures. Integrate into your build pipeline to block non-compliant releases before delivery.