Skip to main content

Akoya
Documentation

Get Consent Grant

GET

https://sandbox-api.akoya.com/consents/{version}/{consentId}

Use this endpoint to get the details of an end-user's consent.

You may use the Consent API to receive notifications of an end-user's change in consent. If you haven't already, subscribe to receive notifications. You'll receive a notification via webhook if your user changes their consent through their provider's website or interface. To see a list of the providers which support consent notifications, log in to the Data Recipient Hub Support Center. Then, view the consent notification providers list.

🛑 The service token should be used as the bearer token with this call.

Path Parameters

  1. version*

    stringdefault: v1

    version of endpoint

  2. consentId*

    string

    Consent Id, may be returned in a notification.

Body Params

Set the grant_type and scope.

  1. grant_type*

    Defaults to client_credentials, your `clientId` and `clientSecret`.

    Example: client_credentials

  2. scope*

    The service accessed by provided credentials.

Responses

  1. 200

    Ok

    Response Body

    object

      id

      string

      The persistent identifier of the consent

      status

      string

      The current status of the consent

      ACTIVEEXPIREDREVOKED

      parties

      array of objects

      The non-end user parties participating in the Consent Grant

        object

          name

          string

          Human recognizable common name

          type

          string

          Extensible string enum identifying the type of the party

          DATA_ACCESS_PLATFORMDATA_PROVIDERDATA_RECIPIENTINDIVIDUALMERCHANTVENDOR

          registeredEntityId

          string

          Registered id of party

      createdTime

      string

      When the consent was initially granted

      resources

      array of objects

      The permissioned resource entities

        object

          resourceType

          string

          Type of resource to be permissioned

          ACCOUNTCUSTOMERDOCUMENT

          resourceId

          string

          Identifier of resource to be permissioned

          dataClusters

          array of objects

          Names of clusters of data elements permissioned

            string

CTRL + K

Try it

Authorization

const options = {
	"method": "GET",
	"headers": {
		"accept": "application/json"
	},
	"body": {
		"application/json": {
			"grant_type": "client_credentials",
			"scope": "notifications_subscriptions advisory"
		}
	}
}};
fetch('https://sandbox-api.akoya.com/consents/v1/', options)
  .then(response => response.json())
  .catch(err => console.error(err));
Send sandbox test event