3776777 - How to Identify Field IDs for Onboarding Compliance Forms - Onboarding

The complete list of field IDs defined in a specific Onboarding compliance form is required to build OData API queries using the ComplianceUserFormData entity, configure Integration Center integrations, or validate data completeness of submitted forms. SAP does not publish a static master list of field IDs for country-specific compliance forms. The metadataForFormFields property available within the Compliance Form object in Manage Data provides this information directly in the system. Guidance is required on how to retrieve all field IDs for a given compliance form and how to use that list to validate the data returned by the OData API.

SAP SuccessFactors Onboarding

To retrieve all field IDs for an Onboarding compliance form, navigate to the Compliance Form object in Manage Data and inspect the metadataForFormFields property. This property contains the complete list of field IDs and field names defined for the form. Once the field IDs are available, they can be compared against the output of a ComplianceUserFormData OData V2 query to verify which fields are actively stored for a given submission.

Note: The permission Compliance Form > metadataForFormFields (FormFieldMetadata) must be enabled for the administrator role to access this property. For permission configuration, refer to Role-Based Permissions for Onboarding and Offboarding Tasks.

Step 1: Retrieve field IDs from Manage Data

1. Navigate to Admin Center > Manage Data.
2. In the entity type selector, choose Compliance Form.
3. Enter the Form ID of the target form (for example, AUS_TFN_2025_V1 for the Australian Tax File Number form, or AUS_SAF_2025_V1 for the Australian Superannuation form) and open the record.
4. Scroll to the metadataForFormFields section. This section lists all field IDs and their corresponding field names for the selected form.
5. Note the field IDs. These IDs correspond to the id field returned in ComplianceFormDataFieldValue records via the OData API.

Note: The metadataForFormFields list represents the complete set of fields defined for the form at configuration level. Fields that are display only, conditional, or not presented to the onboardee during form completion will not produce a stored ComplianceFormDataFieldValue record and will therefore not appear in API output even though they are present in the metadata.

Step 2: Validate field coverage against the OData API output

To confirm which fields are stored for a completed submission, use the ComplianceUserFormData OData V2 entity with the data navigation property expanded.

1. Build a query using ComplianceUserFormData with the $expand=data parameter. Apply no filter on field ID to return all stored values for the submission. Note: ComplianceFormDataFieldValue is not directly queryable as a root entity. It must always be accessed through the data navigation property of ComplianceUserFormData.
2. Execute the query against a completed form submission. The response returns one ComplianceFormDataFieldValue record per stored field, each containing an id and a value.
3. Compare the id values returned in the API response against the field IDs retrieved in Step 1. Any field ID present in metadataForFormFields but absent from the API response was either left blank by the onboardee, is a display only element, or was not presented due to conditional form logic.

For additional information on querying ComplianceUserFormData, refer to ComplianceUserFormData, SAP SuccessFactors API Reference Guide (OData V2) and KBA 3265228: How to fetch compliance form data API Query in Onboarding.

After completing the steps above, the administrator has a confirmed list of field IDs for the target compliance form and can identify which fields are stored for any given submission. If a field ID from metadataForFormFields is consistently absent from all API responses for completed submissions, the field is likely a display only element or a section header that does not generate stored data.

• 3772557 - How to report the fields within Onboarding compliance forms using Integration Center - SAP for Me
• 3265228 - [Onboarding] How to fetch compliance form data API Query in Onboarding - SAP for Me
• ComplianceUserFormData | SAP Help Portal
• Role-Based Permissions for Onboarding and Offboarding Tasks | SAP Help Portal

ComplianceUserFormData, ComplianceFormDataFieldValue, metadataForFormFields, compliance form, field IDs, field list, Onboarding compliance form, OData V2, Manage Data, AUS_TFN_2025_V1, AUS_SAF_2025_V1, form field metadata, data completeness, Integration Center, SAP SuccessFactors Onboarding, OBX, LOD-SF-OBX-FRM , KBA , LOD-SF-OBX-FRM , Compliance 2.0 Country Forms (except i9&EV) , How To