Skip to content

Commit 5598113

Browse files
tierriMonteiroandregoncalvesdev
authored andcommitted
Add kyc webhooks docs
1 parent 37c784d commit 5598113

2 files changed

Lines changed: 114 additions & 0 deletions

File tree

docs/events/user.mdx

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ import TabItem from '@theme/TabItem';
1111
| - | - |
1212
| [`user:created`](#usercreated) | User created a new account. |
1313
| [`user:logged-in`](#userlogged-in) | User logged in. |
14+
| [`user:kyc:identity:initiated`](#userkycidentityinitiated) | User's KYC identity process has been initiated. |
15+
| [`user:kyc:identity:succeeded`](#userkycidentitysucceeded) | User's KYC identity process has succeeded. |
16+
| [`user:kyc:identity:failed`](#userkycidentityfailed) | User's KYC identity process has failed. |
1417

1518
## `user:created`
1619

@@ -79,3 +82,111 @@ Triggered when a user logs in.
7982

8083
</TabItem>
8184
</Tabs>
85+
86+
## `user:kyc:identity:initiated`
87+
88+
Triggered when a user's KYC process has been initiated.
89+
90+
<Tabs>
91+
<TabItem label="Schema" value="schema" default>
92+
93+
- `kycSession`: KYC session object.
94+
- `initiatedAt`: Timestamp at which the KYC session was initiated.
95+
- `user`: User object.
96+
- `id`: UUID of the user.
97+
98+
</TabItem>
99+
<TabItem label="Example" value="example">
100+
101+
```js
102+
{
103+
"name": "user:kyc:identity:initiated",
104+
"id": "00a991cf-a870-43af-88b8-43c51532831d",
105+
"bootstrapTokenId": "141bfa06-481e-4684-96eb-cec4ad529616",
106+
"data": {
107+
// highlight-start
108+
"kycSession": {
109+
"initiatedAt": "2024-01-15T10:30:00.000Z"
110+
},
111+
"user": {
112+
"id": "b9fe022b-f436-49e1-bb89-6f2e8eabf336"
113+
}
114+
// highlight-end
115+
}
116+
}
117+
```
118+
119+
</TabItem>
120+
</Tabs>
121+
122+
## `user:kyc:identity:succeeded`
123+
124+
Triggered when a user's KYC process has succeeded.
125+
126+
<Tabs>
127+
<TabItem label="Schema" value="schema" default>
128+
129+
- `kycSession`: KYC session object.
130+
- `updatedAt`: Timestamp at which the KYC session was last updated.
131+
- `user`: User object.
132+
- `id`: UUID of the user.
133+
134+
</TabItem>
135+
<TabItem label="Example" value="example">
136+
137+
```js
138+
{
139+
"name": "user:kyc:identity:succeeded",
140+
"id": "00a991cf-a870-43af-88b8-43c51532831d",
141+
"bootstrapTokenId": "141bfa06-481e-4684-96eb-cec4ad529616",
142+
"data": {
143+
// highlight-start
144+
"kycSession": {
145+
"updatedAt": "2024-01-15T10:35:00.000Z"
146+
},
147+
"user": {
148+
"id": "b9fe022b-f436-49e1-bb89-6f2e8eabf336"
149+
}
150+
// highlight-end
151+
}
152+
}
153+
```
154+
155+
</TabItem>
156+
</Tabs>
157+
158+
## `user:kyc:identity:failed`
159+
160+
Triggered when a user's KYC process has failed.
161+
162+
<Tabs>
163+
<TabItem label="Schema" value="schema" default>
164+
165+
- `kycSession`: KYC session object.
166+
- `updatedAt`: Timestamp at which the KYC session was last updated.
167+
- `user`: User object.
168+
- `id`: UUID of the user.
169+
170+
</TabItem>
171+
<TabItem label="Example" value="example">
172+
173+
```js
174+
{
175+
"name": "user:kyc:identity:failed",
176+
"id": "00a991cf-a870-43af-88b8-43c51532831d",
177+
"bootstrapTokenId": "141bfa06-481e-4684-96eb-cec4ad529616",
178+
"data": {
179+
// highlight-start
180+
"kycSession": {
181+
"updatedAt": "2024-01-15T10:35:00.000Z"
182+
},
183+
"user": {
184+
"id": "b9fe022b-f436-49e1-bb89-6f2e8eabf336"
185+
}
186+
// highlight-end
187+
}
188+
}
189+
```
190+
191+
</TabItem>
192+
</Tabs>

docs/webhooks.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,9 @@ Full information about the available events and their associated payloads can be
5252
| - | - |
5353
| [`user:created`](./events/user.mdx#usercreated) | User created a new account. |
5454
| [`user:logged-in`](./events/user.mdx#userlogged-in) | User logged in. |
55+
| [`user:kyc:identity:initiated`](./events/user.mdx#userkycinitiated) | User's KYC identity process has been initiated. |
56+
| [`user:kyc:identity:succeeded`](./events/user.mdx#userkycsucceeded) | User's KYC identity process has succeeded. |
57+
| [`user:kyc:identity:failed`](./events/user.mdx#userkycfailed) | User's KYC identity process has failed. |
5558

5659
## Verifying a request
5760

0 commit comments

Comments
 (0)