> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.royalti.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Check Asset DDEX Readiness
> **GET /asset/{id}/ddex-readiness**
This endpoint requires authentication. Include your Bearer token in the Authorization header.
## Description
**GET /asset/{id}/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:**
| Parameter | Type | Description |
| --------- | ------ | ---------------------------------- |
| id | string | The 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
```javascript Node.js theme={null}
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);
```
```python Python theme={null}
import requests
response = requests.get(
'https://api.royalti.io/asset/example-id/ddex-readiness',
headers={
'Authorization': f'Bearer {token}'
},
)
data = response.json()
print(data)
```
```bash cURL theme={null}
curl -X GET https://api.royalti.io/asset/example-id/ddex-readiness \
-H "Authorization: Bearer YOUR_TOKEN" \
```
## OpenAPI
````yaml get /asset/{id}/ddex-readiness
openapi: 3.0.0
info:
title: Royalti.io API
description: "# Royalti API\r\n\r\nThis is the Royalti music royalty management platform API server.\r\n\r\n## Overview\r\n\r\nThe Royalti API provides comprehensive music royalty management services including:\r\n- Music publishing and writer management\r\n- Royalty processing and analytics\r\n- DDEX integration for music industry standards\r\n- File processing and pattern recognition\r\n- Payment processing and distribution\r\n\r\n## Authentication\r\n\r\nThe API uses JWT-based authentication with multiple protection levels:\r\n- Public endpoints for basic operations\r\n- Protected endpoints requiring valid JWT tokens\r\n- Admin endpoints for administrative functions\r\n\r\n## Features\r\n\r\n- Multi-dimensional royalty analytics\r\n- CWR (Collective Works Registration) support\r\n- DDEX integration for music metadata\r\n- Advanced file processing with pattern recognition\r\n- Real-time data processing with queue system"
version: 2.6.0
contact:
name: Royalti.io Support
email: support@royalti.io
url: https://royalti.io
license:
name: Proprietary
url: https://royalti.io/terms
servers:
- url: https://api.royalti.io
description: Production server
- url: https://api-dev.royalti.io
description: Development server
- url: http://localhost:8084
description: Local development
security:
- bearerAuth: []
tags:
- name: Accounting
description: Accounting and financial transaction operations
- name: DDEX
description: DDEX operations (ERN/MEAD, messages, delivery, providers)
- name: Label
description: Label management operations
- name: Internal Webhooks
description: Internal system webhooks for royalty processing and downloads
- name: Payment Webhooks
description: Payment processor webhook endpoints
- name: Billing Webhooks
description: Stripe billing and subscription webhooks
- name: Infrastructure Webhooks
description: Cloudflare domain and SSL webhooks
- name: Distribution Webhooks
description: Digital distribution platform webhooks (FUGA)
paths:
/asset/{id}/ddex-readiness:
get:
tags:
- Asset
summary: Check Asset DDEX Readiness
description: >-
**GET /asset/{id}/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:**
| Parameter | Type | Description |
| --- | --- | --- |
| id | string | The 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
parameters:
- name: id
in: path
required: true
description: Asset ID
schema:
type: string
responses:
'200':
description: Readiness check completed
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: success
message:
type: string
example: DDEX readiness check completed
data:
type: object
properties:
assetId:
type: string
isReady:
type: boolean
description: Whether asset is ready for DDEX delivery
readinessScore:
type: integer
minimum: 0
maximum: 100
description: Readiness score out of 100
missingFields:
type: array
items:
type: string
description: List of required fields that are missing
invalidFields:
type: array
items:
type: object
properties:
field:
type: string
currentValue:
type: string
reason:
type: string
description: List of fields with invalid values
warnings:
type: array
items:
type: string
description: Non-blocking validation warnings
suggestions:
type: object
description: Suggested values for missing fields
additionalProperties: true
requiredForDelivery:
type: array
items:
type: string
description: Fields required for DDEX delivery
example:
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
'401':
$ref: '#/components/responses/Unauthorized'
'404':
description: Asset not found
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Asset not found
'500':
$ref: '#/components/responses/ServerError'
security:
- bearerAuth: []
components:
responses:
Unauthorized:
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: error
message:
type: string
example: Unauthorized
ServerError:
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
schemas:
Error:
type: object
properties:
success:
type: boolean
example: false
error:
type: object
properties:
code:
type: string
message:
type: string
details:
type: array
items:
type: string
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: >-
JWT Authorization header using the Bearer scheme. Format: "Bearer
{token}"
````