Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

iOS AppEncryptionDeclarationDocuments API

The AppEncryptionDeclarationDocuments API from iOS — 2 operation(s) for appencryptiondeclarationdocuments.

iOS AppEncryptionDeclarationDocuments API is one of 199 APIs that iOS publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include AppEncryptionDeclarationDocuments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and release notes.

This API exposes 3 operations across 2 paths, and defines 14 schemas. It is described by OpenAPI 3.0.1, at version 4.3.1.

Requests are made against a single base URL, https://api.appstoreconnect.apple.com/.

3 operations 2 paths 14 schemas 1 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
4.3.1
Base URL
https://api.appstoreconnect.apple.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

iOS AppEncryptionDeclarationDocuments API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (itc-bearer-token). By default, every request must be authenticated.

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 1 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

AppEncryptionDeclarationDocuments 3
POST
/v1/appEncryptionDeclarationDocuments
Create App Encryption Declaration Documents
appEncryptionDeclarationDocuments_createInstance body → 400401403422201409429
GET
/v1/appEncryptionDeclarationDocuments/{id}
Get App Encryption Declaration Documents
appEncryptionDeclarationDocuments_getInstance 2 params → 400401403404200429
PATCH
/v1/appEncryptionDeclarationDocuments/{id}
Update App Encryption Declaration Documents
appEncryptionDeclarationDocuments_updateInstance 1 param body → 400401403404422200409429

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are UploadOperation (5 properties), AppEncryptionDeclarationDocument (4 properties), AppMediaAssetState (3 properties), AppEncryptionDeclarationDocumentResponse (2 properties). Each schema is shown below with its type and property counts.

DocumentLinks
object
1 property 1 required
ResourceLinks
object
1 property
UploadOperation
object
5 properties
ErrorSourceParameter
object
1 property 1 required
ErrorLinks
object
2 properties
AppEncryptionDeclarationDocumentUpdateRequest
object
1 property 1 required
AppEncryptionDeclarationDocumentResponse
object
2 properties 2 required
AppEncryptionDeclarationDocumentCreateRequest
object
1 property 1 required
ErrorResponse
object
1 property
AppMediaStateError
object
2 properties
ErrorSourcePointer
object
1 property 1 required
AppMediaAssetState
object
3 properties
AppEncryptionDeclarationDocument
object
4 properties 2 required
HttpHeader
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ios-appencryptiondeclarationdocuments-api-openapi.yml Raw ↑

Other APIs iOS publishes across the network.

App Store Server API
App Store Server Notifications
Apple Push Notification Service (APNs)
DeviceCheck and App Attest
Sign in with Apple REST API
Apple Music API
Wallet / PassKit Web Service
iOS AccessibilityDeclarations API
iOS Actors API
iOS AgeRatingDeclarations API
iOS AlternativeDistributionDomains API
iOS AlternativeDistributionKeys API