Skip to content

docs: add identity verification sessions to the api reference #166

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
Benzilla merged 3 commits into from
Sep 22, 2026
Merged

docs: add identity verification sessions to the api reference #166

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dcc7ed6
docs: add identity verification sessions to the api reference
TTyChud Sep 21, 2026
2a2339e
docs: document identity verification session events
TTyChud Sep 21, 2026
a0b3ed9
docs: render the cancel verification session callout as html
TTyChud Sep 22, 2026
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 apps/docs/src/app/pages/docs/data/connect.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import { INVOICE_ITEMS_SUBSECTION } from './invoice-items';
import { INVOICES_SUBSECTION } from './invoices';
import { BILLING_SUBSECTION } from './billing';
import { EVENTS_SUBSECTION } from './events';
import { IDENTITY_VERIFICATION_SESSIONS_SUBSECTION } from './identity-verification-sessions';
import { WEBHOOK_ENDPOINTS_SUBSECTION } from './webhook-endpoints';

export const CORE_RESOURCES_SECTION: DocSection = {
Expand Down Expand Up @@ -80,6 +81,12 @@ export const CONNECT_SECTION: DocSection = {
],
};

export const IDENTITY_SECTION: DocSection = {
id: 'identity',
title: 'Identity',
children: [IDENTITY_VERIFICATION_SESSIONS_SUBSECTION],
};

export const WEBHOOKS_SECTION: DocSection = {
id: 'webhooks-section',
title: 'Webhooks',
Expand All @@ -93,5 +100,6 @@ export const API_SECTIONS: DocSection[] = [
PAYMENT_LINKS_SECTION,
BILLING_SECTION,
CONNECT_SECTION,
IDENTITY_SECTION,
WEBHOOKS_SECTION,
];
47 changes: 47 additions & 0 deletions apps/docs/src/app/pages/docs/data/event-types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,53 @@ export const EVENT_TYPE_DEFINITIONS: EventTypeDefinition[] = [
description: 'Occurs whenever an external wallet is deleted.',
},

// Identity verification session events
{
name: 'identity.verification_session.created',
resource: 'identity.verification_session',
objectType: 'VerificationSession',
objectHref: '#identity-verification-sessions-object',
description: 'Occurs whenever a verification session is created.',
},
{
name: 'identity.verification_session.processing',
resource: 'identity.verification_session',
objectType: 'VerificationSession',
objectHref: '#identity-verification-sessions-object',
description:
'Occurs whenever a verification session transitions to <code>processing</code>, once the seller submits their documents or moves through the flow.',
},
{
name: 'identity.verification_session.requires_input',
resource: 'identity.verification_session',
objectType: 'VerificationSession',
objectHref: '#identity-verification-sessions-object',
description:
'Occurs whenever a verification session transitions to <code>requires_input</code>, when the seller needs to provide more information or try again.',
},
{
name: 'identity.verification_session.verified',
resource: 'identity.verification_session',
objectType: 'VerificationSession',
objectHref: '#identity-verification-sessions-object',
description:
'Occurs whenever a verification session transitions to <code>verified</code>, once the check passes.',
},
{
name: 'identity.verification_session.canceled',
resource: 'identity.verification_session',
objectType: 'VerificationSession',
objectHref: '#identity-verification-sessions-object',
description: 'Occurs whenever a verification session is canceled.',
},
{
name: 'identity.verification_session.redacted',
resource: 'identity.verification_session',
objectType: 'VerificationSession',
objectHref: '#identity-verification-sessions-object',
description: 'Occurs whenever a verification session is redacted.',
},

// Invoice events
{
name: 'invoice.created',
Expand Down
Loading
Loading