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.

MethodAPI
POST/v2/Individual/eprofile/sanctions

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
ReportingEntityStringTrue or False
DatabankIDStringIf false, an appropriate error message will be displayed
DCNStringDCN
PreviousDCNStringPrevious DCN
ActionSubmittedDateStringDate the action was submitted
ActionDateStringDate of the action
ActionEffectiveDateStringDate the action was effective
ActionExpiryDateStringDate the action expired
ActionLengthTypeStringAction length type
ActionLengthYearsStringNumber of years of the action
ActionLengthMonthsStringNumber of months of the action
ActionLengthDaysStringNumber of days of the action
ActionFineAmountStringAmount of the action fine
ActionDescriptionStringDescription of the action
ActionOnAppealStringAction on the appeal
AppealDateStringDate of the appeal
CertPrefixStringCert prefix
CertFirstNameStringCert first name
CertMiddleNameStringCert middle name
CertLastNameStringCert last name
CertSuffixStringCert suffix
CertTitleStringCert title
CertPhoneStringCert phone
CertPhoneExtStringCert phone extension
CertDateStringCert date
LicenseIssueStateStringIssuing state of the license
LicenseIssuedDateStringDate the license was issued
TransmissionModeStringTransmission mode
ParentDCNStringParent DCN
LicenseNumberStringLicense number or license status (if recorded as NO LICENSE)

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