Skip to content

Add end-user terms consent customer APIs #788

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

Draft
ls-bolt wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Add end-user terms consent customer APIs #788

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: 8 additions & 0 deletions .stainless/stainless.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,9 @@ resources:
business_customer_create_request: '#/components/schemas/BusinessCustomerCreateRequest'
individual_customer_update_request: '#/components/schemas/IndividualCustomerUpdateRequest'
business_customer_update_request: '#/components/schemas/BusinessCustomerUpdateRequest'
end_user_terms: '#/components/schemas/EndUserTerms'
end_user_terms_consent: '#/components/schemas/EndUserTermsConsent'
end_user_terms_consent_request: '#/components/schemas/EndUserTermsConsentRequest'
# Internal-account management (list/update/export under this resource)
internal_account_list_response: '#/components/schemas/InternalAccountListResponse'
internal_account_update_request: '#/components/schemas/InternalAccountUpdateRequest'
Expand All @@ -139,6 +142,11 @@ resources:
create_kyc_link:
endpoint: post /customers/{customerId}/kyc-link
body_param_name: KycLinkCreateRequest
retrieve_end_user_terms: get /customers/end-user-terms
retrieve_end_user_terms_consent: get /customers/{customerId}/end-user-terms-consent
update_end_user_terms_consent:
endpoint: patch /customers/{customerId}/end-user-terms-consent
body_param_name: EndUserTermsConsentRequest
# Subresources define resources that are nested within another for more powerful
# logical groupings, e.g. `cards.payments`.
subresources:
Expand Down
159 changes: 159 additions & 0 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.

4 changes: 4 additions & 0 deletions mintlify/payouts-and-b2b/onboarding/disclosures.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ Copy Lightspark's End User Terms and append them to your own terms of service, s

Present the combined terms in your onboarding or consent flow, and require each end user to affirmatively accept them (for example, an unchecked checkbox or an "I Agree" button) before they can use Grid.

Use `GET /customers/end-user-terms` to retrieve the current terms URL and version. Record acceptance when you create the customer with `endUserTermsConsent`, or later with `PATCH /customers/{customerId}/end-user-terms-consent`. The acceptance record includes the timestamp, device IP address, terms version, and acceptance method. Grid rejects versions that it does not recognize.

For unregulated platforms, Grid does not open customer accounts until you record this acceptance. You can retrieve the current record with `GET /customers/{customerId}/end-user-terms-consent`.

## Provide evidence of your consent flow

Send Lightspark evidence that your end users are shown the End User Terms and consent to them. Provide both:
Expand Down
Loading
Loading