e-Profile Holder Consent API

The e-Profile Holder Consent API makes it easy for individual e-Profile holders to provide their consent for data share. Read more about the parameters. The data returned from this API can be found below.

Parties requesting an API key will need to contact our technology department and follow the setup guidelines provided.

The e-Profile Holder Consent API provides e-Profile information for an individual profile using the provided parameters.

MethodAPI
POST/v1/Individual/Consent

Parameters

NameValueDescription
eProfileIDIntegere-Profile ID of person
ConsentDateTimeStringISO-8601 (Format: 2018-07-14T19:43:37+0100)
DOBStringDate of birth of the e-Profile ID holder (Format: MM-DD)

Responses

Status CodeDescription
200Successful response
400Invalid request
401Unauthorized
403Forbidden
404Person with given e-Profile ID does not exist
409Provided DOB is not a match/e-Profile ID not found
500Error while processing request

Looking for additional assistance?

Contact the Member Relations and Government Affairs team for API requests or incidents.

API Interest Form