Skip to main content
GET
/
identity-records
/
{ir}
Retrieve an Identity Record
curl --request GET \
  --url https://api.central.consent/v1/identity-records/{ir} \
  --header 'Authorization: Bearer <token>'
{
  "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
  }
}

Authorizations

Authorization
string
header
required

JWT from GET /auth/token. Pass as Authorization: Bearer <token>. Expires after 7200s.

Path Parameters

ir
string
required

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.

Pattern: ^ir_[0-9a-f]{24}$
Example:

"ir_a3c5e7f9b1d3a3c5e7f9b1d3"

Response

Identity record found and returned.

response
object
required
identity-record
object
required

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.

Last modified on March 25, 2026