Sensitive Field Configuration - API Contract

GET /api/v1/sensitive-fields/api/v1/sensitive-fields

List all registered sensitive field configurations

Public

Response Example

{
  "data": [
    {
      "id": "sf-001",
      "field_id": "patient_ssn",
      "label": "Social Security Number",
      "route_context": "PatientProfile",
      "is_sensitive": true,
      "registered_at": "2026-03-20T10:00:00Z"
    },
    {
      "id": "sf-002",
      "field_id": "credit_card_number",
      "label": "Credit Card Number",
      "route_context": "PaymentScreen",
      "is_sensitive": true,
      "registered_at": "2026-03-20T10:01:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 2
  }
}

GET /api/v1/sensitive-fields/api/v1/sensitive-fields/:id

Get a specific sensitive field configuration by ID

Public

Response Example

{
  "id": "sf-001",
  "field_id": "patient_ssn",
  "label": "Social Security Number",
  "route_context": "PatientProfile",
  "is_sensitive": true,
  "registered_at": "2026-03-20T10:00:00Z"
}

POST /api/v1/sensitive-fields/api/v1/sensitive-fields

Register a new sensitive field with its label and route context

Public

Request Example

{
  "field_id": "date_of_birth",
  "label": "Date of Birth",
  "route_context": "PatientDemographics"
}

Response Example

{
  "id": "sf-003",
  "field_id": "date_of_birth",
  "label": "Date of Birth",
  "route_context": "PatientDemographics",
  "is_sensitive": true,
  "registered_at": "2026-03-26T12:10:00Z"
}

PUT /api/v1/sensitive-fields/api/v1/sensitive-fields/:id

Update the label or route context of a sensitive field registration

Public

Request Example

{
  "label": "Patient Date of Birth",
  "route_context": "PatientDemographics,PatientProfile"
}

Response Example

{
  "id": "sf-003",
  "field_id": "date_of_birth",
  "label": "Patient Date of Birth",
  "route_context": "PatientDemographics,PatientProfile",
  "is_sensitive": true,
  "registered_at": "2026-03-26T12:10:00Z",
  "updated_at": "2026-03-26T12:15:00Z"
}

DELETE /api/v1/sensitive-fields/api/v1/sensitive-fields/:id

Unregister a sensitive field configuration

Public

Response Example

{
  "message": "Sensitive field sf-003 unregistered successfully"
}

GET /api/v1/sensitive-fields/api/v1/sensitive-fields/:id/sensitivity

Check whether a field is currently marked as sensitive

Public

Response Example

{
  "field_id": "date_of_birth",
  "is_sensitive": true,
  "label": "Patient Date of Birth",
  "route_context": "PatientDemographics,PatientProfile"
}

Additional Metadata

{
  "contract_summary": {
    "total_contracts": 410,
    "total_endpoints": 2416,
    "api_styles_used": [
      "rest"
    ]
  },
  "generated_at": "2026-03-26T06:55:53.316Z"
}