API Change Log¶

Deprecated¶

Fields deprecated or scheduled for deprecation, and will be decommissioned (removed). The columns below show the status of each field per API version: fields decommissioned in API v3 on the date shown are still retained in API v2 until v2's future sunset (date to be advised).

Name	API Schema	Deprecation Date	Decommission Date (API v3)	Decommission Date (API v2)
`enterDate`	Entity EntityCorp	26 Feb 2023	26 Jul 2026	TBA
`title`	Entity	26 Feb 2023	26 Jul 2026	TBA
`NameDetail.title`	Entity	26 Feb 2023	26 Jul 2026	TBA
`xmlFurtherInformation`	Entity EntityCorp	26 Feb 2023	26 Jul 2026	TBA
`image`	Entity	30 Jun 2024	26 Jul 2026	TBA
`originalScriptNames`	Entity EntityCorp	30 Jun 2024	~~26 Jul 2026~~	TBA
`dates_Urls`	Source	30 Jun 2024	~~26 Jul 2026~~	TBA
`membersChecked`	MonitoringScanHistoryLog MonitoringScanResults	30 Jun 2024	26 Jul 2026	TBA
`companiesChecked`	CorpMonitoringScanHistoryLog CorpMonitoringScanResults	30 Jun 2024	26 Jul 2026	TBA
`isIgnoreBlankDobActive`	memberScanSettings	16 Nov 2025	26 Jul 2026	TBA
`isIgnoreBlankNationalityActive`	memberScanSettings	16 Nov 2025	26 Jul 2026	TBA
`ignoreBlankPolicy`	MemberScan CorpScan	6 Sep 2026	TBA	TBA

Reintroduction of deprecated fields

originalScriptNames and dates_Urls have been reintroduced into API v3 on August 29, 2026.

Release 10.6.0¶

Released: Oct 4, 2026

Name API Schema Description

GET /api/v3/aml-risk/member-scans/questionnaire
POST /api/v3/aml-risk/member-scans/questionnaire
GET /api/v3/aml-risk/member-scans/{scanId}/questionnaire
POST /api/v3/aml-risk/member-scans/{scanId}/questionnaire
GET /api/v3/aml-risk/corp-scans/questionnaire
POST /api/v3/aml-risk/corp-scans/questionnaire
GET /api/v3/aml-risk/corp-scans/{scanId}/questionnaire
POST /api/v3/aml-risk/corp-scans/{scanId}/questionnaire
POST /api/v3/organisations/{id}/risk-assessment/publish
POST /api/v3/organisations/{id}/risk-assessment/discard
POST /api/v3/organisations/{id}/risk-assessment/share
POST /api/v3/organisations/{id}/risk-assessment/stop-sharing
POST /api/v3/organisations/{id}/risk-assessment/adopt

New methods, API v3 only, for the AML Risk Assessment questionnaire of the organisation.

An assessment against a published custom questionnaire is available only through the new questionnaire methods. The existing Risk Assessment methods, in API v2 and v3, use the standard questionnaire only.

The new methods also support the standard questions. Where an organisation has no published custom questionnaire, they use the standard questionnaire.

Risk Assessment checks, for member scans and corporate scans:

GET .../questionnaire returns the included questions of the published questionnaire as RiskQuestionnaireDetail, with the category, the controlType, the answer options, isRequired and isCustom.
POST .../questionnaire performs a new assessment. The request (RiskQuestionnaireScanParam or CorpRiskQuestionnaireScanParam) carries a questions list of questionId and answerId pairs (RiskQuestionAnswerParam).
POST .../{scanId}/questionnaire updates the assessment of a scan against the questionnaire version it was made with, or adds an assessment to a scan that has none. The request is a RiskQuestionnaireUpdateParam. This method updates assessments made with the questionnaire methods only. An assessment made with the existing methods is updated with POST .../{scanId}.
GET .../{scanId}/questionnaire returns the questions for that update: the questionnaire version of the assessment, or the published questionnaire for a scan with no assessment. For an assessment made with the existing methods, it returns the standard questions.

Organisation questionnaire, each with a checkType of Individual or Corporate:

