Consent
Update a consumer consent record's scope, expiry, or consented fields
Update a consumer consent record’s scope, expiry, or consented fields. Identity fields are immutable.
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.solo.one/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>"
}
'import requests
url = "https://api.solo.one/v1/consent/consumer/{consent_id}"
payload = {
"network_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scope": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"consented_fields": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
network_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
scope: '<string>',
expires_at: '2023-11-07T05:31:56Z',
consented_fields: '<string>'
})
};
fetch('https://api.solo.one/v1/consent/consumer/{consent_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.solo.one/v1/consent/consumer/{consent_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'network_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'scope' => '<string>',
'expires_at' => '2023-11-07T05:31:56Z',
'consented_fields' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.solo.one/v1/consent/consumer/{consent_id}"
payload := strings.NewReader("{\n \"network_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scope\": \"<string>\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"consented_fields\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.solo.one/v1/consent/consumer/{consent_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"network_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scope\": \"<string>\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"consented_fields\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.solo.one/v1/consent/consumer/{consent_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"network_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scope\": \"<string>\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"consented_fields\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
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.
Response
Successful Response
Create a consumer consent record (direct, server-to-server). Returns a consent_id used for all subsequent queries.
⌘I
Update a consumer consent record's scope, expiry, or consented fields. Identity fields are immutable.
curl --request PUT \
--url https://api.solo.one/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>"
}
'import requests
url = "https://api.solo.one/v1/consent/consumer/{consent_id}"
payload = {
"network_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scope": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"consented_fields": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
network_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
scope: '<string>',
expires_at: '2023-11-07T05:31:56Z',
consented_fields: '<string>'
})
};
fetch('https://api.solo.one/v1/consent/consumer/{consent_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.solo.one/v1/consent/consumer/{consent_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'network_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'scope' => '<string>',
'expires_at' => '2023-11-07T05:31:56Z',
'consented_fields' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.solo.one/v1/consent/consumer/{consent_id}"
payload := strings.NewReader("{\n \"network_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scope\": \"<string>\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"consented_fields\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.solo.one/v1/consent/consumer/{consent_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"network_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scope\": \"<string>\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"consented_fields\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.solo.one/v1/consent/consumer/{consent_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"network_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scope\": \"<string>\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"consented_fields\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}