chore: update v3 OpenAPI specs to v3.845.0 - #38
Conversation
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
| content: | ||
| multipart/form-data: | ||
| schema: | ||
| $ref: '#/components/schemas/AmlMonitoringRequest' |
There was a problem hiding this comment.
Suggestion: The requestBody description states that countries and aliases must be sent as a single JSON-encoded string, but the schema declares them as plain arrays, so generated clients will emit repeated form fields and the request will fail validation. Declare an encoding block marking these parts as application/json so tooling/codegen serializes them correctly. [possible issue, importance: 6]
| content: | |
| multipart/form-data: | |
| schema: | |
| $ref: '#/components/schemas/AmlMonitoringRequest' | |
| content: | |
| multipart/form-data: | |
| schema: | |
| $ref: '#/components/schemas/AmlMonitoringRequest' | |
| encoding: | |
| countries: | |
| contentType: application/json | |
| aliases: | |
| contentType: application/json |
| AmlMonitoringRequest: | ||
| type: object | ||
| required: | ||
| - countries | ||
| - user_details | ||
| - consent | ||
| properties: |
There was a problem hiding this comment.
Suggestion: The documented rule "full_name is required unless search_existing_user is true" is not expressed in the schema, so invalid payloads (neither field present) validate successfully and only fail server-side with a 400. Encode the constraint with anyOf, mirroring the pattern already used by BiometricAuthenticationRequest. [general, importance: 5]
| AmlMonitoringRequest: | |
| type: object | |
| required: | |
| - countries | |
| - user_details | |
| - consent | |
| properties: | |
| AmlMonitoringRequest: | |
| type: object | |
| required: | |
| - countries | |
| - user_details | |
| - consent | |
| anyOf: | |
| - required: | |
| - full_name | |
| - required: | |
| - search_existing_user | |
| properties: | |
| search_existing_user: | |
| type: boolean | |
| enum: | |
| - true | |
| properties: |
| countries: | ||
| type: array | ||
| minItems: 1 | ||
| description: >- | ||
| ISO 3166-1 alpha-2 country codes (uppercase) to screen against. Send | ||
| as a JSON-encoded string in the multipart body, e.g. '["NG","GH"]'. | ||
| items: | ||
| type: string | ||
| minLength: 2 | ||
| maxLength: 2 | ||
| example: NG |
There was a problem hiding this comment.
Suggestion: countries items only constrain length, so lowercase or non-alphabetic values like ng or 12 validate but will be rejected by the API. Add the uppercase alpha-2 pattern (consistent with the existing country query parameter) so client-side validation matches server behaviour. [general, importance: 5]
| countries: | |
| type: array | |
| minItems: 1 | |
| description: >- | |
| ISO 3166-1 alpha-2 country codes (uppercase) to screen against. Send | |
| as a JSON-encoded string in the multipart body, e.g. '["NG","GH"]'. | |
| items: | |
| type: string | |
| minLength: 2 | |
| maxLength: 2 | |
| example: NG | |
| countries: | |
| type: array | |
| minItems: 1 | |
| description: >- | |
| ISO 3166-1 alpha-2 country codes (uppercase) to screen against. Send | |
| as a JSON-encoded string in the multipart body, e.g. '["NG","GH"]'. | |
| items: | |
| type: string | |
| minLength: 2 | |
| maxLength: 2 | |
| pattern: '^[A-Z]{2}$' | |
| example: NG |
User description
Automated v3 OpenAPI spec update for v3.845.0.
Triggered by Solomon Nsubuga (@solnsubuga) - assigned to you in case it needs a manual merge.
PR Type
Enhancement, Documentation
Description
Add new
POST /v3/aml/monitoringspec and endpointReplace AML
adverse_mediawithnews_summaryRename reason
adverse_media_matchtonews_media_matchUpdate docs, README table, and CHANGELOG for v3.845.0
Diagram Walkthrough
File Walkthrough
v3-aml-monitoring-entry.yaml
New AML Monitoring endpoint specificationspecs/v3/v3-aml-monitoring-entry.yaml
POST /v3/aml/monitoring(async AML monitoringenrollment).
AmlMonitoringRequest(countries, full_name, birth_year,aliases, strict_match, search_existing_user, user_details, consent,
callback_url).
auth/HMAC headers.
Consent,AcceptedResponse,ApiErrorResponseschemas.openapi.yaml
Aggregate spec: add AML Monitoring, rework news mediaspecs/v3/openapi.yaml
AML Monitoringtag and/v3/aml/monitoringPOST operation withfull response set.
AmlMonitoringRequestschema and reordersBiometricAuthenticationRequestdefinition.adverse_mediaarray with structurednews_summary(category, label, article count).
adverse_media_matchtonews_media_match.v3-one-time-aml-entry.yaml
One-Time AML: news_summary replaces adverse_mediaspecs/v3/v3-one-time-aml-entry.yaml
adverse_mediafield withnews_summaryobject array in personschema.
structure.
news_media_match.index.html
Register AML Monitoring spec in docs viewerdocs/index.html
v3-aml-monitoring-entryentry to the docs spec selector list.README.md
Document AML Monitoring spec in README tableREADME.md
description.
CHANGELOG.md
Add v3.845.0 changelog entryCHANGELOG.md
v3.845.0release entry dated 2026-08-21.openapi,v3-aml-monitoring-entry, andv3-one-time-aml-entry.