publish makes the draft the live version. New assessments made with the questionnaire methods use it. Existing assessments keep their version.
discard deletes the draft. The published questionnaire is unchanged.
share offers the published questionnaire as a template to all organisations below, at any level. A later publish updates the template. stop-sharing withdraws the template. Copies that organisations adopted are not changed by either method.
adopt copies a template that an organisation above shares, identified by sourceOrganisationId, into the draft. It adds the custom questions of the template, replacing a custom question with the same id, applies its settings for the standard questions, and keeps the other questions of the draft.

riskAssessmentQuestionnaires
questions

GET /api/v3/organisations/{id}
OrgDetails
OrgRiskQuestionnaire
GET /api/v3/aml-risk/member-scans/{scanId}
GET /api/v3/aml-risk/corp-scans/{scanId}
RiskAssessmentParamHistory
CorpRiskAssessmentParamHistory

New response fields in existing methods, API v3 only.

riskAssessmentQuestionnaires in OrgDetails is returned when Risk Assessment is enabled for the organisation. It holds an OrgRiskQuestionnaire for the Individual questionnaire, and one for the Corporate questionnaire when the user has access to Corporate scans. Each carries checkType, liveVersion and liveVersionDate, hasUnpublishedChanges, isSharedWithSubOrgs and sharedVersion, the questions (excluded questions included), and the availableTemplates that organisations above share.

questions in the assessment history (riskAssessmentParam for member scans, corpRiskAssessmentParam for corporate scans) holds the submitted answers of an assessment made with the questionnaire methods. For such an assessment, the v3 history returns questions in place of the fixed answer fields, such as professionId for member scans and legalStatusId for corporate scans. The v2 history keeps the fixed answer fields.

otherLegalStatus

POST /api/v{version}/aml-risk/member-scans/{scanId}
POST /api/v{version}/aml-risk/corp-scans/{scanId}
POST /api/v{version}/aml-risk/corp-scans

Changed behaviour in existing methods, API v2 and v3.

POST .../member-scans/{scanId} and POST .../corp-scans/{scanId} update assessments made with the existing methods only. An assessment made with the questionnaire methods is updated with POST .../{scanId}/questionnaire (API v3). From this release, assessments made in the web application use the questionnaire methods.
POST .../corp-scans and POST .../corp-scans/{scanId}: a request that sets legalStatusId to the "Other" legal status without otherLegalStatus now returns a 400 validation error that names the missing field.

Apart from these changes, the existing Risk Assessment methods work as before, with the standard questionnaire. To use a published custom questionnaire, an integration moves to the new API v3 methods.

Release 10.5.3¶

Released: Sep 13, 2026

