Uploads

Validate an upload create

Copy page

Dry-runs POST/api/v3/uploads with the same body. Returns the same problem the create would return, or a verdict saying it would succeed.

POST/api/v3/uploads/validate-create

Validate an upload create

Dry-runs `POST /api/v3/uploads` with the same body. Returns the same problem the create would return, or a verdict saying it would succeed. Requires `customisers:write`. Nothing is created, no target is minted, no idempotency key is consumed, and no budget is spent.

Validate an upload create

Overview

Requires customisers:write. Nothing is created, no target is minted, no idempotency key is consumed, and no budget is spent.

Authorisation

Bearer token required. Include it in theAuthorization header.

Required scope: customisers:write

Request body

purposestringbody

filenamestringbody

content_typestringbody

byte_sizeintegerbody

Request body example

{
  "purpose": "font_ttf",
  "filename": "Signature.ttf",
  "content_type": "font/ttf",
  "byte_size": 184320
}

Validate an upload create

curl https://web.signcustomiser.com/api/v3/uploads/validate-create \
  --request POST \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "purpose": "font_ttf",
  "filename": "Signature.ttf",
  "content_type": "font/ttf",
  "byte_size": 184320
}'

{
  "data": {
    "object": "upload_validation",
    "operation": "create",
    "purpose": "font_ttf",
    "valid": true
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/uploads/validate-create",
    "documentation": "https://www.signcustomiser.com/help/api/"
  },
  "meta": {
    "api_version": "v3",
    "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
  }
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/missing_api_key",
  "title": "Missing API key",
  "status": 401,
  "code": "missing_api_key",
  "detail": "Provide a store API key as a bearer token.",
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/insufficient_scope",
  "title": "Insufficient scope",
  "status": 403,
  "code": "insufficient_scope",
  "detail": "This operation requires the customisers:write scope.",
  "required_scopes": [
    "customisers:write"
  ],
  "granted_scopes": [
    "customisers:read"
  ],
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/upload_size_exceeded",
  "title": "Upload size exceeded",
  "status": 422,
  "code": "upload_size_exceeded",
  "detail": "A font_ttf upload must not exceed 10485760 bytes, and this one declares 20971520.",
  "errors": [
    {
      "pointer": "/byte_size",
      "code": "upload_size_exceeded",
      "detail": "A font_ttf upload must not exceed 10485760 bytes, and this one declares 20971520."
    }
  ],
  "purpose": "font_ttf",
  "max_byte_size": 10485760,
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/rate_limited",
  "title": "Too many requests",
  "status": 429,
  "code": "rate_limited",
  "detail": "You have exceeded the request limit for this API key.",
  "retry_after": 60,
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}