Skip to content

chore: update v3 OpenAPI specs to v3.635.0#11

Open
Ed Fricker (beastawakens) wants to merge 1 commit into
mainfrom
sync/v3.635.0
Open

chore: update v3 OpenAPI specs to v3.635.0#11
Ed Fricker (beastawakens) wants to merge 1 commit into
mainfrom
sync/v3.635.0

Conversation

@beastawakens
Copy link
Copy Markdown
Member

@beastawakens Ed Fricker (beastawakens) commented Jun 4, 2026

User description

Automated v3 OpenAPI spec update for v3.635.0.


PR Type

Enhancement


Description

  • Replace v3-block-user API with new v3-report-user-fraud endpoint

  • Add missingCallbackUrl error example to multiple verification specs

  • New fraud reporting supports structured reasons and email-based attribution


Diagram Walkthrough

flowchart LR
  A["v3-block-user (removed)"] -- "replaced by" --> B["v3-report-user-fraud (new)"]
  C["Verification specs"] -- "added error example" --> D["missingCallbackUrl 400 response"]
Loading

File Walkthrough

Relevant files
Documentation
3 files
CHANGELOG.md
Add v3.635.0 changelog with updated and removed specs       
+15/-0   
README.md
Replace Block User with Report User Fraud in API table     
+1/-1     
index.html
Update spec list: remove block-user, add report-user-fraud
+1/-1     
Enhancement
9 files
v3-biometric-authentication-entry.yaml
Add missingCallbackUrl error example to 400 response         
+5/-0     
v3-biometric-enrollment-entry.yaml
Add missingCallbackUrl error example to 400 response         
+5/-0     
v3-biometric-kyc-entry.yaml
Add missingCallbackUrl error example to 400 response         
+5/-0     
v3-block-user.yaml
Remove entire Block User API specification                             
+0/-261 
v3-document-verification-entry.yaml
Add missingCallbackUrl error example to 400 response         
+5/-0     
v3-enhanced-document-verification-entry.yaml
Add missingCallbackUrl error example to 400 response         
+5/-0     
v3-enhanced-kyc-entry.yaml
Add missingCallbackUrl error example to 400 response         
+5/-0     
v3-report-user-fraud.yaml
Add new Report User Fraud API specification                           
+287/-0 
v3-smart-selfie-compare-entry.yaml
Add missingCallbackUrl error example to 400 response         
+5/-0     


Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
  • Copilot AI review requested due to automatic review settings June 4, 2026 21:39
    @prfectionist
    Copy link
    Copy Markdown

    prfectionist Bot commented Jun 4, 2026

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🏅 Score: 90
    🧪 No relevant tests
    🔒 No security concerns identified
    🔀 No multiple PR themes
    ⚡ Recommended focus areas for review

    Schema Permissiveness

    The ReportUserFraudRequest schema sets additionalProperties: true, which means any arbitrary fields can be sent in the request body. This could lead to unexpected data being accepted and potentially stored. Consider whether this is intentional or if it should be false to enforce a strict contract.

    additionalProperties: true
    Conditional Validation

    The reason field is described as required when is_fraud is true but this conditional requirement cannot be expressed in OpenAPI 3.0.3 schema alone (no if/then/else or dependentRequired). The schema marks only is_fraud and reported_by as top-level required fields, so clients relying solely on schema validation won't catch a missing reason when is_fraud is true. This is documented in the description but worth noting as a potential source of confusion for code generators.

    required:
      - is_fraud
      - reported_by
    properties:
      is_fraud:
        type: boolean
        description: |
          `true` to flag the user as fraudulent, `false` to clear a previous
          fraud flag.
        example: true
      reason:
        type: string
        description: |
          Reason for the fraud report. **Required when `is_fraud` is `true`**;
          ignored when `is_fraud` is `false`. If `OTHER` is selected, `notes`
          becomes required.
        enum:
          - FIRST_PARTY_FRAUD
          - SECOND_PARTY_FRAUD
          - THIRD_PARTY_FRAUD
          - SYNTHETIC_IDENTITY
          - ACCOUNT_TAKEOVER
          - DOCUMENT_FORGERY
          - IDENTITY_FARMING
          - MULE_ACCOUNT
          - OTHER

    @prfectionist
    Copy link
    Copy Markdown

    prfectionist Bot commented Jun 4, 2026

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    Copy link
    Copy Markdown

    Copilot AI left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Pull request overview

    Automated update of the Smile Identity v3 OpenAPI specs to v3.635.0, including replacing the removed v3-block-user specification with a new fraud reporting endpoint and expanding documented 400-error examples across multiple verification entry specs.

    Changes:

    • Added a new v3-report-user-fraud OpenAPI spec and updated docs to reference it instead of v3-block-user.
    • Removed the v3-block-user OpenAPI spec.
    • Added a missingCallbackUrl 400-response example to several verification entry specs.

    Reviewed changes

    Copilot reviewed 12 out of 12 changed files in this pull request and generated 2 comments.

    Show a summary per file
    File Description
    CHANGELOG.md Adds a v3.635.0 release entry documenting changed/removed specs (needs a small categorization fix).
    README.md Replaces the Block User row with Report User Fraud in the API table.
    docs/index.html Updates the rendered spec list: removes block-user and adds report-user-fraud.
    specs/v3/v3-biometric-authentication-entry.yaml Adds missingCallbackUrl example to 400 responses.
    specs/v3/v3-biometric-enrollment-entry.yaml Adds missingCallbackUrl example to 400 responses.
    specs/v3/v3-biometric-kyc-entry.yaml Adds missingCallbackUrl example to 400 responses.
    specs/v3/v3-document-verification-entry.yaml Adds missingCallbackUrl example to 400 responses.
    specs/v3/v3-enhanced-document-verification-entry.yaml Adds missingCallbackUrl example to 400 responses.
    specs/v3/v3-enhanced-kyc-entry.yaml Adds missingCallbackUrl example to 400 responses.
    specs/v3/v3-smart-selfie-compare-entry.yaml Adds missingCallbackUrl example to 400 responses.
    specs/v3/v3-block-user.yaml Removes the Block User OpenAPI specification.
    specs/v3/v3-report-user-fraud.yaml Introduces the new Report User Fraud OpenAPI specification.

    💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

    Comment thread CHANGELOG.md
    Comment on lines +10 to +18
    ### Changed
    - Updated `v3-biometric-authentication-entry`
    - Updated `v3-biometric-enrollment-entry`
    - Updated `v3-biometric-kyc-entry`
    - Updated `v3-document-verification-entry`
    - Updated `v3-enhanced-document-verification-entry`
    - Updated `v3-enhanced-kyc-entry`
    - Updated `v3-report-user-fraud`
    - Updated `v3-smart-selfie-compare-entry`
    Comment on lines +133 to +134
    The response is `202 Accepted` once the request has been validated
    and handled.
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    2 participants