Name	API Schema	Description
`matchScopePolicy`	`POST /api/v3/member-scans/single` `POST /api/v3/corp-scans/single` `POST /api/v3/member-scans/batch` `POST /api/v3/corp-scans/batch`	New request parameter that sets how widely each screening field narrows the results. It replaces `ignoreBlankPolicy`. The parameter is an object. Its keys are `dob`, `gender`, `nationality` and `idNumber` for member scans, and `registrationNumber` for corporate scans. Accepted values, from the narrowest to the widest, are `MatchesOnly`, `MatchesAndBlanks` and `Mismatches`. Send only the fields you want to set. A field whose organisation setting is not `User Defined` keeps that setting. A blank value for a screening field narrows nothing. No screening field is mandatory.
`matchScopePolicy`	Every member and corporate scan response, including `GET /api/v3/member-scans/single/{id}`, `GET /api/v3/member-scans/batch`, `GET /api/v3/member-scans/batch/{id}`, `GET /api/v3/member-scans/monitoring`, `GET /api/v3/member-scans/monitoring/{id}`, `POST /api/v3/member-scans/single/{id}/rescan`, the corporate equivalents, `GET /api/v3/kyb/{scanId}` and the `data-management` lists	New response parameter that reports the matching scope the scan ran under, so a result can be reproduced. A scan that carried no `matchScopePolicy` on the request reports the effective organisation setting.
`matchScopePolicy`	`GET /api/v3/organisations/{id}` `GET /api/v3/organisations/{id}/scan-settings`	New parameter in the `memberScanSettings`, `corporateScanSettings` and both `monitoringSettings` blocks. It returns the matching scope held against the organisation for each screening field. The scan settings accept `MatchesOnly`, `MatchesAndBlanks`, `Mismatches` and `UserDefined`, which hands the choice to the user at screening time. The monitoring settings carry no `UserDefined`, because no user is present to make the choice on a monitoring run.
`ignoreBlankPolicy`	Every scan method and organisation setting listed above	Deprecated, and retained without change. Existing integrations continue to work and need no change. The parameter behaves as before: it eliminates profiles that hold no value for the field, and its result set is the same as `MatchesOnly` for that field. Where a request sends both parameters, `matchScopePolicy` takes precedence for the field it carries. Organisation settings were migrated on upgrade, so results and monitoring volume do not change: `Yes` became `MatchesOnly`, `No` became `MatchesAndBlanks`, and `UserDefined` is unchanged.
`isIgnoreBlankDobActive` `isIgnoreBlankNationalityActive`	`GET /api/v2/organisations/{id}` `GET /api/v2/organisations/{id}/scan-settings`	Both remain deprecated, as they have been since release 10.4.5, and are not returned by API v3. The deprecation note now names `matchScopePolicy` as the replacement in place of `ignoreBlankPolicy`.
`POST /api/v3/id-verification/single/{scanId}/override`		New method. It records or removes an override of the ID Verification outcome. Set `value` to `Verified` or `NotVerified` to record an override, or omit it to remove the current override. `comment` is required on every request and accepts up to 200 characters. The provider result itself is never changed. The response is an `IdvOverrideResult`, carrying `idvStatus`, the effective outcome after the action; `overridden`, whether that outcome is a user override; `originalIdvStatus`, the provider result before the override; `idvFaceMatchStatus`, the effective FaceMatch outcome; and `originalIdvFaceMatchStatus`, the provider FaceMatch result before the override. An `original` parameter is returned only where the action affects that check. The override applies to the checks the verification covers. An ID Check verification overrides the ID Check outcome, a FaceMatch verification overrides the FaceMatch outcome, and a combined verification overrides both. `value` must change the outcome on at least one of those checks. `Pass` and `Verified` carry the same outcome, as do `Fail` and `NotVerified`, so a request that repeats the current outcome is rejected. To restore the original outcome, omit `value`.
`GET /api/v3/id-verification/single/{scanId}/override/history`		New method. It returns every action recorded against the verification, most recent first. Each entry carries `username`, `date`, `newValue`, the value the user chose, and `comment`. The outcome on each side of the action is reported per check: `previousIDCValue` and `afterIDCValue` for ID Check, and `previousFaceMatchValue` and `afterFaceMatchValue` for FaceMatch. `newValue` is absent where the action removed the override.
`overridden` `originalIdvStatus` `originalIdvFaceMatchStatus`	`GET /api/v3/id-verification/single/{scanId}` `GET /api/v3/member-scans/single` `GET /api/v3/data-management/member-scans`	New response parameters. `overridden` reports whether the outcome returned is a user override, and the `original` parameters carry the provider result from before the override. Where a single verification outcome is returned, API v3 returns the override in place of the provider result. API v2 is unchanged and continues to return the provider result, so no action is required to keep an existing v2 integration working. A client reading over API v2 records the provider value while the application shows the override. To read the override, move the integration to API v3.
`idvOverride`	`GET /api/v3/member-scans/single` `GET /api/v3/member-scans/single/report`	New filter that selects scans by whether the ID Verification outcome was overridden. The values are `All`, `NotOverridden` and `Overridden`, and `All` is the default. It applies to the `IDVerification` scan service, and is accepted on every report format.
`POST /api/v3/organisations/{id}/custom-list`		Removed from the API reference. It joins the restricted organisation management methods, which are published on a TEST instance only. The method itself is unchanged and continues to work, and `GET /api/v3/organisations/{id}/custom-list/{fileId}` is unaffected.

Release 10.5.0¶

Released: Jul 26, 2026

