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.
Method | API |
POST | /v2/Individual/eprofile/validate |
Parameters
Name | Value | Description |
eProfileID | Integer | (Mandatory) e-Profile ID of person |
DOB | String | (Mandatory) Date of birth of the e-Profile ID holder (Format: MM-DD) |
Returned Data
Name | Value | Description |
FirstName | String | Last name of the person |
LastName | String | First name of the person |
eProfileID | Integer | Reported e-Profile ID of the person |
Merged from eProfileID | Integer | Last e-Profile ID of the person prior to the profile merge, if occurs |
Subscriber | String | Y or N |
is Valid | Boolean | True or False |
ErrorMessage | String | If false, an appropriate error message will be displayed |
Responses
Status Code | Description |
200 | True |
400 | Invalid request/please retry |
401 | Unauthorized |
403 | Forbidden |
409 | False |
500 | Error while processing request |
Looking for additional assistance?
Contact the Member Relations and Government Affairs team for API requests or incidents.