-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathvl.yaml
236 lines (230 loc) · 5.96 KB
/
vl.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
openapi: "3.0.0"
info:
version: 1.0.0
title: Identity Verification Layer
description: Verification Layer of VerifID - open source identity verification platform.
license:
name: MIT
url: https://github.com/verifid/vl/blob/master/LICENSE
servers:
- url: https://api.verifid.app/v1
paths:
/user/sendUserData:
post:
description: Creates a new user for verification. Duplicates are allowed.
operationId: sendUserData
requestBody:
description: User going to be verified.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/User'
responses:
'200':
description: User data received successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/UserDataResponse'
'400':
description: Failed operation, invalid request.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
default:
description: Unexpected error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/user/verify:
post:
description: Verifies user with given user id.
operationId: verify
requestBody:
description: User id and language that is required for verification.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/VerifyUser'
responses:
'200':
description: User verification completed.
content:
application/json:
schema:
$ref: '#/components/schemas/UserVerificationResponse'
'400':
description: Failed operation, unexpected error.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
/image/uploadProfile:
post:
description: Uploads a profile image.
operationId: uploadProfile
requestBody:
description: User id and base64 encoded binary string of image file.
required: true
content:
application/json:
schema:
$ref: '#components/schemas/ImageUpload'
responses:
'200':
description: Successful operation.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
'204':
description: Failed operation, no user found with given id.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
'400':
description: Failed operation, no user found with given id.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
default:
description: Unexpected error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/image/uploadIdentity:
post:
description: Uploads an identity image.
operationId: uploadIdentity
requestBody:
description: User id and base64 encoded binary string of image file.
required: true
content:
application/json:
schema:
$ref: '#components/schemas/ImageUpload'
responses:
'200':
description: Successful operation.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
'204':
description: Failed operation, no user found with given id.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
'400':
description: Failed operation, no user found with given id.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
default:
description: Unexpected error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
User:
type: object
required:
- name
- surname
- dateOfBirth
- country
properties:
name:
type: string
surname:
type: string
dateOfBirth:
type: string
country:
type: string
VerifyUser:
type: object
required:
- userId
- language
properties:
userId:
type: string
language:
type: string
ImageUpload:
type: object
required:
- userId
- image
properties:
userId:
type: string
image:
type: string
format: binary
ApiResponse:
type: object
required:
- code
- type
- message
properties:
code:
type: integer
format: int32
type:
type: string
message:
type: string
UserDataResponse:
type: object
required:
- code
- type
- message
- userId
properties:
code:
type: integer
format: int32
type:
type: string
message:
type: string
userId:
type: string
UserVerificationResponse:
type: object
required:
- code
- verificationRate
properties:
code:
type: integer
format: int32
verificationRate:
type: integer
format: int32
Error:
type: object
required:
- code
- message
properties:
code:
type: integer
format: int32
message:
type: string