Skip to content

Add HOLD KYB/KYC status and FAILED internal account status #658

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
Jul 8, 2026
+25 −6
Merged

Add HOLD KYB/KYC status and FAILED internal account status #658

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
8 changes: 6 additions & 2 deletions 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.

8 changes: 6 additions & 2 deletions openapi.yaml
View file
Open in desktop

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

5 changes: 5 additions & 0 deletions openapi/components/schemas/customers/InternalAccountStatus.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ enum:
- ACTIVE
- CLOSED
- FROZEN
- FAILED
description: >-
Status of a Grid internal account. The status determines whether the account
can send or receive payments.
Expand All @@ -22,4 +23,8 @@ description: >-
- `FROZEN`: The account cannot send or receive payments. Grid may freeze an
account in response to compliance or fraud signals; payments are blocked
while the account remains frozen.

- `FAILED`: The account could not be provisioned. Grid was unable to create

@jklein24 jklein24 Jul 7, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Is it worth also adding a failureReason or errorMessage or something?

@wuvictor-95 wuvictor-95 Jul 8, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

All the failures have been validation failures that have since been patched. If we run into failures that we can't fix by making changes to our API, we can start adding in failure reasons here.

the underlying account, so it cannot send or receive payments and requires
remediation.
example: ACTIVE
5 changes: 4 additions & 1 deletion openapi/components/schemas/customers/KybStatus.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,8 @@ enum:
- PENDING
- APPROVED
- REJECTED
description: The current KYB status of a business customer
- HOLD
description: >-
The current KYB status of a business customer. `HOLD` means the customer is
placed on hold and may be required to update or provide more information.
example: APPROVED
Comment on lines +8 to 11

@greptile-apps greptile-apps Bot Jul 7, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P2 Same documentation gap as KycStatus.yaml — only HOLD is described inline while UNVERIFIED, PENDING, APPROVED, and REJECTED remain undocumented. InternalAccountStatus in this same PR demonstrates the preferred pattern of enumerating every value.

Suggested change
description: >-
The current KYB status of a business customer. `HOLD` means the customer is
placed on hold and may be required to update or provide more information.
example: APPROVED
description: >-
The current KYB status of a business customer.
- `UNVERIFIED`: The business has not yet started the KYB process.
- `PENDING`: The business's identity is under review.
- `APPROVED`: The business has successfully passed KYB verification.
- `REJECTED`: The business's KYB application was rejected.
- `HOLD`: The customer is placed on hold and may be required to update or
provide more information.
example: APPROVED
Prompt To Fix With AI 
This is a comment left during a code review.
Path: openapi/components/schemas/customers/KybStatus.yaml
Line: 8-11

Comment:
Same documentation gap as `KycStatus.yaml` — only `HOLD` is described inline while `UNVERIFIED`, `PENDING`, `APPROVED`, and `REJECTED` remain undocumented. `InternalAccountStatus` in this same PR demonstrates the preferred pattern of enumerating every value.

```suggestion
description: >-
  The current KYB status of a business customer.

  - `UNVERIFIED`: The business has not yet started the KYB process.

  - `PENDING`: The business's identity is under review.

  - `APPROVED`: The business has successfully passed KYB verification.

  - `REJECTED`: The business's KYB application was rejected.

  - `HOLD`: The customer is placed on hold and may be required to update or
  provide more information.
example: APPROVED
```

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

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

@jklein24 jklein24 Jul 7, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I agree with greptile here. Just a bit weird to have HOLD explicitly called out on its own.

5 changes: 4 additions & 1 deletion openapi/components/schemas/customers/KycStatus.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,8 @@ enum:
- PENDING
- APPROVED
- REJECTED
description: The current KYC status of a customer
- HOLD
description: >-
The current KYC status of a customer. `HOLD` means the customer is placed on
hold and may be required to update or provide more information.
example: APPROVED
Comment on lines +8 to 11

@greptile-apps greptile-apps Bot Jul 7, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P2 The description explains HOLD inline but leaves UNVERIFIED, PENDING, APPROVED, and REJECTED undocumented. InternalAccountStatus in the same PR uses a per-value bullet list for all values — applying the same pattern here makes the schema equally self-contained for API consumers who read only the KYC/KYB status field docs.

Suggested change
description: >-
The current KYC status of a customer. `HOLD` means the customer is placed on
hold and may be required to update or provide more information.
example: APPROVED
description: >-
The current KYC status of a customer.
- `UNVERIFIED`: The customer has not yet started the KYC process.
- `PENDING`: The customer's identity is under review.
- `APPROVED`: The customer has successfully passed KYC verification.
- `REJECTED`: The customer's KYC application was rejected.
- `HOLD`: The customer is placed on hold and may be required to update or
provide more information.
example: APPROVED
Prompt To Fix With AI 
This is a comment left during a code review.
Path: openapi/components/schemas/customers/KycStatus.yaml
Line: 8-11

Comment:
The description explains `HOLD` inline but leaves `UNVERIFIED`, `PENDING`, `APPROVED`, and `REJECTED` undocumented. `InternalAccountStatus` in the same PR uses a per-value bullet list for all values — applying the same pattern here makes the schema equally self-contained for API consumers who read only the KYC/KYB status field docs.

```suggestion
description: >-
  The current KYC status of a customer.

  - `UNVERIFIED`: The customer has not yet started the KYC process.

  - `PENDING`: The customer's identity is under review.

  - `APPROVED`: The customer has successfully passed KYC verification.

  - `REJECTED`: The customer's KYC application was rejected.

  - `HOLD`: The customer is placed on hold and may be required to update or
  provide more information.
example: APPROVED
```

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

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Loading