Skip to main content
PUT
/
v1
/
consent
/
consumer
/
{consent_id}
Update a consumer consent record's scope, expiry, or consented fields. Identity fields are immutable.
curl --request PUT \
  --url https://api.example.com/v1/consent/consumer/{consent_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "network_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "scope": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "consented_fields": "<string>"
}
'
{
  "consent_id": "<string>",
  "field_access_grants": [
    {
      "furnishing_entity_id": "<string>",
      "field_definitions": [],
      "effective_from": "<string>",
      "effective_to": "<string>"
    }
  ],
  "created_at": "<string>",
  "events": "<string>",
  "scope": "<string>",
  "expires_at": "<string>",
  "consented_fields": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
consent_id
string
required

Body

application/json

Update a consumer consent record (scope, expiry, or consented fields).

Identity fields are immutable: a consent record is an audit artifact of who consented and when. To consent with different identity data, create a new consent record instead.

​
network_id
string<uuid>
required
​
scope
string | null
​
expires_at
string<date-time> | null
​
consented_fields
string | null

Response

Successful Response

Create a consumer consent record (direct, server-to-server). Returns a consent_id used for all subsequent queries.

​
consent_id
string
required
​
field_access_grants
FieldAccessGrantOutput · object[]
required
​
created_at
string
required
​
events
string
required
​
scope
string
required
​
expires_at
string | null
​
consented_fields
string | null