Skip to main content
POST
/
register-access
Register Access
curl --request POST \
  --url https://api.central.ccs/register-access \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "move-in-date": "2022-06-31",
  "evidence": {
    "date": "2023-11-07T05:31:56Z",
    "terms-url": "https://mycompany.com/consumer-terms-and-conditions-v2.html",
    "expiry": "2023-11-07T05:31:56Z",
    "user-defined-reference": "<string>",
    "method": "Credit Card Verification"
  },
  "cid": "cid_691df0c788ca043403b7fa90"
}
'
{
  "response": {
    "resource": "/<request-end-point-path>",
    "response-time-stamp": "2027-11-10T17:07:01.580Z",
    "transaction-id": "tid_691df0c788ca043403b7fa90"
  },
  "consent-token": {
    "key": "ctk_691df0c788ca043403b7fa90",
    "expiry": "2027-11-10T17:07:01.580Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer tokens are available via the /login endpoint

Body

application/json

Provides details associated with the consent record.

​
move-in-date
string<date>
required

Date from which the consumer started to occupy the property and therefore from what point should the data be available from (inclusive)

Example:

"2022-06-31"

​
evidence
object
required

information required to demonstrate consent was gained appropriately.

​
cid
string

Unique Id that represents the consumer

Example:

"cid_691df0c788ca043403b7fa90"

Response

Consent registered success.

​
response
object
required

Metadata about the response.

​
consent-token
object
required

Fields associated with the consent token that will be used by the Data User to access the consumers data