Retrieve an Identity Record
Returns the full Identity Record for a given ir key. Only accessible to
the authenticated Data User that created the record.
The email field is never returned in plaintext — has-email indicates
whether an email address is registered on the record. The credentials
array returns passkey metadata (credential ID, registered-at) but never
the public key material itself.
curl --request GET \
--url https://api.central.consent/v1/identity-records/{ir} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.central.consent/v1/identity-records/{ir}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.central.consent/v1/identity-records/{ir}', 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.central.consent/v1/identity-records/{ir}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.central.consent/v1/identity-records/{ir}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.central.consent/v1/identity-records/{ir}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.central.consent/v1/identity-records/{ir}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"response": {
"resource": "/v1/access-records/ak_691df0c788ca043403b7fa90",
"timestamp": "2026-03-11T12:00:00Z",
"transaction-id": "tid_691df0c788ca043403b7fa90"
},
"identity-record": {
"ir": "ir_a3c5e7f9b1d3a3c5e7f9b1d3",
"created-at": "2024-01-15T09:30:00Z",
"has-email": true,
"credentials": [
{
"credential-id": "cred_1a2b3c4d5e6f1a2b3c4d5e6f",
"registered-at": "2024-01-15T09:35:00Z",
"transports": [
"internal"
]
}
],
"pii-principal": {
"mpxn": "1234567890123",
"move-in-date": "2022-06-30",
"address": {
"addressLine1": "221B Baker Street",
"townCity": "London",
"postcode": "NW1 6XE",
"addressLine2": "Marylebone",
"county": "Greater London"
}
},
"expressed-by": "data-subject",
"principal-verification": {
"method": "credit-card",
"verified-at": "2023-11-07T05:31:00Z",
"outcome": "verified",
"reference": "ch_3ABC123xyz",
"submitted": "XXXX-XXXX-XXXX-4242",
"verified-against": "Stripe customer record cus_ABC123",
"detail": {
"last4": "4242",
"brand": "visa",
"stripe_customer": "cus_ABC123"
}
},
"anonymised-at": null
}
}{
"response": {
"resource": "/v1/access-records/ak_691df0c788ca043403b7fa90",
"timestamp": "2026-03-11T12:00:00Z",
"transaction-id": "tid_691df0c788ca043403b7fa90"
},
"errors": [
{
"error-code": "VAL001",
"message": "Field 'mpxn' does not match the required pattern."
}
]
}{
"response": {
"resource": "/v1/access-records/ak_691df0c788ca043403b7fa90",
"timestamp": "2026-03-11T12:00:00Z",
"transaction-id": "tid_691df0c788ca043403b7fa90"
},
"errors": [
{
"error-code": "VAL001",
"message": "Field 'mpxn' does not match the required pattern."
}
]
}{
"response": {
"resource": "/v1/access-records/ak_691df0c788ca043403b7fa90",
"timestamp": "2026-03-11T12:00:00Z",
"transaction-id": "tid_691df0c788ca043403b7fa90"
},
"errors": [
{
"error-code": "VAL001",
"message": "Field 'mpxn' does not match the required pattern."
}
]
}{
"response": {
"resource": "/v1/access-records/ak_691df0c788ca043403b7fa90",
"timestamp": "2026-03-11T12:00:00Z",
"transaction-id": "tid_691df0c788ca043403b7fa90"
},
"errors": [
{
"error-code": "VAL001",
"message": "Field 'mpxn' does not match the required pattern."
}
]
}Authorizations
JWT from GET /auth/token. Pass as Authorization: Bearer <token>. Expires after 7200s.
Path Parameters
The identity record key issued at creation.
Unique opaque identifier for an Identity Record, issued by the register on creation. Referenced from record-metadata.identity-record-ref on an AccessRecord to link the two resources.
^ir_[0-9a-f]{24}$"ir_a3c5e7f9b1d3a3c5e7f9b1d3"
Response
Identity record found and returned.
Show child attributes
Show child attributes
Holds the person-property relationship for a consent or access registration.
Returned by GET /identity-records/{ir}.
The email field is never returned in plaintext — has-email indicates
whether an email address is stored. Passkey public keys are never returned —
credentials contains only metadata (ID, registered-at, transports).
ir and created-at are assigned by the register on creation.
Show child attributes
Show child attributes
curl --request GET \
--url https://api.central.consent/v1/identity-records/{ir} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.central.consent/v1/identity-records/{ir}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.central.consent/v1/identity-records/{ir}', 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.central.consent/v1/identity-records/{ir}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.central.consent/v1/identity-records/{ir}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.central.consent/v1/identity-records/{ir}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.central.consent/v1/identity-records/{ir}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"response": {
"resource": "/v1/access-records/ak_691df0c788ca043403b7fa90",
"timestamp": "2026-03-11T12:00:00Z",
"transaction-id": "tid_691df0c788ca043403b7fa90"
},
"identity-record": {
"ir": "ir_a3c5e7f9b1d3a3c5e7f9b1d3",
"created-at": "2024-01-15T09:30:00Z",
"has-email": true,
"credentials": [
{
"credential-id": "cred_1a2b3c4d5e6f1a2b3c4d5e6f",
"registered-at": "2024-01-15T09:35:00Z",
"transports": [
"internal"
]
}
],
"pii-principal": {
"mpxn": "1234567890123",
"move-in-date": "2022-06-30",
"address": {
"addressLine1": "221B Baker Street",
"townCity": "London",
"postcode": "NW1 6XE",
"addressLine2": "Marylebone",
"county": "Greater London"
}
},
"expressed-by": "data-subject",
"principal-verification": {
"method": "credit-card",
"verified-at": "2023-11-07T05:31:00Z",
"outcome": "verified",
"reference": "ch_3ABC123xyz",
"submitted": "XXXX-XXXX-XXXX-4242",
"verified-against": "Stripe customer record cus_ABC123",
"detail": {
"last4": "4242",
"brand": "visa",
"stripe_customer": "cus_ABC123"
}
},
"anonymised-at": null
}
}{
"response": {
"resource": "/v1/access-records/ak_691df0c788ca043403b7fa90",
"timestamp": "2026-03-11T12:00:00Z",
"transaction-id": "tid_691df0c788ca043403b7fa90"
},
"errors": [
{
"error-code": "VAL001",
"message": "Field 'mpxn' does not match the required pattern."
}
]
}{
"response": {
"resource": "/v1/access-records/ak_691df0c788ca043403b7fa90",
"timestamp": "2026-03-11T12:00:00Z",
"transaction-id": "tid_691df0c788ca043403b7fa90"
},
"errors": [
{
"error-code": "VAL001",
"message": "Field 'mpxn' does not match the required pattern."
}
]
}{
"response": {
"resource": "/v1/access-records/ak_691df0c788ca043403b7fa90",
"timestamp": "2026-03-11T12:00:00Z",
"transaction-id": "tid_691df0c788ca043403b7fa90"
},
"errors": [
{
"error-code": "VAL001",
"message": "Field 'mpxn' does not match the required pattern."
}
]
}{
"response": {
"resource": "/v1/access-records/ak_691df0c788ca043403b7fa90",
"timestamp": "2026-03-11T12:00:00Z",
"transaction-id": "tid_691df0c788ca043403b7fa90"
},
"errors": [
{
"error-code": "VAL001",
"message": "Field 'mpxn' does not match the required pattern."
}
]
}