Name	API Schema	Description
`/api/v3/`		Introduction of API v3. A new major API version is now served under the base path `/api/v3/`. Authentication, the request payloads of the core screening endpoints, and error-response wording are unchanged from v2. API v2 continues to be served under `/api/v2/`. The changes listed below apply to v3 unless a schema name (e.g. `ScanResult`) is shown, in which case the change is available in both versions.
`idvDataSource` `verificationProcess` `idvAssuranceLevel` `subscriberCode` `consent` `parentOrigin`	`POST /api/v3/id-verification/single` `POST /api/v3/member-scans/single`	New input parameters for the modernised ID Verification service. Select the verification data source and process, set the required identity assurance level, supply a subscriber code, and record the individual's consent for the verification. These support Australian government document verification, international document verification, and biometric facial verification. Accepted values: `idvDataSource` = `AuGovtVerification` / `AuGovtRecords` / `Commercial`; `verificationProcess` = `StepByStep` / `Comprehensive`; `idvAssuranceLevel` = `SingleSource` / `CrossSource`. The optional `parentOrigin` records the origin of the parent window that initiated the verification request.
`idvSettings.idvDataSource` `idvSettings.idVerificationProcess` `idvSettings.idvAssuranceLevel` `idvSettings.idvCountriesType` `idvSettings.idvCountries` `idvSettings.subscriberCodes` `isIDCheckActive`	`GET /api/v3/organisations/{id}` `GET /api/v3/organisations/{id}/scan-settings`	New organisation-level ID Verification configuration returned in the organisation responses in v3: default data source, verification process, assurance level, country-coverage type, the list of countries enabled for international document verification, subscriber codes, and the ID Check service-activation flag (`isIDCheckActive`). The country-coverage type (`idvCountriesType`) is one of `All` / `Exclude` / `Include`.
`GET /api/v3/id-verification/single/sms-enabled-countries`		New v3-only method. Retrieve the list of countries enabled for SMS delivery of a verification request.
`POST /api/v3/id-verification/single`		The two ID Verification "verify" methods have been consolidated. The former `id-verification/single2` is no longer part of v3; use `POST id-verification/single`. In v2 this method returned a raw integer scan identifier; in v3 it returns a JSON object (`IDVResponse` with `scanId` and `idvUrl`), so update your response handling accordingly.
`GET /api/v3/id-verification/single/{scanId}/file-url`		Narrowed in v3. The `type` and `isCompressed` query parameters have been removed and this method now returns only the liveness-video URL; front/back document-image and still-image URL retrieval is no longer exposed here.
`POST /api/v3/id-verification/single/{scanId}/resend`		The resend-verification-link method is temporarily unavailable in API v3 and is planned to be reintroduced in a future release. It continues to be available under `/api/v2/`.
`idvStatus` `idvFaceMatchStatus` `idvVerificationResult` `faceMatchVerificationResult`	`GET /api/v3/id-verification/single/{scanId}` `POST /api/v3/member-scans/single` `GET /api/v3/member-scans/single`	Enriched ID Verification results in v3. `idvStatus` adds `InvalidData`, `ReviewRequired` and `TechnicalError`, and `idvFaceMatchStatus` adds `NotVerified` and `Verified`. Structured result objects are returned for document verification (`idvVerificationResult` with `driverLicenceResult`, `passportResult`, `medicareResult`, `nationalIDResult`) and for biometric facial verification (`faceMatchVerificationResult`). These are additive; a permissive deserialiser that ignores unknown fields is recommended.
`idvCountry.code` `Country.code`	`POST /api/v3/id-verification/single` `POST /api/v3/member-scans/single`	The list of countries supported for ID Verification has been expanded from 21 to 31 in v3. Newly supported: `AE`, `GH`, `HK`, `JP`, `KE`, `NG`, `PL`, `SG`, `SL`, `TR`. Refer to the Swagger for the full list, and use the new `GET /api/v3/id-verification/single/sms-enabled-countries` method to check which destinations support SMS delivery of the verification request.
`firstName` `lastName`	`POST /api/v3/id-verification/single` `POST /api/v3/member-scans/single`	Maximum-length validation tightened in both API versions: `firstName` from 255 to 249 characters and `lastName` from 255 to 251 characters. A request exceeding these limits will fail validation.
`scriptNameFullName`	`POST /api/v3/id-verification/single` `POST /api/v3/member-scans/single`	Original-script name handling broadened in v3. In v2, `scriptNameFullName` (a full name in its original script) could only be supplied for China (`CN`); in v3 this country restriction is removed and it may be provided for any country.
`fatfJurisdictionRiskResults. fatfBlackGreyRisk` `fatfJurisdictionRiskResult. fatfBlackGreyRisk`	`ScanResult` `CorpScanResult`	New response parameter returning FATF Black List and Grey List jurisdiction-risk information based on the screened entity, whether or not a profile match is found. Available in both API versions.
`clientId`	`GET member-scans/single` `GET member-scans/single/report` `GET corp-scans/single` `GET corp-scans/single/report` `GET member-scans/monitoring/{id}` `GET corp-scans/monitoring/{id}` `GET monitoring-lists/member` `GET monitoring-lists/corp`	The `clientId` filter now supports partial (contains) matching, so scan results and monitoring lists can be filtered by a Client ID fragment to find and bulk-manage groups of entities. Available in both API versions.
`dataSources`	`POST member-scans/single` `POST corp-scans/single` `POST member-scans/batch` `POST corp-scans/batch` `GET member-scans/single` `GET corp-scans/single` `GET member-scans/single/report` `GET corp-scans/single/report` `GET member-scans/single/{id}` `GET corp-scans/single/{id}` `GET member-scans/batch/{id}` `GET corp-scans/batch/{id}` `GET member-scans/monitoring/{id}` `GET corp-scans/monitoring/{id}` `POST member-scans/single/{id}/rescan` `POST corp-scans/single/{id}/rescan` `GET kyb/{scanId}`	New parameter to select which watchlist data source(s) to screen against for a scan. Present as a request-body input on the single and batch scan requests, as a filter query parameter on the scan-history requests, and returned in the response of the scan, rescan, batch, monitoring and KYB requests. Accepted values are `Acuris`, `LexisNexis` and `MemberCheck`. Available in both API versions.
`dataSources` `isDataSourceEditable`	`GET organisations` `GET organisations/{id}` `GET organisations/{id}/scan-settings`	New response parameters returning the organisation's configured watchlist data source(s) and whether the data-source selection can be changed during screening (`isDataSourceEditable`). Available in both API versions.
`Country`	`GET member-scans/single/report`	The Country field is now included in the Individual Scan Results report (CSV) output, so high-risk countries can be identified for reporting and risk management (the Corporate Scan Results report already includes it). This is a change to the generated report content; the report endpoint returns a file, so there is no new response-schema field. Available in both API versions.

