> ## Documentation Index > Fetch the complete documentation index at: https://docs.serval.com/llms.txt > Use this file to discover all available pages before exploring further. # Reveal Sensitive Entity Field Value > Reveal the value of a sensitive field on one entity. Entity reads withhold values of fields marked sensitive and return the field with `sensitive: true` and no value. Call this only after a read returned such a field, passing that entry's field_id or field_key. Every call is recorded in the audit log. Set include_history to also receive the field's value history. ## OpenAPI ````yaml /sections/api-reference/openapi-spec-v2.yaml post /v2/entities/{entity_id}/reveal-field openapi: 3.1.0 info: title: Serval Public API description: Serval Public API contact: name: Serval url: https://serval.com email: support@serval.com license: name: Serval License url: https://serval.com/license version: 2.0.0 servers: - url: https://public.api.serval.com security: - BearerAuth: [] tags: - name: Access Policy API - name: Access Policy Approval Procedure API - name: Access Profile API - name: Access Relationship API - name: Access Request API - name: Agent API - name: App Instance API - name: App Resource API - name: App Resource Role API - name: Approval Delegation API - name: Approval Request API - name: Assignment Rules API - name: Audit Log API - name: Change Blackout API - name: Change Model API - name: Custom Field API - name: Custom Service API - name: Entity API - name: Entity Field Mapping API - name: Entity Ingestion Config API - name: Entity Type API - name: Folder API - name: Forms API - name: Group API - name: Guidance API - name: Help Agent API - name: Journey API - name: Knowledge API - name: Knowledge Base API - name: Report API - name: Roles API - name: SLA API - name: Schedule API - name: Tag API - name: Team API - name: Team Group API - name: Team User API - name: Ticket API - name: Topic API - name: User API - name: User Relationship API - name: Workflow API - name: Workflow Approval Procedure API - name: Workflow Run API paths: /v2/entities/{entity_id}/reveal-field: post: tags: - Entity API summary: Reveal Sensitive Entity Field Value description: >- Reveal the value of a sensitive field on one entity. Entity reads withhold values of fields marked sensitive and return the field with `sensitive: true` and no value. Call this only after a read returned such a field, passing that entry's field_id or field_key. Every call is recorded in the audit log. Set include_history to also receive the field's value history. operationId: svrelay.publicv2.PublicAPIServiceV2.RevealEntityFieldValue parameters: - name: entity_id in: path required: true schema: type: string title: entity_id description: The ID of the entity. requestBody: content: application/json: schema: type: object allOf: - properties: includeHistory: type: boolean title: include_history description: >- Also return the field's value history on this entity, most recent first. Recorded on the audit event. - oneOf: - type: object properties: fieldId: type: string title: field_id description: >- The field's ID as returned in field_values[].field_id by entity reads. Set exactly one of field_id or field_key. title: field_id required: - fieldId - type: object properties: fieldKey: type: string title: field_key description: >- The field's key as returned in field_values[].field_key. title: field_key required: - fieldKey title: RevealEntityFieldValueRequest additionalProperties: false required: true responses: '200': description: Success content: application/json: schema: $ref: >- #/components/schemas/svstore.publicapi.RevealEntityFieldValueResponse security: - BearerAuth: [] components: schemas: svstore.publicapi.RevealEntityFieldValueResponse: type: object properties: data: $ref: '#/components/schemas/svstore.EntityFieldValue' title: data description: |- The current value. `sensitive` is false and `value` is set when the entity stores one. x-stainless-terraform-configurability: optional history: type: array items: $ref: '#/components/schemas/svstore.EntityFieldValue' title: history description: Present only when include_history was requested. x-stainless-terraform-configurability: optional title: RevealEntityFieldValueResponse additionalProperties: false svstore.EntityFieldValue: type: object properties: id: type: string title: id description: >- The EAV row id. NOT populated on entity read paths (Entity.field_values: search / list / get / create / update) since the v4 slim document_json dropped it — it has no consumer there. It IS populated on the listEntityFieldValueHistory RPC, which reads EAV rows directly. x-stainless-terraform-configurability: optional entityId: type: string title: entity_id x-stainless-terraform-configurability: optional fieldId: type: string title: field_id x-stainless-terraform-configurability: optional fieldKey: type: string title: field_key x-stainless-terraform-configurability: optional fieldName: type: string title: field_name x-stainless-terraform-configurability: optional dataType: $ref: '#/components/schemas/svstore.EntityTypeField.DataType' title: data_type x-stainless-terraform-configurability: optional value: $ref: '#/components/schemas/google.protobuf.Value' title: value description: |- The field value as a JSON-compatible value. Type interpretation is determined by data_type: TEXT, UNIQUE, ENUM, ENTITY_REF, USER_REF → string NUMBER → number BOOL → bool TIMESTAMP → string (ISO 8601, e.g. "2024-03-15T10:30:00Z") MULTI_SELECT → list of strings (enum option IDs) x-stainless-terraform-configurability: optional setByUserId: type: - string - 'null' title: set_by_user_id description: |- Attribution: who/what set this field value. Stored in the slim document_json and populated on ALL entity read paths (search / list / get / create / update) as well as field-value history. x-stainless-terraform-configurability: optional setByAppInstanceId: type: - string - 'null' title: set_by_app_instance_id x-stainless-terraform-configurability: optional createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: created_at description: >- Temporal context. NOT populated on entity read paths (Entity.field_values) since the v4 slim document_json dropped created_at — it has no consumer there. It IS populated on the listEntityFieldValueHistory RPC. The current value for a field has deleted_at unset. x-stainless-terraform-configurability: optional deletedAt: oneOf: - $ref: '#/components/schemas/google.protobuf.Timestamp' - type: 'null' title: deleted_at x-stainless-terraform-configurability: optional pinned: type: boolean title: pinned description: >- When true, ingestion cannot overwrite this user-set value. Stored in the slim document_json and populated on ALL entity read paths. x-stainless-terraform-configurability: computed_optional redacted: type: boolean title: redacted description: >- Set when an access rule hides this field's value from the caller: the placement exists on the entity's type, but value and attribution are withheld (unset) — whether or not a value is stored. x-stainless-terraform-configurability: computed_optional sensitive: type: boolean title: sensitive description: >- Set when the field is marked sensitive and the caller may read it: the value is withheld (unset) — whether or not one is stored — until the caller reveals it with RevealEntityFieldValue, an audited call. Attribution and pinned state are still populated. Never set together with redacted (a hidden field is hidden, not sensitive). x-stainless-terraform-configurability: computed_optional title: EntityFieldValue additionalProperties: false description: |- EntityFieldValue represents a concrete field value on a specific entity. Used for both current values (on Entity.field_values) and historical values (in field value history responses). svstore.EntityTypeField.DataType: type: string title: DataType enum: - DATA_TYPE_UNSPECIFIED - TEXT - NUMBER - BOOL - TIMESTAMP - ENUM - ENTITY_REF - USER_REF - UNIQUE - MULTI_SELECT - FILE google.protobuf.Value: oneOf: - type: 'null' - type: number - type: string - type: boolean - type: array - type: object additionalProperties: true description: |- `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. The JSON representation for `Value` is JSON value. google.protobuf.Timestamp: type: string examples: - '2025-01-15T01:30:15.000Z' - '2025-06-01T00:00:00.000Z' format: date-time description: A timestamp in RFC 3339 format (e.g., "2025-01-15T01:30:15Z"). securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT ````