Verify Consumer

GET

verify-consumer

{cid}

Verify Consumer

curl --request GET \
  --url https://api.central.ccs/verify-consumer/{cid} \
  --header 'Authorization: Bearer <token>'

{
  "response": {
    "resource": "/<request-end-point-path>",
    "response-time-stamp": "2027-11-10T17:07:01.580Z",
    "transaction-id": "tid_691df0c788ca043403b7fa90"
  },
  "address": {
    "addressLine1": "221B Baker Street",
    "townCity": "London",
    "postcode": "NW1 6XE",
    "addressLine2": "Marylebone",
    "county": "Greater London"
  },
  "mpxn": [
    "3456789012345"
  ]
}

Enables verification of a consumer identity to allow the data provider to identify the correct data to share. Endpoint should be called by the Data Provider the first time data is requested by a Data User to match their consent and Consumer Identity with the data they hold.

Authorizations

Authorization

string

header

required

Bearer tokens are available via the /login endpoint

Path Parameters

cid

string

required

Unique Id that represents the consumer

Example:

"cid_691df0c788ca043403b7fa90"

Response

Consent verification success.

response

object

required

Metadata about the response.

Show child attributes

response.resource

string

required

The request's resource path.

Example:

"/<request-end-point-path>"

response.response-time-stamp

string<date-time>

required

The timestamp when this response was created.

Example:

"2027-11-10T17:07:01.580Z"

response.transaction-id

string

Unique Id that represents this transaction

Example:

"tid_691df0c788ca043403b7fa90"

address

object

Address of the consumer

Show child attributes

address.addressLine1

string

required

Primary street address or building number and name

Example:

"221B Baker Street"

address.townCity

string

required

Town or city name

Example:

"London"

address.postcode

string

required

UK postal code in standard format

Example:

"NW1 6XE"

address.addressLine2

string | null

Secondary address information (optional)

Example:

"Marylebone"

address.county

string | null

County or administrative area (optional)

Example:

"Greater London"

mpxn

string[]

List of MPxN of the consumers meter

AuthenticationSolution uses bearer authentication to authorise access to endpoints. To create a bearer, using this endpoint with basic authentication

⌘I

Verify Consumer

curl --request GET \
  --url https://api.central.ccs/verify-consumer/{cid} \
  --header 'Authorization: Bearer <token>'

{
  "response": {
    "resource": "/<request-end-point-path>",
    "response-time-stamp": "2027-11-10T17:07:01.580Z",
    "transaction-id": "tid_691df0c788ca043403b7fa90"
  },
  "address": {
    "addressLine1": "221B Baker Street",
    "townCity": "London",
    "postcode": "NW1 6XE",
    "addressLine2": "Marylebone",
    "county": "Greater London"
  },
  "mpxn": [
    "3456789012345"
  ]
}

Overview

Authentication

Data Users

Data Providers

API Reference

Authorizations

Path Parameters

Response