Skip to content

feat(identity-verification): sonderformat input#4027

Draft
Aaron-Ritter wants to merge 52 commits intoFusionAuth:feature/pre-verified/devrelfrom
sonderformat-llc:wied03/pre-verified-sonderformat-input
Draft

feat(identity-verification): sonderformat input#4027
Aaron-Ritter wants to merge 52 commits intoFusionAuth:feature/pre-verified/devrelfrom
sonderformat-llc:wied03/pre-verified-sonderformat-input

Conversation

@Aaron-Ritter
Copy link
Contributor

@Aaron-Ritter Aaron-Ritter commented Dec 18, 2025

This pull request focuses on improving the clarity, consistency, and accuracy of identity verification documentation across several files. The main changes include clarifying possible values for API fields, improving explanations and instructions, fixing minor typos, and ensuring consistent terminology. Also splitting and renaming existing pre-verification documentation, adding a new tutorial for phone identity pre-verification as well as api identity pre-verification, and introducing deprecation warnings for outdated features.

Changes Made

Refactor identity-verification documentation:

  • Separated email pre-verification and phone pre-verification instructions into distinct sections.
  • Improved document titles for consistency and clarity.
  • Added a draft Troubleshooting section for common issues.

New tutorials added:

  • Provided step-by-step guidance for setting up phone identity pre-verification, aligning it with email pre-verification content.
  • The same for using API only to verify identities.

Deprecation notice:

  • Added a deprecation warning for the legacy registration verification feature.

API Field Value Clarifications and Consistency:

  • Added explicit "possible values" sections for fields like user.encryptionScheme, user.twoFactor.methods[x].method, loginIdType, existingUserStrategy, verificationStrategy, and form step/type fields in various API documentation files. This makes it clearer what values are accepted or expected for these fields and therefore follows the docs guidelines.
  • Improved and clarified descriptions for several API fields, including user.email, user.encryptionScheme, and others to reduce ambiguity and improve readability.

Documentation and Terminology Improvements:

  • Updated terminology to consistently refer to the "FusionAuth admin UI" instead of just "FusionAuth UI" in form-related documentation.
  • Improved instructions and explanations for identity verification APIs, including clearer distinctions between verifying existing users and pre-verifying identities before user creation, and added links to relevant tutorials.

Typographical and Minor Corrections:

  • Fixed minor typos and improved sentence structure in various places, such as correcting "had completed verification" to "have already completed verification" and clarifying the meaning of certain fields.
  • Corrected example code snippets and markdown formatting for clarity.

Link and Reference Updates:

  • Updated documentation links to remove unnecessary trailing slashes for consistency and accuracy.
  • Added tutorial links for identity pre-verification use cases.

Formatting and List Consistency:

  • Standardized bullet lists and step formatting to improve readability and maintain consistency throughout the documentation.

wied03 and others added 30 commits October 29, 2025 17:09
…cumentation to mail identity pre-verification and finalize content
…fication setup similar to email identity pre-verification
…ocumentation for email and phone identity pre-verification and add a draft to the Troubleshooting section
…I reference section in draft, deprecation notes and improved testing instructions
# Conflicts:
#	astro/src/content/docs/customize/look-and-feel/upgrade.mdx
#	astro/src/content/docs/release-notes/index.mdx
Aaron-Ritter and others added 20 commits November 25, 2025 10:15
- TODO [User API] vs [Users API]
- TODO [Registration API] vs [Registrations API]
# Conflicts:
#	astro/src/content/docs/customize/look-and-feel/upgrade.mdx
#	astro/src/content/docs/release-notes/index.mdx
@Aaron-Ritter Aaron-Ritter requested review from a team as code owners December 18, 2025 09:21
@Aaron-Ritter Aaron-Ritter changed the title feat(identity-verification): sonderformat input #3976 feat(identity-verification): sonderformat input Dec 18, 2025
@Aaron-Ritter Aaron-Ritter marked this pull request as draft December 18, 2025 09:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants