POST
/
v1
/
policies
Create a verification policy
curl --request POST \
  --url https://sandbox.authbound.io/v1/policies \
  --header 'Content-Type: application/json' \
  --header 'X-Authbound-Key: <api-key>' \
  --data '
{
  "name": "Pension eligibility",
  "requested_claims": [
    "given_name",
    "family_name",
    {
      "claim": "age_over_18",
      "values": [
        true
      ]
    }
  ],
  "attestation_type": "pid",
  "ecosystem": "eudi",
  "description": "Confirm that a customer is eligible for pension benefits.",
  "purpose": "Pension benefit enrollment",
  "credential_definition_id": "pension_credential_v1",
  "vct": "urn:vc:authbound:pension:1.0"
}
'
{
  "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).

Headers

Idempotency-Key
string

Unique key for idempotent requests

Maximum string length: 255

Body

application/json

Exactly one of attestation_type, credential_definition_id, or vct is required. attestation_type also requires ecosystem and format. Custom credential_definition_id and vct targets support dc+sd-jwt only. Selected claims control both requested information and returned output; return_attrs is rejected on creation. Output keys use canonical aliases where applicable, for example birthdate becomes birth_date. Existing saved policy IDs retain their stored output selection.

name
string
required
Maximum string length: 255
Example:

"Pension eligibility"

requested_claims
(string | object)[]
required

Each selected claim is requested, required and returned. Use an object to require one of the exact typed values. Claim names must be unique after alias resolution.

Required array length: 1 - 256 elements
Required string length: 1 - 256
Example:
[
"given_name",
"family_name",
{ "claim": "age_over_18", "values": [true] }
]
attestation_type
string
required

Built-in attestation target. Exactly one target field is required.

Example:

"pid"

ecosystem
string
required

Required when attestation_type is supplied.

Example:

"eudi"

format
enum<string>
required
Available options:
dc+sd-jwt,
mso_mdoc
description
string
Maximum string length: 5000
Example:

"Confirm that a customer is eligible for pension benefits."

purpose
string
Maximum string length: 1000
Example:

"Pension benefit enrollment"

credential_definition_id
string

Project or approved credential definition target. Exactly one target field is required.

Example:

"pension_credential_v1"

vct
string

Custom dc+sd-jwt VCT target. Exactly one target field is required.

Example:

"urn:vc:authbound:pension:1.0"

Response

Policy created

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