Check Consent Request Status
When you subscribe to data that contains personally identifiable information and send out a consent request, you initiate the consent management process. The data subject reviews your consent request to grant or deny data access. Your data becomes available when the data subject provides consent by approving your request.
To check the consent request status you need to obtain credentials and authenticate with HERE platform. For more information, see Get Access to HERE Marketplace.
Use api-lookup
service to get the base URLs of all HERE platform APIs. HERE platform APIs are those that are not tied to a specific catalog. To get a list of all HERE platform APIs, make request:
GET /lookup/v1/platform/apis HTTP/1.1
Host: api-lookup.data.api.platform.here.com
Authorization: Bearer <Authorization Token>
Cache-Control: no-cache
curl -X GET \
-H "Authorization: Bearer <Authorization Token>" \
-H "Cache-Control: no-cache" \
https://api-lookup.data.api.platform.here.com/lookup/v1/platform/apis
A response includes a list of HERE platform APIs that you have access to, including their base URLs.
You can also use api-lookup
service to get the base URL for the Consent Management API. Make request:
GET /lookup/v1/platform/apis/consent/v1 HTTP/1.1
Host: api-lookup.data.api.platform.here.com
Authorization: Bearer <Authorization Token>
Cache-Control: no-cache
curl -X GET \
-H "Authorization: Bearer <Authorization Token>" \
-H "Cache-Control: no-cache" \
https://api-lookup.data.api.platform.here.com/lookup/v1/platform/apis/consent/v1
In case of a successful run, you receive the following response:
{
"api": "consent",
"version": "v1",
"baseURL": "https://consent.api.platform.here.com/consent-service/v1",
"parameters": {}
}
For more information about api-lookup
API, see API Lookup Developer's Guide.
Additionally to consent request status you can also check the overall number of pending, approved, and revoked consent requests by using HERE Neutral Server API endpoints.
Сheck the consent request status for a specific VIN number
Example of a consent request status check:
https://consent.api.platform.here.com/consent-service/v1/consents/status?consentRequestId=consent_request_id&vin=JH1TB2H25CC000000
curl -X GET \
-H "Accept: application/json" \
"https://consent.api.platform.here.com/consent-service/v1/consents/status?consentRequestId=consent_request_id&vin=JH1TB2H25CC000000"
In case of a successful run, you receive the following status information:
{
"consentRequestId": "string",
"vin": "JH1TB2H25CC000000",
"state": "PENDING"
}
Check the common consent request status: the number of pending, approved, revoked, rejected and expired consent requests
Example of how to get a common consent request status:
https://consent.api.platform.here.com/consent-service/v1/consentRequests/consent_request_id/status
Authorization: Bearer <Authorization Token>
Cache-Control: no-cache
curl -X GET \
-H "Authorization: Bearer <Authorization Token>" \
-H "Cache-Control: no-cache" \
-H "Accept: application/json" \
"https://consent.api.platform.here.com/consent-service/v1/consentRequests/consent_request_id/status"
In case of a successful run, you receive the following status information:
{
"approved": 0,
"pending": 0,
"revoked": 0,
"rejected": 0,
"expired": 0
}