Sign in

v2

latestOpenAPI 3.0.0raw.githubusercontent.com2026-06-027801.5 MB
Consent Info v0.1.0

Create a request to retrieve the validity status of the data processing

Create a request to retrieve the validity status of the API Consumer data processing for a given User, scope(s) and Purpose.

post/passthrough/camara/v1/consent-info/consent-info/v0.1/retrieve

Headers

{"stackTrail":"paths:/passthrough/camara/v1/consent-info/consent-info/v0.1/retrieve:post:parameters:0:schema","oasType":"schema","type":"unknown"}

Correlation id for the different services

x-rapidapi-hoststring required
Example:network-as-code.p-eu.rapidapi.com

The API's Host value as defined in the RapidAPI Hub.

Request body

phoneNumberstring

A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Number). In order to be globally unique it has to be formatted in international format, according to E.164 standard, prefixed with '+'.

scopesstring[] required

List of requested scopes. The scope is a string that represents the access rights that the API Consumer is requesting from the User.

purposestring required

The reason for which personal data will be processed by the API Consumer. CAMARA defines a standard set of Purposes which can be used by API Consumers to specify the reason for their intended personal data processing. CAMARA uses the W3C Data Privacy Vocabulary (DPV) to represent these purposes e.g. dpv:FraudPreventionAndDetection or dpv:RequestedServiceProvision.

requestCaptureUrlboolean required

A boolean flag indicating whether the API Consumer requests API Provider to return a Consent capture URL.

  • true - If set to true the API will include a captureUrl in the response body if applicable.
  • false - The API will omit the Consent capture URL from the response.

Response

captureUrlstring url

URL where the User can provide the necessary Consent. This field is only present in the API response if the API Consumer requests it and if the following conditions are met:

  • statusInfo[*].statusValidForProcessing is false, and
  • statusInfo[*].statusReason is PENDING, REQUESTED or EXPIRED.

Please note that this field is only applicable when the User Consent is required to enable valid data processing. A unique URL is provided to authorise all items in the statusInfo list that require user action.