Get applied policy details

GET

/api/v1/projects/{projectId}/policies/{appliedPolicyId}/details

curl --request GET \
  --url https://localhost:10001/api/v1/projects/example/policies/example/details \
  --header 'Authorization: <Authorization>'

Retrieve detailed information about an applied policy, its controls, and its credential

Authorizations

• BearerAuth

Parameters

Path Parameters

projectId

required

string

Project ID, UUID (urn:uuid optional), or slug:my-project

appliedPolicyId

required

string

Applied policy ID, slug:my-policy, or urn:cid:bafy…

Responses

200

Applied policy details with controls and credential

Media type application/json

An applied policy with its controls, credential, and aggregate compliance state

object

appliedPolicy

A policy applied to a project, tracked independently of the library template it came from

object

appliedAt

string format: date-time

appliedBy

string

appliedByDid

Verifiable actor; appliedBy is the label

string

archivedAt

Set via the archive endpoint

string format: date-time

archivedBy

Set via the archive endpoint

string

archivedByDid

Verifiable actor; archivedBy is the label

string

cid

Assigned by the integrity service

string

createdAt

string format: date-time

id

integer

isArchived

Set via the archive endpoint

boolean

isReapplied

boolean

name

string

policyId

Taken from the path on create

integer

projectId

Taken from the path on create

integer

slug

Derived from name

string

status

string

subjectCid

Assigned by the integrity service

string

updatedAt

string format: date-time

controls

Array<object>

A control within an applied policy, expanded with its full declaration and review history

object

appliedPolicyControlId

integer

cid

string

citations

Array<object>

object

title

string

url

string

controlCode

string

controlId

integer

declarations

Array<object>

A declaration as returned inside control details, without the CID inputs the create call accepts

object

appliedPolicyControlId

integer

cid

string

createdAt

string format: date-time

fileAttachments

Array<object>

A file stored against a declaration or review, with its CID and retention window

object

cid

string

contentType

string

declarationId

integer

description

string

fileName

string

id

integer

isPublic

boolean

retentionExpires

string format: date-time

reviewId

integer

sizeBytes

integer

storagePath

string

uploadedAt

string format: date-time

uploadedBy

string

uploadedByDid

Verifiable actor; uploadedBy is the label

string

id

integer

isAutomated

boolean

isReadyForReview

boolean

statement

string

subjectLine

string

submittedAt

string format: date-time

submittedBy

string

submittedByDid

Verifiable actor; submittedBy is the label

string

updatedAt

string format: date-time

description

string

indicators

Array<object>

An indicator bound to an applied policy control, defining how and when it is evaluated

object

applicationUuid

Urn:uuid form

string

appliedPolicyControlId

integer

createdAt

string format: date-time

criteria

Custom indicators only

object

declarationProfile

object

emitOn

required

When to emit a declaration

string

Allowed values: pass fail both none

statementTemplate

string

titleTemplate

string

extractionRules

Custom indicators only

object

id

integer

indicatorId

Urn:uuid form

string

lastEvaluatedAt

string format: date-time

parameters

object

status

string

Allowed values: active disabled archived

triggerType

string

Allowed values: event

updatedAt

string format: date-time

reviews

Array<object>

A review as returned inside control details, without the CID inputs the create call accepts

object

appliedPolicyControlId

integer

cid

string

commentType

string

createdAt

string format: date-time

fileAttachments

Array<object>

A file stored against a declaration or review, with its CID and retention window

object

cid

string

contentType

string

declarationId

integer

description

string

fileName

string

id

integer

isPublic

boolean

retentionExpires

string format: date-time

reviewId

integer

sizeBytes

integer

storagePath

string

uploadedAt

string format: date-time

uploadedBy

string

uploadedByDid

Verifiable actor; uploadedBy is the label

string

id

integer

outcome

string

statement

string

subjectLine

string

submittedAt

string format: date-time

submittedBy

string

submittedByDid

Verifiable actor; submittedBy is the label

string

updatedAt

string format: date-time

status

string

title

string

credential

A verifiable credential issued over an applied policy, revocable but never deleted

object

appliedPolicyId

Taken from the path on create

integer

credential

object

credentialId

Urn:uuid minted per issuance; identifies the row

string

expiresAt

string format: date-time

id

integer

issuedAt

string format: date-time

issuedBy

string

issuedByDid

Verifiable actor; issuedBy is the label

string

revoked

Set via the revoke endpoint

boolean

revokedAt

Set via the revoke endpoint

string format: date-time

revokedBy

Set via the revoke endpoint

string

revokedByDid

Verifiable actor; revokedBy is the label

string

revokedReason

Set via the revoke endpoint

string

sourceCid

Assigned by the integrity service

string

Example

{
  "controls": [
    {
      "indicators": [
        {
          "declarationProfile": {
            "emitOn": "pass"
          },
          "status": "active",
          "triggerType": "event"
        }
      ]
    }
  ]
}

400

Bad request - Invalid project ID or applied policy ID

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

{
  "error": "Invalid request body"
}

401

Unauthorized - Authentication required

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

{
  "error": "Invalid request body"
}

403

Forbidden - No project access or insufficient permissions

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

{
  "error": "Invalid request body"
}

404

Applied policy not found

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

{
  "error": "Invalid request body"
}

500

Internal server error

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

{
  "error": "Invalid request body"
}