API Change Log¶
Deprecated¶
Fields deprecated or scheduled for deprecation, and will be decommissioned (removed).
| Name | API Schema | Deprecation Date | Decommission Date |
|---|---|---|---|
enterDate | Entity EntityCorp | 26 Feb 2023 | TBA |
title | Entity | 26 Feb 2023 | TBA |
NameDetail.title | Entity | 26 Feb 2023 | TBA |
xmlFurtherInformation | Entity EntityCorp | 26 Feb 2023 | TBA |
image | Entity | 30 Jun 2024 | TBA |
originalScriptNames | Entity EntityCorp | 30 Jun 2024 | TBA |
dates_Urls | Source | 30 Jun 2024 | TBA |
membersChecked | MonitoringScanHistoryLog MonitoringScanResults | 30 Jun 2024 | TBA |
companiesChecked | CorpMonitoringScanHistoryLog CorpMonitoringScanResults | 30 Jun 2024 | TBA |
isIgnoreBlankDobActive | memberScanSettings | 16 Nov 2025 | TBA |
isIgnoreBlankNationalityActive | memberScanSettings | 16 Nov 2025 | TBA |
Release 10.4.6¶
Released: Nov 30, 2025
| Name | API Schema | Description |
|---|---|---|
X-Request-Language | GET member-scans/single/reportGET member-scans/single/{id}/reportGET member-scans/single/results/{id}/reportGET member-scans/single/{id}/no-results-report... GET corp-scans/single/{id}/reportGET corp-scans/batch/reportGET corp-scans/single/results/{id}/report... | New header parameter to specify the language code to generate the report. Supported language codes are EN, FR, ZH, AR, and JA.This is optional and defaults to |
Release 10.4.5¶
Released: Nov 16, 2025
| Name | API Schema | Description |
|---|---|---|
ignoreBlankPolicy | POST member-scans/singlePOST member-scans/batchPOST corp-scans/singlePOST corp-scans/batch | New input parameter to define fields to exclude results where watchlist profile fields are blank and have no data e.g., DOB, nationality, gender, identity number. |
ignoreBlankPolicy | GET member-scans/single/{id}GET member-scans/batchGET corp-scans/single/{id}GET corp-scans/batch | New parameter to indicate which fields in Ignore Blank Policies were applied for the screening, if any. |
ignoreBlankPolicy | GET organisations/{id}GET organisations/{id}/scan-settings | New parameter to indicate the settings of Ignore Blank Policies applied to the organisation e.g., Yes (exclude blanks), No (include matches where no data is available) or UserDefined (select during screening). |
riskAssessmentEnabled | GET organisations/{id}GET organisations/{id}/scan-settingsGET organisations/{id} | New parameter to indicate the Risk Assessment service status of the organisation or suborganisation. This will only be valid for organisations with the Risk Assessment check service activated in isRiskAssessmentActive. |
Release 10.4.4¶
Released: Oct 11, 2025
| Name | API Schema | Description |
|---|---|---|
users | POST users | Schema and documentation cleaned up to only contain essential and relevant fields. The following redundant fields have been removed:
|
users | PUT users | Schema and documentation cleaned up to only contain essential and relevant fields. The following redundant fields have been removed:
|
Release 10.4.3¶
Released: Jul 27, 2025
| Name | API Schema | Description |
|---|---|---|
sourceofFundsId | POST aml-risk/member-scansPOST aml-risk/member-scans/{scanId} | New input parameter for source of funds for the screened individual. This field is optional. |
sourceofFundsId | GET aml-risk/member-scans/{scanId} | New parameter to indicate the source of fund ID for the individual. |
RiskAssessmentDetail | GET aml-risk/member-scans | New question added for source of funds. |
enableEmailNotification | GET organisations/{id}GET organisations/{id}/scan-settings | New parameter to indicate if notifications are sent by email. |
webhookNotificationenableurlservicechannelName | GET organisations/{id}GET organisations/{id}/scan-settings | New parameter and fields for webhook notifications. |
Release 10.4.2¶
Released: Jul 27, 2025
| Name | API Schema | Description |
|---|---|---|
scriptNameFullName | aml-risk/member-scans | New input parameter to enable entry of Script Name or Latin-based Full Name for the standalone Risk Assessment Check. |
member-scans/single/results/{id}/linked-individuals/risk-levelsmember-scans/single/results/{id}/linked-companies/risk-levels corp-scans/single/results/{id}/linked-individuals/risk-levelscorp-scans/single/results/{id}/linked-companies/risk-levels | New methods to retrieve the recommended risk level of an associated individual or corporate entity based on the organisation risk settings of categories and subcategories. | |
suggestedRisk | POST member-scans/singlePOST member-scans/single/{id}/rescanGET member-scans/single/{id}POST corp-scans/singlePOST corp-scans/single/{id}/rescanGET corp-scans/single/{id} | New parameter returning the recommended risk level of the matched profile based on the organisation risk settings of categories and subcategories. |
exactMidName | POST corp-scans/singleGET corp-scans/singleGET corp-scans/single/report | Removed supported value for matchType for screening and filtering of Corporate entities as this relates to Individual entities. |
Release 10.4.1¶
Released: Jun 28, 2025
| Name | API Schema | Description |
|---|---|---|
aml-risk/member-scansaml-risk/member-scans/{scanId}aml-risk/member-scans/{scanId}/reportaml-risk/corp-scansaml-risk/corp-scans/{scanId}aml-risk/corp-scans/{scanId}/report | New methods to perform and retrieve reports of the AML risk check for individuals and corporate entities. | |
reports/aml-risk-activity | New method to download report of AML Risk check activities. | |
member-scans/singlemember-scans/single/{id}/rescanmember-scans/batchmember-scans/single/{id} corp-scans/singlecorp-scans/single/{id}/rescancorp-scans/batchcorp-scans/single/{id} | New parameter includeRiskAssessment for Risk Assessment Check. | |
member-scans/singlemember-scans/single/reportcorp-scans/singlecorp-scans/single/report | New parameter amlRiskLevel to indicate AML Risk Level result. New value RiskAssessment for parameter scanService. | |
member-scans/batch/{id}member-scans/monitoring/{id}corp-scans/batch/{id}corp-scans/monitoring/{id} | New parameter amlRiskLevel to indicate AML Risk Level result. | |
data-management/scans/countdata-management/scans | New value for input parameter scanType to reflect the Risk Assessment Check. | |
data-management/member-scansdata-management/member-documentsdata-management/corp-scansdata-management/corp-documents | New value for input parameter scanService to reflect the Risk Assessment Check | |
Release 10.4¶
Released: Jun 1, 2025
| Name | API Schema | Description |
|---|---|---|
includeAdvancedMedia | ScanInputParam CorpScanInputParam | New input parameter to include advanced media search of news articles for the entity during screening. |
advancedMediaResults | ScanResult CorpScanResult | New parameter that returns the advanced media results. |
advancedMediaSearch | OrgDetails.memberScanSettings OrgDetails.corporateScanSettings | New parameter that returns the advanced media search default setting (Yes/No) for the scan. |
advancedMediaSearch | ScanHistoryDetail.scanResult CorpScanHistoryDetail.scanResult | New parameter that returns the advanced media results. |
webSearchadvancedMediaSearchfatfJurisdictionRisk | OrgDetails.memberScanSettings OrgDetails.corporateScanSettings | New parameters that return the default setting (Yes/No) for the scan for web search (Google), advanced media search and FATF jurisdiction risk search. |
includeAdvancedMedia | GET /api/v2/member-scans/singleGET /api/v2/member-scans/single/reportGET /api/v2/corp-scans/singleGET /api/v2/corp-scans/single/report | New parameter to filter results where advanced media search was included during screening. |
member-scans/advanced-media/bookmarkcorp-scans/advanced-media/bookmark | New method to add or remove bookmarks for advanced media articles within the MemberCheck UI. | |
clientId | IDVInputParam | New parameter that enables you to record an Account or Customer Reference Number for the ID Verification scan to help search and identify the screened individual. |
Release 10.3.4¶
Released: Apr 13, 2025
| Name | API Schema | Description |
|---|---|---|
id-verification/single2 | New method to initiate a new ID Verification request that returns a Verification URL to the verification process. | |
member-scans/single/{id}/rescancorp-scans/single/{id}/rescan | New methods to run a new scan using previously entered details of the entity and scan policies, with the exception of the watchlist, which will be determined by the organisation's current list access scope. Rescan requests count toward the organisation's scan activity and usage. | |
Release 10.3.3¶
Released: Feb 16, 2025
| Name | API Schema | Description |
|---|---|---|
idisCopyrighted | scanResult.matchedEntities.resultEntity.sourceDetails | New response parameter for source and adverse media to help identify and indicate if a source media is copyrighted. This id is used in the new methods to request for the asset URL of the copyrighted media.This is available for Acuris data source only. |
member-scans/single/results/{id}/sources/{sourceId}/asset-urlcorp-scans/single/results/{id}/sources/{sourceId}/asset-url | New methods. Where a source or adverse media is copyrighted and the cached PDF is not available, you can call this to get the asset file URL of a specific source of the matched member, company, linked individual or linked company to download as PDF. It is recommended to only use this request if the URL is broken or the cached PDF is not available. This is available for Acuris data source only. | |
lookup-values/document-types | New method to retrieve the complete list of document types for the Supporting Document feature. | |
member-scans/single/{id}/documentsmember-scans/single/{id}/documents/{documentId}/downloadmember-scans/single/{id}/documents/{documentId}/pinmember-scans/single/{id}/documents/{documentId}member-scans/single/{id}/documents/history | New methods for upload, list, download and delete supporting documents for Individual (member) scans. | |
corp-scans/single/{id}/documentscorp-scans/single/{id}/documents/{documentId}/downloadcorp-scans/single/{id}/documents/{documentId}/pincorp-scans/single/{id}/documents/{documentId}corp-scans/single/{id}/documents/history | New methods for upload, list, download and delete supporting documents for Corporate scans. | |
id-verification/single/{id}/documentsid-verification/single/{id}/documents/{documentId}/downloadid-verification/single/{id}/documents/{documentId}/pinid-verification/single/{id}/documents/{documentId}id-verification/single/{id}/documents/history | New methods for upload, list, download and delete supporting documents for ID verification. | |
kyb/single/{id}/documentskyb/single/{id}/documents/{documentId}/downloadkyb/single/{id}/documents/{documentId}/pinkyb/single/{id}/documents/{documentId}kyb/single/{id}/documents/history | New methods for upload, list, download and delete supporting documents for Know Your Business scans. | |
data-management/member-documentsdata-management/corp-documentsdata-management/single-scans/documentsdata-management/documents | New methods to search and remove supporting documents. | |
Release 10.3¶
Released: Dec 1, 2024
| Name | API Schema | Description |
|---|---|---|
GET organisations/new | Temporarily removed. | |
watchlists | ScanInputParam CorpScanInputParam BatchScanInputParam CorpBatchScanInputParam | New input parameter used for setting the watchlist scope for screening. If this is NULL or undefined, the organisation's list access settings will be used by default. |
isWatchlistActive | OrgDetails | Indicates if the watchlist selection option is enabled for user selection during screening. |
country | ScanInputParam CorpScanInputParam | New input parameter to match for country of residence for individual or operation for corporates. Separate from Address and supports up to 5 countries. Format should be based on ISO 3166-1 alpha-2. |
nationality | ScanInputParam | New input parameter to match for nationality or citizenship. Supports up to 5 nationalities. Format should be based on ISO 3166-1 alpha-2. |
country | MonitoringListMemberItem MonitoringListCorpItem | Returns the country scanned for the entity. |
nationality | MonitoringListMemberItem | Returns the nationality scanned for the individual person. |
IsIgnoreBlankNationalityActive | OrgDetails.memberScanSettings | Returns the status of the ignore blank nationality match setting. When turned on, nationality is enforced during screening. |
member-scans/batch/{id}/monitor/enablemember-scans/batch/{id}/monitor/disablecorp-scans/batch/{id}/monitor/enablecorp-scans/batch/{id}/monitor/disable | Add (enable) or remove (disable) Member or Corporate batch scans from monitoring. | |
lastMonitored | MonitoringListMemberItem MonitoringListCorpItem | New parameter of the last monitored date of the entity. |
lastMonitoredFromlastMonitoredTo | MonitoringListMemberItem MonitoringListCorpItem monitoring-lists/member/report monitoring-lists/corp/report | New input parameter to search for last monitored date. |
Release 10.2¶
Released: Oct 27, 2024
| Name | API Schema | Description |
|---|---|---|
member-scans/single/{id}/monitor/reviewcorp-scans/single/{id}/monitor/review | If Monitoring Review has been enabled for the organisation by the Compliance Officer via the Organisation Administration UI, you can set review status to track assessment of profile updates from ongoing monitoring. Check for the organisation's monitoring review status via monitoringSettings.monitoringReviewEnabled in GET organisations/{id}. | |
reviewStatus | MonitoringScanHistoryLog CorpMonitoringScanHistoryLog | New optional input parameter to filter for monitoring review status. |
reviewStatusmembersReviewedcompaniesReviewed | MonitoringScanHistoryLog CorpMonitoringScanHistoryLog | Returns the overall monitoring review status of the monitoring event with the number of entities completed review for In Progress assessments. |
monitoringReviewStatusmonitoringReviewSummary | ScanHistoryDetail.scanResult CorpScanHistoryDetail.scanResult | Returns the completed review status of the monitored entity with detected changes. Summary contains the date time and username to indicate the user who has marked the assessment as completed for auditing references. |
category | CorpScanHistoryLog | New value SOE added to category for State Owned Enterprise entities. |
scanType | New value AllWithMonitoring added to scan type in GET data-management/scans/count and DELETE data-management/scans. | |
subCategory | New values added for former PEP and former sanctions in GET member-scans/single and GET corp-scans/single | |
lookup-values/sso-url/{token} | SsoSettings | New method to return the Single Sign-On (SSO) login and logout URLs |
identityclientId | UserDetails.userSsoSettings | The unique identity (e.g. email address) of the user and the unique key of the Identity Provider. |
Release 10.1¶
Released: Jun 30, 2024
| Name | API Schema | Description |
|---|---|---|
whitelistPolicy | orgDetails.monitoringSettings.memberScanSettings orgDetails.monitoringSettings.corporateScanSettings | Returns the monitoring whitelist policy setting if due diligence decisions are applied or ignored for continuous monitoring and monitoring rescans. |
Release 9.6¶
Released: May 19, 2024
| Name | API Schema | Description |
|---|---|---|
dobTolerance | ScanInputParam BatchScanInputParam | New parameter to specify the number of years allowed for variations in the birthdate. Note: The organisation administration settings must have the policy enabled. |
Release 9.5¶
Released: Mar 17, 2024
| Name | API Schema | Description |
|---|---|---|
categorysubcategoryriskoverallRisk | RiskResult | New method to retrieve organisation-wide defined risk levels, and overall risk score, for the specific scan result. The risk levels are set by the Compliance Officer within the application Administration screens. |
Release 9.4.2¶
Released: Feb 18, 2024
| Name | API Schema | Description |
|---|---|---|
companyProfileAvailableproductAvailable | KYBCountryResult | New parameters to indicate if the enhanced company details (including UBO) and registry documents are available for the country jurisdiction. |
companyProfileAvailableproductAvailable | KYBStateResult | New parameters to indicate if the enhanced company details (including UBO) and registry documents are available for the country-state jurisdiction. |
nationalitiesCodes | ScanResult.matchedEntities | 2-letter country code of nationality based on ISO 3166-2 standard. |
taxHavenCountryResult | ScanResult.matchedEntities CorpScanResult.matchedEntities | Indicator of tax haven jurisdiction. |
sanctionedCountryResult | ScanResult.matchedEntities CorpScanResult.matchedEntities | Indicator of sanctioned jurisdiction. |
isPrimaryLocationcountryCodecommenturl | ScanResult.matchedEntities. taxHavenCountryResults CorpScanResult.matchedEntities. ScanResult.matchedEntities. CorpScanResult.matchedEntities. ScanResult.matchedEntities. CorpScanResult.matchedEntities. | Additional information of the tax haven jurisdiction and if it applies to the primary location of the entity. |
isPrimaryLocationcountryCodecommenturlisBlackListisGreyList | ScanResult.matchedEntities. sanctionedCountryResults CorpScanResult.matchedEntities. ScanResult.matchedEntities. CorpScanResult.matchedEntities. ScanResult.matchedEntities. CorpScanResult.matchedEntities. | Additional information of the sanctioned jurisdiction and if it applies to the primary location of the entity. |
scanService | ScanHistoryDetail.scanParam CorpScanHistoryDetail.scanParam | New parameter returns the type of scan service. |
Release 9.4¶
Released: Dec 10, 2023
| Name | API Schema | Description |
|---|---|---|
commenturl | ScanResult.matchedEntities. taxHavenCountryResult CorpScanResult.matchedEntities. | New parameters to indicate if the individual's primary country of residence or a company's primary address is considered a tax haven country. |
commenturlisBlackListisGreyList | ScanResult.matchedEntities. sanctionedCountryResult CorpScanResult.matchedEntities. | New parameters to indicate if the individual's primary country of residence or a company's primary address is considered a sanctioned country, and the associated FATF lists. Countries in the "black list" are considered high risk jurisdictions and "grey lists" are countries under increased monitoring. |
isAIAnalysisActive | OrgInfo OrgDetails | Indicates if the AI Analysis service is enabled for organisation. |
isKybActive | OrgInfo OrgDetails.corporateScanSettings | Indicates if the Business check service (KYB) is enabled for organisation. |
aiAnalysisQuestionCount | ScanResult.matchedEntities CorpScanResult.matchedEntities | Returns the number of remaining questions or credits for AI queries on a profile. |
member-scans/single/results/{id}/questionsmember-scans/single/results/{id}/questions/{questionId} | New methods available in Individual scans to perform AI Analysis of profiles. | |
corp-scans/single/results/{id}/questionscorp-scans/single/results/{id}/questions/{questionId} | New methods available in Corporate scans to perform AI Analysis of profiles. | |
kyb/countrieskyb/countries/{countryCode}/stateskyb/companykyb/{scanId}/company/profilekyb/{scanId}/productskyb/{scanId}/products/orderkyb/{scanId}/products/statuskyb/{scanId}/products/{productId}/filekyb/{scanId}kyb/{scanId}/company/{companyId}/reportkyb/{scanId}/products/filekyb/{scanId}/company/{companyId}/products/filekyb/{scanId}/products/sample/{productTitle}/filekyb/{scanId}/company/{companyId}/profile/reportkyb/{scanId}/company/profile/chargekyb/{scanId}/products/report | New methods available in business-ubo-checks to support business verifications for Know Your Business (KYB) and Ultimate Beneficial Owner (UBO). | |
reports/business-ubo-activity | New method to download report of KYB and UBO activities. | |
scanType | data-management/scans data-management/corp-scans data-management/scans/count | Support for KYB scan type. |
countryCoderegistrationNumberSearchallowDuplicateKYBScan | CorpScanInputParam.kybParam | New parameters for Business check service (KYB). |
KYBCountry | CorpScanInputParamHistory | Country or country-state code for KYB scan |
KYBScanResult | CorpScanResult | Results returned for KYB scan |
KYBProductsCountKYBCompanyProfileCountIsPaSIsKYBScanService | CorpScanHistoryLog | Returns KYB related information for KYB scans. |
Release 9.3.4¶
Released: August 6, 2023
| Name | API Schema | Description |
|---|---|---|
data-management/member-scans | New method to return a list of Individual scan results and the associated scanId. This provides a subset of functionality to member-scans/single but is specifically catered for API user accounts with data management permissions. | |
data-management/corp-scans | New method to return a list of Corporate scan results and the associated scanId. This provides a subset of functionality to corp-scans/single but is specifically catered for API user accounts with data management permissions. | |
data-management/single-scans | New method to delete at a granular level, single scan results for Individual and Corporate entities. This includes PEP, Sanctions & Adverse Media and ID Verification results. |
Release 9.3.3¶
Released: June 25, 2023
| Name | API Schema | Description |
|---|---|---|
idNumber | ScanInputParam | Optionally include an ID Number (e.g. Passport Number, National ID, VAT/Tax Number, Professional Registration ID) for screening of the individual to exclude matches that does not contain the entered ID Number. |
includeJurisdictionRisk | ScanInputParam BatchScanInputParam CorpScanInputParam CorpBatchScanInputParam | Option to search for FATF jurisdiction risk rating and information for countries associated with matched profiles. |
fatfJurisdictionRiskResult. | ScanResult CorpScanResult | Country name of FATF jurisdiction. |
fatfJurisdictionRiskResult. | ScanResult CorpScanResult | Effectiveness score to which the country's measures are effective based on the ratings against the 11 immediate outcomes from FATF. |
fatfJurisdictionRiskResult. | ScanResult CorpScanResult | Level of effectiveness of the country's measures. |
fatfJurisdictionRiskResult. | ScanResult CorpScanResult | Compliance score to which the country's implementation of technical requirements of the 40 FATF Recommendations. |
fatfJurisdictionRiskResult. | ScanResult CorpScanResult | Level of compliance of the country's technical implementation. |
fatfJurisdictionRiskResult. | ScanResult CorpScanResult | Summary of compliance with FATF recommendations. |
fatfJurisdictionRiskResult. | ScanResult CorpScanResult | Status of compliance. |
fatfJurisdictionRiskResult. | ScanResult CorpScanResult | Notes on compliance shortcomings. |
fatfJurisdictionRiskResult. | ScanResult CorpScanResult | Level of effectiveness of the country's measures. |
fatfJurisdictionRiskResult. | ScanResult CorpScanResult | Notes on effectiveness shortcomings. |
fatfJurisdictionRiskResult. | ScanResult CorpScanResult | Overall level of effectiveness of the country's measures. |
fatfJurisdictionRiskResult. | ScanResult CorpScanResult | Two-letter country code. |
Release 9.3.1¶
Released: May 7, 2023
| Name | API Schema | Description |
|---|---|---|
closeMatchRateThreshold | CorpScanInputParam CorpBatchScanInputParam | Specify the close match rate threshold for entity screening (from 100% for very close to 1% for somewhat similar).This is optional and defaults to 80% if not specified. |
closeMatchRateThreshold | CorpScanInputParamHistory CorpBatchScanResults CorpMonitoringScanResults | Returns Close Match Rate threshold applied during screening. |
matchRate | CorpScanEntity | Returns percentage rate of the matching name of the entity profile. |
Release 9.3¶
Released: February 26, 2023
| Name | API Schema | Description |
|---|---|---|
title | Entity | Removed parameter. |
NameDetail.title | Entity | Removed parameter. |
disqualifiedDirectors | Entity | New parameter for a list of disqualifications for the profile. |
nationalities | Entity | New parameter with the nationalities of the profile. |
placeOfBirth | Entity | New parameter for the birthplace for the profile. |
generalInfo | Entity | Parameter changed to only return the nationality for an individual. |
generalInfo | EntityCorp | Parameter changed to return additional information for the company, where available. |
enterDate | Entity EntityCorp | Removed parameter. |
xmlFurtherInformation | Entity EntityCorp | Removed parameter. |
identifiers | Entity EntityCorp | New parameter for a list of registration or ID numbers for the profile. |
images | Entity EntityCorp | New parameter with a list of pictures available for the profile. |
lastReviewed | Entity EntityCorp | New parameter of date the profile record was last reviewed or updated. |
profileOfInterest | Entity EntityCorp | New parameter with detailed profile of interests for the profile. |
category | Entity EntityCorp | Parameter includes the new "POI" category of the profile. |
categories | Entity EntityCorp | Parameter includes the new "POI" category of the profile. |
countryCode | Location | New parameter for the country code of the location. |
type | Location | New parameter for the location type. |
category | OfficialList | New parameter for the watchlist category of the official list. |
measures | OfficialList | New parameter with a list of measures enforced by the official list. |
origin | OfficialList | New parameter of the country or region of the official list. |
types | OfficialList | New parameter of the type of sanction classified by the official list. |
segment | Role | New parameter of the category of in scope positions for the PEP for a particular country. |
status | Role | New parameter of the status of the associated role held by the PEP. |
details | Source | New parameter with a list of details for the captured source and adverse media. |
categories | Source | Changes in the returned values for the category of the source and adverse media. |
nameType | NameDetail CorpNameDetail | Change in returned values. Expanded to include more details. |
description1 | Description | Parameter includes the new "POI" reference for the profile. |
description2 | Description | Parameter includes the new "Reputational Risk" reference for the profile. |
category | AssociatePerson AssociateCorp | Parameter includes the new "POI" reference for the profile. |
Release 9.2.1¶
Released: February 12, 2023
| Name | API Schema | Description |
|---|---|---|
emailAddress | IDVInputParam | New parameter to enable the ID Verification request link to be sent to the individual's email address. |
birthDate | IDVInputParam | New parameter for the individuals birthdate for ID Verification, if available. Date format: DD/MM/YYYY. |
idvSubType | IDVInputParam | New parameter to specify the delivery method and ID Verification type e.g. email/SMS the ID Check, FaceMatch or both. |
dataBreachCheckParam.emailAddress | ScanInputParam | New parameter to include the individual's email address to run a compromised information check against a list of known data breaches. |
dataBreachCheckResults | ScanResult | New parameter in response body containing a list of email breaches found, if an email address was provided in dataBreachCheckParam.emailAddress. |
Release 9.2¶
Released: December 10, 2022
| Name | API Schema | Description |
|---|---|---|
isPepJurisdictionExclude | ScanInputParamHistory BatchScanResults MonitoringScanResults | New parameter to either include or exclude one or more countries for the PEP Jurisdiction policy. |
pepJurisdictionCountries | ScanInputParamHistory BatchScanResults MonitoringScanResults | New parameter to specify one or more countries for inclusion or exclusion for PEP Jurisdiction. |
pepJurisdictionExclude | ScanInputParamHistory BatchScanResults MonitoringScanResults | Decommission parameter. |
Release 9.1.2¶
Released: October 1, 2022
| Name | API Schema | Description |
|---|---|---|
dates | Source | Decommission parameter. Replaced by dates_Urls |
dates_Urls | Source | New parameter replacing dates to include link to cached PDF of URL, if available. |