POST
/
v1
/
policies
/
{id}
/
archive
Archive a verification policy
curl --request POST \
  --url https://sandbox.authbound.io/v1/policies/{id}/archive \
  --header 'X-Authbound-Key: <api-key>'
{
  "object": "policy",
  "id": "pol_pension_eligibility_a1b2c3d4_v1",
  "name": "Pension eligibility",
  "description": "<string>",
  "purpose": "<string>",
  "attestation_type": "<string>",
  "credential_definition_id": "<string>",
  "vct": "urn:vc:authbound:pension:1.0",
  "ecosystem": "eudi",
  "requested_claims": [
    "Pension.startDate",
    "Pension.provider"
  ],
  "return_attrs": [
    "Pension.startDate",
    "Pension.provider"
  ],
  "verification_config_id": "pvc_2wHqf3EJQv9K2J4bN1",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

X-Authbound-Key
string
header
required

Server-side secret key header. Format: sk_live_* (production) or sk_test_* (testing).

Path Parameters

id
string
required

Response

Policy archived

object
enum<string>
required
Available options:
policy
id
string
required
Example:

"pol_pension_eligibility_a1b2c3d4_v1"

name
string
required
Example:

"Pension eligibility"

description
string | null
required
purpose
string | null
required
target_type
enum<string> | null
required
Available options:
attestation,
credential_definition,
vct
attestation_type
string | null
required
credential_definition_id
string | null
required
vct
string | null
required
Example:

"urn:vc:authbound:pension:1.0"

ecosystem
string | null
required
Example:

"eudi"

format
enum<string> | null
required
Available options:
dc+sd-jwt,
mso_mdoc
requested_claims
string[]
required
Example:
["Pension.startDate", "Pension.provider"]
return_attrs
string[]
required
read-only

Output keys derived from selected claims when this policy was created. Existing policies retain their stored selection. This field is not accepted on creation.

Example:
["Pension.startDate", "Pension.provider"]
status
enum<string>
required
Available options:
active,
archived
verification_config_id
string | null
required
Example:

"pvc_2wHqf3EJQv9K2J4bN1"

created_at
string<date-time>
required
updated_at
string<date-time>
required