Essence Developer Portal API

Version v1 · OpenAPI 3.0.1 · 175 operations · Download the JSON document

EPIC 25 — Developer Portal REST surface (33 endpoints).

Generated from the DeveloperPortal service's code at build time (api-specs/generated/DeveloperPortal/Essence.Developer.Portal.Api.json) and drift-checked in CI. It describes what the code registers, which is not the same as what any one deployment has routed.

AccountClosure

GET/api/v1/developer/account-closure

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — ClosureCaseDto[]

401Unauthorized — ProblemDetails

POST/api/v1/developer/account-closure

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

OpenClosureCommand as application/*+json, application/json, text/json

Responses

201Created — ClosureCaseDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/developer/account-closure/stages

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — ClosureStep[]

GET/api/v1/developer/account-closure/{caseId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`caseId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — ClosureCaseDto

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/developer/account-closure/{caseId}/abandon

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`caseId`	path	`string`	yes	—

Request body

Not marked as required in the document.

AbandonClosureRequest as application/*+json, application/json, text/json

Responses

200OK — ClosureCaseDto

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/developer/account-closure/{caseId}/apps/{appId}/accept-transfer

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`caseId`	path	`string`	yes	—
`appId`	path	`string`	yes	—

Request body

Not marked as required in the document.

AcceptClosureTransferRequest as application/*+json, application/json, text/json

Responses

200OK — ClosureCaseDto

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/developer/account-closure/{caseId}/apps/{appId}/consumers/{consumerRef}/migrated

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`caseId`	path	`string`	yes	—
`appId`	path	`string`	yes	—
`consumerRef`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — ClosureCaseDto

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/developer/account-closure/{caseId}/attestation

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`caseId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — ClosureAttestationDto

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/developer/account-closure/{caseId}/dispositions

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`caseId`	path	`string`	yes	—

Request body

Not marked as required in the document.

SetClosureDispositionCommand as application/*+json, application/json, text/json

Responses

200OK — ClosureCaseDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/developer/account-closure/{caseId}/erasure

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`caseId`	path	`string`	yes	—

Request body

Not marked as required in the document.

ConfirmClosureErasureCommand as application/*+json, application/json, text/json

Responses

200OK — ClosureCaseDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/developer/account-closure/{caseId}/erasure/refresh

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`caseId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — ClosureCaseDto

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/developer/account-closure/{caseId}/freeze

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`caseId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — ClosureCaseDto

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/developer/account-closure/{caseId}/notify-consumers

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`caseId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — ClosureCaseDto

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/developer/account-closure/{caseId}/settlement

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`caseId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — ClosureCaseDto

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

AccountClosureAdmin

GET/api/v1/developer/admin/account-closure

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — ClosureCaseDto[]

403Forbidden — ProblemDetails

POST/api/v1/developer/admin/account-closure/{caseId}/acknowledgements

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`caseId`	path	`string`	yes	—

Request body

Not marked as required in the document.

AcknowledgeClosureBlockerCommand as application/*+json, application/json, text/json

Responses

200OK — ClosureCaseDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/developer/admin/account-closure/{caseId}/attestation

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`caseId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — ClosureAttestationDto

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

Analytics

GET/api/v1/analytics/api-calls

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`developerId`	query	`string`	no	—

Request body

No request body.

Responses

200OK — ApiCallVolumeDto

GET/api/v1/analytics/apps/{applicationId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — AppAnalyticsDto

GET/api/v1/analytics/overview

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`developerId`	query	`string`	no	—

Request body

No request body.

Responses

200OK — OverviewDto

GET/api/v1/analytics/revenue

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`developerId`	query	`string`	no	—

Request body

No request body.

Responses

200OK — RevenueSummaryDto

GET/api/v1/developer/analytics/api-calls

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`developerId`	query	`string`	no	—

Request body

No request body.

Responses

200OK — ApiCallVolumeDto

GET/api/v1/developer/analytics/apps/{applicationId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — AppAnalyticsDto

GET/api/v1/developer/analytics/overview

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`developerId`	query	`string`	no	—

Request body

No request body.

Responses

200OK — OverviewDto

GET/api/v1/developer/analytics/revenue

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`developerId`	query	`string`	no	—

Request body

No request body.

Responses

200OK — RevenueSummaryDto

ApiKeys

GET/api/v1/api-keys

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	query	`string`	no	—
`limit`	query	`integer (int32)`	no	—
`offset`	query	`integer (int32)`	no	—

Request body

No request body.

Responses

200OK — ApiKeyDto[]

POST/api/v1/api-keys

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

GenerateApiKeyCommand as application/*+json, application/json, text/json

Responses

400Bad Request — ProblemDetails

402Payment Required — ProblemDetails

GET/api/v1/api-keys/{keyId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`keyId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — ApiKeyDto

DELETE/api/v1/api-keys/{keyId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`keyId`	path	`string`	yes	—
`developerId`	query	`string`	no	—
`reason`	query	`string`	no	—

Request body

No request body.

Responses

200OK

POST/api/v1/api-keys/{keyId}/rotate

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`keyId`	path	`string`	yes	—

Request body

Not marked as required in the document.

RotateBody as application/*+json, application/json, text/json

Responses

409Conflict — ProblemDetails

GET/api/v1/developer/api-keys

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	query	`string`	no	—
`limit`	query	`integer (int32)`	no	—
`offset`	query	`integer (int32)`	no	—

Request body

No request body.

Responses

200OK — ApiKeyDto[]

POST/api/v1/developer/api-keys

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

GenerateApiKeyCommand as application/*+json, application/json, text/json

Responses

400Bad Request — ProblemDetails

402Payment Required — ProblemDetails

GET/api/v1/developer/api-keys/{keyId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`keyId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — ApiKeyDto

DELETE/api/v1/developer/api-keys/{keyId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`keyId`	path	`string`	yes	—
`developerId`	query	`string`	no	—
`reason`	query	`string`	no	—

Request body

No request body.

Responses

200OK

POST/api/v1/developer/api-keys/{keyId}/rotate

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`keyId`	path	`string`	yes	—

Request body

Not marked as required in the document.

RotateBody as application/*+json, application/json, text/json

Responses

409Conflict — ProblemDetails

ApiQuota

GET/api/v1/developer/api-quota/overage-policy

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`developerId`	query	`string`	no	—

Request body

No request body.

Responses

200OK — OveragePolicyDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

PUT/api/v1/developer/api-quota/overage-policy

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`developerId`	query	`string`	no	—

Request body

Not marked as required in the document.

UpdateOveragePolicyCommand as application/*+json, application/json, text/json

Responses

200OK — OveragePolicyDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/developer/api-quota/tiers

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — ApiQuotaCatalogueDto

AppDataPolicy

GET/api/v1/applications/{applicationId}/data-policy

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — AppDataRetentionPolicySnapshot

404Not Found — ProblemDetails

PUT/api/v1/applications/{applicationId}/data-policy

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—

Request body

Not marked as required in the document.

ChangeAppDataPolicyRequest as application/*+json, application/json, text/json

Responses

200OK — AppDataPolicyChangeDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/applications/{applicationId}/data-policy/changes

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—
`limit`	query	`integer (int32)`	no	—

Request body

No request body.

Responses

200OK — AppDataPolicyChangeDto[]

GET/api/v1/applications/{applicationId}/data-policy/changes/{changeId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—
`changeId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — AppDataPolicyChangeDto

404Not Found — ProblemDetails

POST/api/v1/applications/{applicationId}/data-policy/changes/{changeId}/purge-attestation

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—
`changeId`	path	`string`	yes	—

Request body

Not marked as required in the document.

AttestPurgeRequest as application/*+json, application/json, text/json

Responses

200OK — AppDataPolicyChangeDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/developer/applications/{applicationId}/data-policy

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — AppDataRetentionPolicySnapshot

404Not Found — ProblemDetails

PUT/api/v1/developer/applications/{applicationId}/data-policy

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—

Request body

Not marked as required in the document.

ChangeAppDataPolicyRequest as application/*+json, application/json, text/json

Responses

200OK — AppDataPolicyChangeDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/developer/applications/{applicationId}/data-policy/changes

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—
`limit`	query	`integer (int32)`	no	—

Request body

No request body.

Responses

200OK — AppDataPolicyChangeDto[]

GET/api/v1/developer/applications/{applicationId}/data-policy/changes/{changeId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—
`changeId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — AppDataPolicyChangeDto

404Not Found — ProblemDetails

POST/api/v1/developer/applications/{applicationId}/data-policy/changes/{changeId}/purge-attestation

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—
`changeId`	path	`string`	yes	—

Request body

Not marked as required in the document.

AttestPurgeRequest as application/*+json, application/json, text/json

Responses

200OK — AppDataPolicyChangeDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

AppDeprecation

GET/api/v1/applications/{applicationId}/deprecation

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — AppSunsetDto

204No Content

POST/api/v1/applications/{applicationId}/deprecation

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—

Request body

Not marked as required in the document.

ScheduleAppDeprecationRequest as application/*+json, application/json, text/json

Responses

201Created — AppSunsetDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/applications/{applicationId}/deprecation/history

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—
`limit`	query	`integer (int32)`	no	—

Request body

No request body.

Responses

200OK — AppSunsetDto[]

POST/api/v1/applications/{applicationId}/deprecation/{deprecationId}/cancel

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—
`deprecationId`	path	`string`	yes	—

Request body

Not marked as required in the document.

CancelAppDeprecationRequest as application/*+json, application/json, text/json

Responses

200OK — AppSunsetDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/applications/{applicationId}/deprecation/{deprecationId}/disposition

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—
`deprecationId`	path	`string`	yes	—

Request body

Not marked as required in the document.

AttestAppSunsetDispositionRequest as application/*+json, application/json, text/json

Responses

200OK — AppSunsetDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/developer/applications/{applicationId}/deprecation

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — AppSunsetDto

204No Content

POST/api/v1/developer/applications/{applicationId}/deprecation

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—

Request body

Not marked as required in the document.

ScheduleAppDeprecationRequest as application/*+json, application/json, text/json

Responses

201Created — AppSunsetDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/developer/applications/{applicationId}/deprecation/history

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—
`limit`	query	`integer (int32)`	no	—

Request body

No request body.

Responses

200OK — AppSunsetDto[]

POST/api/v1/developer/applications/{applicationId}/deprecation/{deprecationId}/cancel

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—
`deprecationId`	path	`string`	yes	—

Request body

Not marked as required in the document.

CancelAppDeprecationRequest as application/*+json, application/json, text/json

Responses

200OK — AppSunsetDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/developer/applications/{applicationId}/deprecation/{deprecationId}/disposition

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—
`deprecationId`	path	`string`	yes	—

Request body

Not marked as required in the document.

AttestAppSunsetDispositionRequest as application/*+json, application/json, text/json

Responses

200OK — AppSunsetDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

AppIncidentNotices

GET/api/v1/developer/app-incident-notices

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — AppIncidentNoticeDto[]

401Unauthorized — ProblemDetails

POST/api/v1/developer/app-incident-notices/{receiptId}/acknowledge

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`receiptId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — AppIncidentNoticeDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

AppIncidents

GET/api/v1/developer/applications/{applicationId}/incidents

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—
`limit`	query	`integer (int32)`	no	—

Request body

No request body.

Responses

200OK — AppIncidentDto[]

POST/api/v1/developer/applications/{applicationId}/incidents

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—

Request body

Not marked as required in the document.

DeclareAppIncidentRequest as application/*+json, application/json, text/json

Responses

201Created — AppIncidentDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/developer/applications/{applicationId}/incidents/audience-preview

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—
`audienceScope`	query	`string`	no	—
`scopes`	query	`string`	no	—

Request body

No request body.

Responses

200OK — AppIncidentAudiencePreview

400Bad Request — ProblemDetails

GET/api/v1/developer/applications/{applicationId}/incidents/live

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — AppIncidentDto

204No Content

POST/api/v1/developer/applications/{applicationId}/incidents/{incidentId}/all-clear

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—
`incidentId`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

ResolveAppIncidentRequest as application/*+json, application/json, text/json

Responses

200OK — AppIncidentDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/developer/applications/{applicationId}/incidents/{incidentId}/register

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—
`incidentId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200OK — AppIncidentRegisterDto

404Not Found — ProblemDetails

POST/api/v1/developer/applications/{applicationId}/incidents/{incidentId}/updates

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—
`incidentId`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

PostAppIncidentUpdateRequest as application/*+json, application/json, text/json

Responses

200OK — AppIncidentDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

Applications

GET/api/v1/applications

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`developerId`	query	`string`	no	—
`limit`	query	`integer (int32)`	no	—
`offset`	query	`integer (int32)`	no	—

Request body

No request body.

Responses

200OK — ApplicationDto[]

POST/api/v1/applications

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

CreateApplicationCommand as application/*+json, application/json, text/json

Responses

200OK — ApplicationDto

GET/api/v1/applications/{applicationId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — ApplicationDto

DELETE/api/v1/applications/{applicationId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK

PATCH/api/v1/applications/{applicationId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—

Request body

Not marked as required in the document.

UpdateApplicationCommand as application/*+json, application/json, text/json

Responses

200OK — ApplicationDto

POST/api/v1/applications/{applicationId}/activate

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — ApplicationDto

GET/api/v1/developer/applications

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`developerId`	query	`string`	no	—
`limit`	query	`integer (int32)`	no	—
`offset`	query	`integer (int32)`	no	—

Request body

No request body.

Responses

200OK — ApplicationDto[]

POST/api/v1/developer/applications

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

CreateApplicationCommand as application/*+json, application/json, text/json

Responses

200OK — ApplicationDto

GET/api/v1/developer/applications/{applicationId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — ApplicationDto

DELETE/api/v1/developer/applications/{applicationId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK

PATCH/api/v1/developer/applications/{applicationId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—

Request body

Not marked as required in the document.

UpdateApplicationCommand as application/*+json, application/json, text/json

Responses

200OK — ApplicationDto

POST/api/v1/developer/applications/{applicationId}/activate

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — ApplicationDto

AppOwnershipTransfer

GET/api/v1/applications/{applicationId}/ownership-transfer

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — AppTransferDto

204No Content

POST/api/v1/applications/{applicationId}/ownership-transfer

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—

Request body

Not marked as required in the document.

InitiateAppTransferRequest as application/*+json, application/json, text/json

Responses

201Created — AppTransferDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/applications/{applicationId}/ownership-transfer/history

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—
`limit`	query	`integer (int32)`	no	—

Request body

No request body.

Responses

200OK — AppTransferDto[]

POST/api/v1/applications/{applicationId}/ownership-transfer/{transferId}/cutover

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—
`transferId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — AppTransferDto

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/applications/{applicationId}/ownership-transfer/{transferId}/dry-run

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—
`transferId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — AppTransferDto

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/applications/{applicationId}/ownership-transfer/{transferId}/schedule-cutover

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—
`transferId`	path	`string`	yes	—

Request body

Not marked as required in the document.

ScheduleAppTransferCutoverRequest as application/*+json, application/json, text/json

Responses

200OK — AppTransferDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/applications/{applicationId}/ownership-transfer/{transferId}/withdraw

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—
`transferId`	path	`string`	yes	—

Request body

Not marked as required in the document.

WithdrawAppTransferRequest as application/*+json, application/json, text/json

Responses

200OK — AppTransferDto

404Not Found — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/developer/applications/{applicationId}/ownership-transfer

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — AppTransferDto

204No Content

POST/api/v1/developer/applications/{applicationId}/ownership-transfer

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—

Request body

Not marked as required in the document.

InitiateAppTransferRequest as application/*+json, application/json, text/json

Responses

201Created — AppTransferDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/developer/applications/{applicationId}/ownership-transfer/history

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—
`limit`	query	`integer (int32)`	no	—

Request body

No request body.

Responses

200OK — AppTransferDto[]

POST/api/v1/developer/applications/{applicationId}/ownership-transfer/{transferId}/cutover

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—
`transferId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — AppTransferDto

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/developer/applications/{applicationId}/ownership-transfer/{transferId}/dry-run

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—
`transferId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — AppTransferDto

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/developer/applications/{applicationId}/ownership-transfer/{transferId}/schedule-cutover

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—
`transferId`	path	`string`	yes	—

Request body

Not marked as required in the document.

ScheduleAppTransferCutoverRequest as application/*+json, application/json, text/json

Responses

200OK — AppTransferDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/developer/applications/{applicationId}/ownership-transfer/{transferId}/withdraw

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—
`transferId`	path	`string`	yes	—

Request body

Not marked as required in the document.

WithdrawAppTransferRequest as application/*+json, application/json, text/json

Responses

200OK — AppTransferDto

404Not Found — ProblemDetails

409Conflict — ProblemDetails

AppStatus

GET/api/v1/developer/app-status

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — AppStatusPayload

GET/api/v1/developer/app-status/{applicationId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — AppStatusComponentDto

404Not Found — ProblemDetails

ContinuityAdmin

GET/api/v1/developer/admin/continuity/cases

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — ContinuityQueueItemDto[]

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

GET/api/v1/developer/admin/continuity/cases/{caseId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`caseId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — ContinuityCaseDto

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/developer/admin/continuity/cases/{caseId}/asset-link

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`caseId`	path	`string`	yes	—

Request body

Not marked as required in the document.

DetermineAssetLinkRequest as application/*+json, application/json, text/json

Responses

200OK — ContinuityCaseDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/developer/admin/continuity/cases/{caseId}/close

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`caseId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — ContinuityCaseDto

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/developer/admin/continuity/cases/{caseId}/data-treatment/review

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`caseId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — ContinuityCaseDto

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/developer/admin/continuity/cases/{caseId}/hold

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`caseId`	path	`string`	yes	—

Request body

Not marked as required in the document.

SetContinuityHoldRequest as application/*+json, application/json, text/json

Responses

200OK — ContinuityCaseDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

ContinuityCases

GET/api/v1/developer/continuity-cases

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — ContinuityCaseDto[]

401Unauthorized — ProblemDetails

POST/api/v1/developer/continuity-cases

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

OpenContinuityClaimRequest as application/*+json, application/json, text/json

Responses

201Created — ContinuityCaseDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/developer/continuity-cases/steps

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — ContinuityStep[]

GET/api/v1/developer/continuity-cases/{caseId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`caseId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — ContinuityCaseDto

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/developer/continuity-cases/{caseId}/authority

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`caseId`	path	`string`	yes	—

Request body

Not marked as required in the document.

SubmitContinuityAuthorityRequest as application/*+json, application/json, text/json

Responses

200OK — ContinuityCaseDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/developer/continuity-cases/{caseId}/dispositions

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`caseId`	path	`string`	yes	—

Request body

Not marked as required in the document.

SetContinuityDispositionsRequest as application/*+json, application/json, text/json

Responses

200OK — ContinuityCaseDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

DELETE/api/v1/developer/continuity-cases/{caseId}/dispositions/{appId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`caseId`	path	`string`	yes	—
`appId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — ContinuityCaseDto

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/developer/continuity-cases/{caseId}/record

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`caseId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — ContinuityCaseRecordDto

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

Developers

POST/api/v1/developer/developers

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

CreateDeveloperAccountCommand as application/*+json, application/json, text/json

Responses

200OK — DeveloperAccountDto

GET/api/v1/developer/developers/{developerId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`developerId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — DeveloperAccountDto

PUT/api/v1/developer/developers/{developerId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`developerId`	path	`string`	yes	—

Request body

Not marked as required in the document.

UpdateDeveloperAccountCommand as application/*+json, application/json, text/json

Responses

200OK — DeveloperAccountDto

DELETE/api/v1/developer/developers/{developerId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`developerId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK

PATCH/api/v1/developer/developers/{developerId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`developerId`	path	`string`	yes	—

Request body

Not marked as required in the document.

UpdateDeveloperAccountCommand as application/*+json, application/json, text/json

Responses

200OK — DeveloperAccountDto

POST/api/v1/developer/developers/{developerId}/verify-email

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`developerId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — DeveloperAccountDto

POST/api/v1/developers

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

CreateDeveloperAccountCommand as application/*+json, application/json, text/json

Responses

200OK — DeveloperAccountDto

GET/api/v1/developers/{developerId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`developerId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — DeveloperAccountDto

PUT/api/v1/developers/{developerId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`developerId`	path	`string`	yes	—

Request body

Not marked as required in the document.

UpdateDeveloperAccountCommand as application/*+json, application/json, text/json

Responses

200OK — DeveloperAccountDto

DELETE/api/v1/developers/{developerId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`developerId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK

PATCH/api/v1/developers/{developerId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`developerId`	path	`string`	yes	—

Request body

Not marked as required in the document.

UpdateDeveloperAccountCommand as application/*+json, application/json, text/json

Responses

200OK — DeveloperAccountDto

POST/api/v1/developers/{developerId}/verify-email

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`developerId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — DeveloperAccountDto

Documentation

GET/api/v1/developer/docs

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`section`	query	`string`	no	—

Request body

No request body.

Responses

200OK — DocPageDto[]

GET/api/v1/developer/docs/search

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`q`	query	`string`	no	—

Request body

No request body.

Responses

200OK — DocPageDto[]

GET/api/v1/developer/docs/{slug}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`slug`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — DocPageDto

GET/api/v1/docs

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`section`	query	`string`	no	—

Request body

No request body.

Responses

200OK — DocPageDto[]

GET/api/v1/docs/search

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`q`	query	`string`	no	—

Request body

No request body.

Responses

200OK — DocPageDto[]

GET/api/v1/docs/{slug}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`slug`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — DocPageDto

IncomingAppTransfers

GET/api/v1/developer/orgs/{orgId}/incoming-app-transfers

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`orgId`	path	`string`	yes	—
`limit`	query	`integer (int32)`	no	—

Request body

No request body.

Responses

200OK — AppTransferDto[]

POST/api/v1/developer/orgs/{orgId}/incoming-app-transfers/{transferId}/accept

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`orgId`	path	`string`	yes	—
`transferId`	path	`string`	yes	—

Request body

Not marked as required in the document.

AcceptAppTransferRequest as application/*+json, application/json, text/json

Responses

200OK — AppTransferDto

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/developer/orgs/{orgId}/incoming-app-transfers/{transferId}/decline

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`orgId`	path	`string`	yes	—
`transferId`	path	`string`	yes	—

Request body

Not marked as required in the document.

DeclineAppTransferRequest as application/*+json, application/json, text/json

Responses

200OK — AppTransferDto

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/developer/orgs/{orgId}/incoming-app-transfers/{transferId}/manifest

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`orgId`	path	`string`	yes	—
`transferId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — AppTransferManifestDto

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/orgs/{orgId}/incoming-app-transfers

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`orgId`	path	`string`	yes	—
`limit`	query	`integer (int32)`	no	—

Request body

No request body.

Responses

200OK — AppTransferDto[]

POST/api/v1/orgs/{orgId}/incoming-app-transfers/{transferId}/accept

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`orgId`	path	`string`	yes	—
`transferId`	path	`string`	yes	—

Request body

Not marked as required in the document.

AcceptAppTransferRequest as application/*+json, application/json, text/json

Responses

200OK — AppTransferDto

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/orgs/{orgId}/incoming-app-transfers/{transferId}/decline

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`orgId`	path	`string`	yes	—
`transferId`	path	`string`	yes	—

Request body

Not marked as required in the document.

DeclineAppTransferRequest as application/*+json, application/json, text/json

Responses

200OK — AppTransferDto

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/orgs/{orgId}/incoming-app-transfers/{transferId}/manifest

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`orgId`	path	`string`	yes	—
`transferId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — AppTransferManifestDto

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

OutageReports

GET/api/v1/developer/outage-reports

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — OutageReportDto[]

401Unauthorized — ProblemDetails

POST/api/v1/developer/outage-reports

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

ReportOutageRequest as application/*+json, application/json, text/json

Responses

201Created — OutageReportDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

GET/api/v1/developer/outage-reports/{reference}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`reference`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — OutageReportDto

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

PartnerApplicationProfiles

GET/api/v1/developer/internal/applications/{applicationId}/profile

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — PartnerApplicationProfileDto

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

Sdks

Tutorials

GET/api/v1/developer/tutorials

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — TutorialDto[]

GET/api/v1/developer/tutorials/{tutorialId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`tutorialId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — TutorialDto

POST/api/v1/developer/tutorials/{tutorialId}/progress

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`tutorialId`	path	`string`	yes	—

Request body

Not marked as required in the document.

ProgressBody as application/*+json, application/json, text/json

ProgressBody as application/*+json, application/json, text/json

Responses

200OK

Webhooks

GET/api/v1/developer/webhooks

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	query	`string`	no	—
`developerId`	query	`string`	no	—
`limit`	query	`integer (int32)`	no	—
`offset`	query	`integer (int32)`	no	—

Request body

No request body.

Responses

200OK — WebhookDto[]

POST/api/v1/developer/webhooks

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

CreateWebhookCommand as application/*+json, application/json, text/json

Responses

200OK — WebhookDto

GET/api/v1/developer/webhooks/deliveries

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`developerId`	query	`string`	no	—
`perEndpointLimit`	query	`integer (int32)`	no	—

Request body

Not marked as required in the document.

UpdateWebhookCommand as application/*+json, application/json, text/json

Responses

200OK — WebhookDto

GET/api/v1/developer/webhooks/{webhookId}/dead-letters

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`webhookId`	path	`string`	yes	—
`limit`	query	`integer (int32)`	no	—

Request body

No request body.

Responses

200OK — WebhookDeliveryFeedDto

GET/api/v1/developer/webhooks/{webhookId}/deliveries

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`webhookId`	path	`string`	yes	—
`limit`	query	`integer (int32)`	no	—

Request body

No request body.

Responses

200OK — WebhookDeliveryFeedDto

GET/api/v1/developer/webhooks/{webhookId}/health

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`webhookId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — WebhookHealthDto

POST/api/v1/developer/webhooks/{webhookId}/rotate-secret

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`webhookId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — WebhookSecretRotationDto

POST/api/v1/developer/webhooks/{webhookId}/test

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`webhookId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — WebhookDeliveryDto

GET/api/v1/webhooks

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`applicationId`	query	`string`	no	—
`developerId`	query	`string`	no	—
`limit`	query	`integer (int32)`	no	—
`offset`	query	`integer (int32)`	no	—

Request body

No request body.

Responses

200OK — WebhookDto[]

POST/api/v1/webhooks

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

CreateWebhookCommand as application/*+json, application/json, text/json

Responses

200OK — WebhookDto

GET/api/v1/webhooks/deliveries

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`developerId`	query	`string`	no	—
`perEndpointLimit`	query	`integer (int32)`	no	—

Request body

Not marked as required in the document.

UpdateWebhookCommand as application/*+json, application/json, text/json

Responses

200OK — WebhookDto

GET/api/v1/webhooks/{webhookId}/dead-letters

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`webhookId`	path	`string`	yes	—
`limit`	query	`integer (int32)`	no	—

Request body

No request body.

Responses

200OK — WebhookDeliveryFeedDto

GET/api/v1/webhooks/{webhookId}/deliveries

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`webhookId`	path	`string`	yes	—
`limit`	query	`integer (int32)`	no	—

Request body

No request body.

Responses

200OK — WebhookDeliveryFeedDto

GET/api/v1/webhooks/{webhookId}/health

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`webhookId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — WebhookHealthDto

POST/api/v1/webhooks/{webhookId}/rotate-secret

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`webhookId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — WebhookSecretRotationDto

POST/api/v1/webhooks/{webhookId}/test

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`webhookId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — WebhookDeliveryDto

Schemas

AbandonClosureRequest

Property	Type	Required	Description
`reason`	`string \| null`	no	—

AcceptAppTransferRequest

Property	Type	Required	Description
`acceptedBy`	`string \| null`	no	—

AcceptClosureTransferRequest

Property	Type	Required	Description
`acceptingDeveloperId`	`string \| null`	no	—

AcknowledgeClosureBlockerCommand

Property	Type	Required	Description
`blocker`	`string \| null`	no	—
`reason`	`string \| null`	no	—
`stage`	`string \| null`	no	—

ApiCallVolumeDto

Property	Type	Required	Description
`developerId`	`string \| null`	no	—
`totalApiCalls`	`integer (int32)`	no	—

ApiKeyDto

Property	Type	Required	Description
`applicationId`	`string \| null`	no	—
`developerId`	`string \| null`	no	—
`environment`	`string \| null`	no	—
`expiresAt`	`string (date-time) \| null`	no	—
`graceExpiresAt`	`string (date-time) \| null`	no	—
`keyId`	`string \| null`	no	—
`keyPrefix`	`string \| null`	no	—
`rateLimitPerDay`	`integer (int32) \| null`	no	—
`rotatedToKeyId`	`string \| null`	no	—
`scopes`	`string[] \| null`	no	—
`status`	`string \| null`	no	—
`tier`	`string \| null`	no	—

ApiQuotaCatalogueDto

Property	Type	Required	Description
`dailyWindowAnchor`	`string \| null`	no	—
`developerOverageSku`	`string \| null`	no	—
`gatewayOverageSku`	`string \| null`	no	—
`tiers`	`ApiQuotaTierDto[] \| null`	no	—

ApiQuotaTierDto

Property	Type	Required	Description
`atLimitBehaviour`	`string \| null`	no	—
`burstConfigKey`	`string \| null`	no	—
`burstPerMinute`	`integer (int32)`	no	—
`burstTierName`	`string \| null`	no	—
`code`	`string \| null`	no	—
`isPurchasable`	`boolean`	no	—
`name`	`string \| null`	no	—
`overageSku`	`string \| null`	no	—
`planSku`	`string \| null`	no	—
`priceDisplay`	`string \| null`	no	—
`requestsPerDay`	`integer (int32) \| null`	no	—
`requiresSalesContact`	`boolean`	no	—
`summary`	`string \| null`	no	—

AppAnalyticsDto

Property	Type	Required	Description
`activeInstallations`	`integer (int32)`	no	—
`applicationId`	`string \| null`	no	—
`totalInstallations`	`integer (int32)`	no	—

AppDataPolicyChangeDto

Property	Type	Required	Description
`appName`	`string \| null`	no	—
`applicationId`	`string \| null`	no	—
`cascadeRaised`	`boolean`	no	—
`changeId`	`string \| null`	no	—
`changedAt`	`string (date-time)`	no	—
`changedBy`	`string \| null`	no	—
`developerId`	`string \| null`	no	—
`diff`	`AppDataPolicyFacetChange[] \| null`	no	—
`effectiveOn`	`string \| null`	no	—
`graceDays`	`integer (int32)`	no	—
`materiality`	`string \| null`	no	—
`newPolicy`	`AppDataRetentionPolicySnapshot`	no	—
`oldPolicy`	`AppDataRetentionPolicySnapshot`	no	—
`purgeAttestedAt`	`string (date-time) \| null`	no	—
`purgeAttestedBy`	`string \| null`	no	—
`purgeMethod`	`string \| null`	no	—
`purgeOutstanding`	`boolean`	no	—
`purgeRecordsDestroyed`	`integer (int32) \| null`	no	—

AppDataPolicyFacetChange

Property	Type	Required	Description
`after`	`string \| null`	no	—
`before`	`string \| null`	no	—
`broadensProcessing`	`boolean`	no	—
`facet`	`string \| null`	no	—

AppDataRetentionPolicySnapshot

Property	Type	Required	Description
`automatedDecisionMaking`	`boolean`	no	—
`dataCategories`	`string[] \| null`	no	—
`postUninstallDays`	`integer (int32)`	no	—
`processingRegions`	`string[] \| null`	no	—
`purposes`	`string[] \| null`	no	—
`retentionDays`	`integer (int32)`	no	—
`thirdPartySharing`	`string[] \| null`	no	—

AppIncidentAudiencePreview

Property	Type	Required	Description
`audienceScope`	`string \| null`	no	—
`recipientCount`	`integer (int32)`	no	—
`truncated`	`boolean`	no	—
`unaddressableInstalls`	`integer (int32)`	no	—

AppIncidentDto

Property	Type	Required	Description
`acknowledgedCount`	`integer (int32)`	no	—
`acknowledgementRequired`	`boolean`	no	—
`affectedScopes`	`string[] \| null`	no	—
`appName`	`string \| null`	no	—
`applicationId`	`string \| null`	no	—
`audienceScope`	`string \| null`	no	—
`audienceTruncated`	`boolean`	no	—
`consumerStatus`	`string \| null`	no	—
`dataAtRisk`	`boolean`	no	—
`declaredAt`	`string (date-time)`	no	—
`declaredBy`	`string \| null`	no	—
`developerId`	`string \| null`	no	—
`incidentId`	`string (uuid)`	no	—
`recipientCount`	`integer (int32)`	no	—
`reference`	`string \| null`	no	—
`resolutionMessage`	`string \| null`	no	—
`resolvedAt`	`string (date-time) \| null`	no	—
`resolvedBy`	`string \| null`	no	—
`severity`	`string \| null`	no	—
`severityLabel`	`string \| null`	no	—
`startedAt`	`string (date-time) \| null`	no	—
`status`	`string \| null`	no	—
`statusLabel`	`string \| null`	no	—
`title`	`string \| null`	no	—
`unaddressableInstalls`	`integer (int32)`	no	—
`updates`	`AppIncidentUpdateDto[] \| null`	no	—

AppIncidentNoticeDto

Property	Type	Required	Description
`acknowledgedAt`	`string (date-time) \| null`	no	—
`acknowledgementRequired`	`boolean`	no	—
`appId`	`string \| null`	no	—
`appName`	`string \| null`	no	—
`consumerStatus`	`string \| null`	no	—
`dataAtRisk`	`boolean`	no	—
`declaredAt`	`string (date-time)`	no	—
`incidentId`	`string (uuid)`	no	—
`receiptId`	`string \| null`	no	—
`reference`	`string \| null`	no	—
`resolutionMessage`	`string \| null`	no	—
`resolvedAt`	`string (date-time) \| null`	no	—
`severity`	`string \| null`	no	—
`severityLabel`	`string \| null`	no	—
`status`	`string \| null`	no	—
`statusLabel`	`string \| null`	no	—

AppIncidentRecipientDto

Property	Type	Required	Description
`acknowledgedAt`	`string (date-time) \| null`	no	—
`acknowledgedBy`	`string \| null`	no	—
`acknowledgementRequired`	`boolean`	no	—
`acknowledgementState`	`string \| null`	no	—
`incidentId`	`string (uuid)`	no	—
`notifiedAt`	`string (date-time)`	no	—
`receiptId`	`string \| null`	no	—
`recipientId`	`string (uuid)`	no	—
`recipientIsOrganisation`	`boolean`	no	—
`restoredNotifiedAt`	`string (date-time) \| null`	no	—

AppIncidentRegisterDto

Property	Type	Required	Description
`acknowledgedCount`	`integer (int32)`	no	—
`acknowledgementRequired`	`boolean`	no	—
`appName`	`string \| null`	no	—
`applicationId`	`string \| null`	no	—
`audienceTruncated`	`boolean`	no	—
`dataAtRisk`	`boolean`	no	—
`declaredAt`	`string (date-time)`	no	—
`deliveryEvidenceNote`	`string \| null`	no	—
`incidentId`	`string (uuid)`	no	—
`outstandingAcknowledgements`	`integer (int32)`	no	—
`recipients`	`AppIncidentRecipientDto[] \| null`	no	—
`reference`	`string \| null`	no	—
`resolvedAt`	`string (date-time) \| null`	no	—
`severity`	`string \| null`	no	—
`unaddressableInstalls`	`integer (int32)`	no	—

AppIncidentUpdateDto

Property	Type	Required	Description
`at`	`string (date-time)`	no	—
`message`	`string \| null`	no	—
`postedBy`	`string \| null`	no	—
`renotified`	`boolean`	no	—
`severity`	`string \| null`	no	—
`severityLabel`	`string \| null`	no	—
`status`	`string \| null`	no	—
`statusLabel`	`string \| null`	no	—

ApplicationDto

Property	Type	Required	Description
`applicationId`	`string \| null`	no	—
`applicationType`	`string \| null`	no	—
`dataProcessingScope`	`DataProcessingScopeDeclaration`	no	—
`description`	`string \| null`	no	—
`developerId`	`string \| null`	no	—
`name`	`string \| null`	no	—
`scopes`	`string[] \| null`	no	—
`status`	`string \| null`	no	—

AppStatusComponentDto

Property	Type	Required	Description
`appId`	`string \| null`	no	—
`appName`	`string \| null`	no	—
`incidentReference`	`string \| null`	no	—
`severity`	`string \| null`	no	—
`severityLabel`	`string \| null`	no	—
`sinceUtc`	`string (date-time) \| null`	no	—
`status`	`string \| null`	no	—
`summary`	`string \| null`	no	—

AppStatusPayload

Property	Type	Required	Description
`components`	`AppStatusComponentDto[] \| null`	no	—

AppSunsetAlternative

Property	Type	Required	Description
`kind`	`string \| null`	no	—
`label`	`string \| null`	no	—
`note`	`string \| null`	no	—
`reference`	`string \| null`	no	—

AppSunsetAlternativeRequest

Property	Type	Required	Description
`kind`	`string \| null`	no	—
`label`	`string \| null`	no	—
`note`	`string \| null`	no	—
`reference`	`string \| null`	no	—

AppSunsetDto

Property	Type	Required	Description
`affectedInstallCount`	`integer (int32)`	no	—
`alternatives`	`AppSunsetAlternative[] \| null`	no	—
`appName`	`string \| null`	no	—
`applicationId`	`string \| null`	no	—
`cancellationReason`	`string \| null`	no	—
`cancelledAt`	`string (date-time) \| null`	no	—
`cancelledBy`	`string \| null`	no	—
`completedAt`	`string (date-time) \| null`	no	—
`daysRemaining`	`integer (int32)`	no	—
`deprecationId`	`string \| null`	no	—
`developerId`	`string \| null`	no	—
`disposition`	`string \| null`	no	—
`dispositionAttestedAt`	`string (date-time) \| null`	no	—
`dispositionAttestedBy`	`string \| null`	no	—
`dispositionJustification`	`string \| null`	no	—
`dispositionOutstanding`	`boolean`	no	—
`scheduledAt`	`string (date-time)`	no	—
`scheduledBy`	`string \| null`	no	—
`state`	`AppSunsetState`	no	—
`sunsetAt`	`string (date-time)`	no	—
`sunsetMessage`	`string \| null`	no	—
`windowDays`	`integer (int32)`	no	—

AppSunsetState

0 | 1 | 2 with no declared properties.

AppTransferAssetOutcome

Property	Type	Required	Description
`found`	`integer (int32)`	no	—
`kind`	`string \| null`	no	—
`moved`	`integer (int32)`	no	—
`note`	`string \| null`	no	—
`selected`	`boolean`	no	—

AppTransferDryRunFinding

Property	Type	Required	Description
`assetKind`	`string \| null`	no	—
`message`	`string \| null`	no	—
`severity`	`string \| null`	no	—

AppTransferDto

Property	Type	Required	Description
`acceptedAt`	`string (date-time) \| null`	no	—
`acceptedBy`	`string \| null`	no	—
`appName`	`string \| null`	no	—
`applicationId`	`string \| null`	no	—
`assetOutcomes`	`AppTransferAssetOutcome[] \| null`	no	—
`completedAt`	`string (date-time) \| null`	no	—
`consentPosture`	`string \| null`	no	—
`consentPostureOutstanding`	`boolean`	no	—
`cutoverAssertionId`	`string \| null`	no	—
`cutoverReady`	`boolean`	no	—
`cutoverScheduledFor`	`string (date-time) \| null`	no	—
`daysToRespond`	`integer (int32)`	no	—
`declinedAt`	`string (date-time) \| null`	no	—
`declinedBy`	`string \| null`	no	—
`dryRunAt`	`string (date-time) \| null`	no	—
`dryRunFindings`	`AppTransferDryRunFinding[] \| null`	no	—
`dryRunVerdict`	`string \| null`	no	—
`expiresAt`	`string (date-time)`	no	—
`fromOrgId`	`string \| null`	no	—
`installedBaseCount`	`integer (int32)`	no	—
`installedBaseRef`	`string \| null`	no	—
`kycEvidenceRef`	`string \| null`	no	—
`kycVerifiedAt`	`string (date-time) \| null`	no	—
`listingIds`	`string[] \| null`	no	—
`offeredAt`	`string (date-time)`	no	—
`offeredBy`	`string \| null`	no	—
`outcome`	`string \| null`	no	—
`outcomeReason`	`string \| null`	no	—
`rolledBackAt`	`string (date-time) \| null`	no	—
`scopes`	`string[] \| null`	no	—
`selectedAssets`	`string[] \| null`	no	—
`state`	`AppTransferState`	no	—
`toOrgId`	`string \| null`	no	—
`toOrgName`	`string \| null`	no	—
`transferId`	`string \| null`	no	—
`withdrawnAt`	`string (date-time) \| null`	no	—

AppTransferManifestDto

Property	Type	Required	Description
`acquirerKycVerified`	`boolean`	no	—
`acquirerKycVerifiedAt`	`string (date-time) \| null`	no	—
`activeGrantCount`	`integer (int32)`	no	—
`consentPosture`	`string \| null`	no	—
`installedBaseCount`	`integer (int32)`	no	—
`obligations`	`string[] \| null`	no	—
`openFindings`	`AppTransferDryRunFinding[] \| null`	no	—
`outstandingPayoutAmount`	`number (double)`	no	—
`outstandingPayoutCurrency`	`string \| null`	no	—
`scopes`	`string[] \| null`	no	—
`transfer`	`AppTransferDto`	no	—

AppTransferState

0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 with no declared properties.

AttestAppSunsetDispositionRequest

Property	Type	Required	Description
`attestedBy`	`string \| null`	no	—
`disposition`	`string \| null`	no	—
`justification`	`string \| null`	no	—

AttestPurgeRequest

Property	Type	Required	Description
`method`	`string \| null`	no	—
`recordsDestroyed`	`integer (int32) \| null`	no	—

CancelAppDeprecationRequest

Property	Type	Required	Description
`cancelledBy`	`string \| null`	no	—
`reason`	`string \| null`	no	—

ChangeAppDataPolicyRequest

Property	Type	Required	Description
`effectiveOn`	`string (date) \| null`	no	—
`policy`	`AppDataRetentionPolicySnapshot`	no	—
`requestedGraceDays`	`integer (int32)`	no	—

ClosureAcknowledgementDto

Property	Type	Required	Description
`acknowledgedAt`	`string (date-time)`	no	—
`acknowledgedBy`	`string \| null`	no	—
`blocker`	`string \| null`	no	—
`reason`	`string \| null`	no	—
`stage`	`string \| null`	no	—

ClosureAppDto

Property	Type	Required	Description
`apiKeysRevoked`	`integer (int32)`	no	—
`appId`	`string \| null`	no	—
`consumers`	`ClosureConsumerDto[] \| null`	no	—
`disposition`	`string \| null`	no	—
`dispositionStatement`	`string \| null`	no	—
`frozen`	`boolean`	no	—
`liveConsumerCount`	`integer (int32)`	no	—
`migrationDeadline`	`string (date) \| null`	no	—
`name`	`string \| null`	no	—
`transferAccepted`	`boolean`	no	—
`transferToLabel`	`string \| null`	no	—

ClosureAttestationDto

Property	Type	Required	Description
`acknowledgements`	`ClosureAcknowledgementDto[] \| null`	no	—
`appsTransferred`	`integer (int32)`	no	—
`appsWoundDown`	`integer (int32)`	no	—
`attestedAt`	`string (date-time) \| null`	no	—
`chainVerified`	`boolean`	no	—
`consumerGrantsRevoked`	`integer (int32)`	no	—
`consumersNotified`	`integer (int32)`	no	—
`developerLabel`	`string \| null`	no	—
`erasureStatement`	`string \| null`	no	—
`quality`	`string \| null`	no	—
`recordsExcludedUnderHold`	`ClosureErasureBlockerDto[] \| null`	no	—
`reference`	`string \| null`	no	—
`settlementStatement`	`string \| null`	no	—
`statement`	`string \| null`	no	—
`timeline`	`ClosureTimelineEntryDto[] \| null`	no	—

ClosureBlockerDto

Property	Type	Required	Description
`acknowledged`	`boolean`	no	—
`key`	`string \| null`	no	—
`statement`	`string \| null`	no	—

ClosureCaseDto

Property	Type	Required	Description
`acknowledgements`	`ClosureAcknowledgementDto[] \| null`	no	—
`apps`	`ClosureAppDto[] \| null`	no	—
`attestationQuality`	`string \| null`	no	—
`attestationStatement`	`string \| null`	no	—
`attestedAt`	`string (date-time) \| null`	no	—
`caseId`	`string \| null`	no	—
`developerId`	`string \| null`	no	—
`developerLabel`	`string \| null`	no	—
`erasure`	`ClosureErasureDto`	no	—
`openedAt`	`string (date-time)`	no	—
`reference`	`string \| null`	no	—
`sandboxes`	`ClosureSandboxDto[] \| null`	no	—
`settlement`	`ClosureSettlementDto`	no	—
`stage`	`string \| null`	no	—
`stageLabel`	`string \| null`	no	—
`stages`	`ClosureStageDto[] \| null`	no	—
`status`	`string \| null`	no	—
`statusStatement`	`string \| null`	no	—
`updatedAt`	`string (date-time)`	no	—

ClosureConsumerDto

Property	Type	Required	Description
`consumerRef`	`string \| null`	no	—
`grantRevocationState`	`string \| null`	no	—
`grantRevocationStatement`	`string \| null`	no	—
`isOrganisation`	`boolean`	no	—
`migrated`	`boolean`	no	—
`noticeReceiptId`	`string \| null`	no	—
`noticeState`	`string \| null`	no	—

ClosureErasureBlockerDto

Property	Type	Required	Description
`category`	`string \| null`	no	—
`reason`	`string \| null`	no	—
`releaseStatement`	`string \| null`	no	—
`releasesAt`	`string (date-time) \| null`	no	—

ClosureErasureDto

Property	Type	Required	Description
`blockers`	`ClosureErasureBlockerDto[] \| null`	no	—
`certificateUrl`	`string \| null`	no	—
`completedAt`	`string (date-time) \| null`	no	—
`confirmedAt`	`string (date-time) \| null`	no	—
`eligibilityReadAt`	`string (date-time) \| null`	no	—
`eligibilityUnavailableReason`	`string \| null`	no	—
`erasureRequestId`	`string (uuid) \| null`	no	—
`state`	`string \| null`	no	—
`statement`	`string \| null`	no	—

ClosureSandboxDto

Property	Type	Required	Description
`freezeState`	`string \| null`	no	—
`freezeStatement`	`string \| null`	no	—
`name`	`string \| null`	no	—
`sandboxId`	`string (uuid)`	no	—

ClosureSettlementDto

Property	Type	Required	Description
`available`	`boolean`	no	—
`currency`	`string \| null`	no	—
`heldForManualHandling`	`integer (int32) \| null`	no	—
`isSettled`	`boolean`	no	—
`owedMinorUnits`	`integer (int64) \| null`	no	—
`paidMinorUnits`	`integer (int64) \| null`	no	—
`reconciledAt`	`string (date-time)`	no	—
`recoveryAction`	`string \| null`	no	—
`statement`	`string \| null`	no	—
`taxRecordsRetainedUntil`	`string (date) \| null`	no	—
`taxStatementUrl`	`string \| null`	no	—

ClosureStageDto

Property	Type	Required	Description
`blockers`	`ClosureBlockerDto[] \| null`	no	—
`completedAt`	`string (date-time) \| null`	no	—
`explains`	`string \| null`	no	—
`nextAction`	`string \| null`	no	—
`ordinal`	`integer (int32)`	no	—
`stage`	`string \| null`	no	—
`startedAt`	`string (date-time) \| null`	no	—
`state`	`string \| null`	no	—
`stateStatement`	`string \| null`	no	—
`title`	`string \| null`	no	—
`whoseMove`	`string \| null`	no	—

ClosureStep

Property	Type	Required	Description
`explains`	`string \| null`	no	—
`key`	`string \| null`	no	—
`ordinal`	`integer (int32)`	no	—
`title`	`string \| null`	no	—
`whoseMove`	`string \| null`	no	—

ClosureTimelineEntryDto

Property	Type	Required	Description
`actor`	`string \| null`	no	—
`hash`	`string \| null`	no	—
`occurredAt`	`string (date-time)`	no	—
`sequence`	`integer (int32)`	no	—
`stage`	`string \| null`	no	—
`statement`	`string \| null`	no	—

ConfirmClosureErasureCommand

Property	Type	Required	Description
`typedConfirmation`	`string \| null`	no	—

ContinuityAppDto

Property	Type	Required	Description
`appId`	`string \| null`	no	—
`businessCriticality`	`string \| null`	no	—
`consumerCountStatement`	`string \| null`	no	—
`criticalityStatement`	`string \| null`	no	—
`currency`	`string \| null`	no	—
`decidedAt`	`string (date-time) \| null`	no	—
`disposition`	`string \| null`	no	—
`dispositionReason`	`string \| null`	no	—
`dispositionStatement`	`string \| null`	no	—
`escrowState`	`string \| null`	no	—
`escrowStatement`	`string \| null`	no	—
`liveConsumerCount`	`integer (int32)`	no	—
`migrationDeadline`	`string (date) \| null`	no	—
`name`	`string \| null`	no	—
`payoutState`	`string \| null`	no	—
`payoutStatement`	`string \| null`	no	—
`payoutUnknownReason`	`string \| null`	no	—
`pendingPayoutMinorUnits`	`integer (int64) \| null`	no	—
`successorLabel`	`string \| null`	no	—
`undoUntil`	`string (date-time) \| null`	no	—

ContinuityAuthorityDto

Property	Type	Required	Description
`accountInEstateMet`	`boolean`	no	—
`accountInEstateSource`	`string \| null`	no	—
`accountInEstateStatement`	`string \| null`	no	—
`contestReason`	`string \| null`	no	—
`contested`	`boolean`	no	—
`determinedAt`	`string (date-time) \| null`	no	—
`determinedBy`	`string \| null`	no	—
`estateAuthorityMet`	`boolean`	no	—
`estateAuthorityStatement`	`string \| null`	no	—
`estateId`	`string (uuid)`	no	—
`evidenceDocumentId`	`string \| null`	no	—
`instrument`	`string \| null`	no	—
`instrumentStatement`	`string \| null`	no	—
`outcome`	`string \| null`	no	—
`reason`	`string \| null`	no	—

ContinuityCaseDto

Property	Type	Required	Description
`accountState`	`string \| null`	no	—
`accountStateStatement`	`string \| null`	no	—
`anchorReceiptPath`	`string \| null`	no	—
`apps`	`ContinuityAppDto[] \| null`	no	—
`authority`	`ContinuityAuthorityDto`	no	—
`caseId`	`string \| null`	no	—
`currentStepKey`	`string \| null`	no	—
`currentStepLabel`	`string \| null`	no	—
`dataTreatment`	`ContinuityDataTreatment`	no	—
`dataTreatmentReviewedAt`	`string (date-time) \| null`	no	—
`dataTreatmentReviewedBy`	`string \| null`	no	—
`deceasedDeveloperId`	`string \| null`	no	—
`deceasedDeveloperLabel`	`string \| null`	no	—
`executorUserId`	`string \| null`	no	—
`nextAction`	`string \| null`	no	—
`notices`	`ContinuityNoticeDto[] \| null`	no	—
`openedAt`	`string (date-time)`	no	—
`reference`	`string \| null`	no	—
`status`	`string \| null`	no	—
`statusStatement`	`string \| null`	no	—
`timeline`	`ContinuityTimelineEntryDto[] \| null`	no	—
`updatedAt`	`string (date-time)`	no	—

ContinuityCaseRecordDto

Property	Type	Required	Description
`anchorReceiptPath`	`string \| null`	no	—
`case`	`ContinuityCaseDto`	no	—
`chainStatement`	`string \| null`	no	—
`chainVerified`	`boolean`	no	—
`firstBrokenSequence`	`integer (int32) \| null`	no	—

ContinuityDataTreatment

Property	Type	Required	Description
`consumerPosture`	`string \| null`	no	—
`consumerPostureStatement`	`string \| null`	no	—
`deceasedDataStatement`	`string \| null`	no	—
`jurisdiction`	`string \| null`	no	—
`regime`	`PostMortemRegime`	no	—
`registryConsulted`	`boolean`	no	—
`registryUnavailableReason`	`string \| null`	no	—
`successorProcessingBasis`	`string \| null`	no	—
`successorProcessingStatement`	`string \| null`	no	—

ContinuityNoticeDto

Property	Type	Required	Description
`appId`	`string \| null`	no	—
`consumerRef`	`string \| null`	no	—
`dispatchedAt`	`string (date-time) \| null`	no	—
`disposition`	`string \| null`	no	—
`migrationDeadline`	`string (date) \| null`	no	—
`queuedAt`	`string (date-time)`	no	—
`receiptId`	`string \| null`	no	—
`state`	`string \| null`	no	—
`statement`	`string \| null`	no	—

ContinuityQueueItemDto

Property	Type	Required	Description
`appCount`	`integer (int32)`	no	—
`awaitingDetermination`	`boolean`	no	—
`caseId`	`string \| null`	no	—
`deceasedDeveloperLabel`	`string \| null`	no	—
`highestCriticality`	`string \| null`	no	—
`openedAt`	`string (date-time)`	no	—
`reference`	`string \| null`	no	—
`status`	`string \| null`	no	—
`statusStatement`	`string \| null`	no	—
`totalLiveConsumers`	`integer (int32)`	no	—
`undecidedAppCount`	`integer (int32)`	no	—
`updatedAt`	`string (date-time)`	no	—

ContinuityStep

Property	Type	Required	Description
`key`	`string \| null`	no	—
`ordinal`	`integer (int32)`	no	—
`title`	`string \| null`	no	—
`whoseMove`	`string \| null`	no	—

ContinuityTimelineEntryDto

Property	Type	Required	Description
`actorLabel`	`string \| null`	no	—
`appId`	`string \| null`	no	—
`contentHash`	`string \| null`	no	—
`detail`	`string \| null`	no	—
`kind`	`string \| null`	no	—
`occurredAt`	`string (date-time)`	no	—
`previousHash`	`string \| null`	no	—
`sequence`	`integer (int32)`	no	—

CreateApplicationCommand

Property	Type	Required	Description
`applicationType`	`string \| null`	no	—
`dataProcessingScope`	`DataProcessingScopeDeclaration`	no	—
`description`	`string \| null`	no	—
`developerId`	`string \| null`	no	—
`name`	`string \| null`	no	—
`privacyPolicyUrl`	`string \| null`	no	—
`scopes`	`string[] \| null`	no	—
`termsOfServiceUrl`	`string \| null`	no	—

CreateDeveloperAccountCommand

Property	Type	Required	Description
`description`	`string \| null`	no	—
`developerId`	`string \| null`	no	—
`displayName`	`string \| null`	no	—
`email`	`string \| null`	no	—
`userId`	`string \| null`	no	—
`website`	`string \| null`	no	—

CreateWebhookCommand

Property	Type	Required	Description
`alertRouting`	`WebhookAlertRouting`	no	—
`applicationId`	`string \| null`	no	—
`description`	`string \| null`	no	—
`developerId`	`string \| null`	no	—
`environment`	`string \| null`	no	—
`eventFilters`	`WebhookEventFilter[] \| null`	no	—
`eventTypes`	`string[] \| null`	no	—
`maxDeliveryAttempts`	`integer (int32) \| null`	no	—
`url`	`string \| null`	no	—

DataProcessingScopeDeclaration

Property	Type	Required	Description
`accessLevel`	`string \| null`	no	—
`automatedDecisionMaking`	`boolean`	no	—
`dataDomains`	`string[] \| null`	no	—
`eventTypes`	`string[] \| null`	no	—
`modelIdentifier`	`string \| null`	no	—
`modelProvider`	`string \| null`	no	—
`purpose`	`string \| null`	no	—
`retentionDays`	`integer (int32) \| null`	no	—
`vaultPaths`	`string[] \| null`	no	—

DeclareAppIncidentRequest

Property	Type	Required	Description
`affectedScopes`	`string[] \| null`	no	—
`audienceScope`	`string \| null`	no	—
`consumerStatus`	`string \| null`	no	—
`dataAtRisk`	`boolean`	no	—
`declaredBy`	`string \| null`	no	—
`severity`	`string \| null`	no	—
`startedAt`	`string (date-time) \| null`	no	—
`title`	`string \| null`	no	—

DeclineAppTransferRequest

Property	Type	Required	Description
`declinedBy`	`string \| null`	no	—
`reason`	`string \| null`	no	—

DetermineAssetLinkRequest

Property	Type	Required	Description
`accountIsEstateAsset`	`boolean`	no	—
`reason`	`string \| null`	no	—

DeveloperAccountDto

Property	Type	Required	Description
`accountStatus`	`string \| null`	no	—
`description`	`string \| null`	no	—
`developerId`	`string \| null`	no	—
`displayName`	`string \| null`	no	—
`email`	`string \| null`	no	—
`emailVerified`	`boolean`	no	—
`identityVerified`	`boolean`	no	—
`identityVerifiedAt`	`string \| null`	no	—
`subscriptionTier`	`string \| null`	no	—
`userId`	`string \| null`	no	—
`verificationAssuranceLevel`	`string \| null`	no	—
`verificationIal`	`string \| null`	no	—
`verificationStubId`	`string \| null`	no	—
`website`	`string \| null`	no	—

DocPageDto

Property	Type	Required	Description
`body`	`string \| null`	no	—
`section`	`string \| null`	no	—
`slug`	`string \| null`	no	—
`title`	`string \| null`	no	—

GenerateApiKeyCommand

Property	Type	Required	Description
`applicationId`	`string \| null`	no	—
`developerId`	`string \| null`	no	—
`environment`	`string \| null`	no	—
`expiryDays`	`integer (int32) \| null`	no	—
`scopes`	`string[] \| null`	no	—

InitiateAppTransferRequest

Property	Type	Required	Description
`listingIds`	`string[] \| null`	no	—
`note`	`string \| null`	no	—
`offerValidityDays`	`integer (int32)`	no	—
`offeredBy`	`string \| null`	no	—
`selectedAssets`	`string[] \| null`	no	—
`toOrgId`	`string \| null`	no	—
`toOrgName`	`string \| null`	no	—

OpenClosureCommand

Property	Type	Required	Description
`developerId`	`string \| null`	no	—
`developerLabel`	`string \| null`	no	—
`jurisdiction`	`string \| null`	no	—
`reason`	`string \| null`	no	—

OpenContinuityClaimRequest

Property	Type	Required	Description
`dateOfDeath`	`string (date) \| null`	no	—
`deceasedDeveloperId`	`string \| null`	no	—
`deceasedDeveloperLabel`	`string \| null`	no	—
`estateId`	`string (uuid)`	no	—
`evidenceDocumentId`	`string \| null`	no	—
`instrument`	`string \| null`	no	—
`jurisdiction`	`string \| null`	no	—
`note`	`string \| null`	no	—

OutageReportDto

Property	Type	Required	Description
`applicationId`	`string \| null`	no	—
`developerId`	`string \| null`	no	—
`id`	`string \| null`	no	—
`impact`	`string \| null`	no	—
`observedFrom`	`string (date-time)`	no	—
`observedTo`	`string (date-time)`	no	—
`reference`	`string \| null`	no	—
`reportedAt`	`string (date-time)`	no	—
`serviceName`	`string \| null`	no	—
`status`	`string \| null`	no	—
`symptoms`	`string \| null`	no	—

OveragePolicyDto

Property	Type	Required	Description
`configured`	`boolean`	no	—
`developerId`	`string \| null`	no	—
`enabled`	`boolean`	no	—
`hardCeilingPerDay`	`integer (int32) \| null`	no	—
`includedRequestsPerDay`	`integer (int32) \| null`	no	—
`overageSku`	`string \| null`	no	—
`supportsOverage`	`boolean`	no	—
`tierCode`	`string \| null`	no	—
`tierName`	`string \| null`	no	—
`windowAnchor`	`string \| null`	no	—

OverviewDto

Property	Type	Required	Description
`totalApiKeys`	`integer (int32)`	no	—
`totalApplications`	`integer (int32)`	no	—

PartnerApplicationProfileDto

Property	Type	Required	Description
`applicationId`	`string \| null`	no	—
`name`	`string \| null`	no	—
`publisherName`	`string \| null`	no	—
`publisherVerified`	`boolean`	no	—

PayoutBeneficiary

0 | 1 with no declared properties.

PostAppIncidentUpdateRequest

Property	Type	Required	Description
`message`	`string \| null`	no	—
`postedBy`	`string \| null`	no	—
`renotify`	`boolean`	no	—
`severity`	`string \| null`	no	—
`status`	`string \| null`	no	—

PostMortemRegime

0 | 1 | 2 with no declared properties.

ProblemDetails

Property	Type	Required	Description
`detail`	`string \| null`	no	—
`instance`	`string \| null`	no	—
`status`	`integer (int32) \| null`	no	—
`title`	`string \| null`	no	—
`type`	`string \| null`	no	—

ProgressBody

Property	Type	Required	Description
`developerId`	`string \| null`	no	—
`step`	`integer (int32)`	no	—

ReportOutageRequest

Property	Type	Required	Description
`applicationId`	`string \| null`	no	—
`impact`	`string \| null`	no	—
`observedFrom`	`string (date-time)`	no	—
`observedTo`	`string (date-time)`	no	—
`serviceName`	`string \| null`	no	—
`symptoms`	`string \| null`	no	—

ResolveAppIncidentRequest

Property	Type	Required	Description
`message`	`string \| null`	no	—
`resolvedBy`	`string \| null`	no	—

RevenueSummaryDto

Property	Type	Required	Description
`developerId`	`string \| null`	no	—
`totalRevenueUsd`	`number (double)`	no	—

RotateBody

Property	Type	Required	Description
`developerId`	`string \| null`	no	—

ScheduleAppDeprecationRequest

Property	Type	Required	Description
`alternatives`	`AppSunsetAlternativeRequest[] \| null`	no	—
`message`	`string \| null`	no	—
`scheduledBy`	`string \| null`	no	—
`windowDays`	`integer (int32)`	no	—

ScheduleAppTransferCutoverRequest

Property	Type	Required	Description
`goLiveAt`	`string (date-time)`	no	—
`scheduledBy`	`string \| null`	no	—

SdkArtifactDto

Property	Type	Required	Description
`checksum`	`string \| null`	no	—
`downloadUrl`	`string \| null`	no	—
`language`	`string \| null`	no	—
`releasedAt`	`string \| null`	no	—
`version`	`string \| null`	no	—

SetClosureDispositionCommand

Property	Type	Required	Description
`appId`	`string \| null`	no	—
`disposition`	`string \| null`	no	—
`migrationDeadline`	`string (date) \| null`	no	—
`transferToDeveloperId`	`string \| null`	no	—
`transferToLabel`	`string \| null`	no	—

SetContinuityDispositionCommand

Property	Type	Required	Description
`appId`	`string \| null`	no	—
`disposition`	`string \| null`	no	—
`migrationDeadline`	`string (date) \| null`	no	—
`payoutTo`	`PayoutBeneficiary`	no	—
`reason`	`string \| null`	no	—
`successorLabel`	`string \| null`	no	—
`successorUserId`	`string \| null`	no	—

SetContinuityDispositionsRequest

Property	Type	Required	Description
`decisions`	`SetContinuityDispositionCommand[] \| null`	no	—

SetContinuityHoldRequest

Property	Type	Required	Description
`contested`	`boolean`	no	—
`reason`	`string \| null`	no	—

SubmitContinuityAuthorityRequest

Property	Type	Required	Description
`evidenceDocumentId`	`string \| null`	no	—
`instrument`	`string \| null`	no	—

TutorialDto

Property	Type	Required	Description
`body`	`string \| null`	no	—
`difficulty`	`string \| null`	no	—
`title`	`string \| null`	no	—
`tutorialId`	`string \| null`	no	—

UpdateApplicationCommand

Property	Type	Required	Description
`applicationType`	`string \| null`	no	—
`dataProcessingScope`	`DataProcessingScopeDeclaration`	no	—
`description`	`string \| null`	no	—
`name`	`string \| null`	no	—
`privacyPolicyUrl`	`string \| null`	no	—
`termsOfServiceUrl`	`string \| null`	no	—

UpdateDeveloperAccountCommand

Property	Type	Required	Description
`description`	`string \| null`	no	—
`displayName`	`string \| null`	no	—
`logoUrl`	`string \| null`	no	—
`website`	`string \| null`	no	—

UpdateOveragePolicyCommand

Property	Type	Required	Description
`enabled`	`boolean`	no	—
`hardCeilingPerDay`	`integer (int32) \| null`	no	—

UpdateWebhookCommand

Property	Type	Required	Description
`alertRouting`	`WebhookAlertRouting`	no	—
`description`	`string \| null`	no	—
`eventFilters`	`WebhookEventFilter[] \| null`	no	—
`eventTypes`	`string[] \| null`	no	—
`status`	`string \| null`	no	—
`url`	`string \| null`	no	—

WebhookAlertRouting

Property	Type	Required	Description
`emailEnabled`	`boolean`	no	—
`emailRecipient`	`string \| null`	no	—
`inAppEnabled`	`boolean`	no	—

WebhookConsolidatedDeliveriesDto

Property	Type	Required	Description
`deliveries`	`WebhookDeliveryDto[] \| null`	no	—
`developerId`	`string \| null`	no	—
`unavailable`	`WebhookFeedGapDto[] \| null`	no	—

WebhookDeliveryContractDto

Property	Type	Required	Description
`activeSubscriptionsMetric`	`string \| null`	no	—
`createFeatureCode`	`string \| null`	no	—
`duplicateGuarantee`	`string \| null`	no	—
`maxRetries`	`integer (int32)`	no	—
`orderingGuarantee`	`string \| null`	no	—
`payloadScope`	`string \| null`	no	—
`retryDelaysSeconds`	`(integer (int32))[] \| null`	no	—
`retryFeatureCode`	`string \| null`	no	—
`secretRotationOverlapHours`	`integer (int32)`	no	—
`signatureAlgorithm`	`string \| null`	no	—
`signatureHeader`	`string \| null`	no	—
`signatureScheme`	`string \| null`	no	—
`terminalDisposition`	`string \| null`	no	—
`timestampHeader`	`string \| null`	no	—
`timestampToleranceSeconds`	`integer (int32)`	no	—
`timestampedSignatureGuidance`	`string \| null`	no	—
`timestampedSignatureHeader`	`string \| null`	no	—
`timestampedSignatureScheme`	`string \| null`	no	—
`verificationSnippet`	`string \| null`	no	—

WebhookDeliveryDto

Property	Type	Required	Description
`attemptNumber`	`integer (int32)`	no	—
`deliveredAt`	`string (date-time) \| null`	no	—
`deliveryId`	`string \| null`	no	—
`durationMs`	`integer (int64) \| null`	no	—
`errorMessage`	`string \| null`	no	—
`eventType`	`string \| null`	no	—
`nextRetryAt`	`string (date-time) \| null`	no	—
`notice`	`string \| null`	no	—
`occurredAt`	`string (date-time) \| null`	no	—
`responseStatusCode`	`integer (int32) \| null`	no	—
`status`	`string \| null`	no	—
`webhookId`	`string \| null`	no	—

WebhookDeliveryFeedDto

Property	Type	Required	Description
`complete`	`boolean`	no	—
`deliveries`	`WebhookDeliveryDto[] \| null`	no	—
`notice`	`string \| null`	no	—
`webhookId`	`string \| null`	no	—

WebhookDto

Property	Type	Required	Description
`alertRouting`	`WebhookAlertRouting`	no	—
`applicationId`	`string \| null`	no	—
`createdAt`	`string (date-time) \| null`	no	—
`description`	`string \| null`	no	—
`developerId`	`string \| null`	no	—
`engineFeatureCode`	`string \| null`	no	—
`engineNotice`	`string \| null`	no	—
`engineRegistered`	`boolean`	no	—
`engineSubscriptionId`	`string \| null`	no	—
`engineUpgradeMessage`	`string \| null`	no	—
`environment`	`string \| null`	no	—
`eventFilters`	`WebhookEventFilter[] \| null`	no	—
`eventTypes`	`string[] \| null`	no	—
`secret`	`string \| null`	no	—
`status`	`string \| null`	no	—
`url`	`string \| null`	no	—
`webhookId`	`string \| null`	no	—

WebhookEngineStatistics

Property	Type	Required	Description
`averageDurationMs`	`number (double)`	no	—
`failedDeliveries`	`integer (int32)`	no	—
`pendingDeliveries`	`integer (int32)`	no	—
`successRate`	`number (double)`	no	—
`successfulDeliveries`	`integer (int32)`	no	—
`totalDeliveries`	`integer (int32)`	no	—

WebhookEventFilter

Property	Type	Required	Description
`eventType`	`string \| null`	no	—
`fieldPath`	`string \| null`	no	—
`matchValue`	`string \| null`	no	—

WebhookFeedGapDto

Property	Type	Required	Description
`reason`	`string \| null`	no	—
`url`	`string \| null`	no	—
`webhookId`	`string \| null`	no	—

WebhookHealthDto

Property	Type	Required	Description
`available`	`boolean`	no	—
`notice`	`string \| null`	no	—
`statistics`	`WebhookEngineStatistics`	no	—
`webhookId`	`string \| null`	no	—

WebhookSecretRotationDto

Property	Type	Required	Description
`newSecret`	`string \| null`	no	—
`notice`	`string \| null`	no	—
`previousSecretValidUntil`	`string (date-time) \| null`	no	—
`rotated`	`boolean`	no	—
`webhookId`	`string \| null`	no	—

WithdrawAppTransferRequest

Property	Type	Required	Description
`reason`	`string \| null`	no	—
`withdrawnBy`	`string \| null`	no	—

Essence Developer Portal API ​

AccountClosure

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

AccountClosureAdmin

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Analytics

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

ApiKeys

Essence Developer Portal API