Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.binarly.io/llms.txt

Use this file to discover all available pages before exploring further.

Download the Post-Quantum Cryptography (PQC) compliance report to assess your binary file’s cryptographic readiness for quantum computing threats.

​
When to Use This Endpoint

Use this endpoint to:
  • Identify cryptographic implementations vulnerable to quantum attacks
  • Generate compliance documentation for PQC readiness audits
  • Track cryptographic migration progress across releases

​
Request

Endpoint 
GET <BINARLY_API_URL>/api/v4/products/{productId}/images/{imageId}/cryptographicMaterialsReport?mode=pqc-compliance
Path Parameters
ParameterRequiredDescription
productId✅Product ID
imageId✅Image ID
Query Parameters
ParameterRequiredDescription
mode✅Must be pqc-compliance
contentType✅Response format: json or pdf
Headers
HeaderValue
AuthorizationBearer <access_token>

​
Example Requests

# JSON format
curl -s \
  -H "Authorization: Bearer ${TOKEN}" \
  "${BINARLY_API_URL}/api/v4/products/${BINARLY_PRODUCT_ID}/images/${IMAGE_ID}/cryptographicMaterialsReport?mode=pqc-compliance&contentType=json" \
  -o pqc-compliance.json

# PDF format
curl -s \
  -H "Authorization: Bearer ${TOKEN}" \
  "${BINARLY_API_URL}/api/v4/products/${BINARLY_PRODUCT_ID}/images/${IMAGE_ID}/cryptographicMaterialsReport?mode=pqc-compliance&contentType=pdf" \
  -o pqc-compliance.pdf

​
Response

Returns the PQC compliance report in the requested format (JSON or PDF). The JSON report includes:
  • Cryptographic algorithms detected
  • Quantum vulnerability assessment
  • Recommended migration paths