Skip to content

Add kyc webhooks docs #114

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
andregoncalvesdev merged 1 commit into from
May 8, 2026
+114 −0
Merged

Add kyc webhooks docs #114

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
111 changes: 111 additions & 0 deletions docs/events/user.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ import TabItem from '@theme/TabItem';
| - | - |
| [`user:created`](#usercreated) | User created a new account. |
| [`user:logged-in`](#userlogged-in) | User logged in. |
| [`user:kyc:identity:initiated`](#userkycidentityinitiated) | User's KYC identity process has been initiated. |
| [`user:kyc:identity:succeeded`](#userkycidentitysucceeded) | User's KYC identity process has succeeded. |
| [`user:kyc:identity:failed`](#userkycidentityfailed) | User's KYC identity process has failed. |

## `user:created`

Expand Down Expand Up @@ -79,3 +82,111 @@ Triggered when a user logs in.

</TabItem>
</Tabs>

## `user:kyc:identity:initiated`

Triggered when a user's KYC process has been initiated.

<Tabs>
<TabItem label="Schema" value="schema" default>

- `kycSession`: KYC session object.
- `initiatedAt`: Timestamp at which the KYC session was initiated.
- `user`: User object.
- `id`: UUID of the user.

</TabItem>
<TabItem label="Example" value="example">

```js
{
"name": "user:kyc:identity:initiated",
"id": "00a991cf-a870-43af-88b8-43c51532831d",
"bootstrapTokenId": "141bfa06-481e-4684-96eb-cec4ad529616",
"data": {
// highlight-start
"kycSession": {
"initiatedAt": "2024-01-15T10:30:00.000Z"
},
"user": {
"id": "b9fe022b-f436-49e1-bb89-6f2e8eabf336"
}
// highlight-end
}
}
```

</TabItem>
</Tabs>

## `user:kyc:identity:succeeded`

Triggered when a user's KYC process has succeeded.

<Tabs>
<TabItem label="Schema" value="schema" default>

- `kycSession`: KYC session object.
- `updatedAt`: Timestamp at which the KYC session was last updated.
- `user`: User object.
- `id`: UUID of the user.

</TabItem>
<TabItem label="Example" value="example">

```js
{
"name": "user:kyc:identity:succeeded",
"id": "00a991cf-a870-43af-88b8-43c51532831d",
"bootstrapTokenId": "141bfa06-481e-4684-96eb-cec4ad529616",
"data": {
// highlight-start
"kycSession": {
"updatedAt": "2024-01-15T10:35:00.000Z"
},
"user": {
"id": "b9fe022b-f436-49e1-bb89-6f2e8eabf336"
}
// highlight-end
}
}
```

</TabItem>
</Tabs>

## `user:kyc:identity:failed`

Triggered when a user's KYC process has failed.

<Tabs>
<TabItem label="Schema" value="schema" default>

- `kycSession`: KYC session object.
- `updatedAt`: Timestamp at which the KYC session was last updated.
- `user`: User object.
- `id`: UUID of the user.

</TabItem>
<TabItem label="Example" value="example">

```js
{
"name": "user:kyc:identity:failed",
"id": "00a991cf-a870-43af-88b8-43c51532831d",
"bootstrapTokenId": "141bfa06-481e-4684-96eb-cec4ad529616",
"data": {
// highlight-start
"kycSession": {
"updatedAt": "2024-01-15T10:35:00.000Z"
},
"user": {
"id": "b9fe022b-f436-49e1-bb89-6f2e8eabf336"
}
// highlight-end
}
}
```

</TabItem>
</Tabs>
3 changes: 3 additions & 0 deletions docs/webhooks.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@ Full information about the available events and their associated payloads can be
| - | - |
| [`user:created`](./events/user.mdx#usercreated) | User created a new account. |
| [`user:logged-in`](./events/user.mdx#userlogged-in) | User logged in. |
| [`user:kyc:identity:initiated`](./events/user.mdx#userkycinitiated) | User's KYC identity process has been initiated. |
| [`user:kyc:identity:succeeded`](./events/user.mdx#userkycsucceeded) | User's KYC identity process has succeeded. |
| [`user:kyc:identity:failed`](./events/user.mdx#userkycfailed) | User's KYC identity process has failed. |

## Verifying a request

Expand Down
Loading