Validate Individual e-Profile API

The Validate Individual e-Profile API compares and validates user provided e-Profile information. 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 Validate Individual e-Profile API provides e-Profile information for an individual profile using the provided parameters.

MethodAPI
POST/v2/Individual/eprofile/validate

Parameters

NameValueDescription
eProfileIDInteger(Mandatory) e-Profile ID of person
DOBString(Mandatory) Date of birth of the e-Profile ID holder (Format: MM-DD)

Returned Data

NameValueDescription
FirstNameStringLast name of the person
LastNameStringFirst name of the person
eProfileIDIntegerReported e-Profile ID of the person
Merged from eProfileIDIntegerLast e-Profile ID of the person prior to the profile merge, if occurs
SubscriberStringY or N
is ValidBooleanTrue or False
ErrorMessageStringIf false, an appropriate error message will be displayed

Responses

Status CodeDescription
200True
400Invalid request/please retry
401Unauthorized
403Forbidden
409False
500Error while processing request

Looking for additional assistance?

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

API Interest Form