Post Individual Sanctions API
The Post Individual Sanctions API provides information on disciplinary actions taken against an individual. 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 Post Individual Sanctions API provides e-Profile information for an individual profile using the provided parameters.
Method | API |
POST | /v2/Individual/eprofile/sanctions |
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 |
ReportingEntity | String | True or False |
DatabankID | String | If false, an appropriate error message will be displayed |
DCN | String | DCN |
PreviousDCN | String | Previous DCN |
ActionSubmittedDate | String | Date the action was submitted |
ActionDate | String | Date of the action |
ActionEffectiveDate | String | Date the action was effective |
ActionExpiryDate | String | Date the action expired |
ActionLengthType | String | Action length type |
ActionLengthYears | String | Number of years of the action |
ActionLengthMonths | String | Number of months of the action |
ActionLengthDays | String | Number of days of the action |
ActionFineAmount | String | Amount of the action fine |
ActionDescription | String | Description of the action |
ActionOnAppeal | String | Action on the appeal |
AppealDate | String | Date of the appeal |
CertPrefix | String | Cert prefix |
CertFirstName | String | Cert first name |
CertMiddleName | String | Cert middle name |
CertLastName | String | Cert last name |
CertSuffix | String | Cert suffix |
CertTitle | String | Cert title |
CertPhone | String | Cert phone |
CertPhoneExt | String | Cert phone extension |
CertDate | String | Cert date |
LicenseIssueState | String | Issuing state of the license |
LicenseIssuedDate | String | Date the license was issued |
TransmissionMode | String | Transmission mode |
ParentDCN | String | Parent DCN |
LicenseNumber | String | License number or license status (if recorded as NO LICENSE) |
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.