Skip to content

update VerificationErrorType and VerificationStatus #310

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wuvictor-95 merged 1 commit into from
Mar 31, 2026
Merged

update VerificationErrorType and VerificationStatus #310

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion mintlify/openapi.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 13 additions & 1 deletion openapi.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 15 additions & 3 deletions openapi/components/schemas/verifications/VerificationErrorType.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,21 @@ enum:
- MISSING_IDENTITY_DOCUMENT
- INVALID_DOCUMENT
- EXPIRED_DOCUMENT
- POOR_QUALITY_DOCUMENT
- SUSPECTED_FRAUD_DOCUMENT
- WRONG_DOCUMENT_TYPE
- INCOMPLETE_DOCUMENT
- UNREADABLE_DOCUMENT
- DOCUMENT_VERIFICATION_FAILED
- APPLICANT_SANCTIONED
- APPLICANT_FRAUD
- APPLICANT_CRIMINAL_RECORD
- APPLICANT_REJECTED
- MISSING_BENEFICIAL_OWNER
description: >-
Type of verification error. The category-specific MISSING_*_DOCUMENT
types indicate which document category is needed and determine the
accepted document types returned in acceptedDocumentTypes.
Type of verification error. The category-specific MISSING_*_DOCUMENT types
indicate which document category is needed. Document quality types
(POOR_QUALITY_DOCUMENT, SUSPECTED_FRAUD_DOCUMENT, etc.) indicate specific
issues with uploaded documents. APPLICANT_* types indicate issues with the
applicant themselves (sanctions, fraud, criminal records).
Comment on lines 24 to +29
Copy link
Copy Markdown
Contributor

@greptile-apps greptile-apps bot Mar 31, 2026

Choose a reason for hiding this comment

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

P2 SUSPECTED_FRAUD_DOCUMENT mislabeled as a "quality" type

The description groups SUSPECTED_FRAUD_DOCUMENT under "Document quality types," but fraud detection is fundamentally different from quality issues like poor resolution or unreadability. API consumers may be confused or implement incorrect handling if they treat fraud detection the same as quality problems. Consider splitting the description into distinct categories.

Suggested change
description: >-
Type of verification error. The category-specific MISSING_*_DOCUMENT
types indicate which document category is needed and determine the
accepted document types returned in acceptedDocumentTypes.
Type of verification error. The category-specific MISSING_*_DOCUMENT types
indicate which document category is needed. Document quality types
(POOR_QUALITY_DOCUMENT, SUSPECTED_FRAUD_DOCUMENT, etc.) indicate specific
issues with uploaded documents. APPLICANT_* types indicate issues with the
applicant themselves (sanctions, fraud, criminal records).
description: >-
Type of verification error. The category-specific MISSING_*_DOCUMENT types
indicate which document category is needed. Document quality types
(POOR_QUALITY_DOCUMENT, WRONG_DOCUMENT_TYPE, INCOMPLETE_DOCUMENT,
UNREADABLE_DOCUMENT, DOCUMENT_VERIFICATION_FAILED) indicate specific
issues with uploaded documents. Fraud types (SUSPECTED_FRAUD_DOCUMENT)
indicate suspected fraudulent documents. APPLICANT_* types indicate issues
with the applicant themselves (sanctions, fraud, criminal records, general
rejection).
Prompt To Fix With AI 
This is a comment left during a code review.
Path: openapi/components/schemas/verifications/VerificationErrorType.yaml
Line: 24-29

Comment:
**`SUSPECTED_FRAUD_DOCUMENT` mislabeled as a "quality" type**

The description groups `SUSPECTED_FRAUD_DOCUMENT` under "Document quality types," but fraud detection is fundamentally different from quality issues like poor resolution or unreadability. API consumers may be confused or implement incorrect handling if they treat fraud detection the same as quality problems. Consider splitting the description into distinct categories.

```suggestion
description: >-
  Type of verification error. The category-specific MISSING_*_DOCUMENT types
  indicate which document category is needed. Document quality types
  (POOR_QUALITY_DOCUMENT, WRONG_DOCUMENT_TYPE, INCOMPLETE_DOCUMENT,
  UNREADABLE_DOCUMENT, DOCUMENT_VERIFICATION_FAILED) indicate specific
  issues with uploaded documents. Fraud types (SUSPECTED_FRAUD_DOCUMENT)
  indicate suspected fraudulent documents. APPLICANT_* types indicate issues
  with the applicant themselves (sanctions, fraud, criminal records, general
  rejection).
```

How can I resolve this? If you propose a fix, please make it concise.

Comment on lines 24 to +29
Copy link
Copy Markdown
Contributor

@greptile-apps greptile-apps bot Mar 31, 2026

Choose a reason for hiding this comment

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

P2 APPLICANT_REJECTED undescribed in description

The description's parenthetical for APPLICANT_* types lists "(sanctions, fraud, criminal records)" but omits APPLICANT_REJECTED. It's unclear from the description alone whether APPLICANT_REJECTED is a catch-all for when no more specific APPLICANT_* reason applies, or if it serves a distinct purpose. API consumers won't know when to expect this value vs the more specific types. Adding a brief note (e.g., "or general rejection") would remove the ambiguity.

Prompt To Fix With AI 
This is a comment left during a code review.
Path: openapi/components/schemas/verifications/VerificationErrorType.yaml
Line: 24-29

Comment:
**`APPLICANT_REJECTED` undescribed in description**

The description's parenthetical for `APPLICANT_*` types lists "(sanctions, fraud, criminal records)" but omits `APPLICANT_REJECTED`. It's unclear from the description alone whether `APPLICANT_REJECTED` is a catch-all for when no more specific `APPLICANT_*` reason applies, or if it serves a distinct purpose. API consumers won't know when to expect this value vs the more specific types. Adding a brief note (e.g., "or general rejection") would remove the ambiguity.

How can I resolve this? If you propose a fix, please make it concise.

example: MISSING_FIELD
1 change: 1 addition & 0 deletions openapi/components/schemas/verifications/VerificationStatus.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@ enum:
- IN_PROGRESS
- APPROVED
- REJECTED
- READY_FOR_VERIFICATION
Copy link
Copy Markdown
Contributor Author

@wuvictor-95 wuvictor-95 Mar 31, 2026

Choose a reason for hiding this comment

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

We do not auto-submit on behalf of the customer after they've resolved all the verification errors. This is why we need this intermediary verification status.

description: Current status of the KYC/KYB verification
example: RESOLVE_ERRORS
1 change: 1 addition & 0 deletions openapi/components/schemas/webhooks/WebhookType.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ enum:
- VERIFICATION.RESOLVE_ERRORS
- VERIFICATION.IN_PROGRESS
- VERIFICATION.PENDING_MANUAL_REVIEW
- VERIFICATION.READY_FOR_VERIFICATION
- INTERNAL_ACCOUNT.BALANCE_UPDATED
- INVITATION.CLAIMED
- BULK_UPLOAD.COMPLETED
Expand Down
Loading