Release 10.4.7.3¶

Released: Apr 26, 2026

Name	API Schema	Description
`defaultScanResult`	`GET /api/v2/organisations/{id}` `GET /api/v2/organisations/{id}/scan-settings`	New parameters in response body of the organisation settings for both `memberScanSettings` and `corporateScanSettings`.
`isCustomList`	`GET /api/v2/organisations/{id}` `GET /api/v2/organisations/{id}/scan-settings`	New parameter in response body of the organisation risk level settings.
`reasonForDeactivation`	`POST /api/v2/organisations/{id}/deactivate`	New optional input parameter (up to `100 characters`) to enter a reason for account deactivation, used for account management purposes.

Release 10.4.7¶

Released: Feb 7, 2026

Name	API Schema	Description
`matchType` `closeMatchRateThreshold` `whitelist` `residence` `blankAddress` `pepJurisdiction` `excludeDeceasedPersons` `dobTolerance` `ignoreBlankPolicy`	`GET member-scans/batch`	New parameters in response body of the scan policies applied to the batch scan for Individuals.
`matchType` `closeMatchRateThreshold` `whitelist` `residence` `blankAddress` `pepJurisdiction` `excludeDeceasedPersons`	`GET member-scans/monitoring`	New parameters in response body of the scan policies applied to the monitoring scan for Individuals.
`matchType` `closeMatchRateThreshold` `whitelist` `addressPolicy` `blankAddress` `ignoreBlankPolicy`	`GET corp-scans/batch`	New parameters in response body of the scan policies applied to the batch scan for Corporate entities.
`matchType` `closeMatchRateThreshold` `whitelist` `addressPolicy` `blankAddress` `defaultCountry`	`GET corp-scans/monitoring`	New parameters in response body of the scan policies applied to the monitoring scan for Corporate entities.

Release 10.4.6¶

Released: Nov 30, 2025

