Get external consent status for a client user

Returns whether the specified client user has an externally-accepted consent.

Path Parameters

• clientUserId string required

  The user's internal Upheal UUID or the partner's partnerUserId (external ID) set during user creation. Note - using partnerUserId may result in slightly higher latency due to an additional lookup.

Responses

• 200
• 401
• 403
• 404

---

Consent status retrieved successfully.

application/json

• Schema
• Example (from schema)

---

Schema

• externalConsentAccepted boolean required

  Whether consent has been accepted externally.

{
  "externalConsentAccepted": true
}

Missing or invalid API key.

Given API key is not allowed to access user with given parameters.

User not found.

Loading...