Read a consent record

GET /v1/consent-records/{consent_record_id}

Answers one record of the consent ledger with its source and evidence (1.62.0), never its address; the evidence's reference, the customer's own text, only when the read names include=evidence, which needs contacts:content and is an audited content read. A record of the other environment is not_found.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the contacts:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/consent-records/csr_..." \
  -H "Authorization: Bearer $VOCAL_API_KEY"

const response = await fetch(`${process.env.VOCAL_API}/v1/consent-records/csr_...`, {
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
  },
});
console.log(response.status, await response.text());

import os

import requests

response = requests.get(
    f"{os.environ['VOCAL_API']}/v1/consent-records/csr_...",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
    },
)
print(response.status_code, response.text)

Parameters

Responses

Fields of the 200 answer

The shape is ConsentRecord.