Name	API Schema	Description
`X-Request-Language`	`GET member-scans/single/report` `GET member-scans/single/{id}/report` `GET member-scans/single/results/{id}/report` `GET member-scans/single/{id}/no-results-report` ... `GET corp-scans/single/{id}/report` `GET corp-scans/batch/report` `GET 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 `EN` (English) if not specified.

Release 10.4.5¶

Released: Nov 16, 2025

Name	API Schema	Description
`ignoreBlankPolicy`	`POST member-scans/single` `POST member-scans/batch` `POST corp-scans/single` `POST 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/batch` `GET 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-settings` `GET 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: `id` `apiKey` `mfaType` `accessRights.name` `assignedOrganisations.name` `role.name` `role.label` `status` `creationDate` `lastLoginDate` `lastActiveDate` `failedLoginDate` `dateTimeZone`
`users`	`PUT users`	Schema and documentation cleaned up to only contain essential and relevant fields. The following redundant fields have been removed: `id` `accessRights.name` `assignedOrganisations.name` `role.name` `role.label` `status` `creationDate` `lastLoginDate` `lastActiveDate` `failedLoginDate` `dateTimeZone`

Release 10.4.3¶

Released: Jul 27, 2025

Name	API Schema	Description
`sourceofFundsId`	`POST aml-risk/member-scans` `POST 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.
`webhookNotification` `enable` `url` `service` `channelName`	`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-levels` `member-scans/single/results/{id}/linked-companies/risk-levels` `corp-scans/single/results/{id}/linked-individuals/risk-levels` `corp-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/single` `POST member-scans/single/{id}/rescan` `GET member-scans/single/{id}` `POST corp-scans/single` `POST corp-scans/single/{id}/rescan` `GET 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/single` `GET corp-scans/single` `GET 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-scans` `aml-risk/member-scans/{scanId}` `aml-risk/member-scans/{scanId}/report` `aml-risk/corp-scans` `aml-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/single` `member-scans/single/{id}/rescan` `member-scans/batch` `member-scans/single/{id}` `corp-scans/single` `corp-scans/single/{id}/rescan` `corp-scans/batch` `corp-scans/single/{id}`		New parameter `includeRiskAssessment` for Risk Assessment Check.
`member-scans/single` `member-scans/single/report` `corp-scans/single` `corp-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/count` `data-management/scans`		New value for input parameter `scanType` to reflect the Risk Assessment Check.
`data-management/member-scans` `data-management/member-documents` `data-management/corp-scans` `data-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.
`webSearch` `advancedMediaSearch` `fatfJurisdictionRisk`	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/single` `GET /api/v2/member-scans/single/report` `GET /api/v2/corp-scans/single` `GET /api/v2/corp-scans/single/report`	New parameter to filter results where advanced media search was included during screening.
`member-scans/advanced-media/bookmark` `corp-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}/rescan` `corp-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
`id` `isCopyrighted`	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-url` `corp-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}/documents` `member-scans/single/{id}/documents/{documentId}/download` `member-scans/single/{id}/documents/{documentId}/pin` `member-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}/documents` `corp-scans/single/{id}/documents/{documentId}/download` `corp-scans/single/{id}/documents/{documentId}/pin` `corp-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}/documents` `id-verification/single/{id}/documents/{documentId}/download` `id-verification/single/{id}/documents/{documentId}/pin` `id-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}/documents` `kyb/single/{id}/documents/{documentId}/download` `kyb/single/{id}/documents/{documentId}/pin` `kyb/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-documents` `data-management/corp-documents` `data-management/single-scans/documents` `data-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/enable` `member-scans/batch/{id}/monitor/disable` `corp-scans/batch/{id}/monitor/enable` `corp-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.
`lastMonitoredFrom` `lastMonitoredTo`	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/review` `corp-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.
`reviewStatus` `membersReviewed` `companiesReviewed`	MonitoringScanHistoryLog CorpMonitoringScanHistoryLog	Returns the overall monitoring review status of the monitoring event with the number of entities completed review for In Progress assessments.
`monitoringReviewStatus` `monitoringReviewSummary`	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
`identity` `clientId`	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
`category` `subcategory` `risk` `overallRisk`	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
`companyProfileAvailable` `productAvailable`	KYBCountryResult	New parameters to indicate if the enhanced company details (including UBO) and registry documents are available for the country jurisdiction.
`companyProfileAvailable` `productAvailable`	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.
`isPrimaryLocation` `countryCode` `comment` `url`	ScanResult.matchedEntities. taxHavenCountryResults CorpScanResult.matchedEntities. taxHavenCountryResults ScanResult.matchedEntities. resultEntity.taxHavenCountryResults CorpScanResult.matchedEntities. resultEntity.taxHavenCountryResults ScanResult.matchedEntities. monitoredOldEntity.taxHavenCountryResults CorpScanResult.matchedEntities. monitoredOldEntity.taxHavenCountryResults	Additional information of the tax haven jurisdiction and if it applies to the primary location of the entity.
`isPrimaryLocation` `countryCode` `comment` `url` `isBlackList` `isGreyList`	ScanResult.matchedEntities. sanctionedCountryResults CorpScanResult.matchedEntities. sanctionedCountryResults ScanResult.matchedEntities. resultEntity.sanctionedCountryResults CorpScanResult.matchedEntities. resultEntity.sanctionedCountryResults ScanResult.matchedEntities. monitoredOldEntity.sanctionedCountryResults CorpScanResult.matchedEntities. monitoredOldEntity.sanctionedCountryResults	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
`comment` `url`	ScanResult.matchedEntities. taxHavenCountryResult CorpScanResult.matchedEntities. taxHavenCountryResult	New parameters to indicate if the individual's primary country of residence or a company's primary address is considered a tax haven country.
`comment` `url` `isBlackList` `isGreyList`	ScanResult.matchedEntities. sanctionedCountryResult CorpScanResult.matchedEntities. sanctionedCountryResult	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}/questions` `member-scans/single/results/{id}/questions/{questionId}`		New methods available in Individual scans to perform AI Analysis of profiles.
`corp-scans/single/results/{id}/questions` `corp-scans/single/results/{id}/questions/{questionId}`		New methods available in Corporate scans to perform AI Analysis of profiles.
`kyb/countries` `kyb/countries/{countryCode}/states` `kyb/company` `kyb/{scanId}/company/profile` `kyb/{scanId}/products` `kyb/{scanId}/products/order` `kyb/{scanId}/products/status` `kyb/{scanId}/products/{productId}/file` `kyb/{scanId}` `kyb/{scanId}/company/{companyId}/report` `kyb/{scanId}/products/file` `kyb/{scanId}/company/{companyId}/products/file` `kyb/{scanId}/products/sample/{productTitle}/file` `kyb/{scanId}/company/{companyId}/profile/report` `kyb/{scanId}/company/profile/charge` `kyb/{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.
`countryCode` `registrationNumberSearch` `allowDuplicateKYBScan`	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
`KYBProductsCount` `KYBCompanyProfileCount` `IsPaS` `IsKYB` `ScanService`	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. jurisdiction`	ScanResult CorpScanResult	Country name of FATF jurisdiction.
`fatfJurisdictionRiskResult. effectivenessScore`	ScanResult CorpScanResult	Effectiveness score to which the country's measures are effective based on the ratings against the 11 immediate outcomes from FATF.
`fatfJurisdictionRiskResult. effectivenessLevel`	ScanResult CorpScanResult	Level of effectiveness of the country's measures.
`fatfJurisdictionRiskResult. complianceScore`	ScanResult CorpScanResult	Compliance score to which the country's implementation of technical requirements of the 40 FATF Recommendations.
`fatfJurisdictionRiskResult. complianceLevel`	ScanResult CorpScanResult	Level of compliance of the country's technical implementation.
`fatfJurisdictionRiskResult. comments`	ScanResult CorpScanResult	Summary of compliance with FATF recommendations.
`fatfJurisdictionRiskResult. fatfCompliance`	ScanResult CorpScanResult	Status of compliance.
`fatfJurisdictionRiskResult. fatfComplianceNotes`	ScanResult CorpScanResult	Notes on compliance shortcomings.
`fatfJurisdictionRiskResult. fatfEffectiveness`	ScanResult CorpScanResult	Level of effectiveness of the country's measures.
`fatfJurisdictionRiskResult. fatfEffectivenessNotes`	ScanResult CorpScanResult	Notes on effectiveness shortcomings.
`fatfJurisdictionRiskResult. fatfEffectivenessSubtitles`	ScanResult CorpScanResult	Overall level of effectiveness of the country's measures.
`fatfJurisdictionRiskResult. countryCode`	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.