docs: document selfie check 4.0 - #166
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: dc0f5c4f8a
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| "integrity_bundle": { | ||
| "description": "Required with version 2 when any response item is a Selfie Check credential (`issuer_schema_id: 11`).", | ||
| "allOf": [ | ||
| { | ||
| "$ref": "#/components/schemas/IntegrityBundle" | ||
| } |
There was a problem hiding this comment.
Enforce the required integrity bundle for Selfie Check
For a request containing an issuer_schema_id: 11 response, this schema still permits integrity_bundle to be omitted because it is absent from the request's required array, and when supplied it permits version 1 through the shared IntegrityBundle enum. Consequently, generated clients and schema validation accept payloads that the description says the verification endpoint rejects; model Selfie Check as a distinct request variant that requires the bundle and constrains its version to 2.
Useful? React with 👍 / 👎.
| "sybil_score": { | ||
| "type": "integer", | ||
| "minimum": 0, | ||
| "description": "Versioned Selfie Check risk signal represented as an integer. Required only when `issuer_schema_id` is 11." |
There was a problem hiding this comment.
Encode the required Selfie Check score in the schema
Although the new description says sybil_score is required for issuer schema 11, the field is not present in this object's required list. API documentation and generated types therefore expose the score as optional and validate a schema-11 response without it, contradicting the documented IDKit contract; use a dedicated oneOf Selfie response variant that requires sybil_score.
Useful? React with 👍 / 👎.
This PR documents Selfie Check 4.0 across the public credential and IDKit references.
selfieCheckpreset and marksselfieCheckLegacyas deprecatedsybil_score, integrity bundle version 2, and repeated-action behaviorContext