SAP Knowledge Base Article - Public

3452944 - Data Privacy Consent Statement APIs - Recruiting Management


You can now use Data Privacy Consent Statement (DPCS) APIs to view consent statements.

You can also view and update the status of acknowledgments for external candidates.

This article demonstrates how to utilize the OData API to view the DPCS details and update the DPCS status for external candidates.


SAP SuccessFactors Recruiting Management



To use the APIs on external candidates in Recruiting, you need the Administrator > Recruiting Permissions > REST API to Manage Data Privacy Consent Statement for External Candidates permission. 

Sample payloads

1. Get the latest DPCS for a given country and locale:

GET: [DC API URL]/rest/security/privacy/v1/statements?type=recruiting_external&language=en_US&country=USA 

2. Update DPCS status for external candidate:

POST: [DC API URL]/rest/security/privacy/v1/acknowledgements
POST Body:

  "statementId": 123,
  "subjectId": "456",
  "action": 1

* statementId: The Id obtained from GET query.
* subjectId: Candidate ID
* action: 1 = accepted; 2 = declined

3. Check whether the candidate has accepted the latest DPCS or not:

GET: [DC API URL]/rest/security/privacy/v1/acknowledgements?type=recruiting_external&language=en_US&country=USA&subjectId=Candidate ID

Please note:

  1. At the current time, the option to update DPCS status is only available for external candidates.  
  2. If you choose to set the action as 2 (declined) for external candidates, their candidate profiles will be deleted right away. This is similar to when the candidate declines the DPCS from their own end. 

See Also

Please check the KBA 2215682 - SuccessFactors API URLs and external IPs to find [DC API URL] for your instance.


OData API, DPCS, Rest API, Data Privacy Consent Statement APIs , KBA , LOD-SF-RCM-API , Webservices & APIs , How To


SAP SuccessFactors Recruiting all versions