Skip to main content
GET
/
asset
/
{id}
/
ddex-readiness
Check Asset DDEX Readiness
curl --request GET \
  --url https://api.royalti.io/asset/{id}/ddex-readiness \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "message": "DDEX readiness check completed",
  "data": {
    "assetId": "asset-123",
    "isReady": false,
    "readinessScore": 75,
    "missingFields": [
      "resourceReference",
      "soundRecordingDetails.recordingDate"
    ],
    "invalidFields": [
      {
        "field": "isrc",
        "currentValue": "INVALID",
        "reason": "ISRC format is invalid. Expected format: CC-XXX-YY-NNNNN"
      }
    ],
    "warnings": [
      "Technical resource details not provided. Will use default values."
    ],
    "suggestions": {
      "resourceReference": "A123456789",
      "soundRecordingDetails": {
        "recordingDate": "2024-01-01"
      }
    },
    "requiredForDelivery": [
      "title",
      "isrc",
      "displayArtist",
      "resourceReference",
      "soundRecordingDetails"
    ]
  }
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

GET /asset//ddex-readiness Description: Check if an asset is ready for DDEX delivery by validating all required metadata fields. This endpoint performs comprehensive validation and returns a readiness status along with any missing or invalid fields. Method: GET Path Parameter:
ParameterTypeDescription
idstringThe unique identifier of the asset
Response includes:
  • Overall readiness status (ready/not_ready)
  • List of missing required fields
  • List of invalid field values
  • Suggestions for fixing issues
  • Validation warnings (non-blocking issues)
Use Cases:
  • Pre-flight check before product delivery
  • Identify missing metadata
  • Validate DDEX compliance
  • Quality assurance for digital distribution

​
Code Examples

const response = await fetch('https://api.royalti.io/asset/example-id/ddex-readiness', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${token}`,
  },
});

const data = await response.json();
console.log(data);

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Path Parameters

​
id
string
required

Asset ID

Response

Readiness check completed

​
status
string
Example:

"success"

​
message
string
Example:

"DDEX readiness check completed"

​
data
object