-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yml
700 lines (650 loc) · 16.8 KB
/
openapi.yml
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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
openapi: 3.0.2
info:
title: Minerva eKYC Documentation
version: v1.0
x-logo:
url: 'https://minerva.vn/wp-content/uploads/2020/06/logo.png'
description: >
Not really a *pseudo-randum* number generator API.
This API uses [Markdown](http://daringfireball.net/projects/markdown/syntax)
in text:
1. in this API description
1. in operation summaries
1. in operation descriptions
1. in schema (model) titles and descriptions
1. in schema (model) member descriptions
servers:
- url: https://ekyc.minerva.vn/v1
description: Production server
paths:
# ------------------------------ START ------------------------------
/ocr/cmnd/:
post:
tags:
- OCR
summary: 'OCR CMND'
description: 'Nhận ảnh CMND mặt trước hoặc sau, trích xuất thông tin của CMND'
operationId: ocr_cmnd__post
parameters:
- in: header
name: TOKEN-ID
schema:
type: string
required: true
description: TOKEN ID
- in: header
name: TOKEN-KEY
schema:
type: string
required: true
description: TOKEN KEY
requestBody:
required: true
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/Body_files_cmnd__post'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/OCRCmnd'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/FailResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
# ------------------------------ END ------------------------------
/ocr/cccd/:
post:
tags:
- OCR
summary: 'OCR CCCD'
description: 'Nhận ảnh CCCD mặt trước hoặc sau, trích xuất thông tin của CCCD'
operationId: ocr_cccd__post
parameters:
- in: header
name: TOKEN-ID
schema:
type: string
required: true
description: TOKEN ID
- in: header
name: TOKEN-KEY
schema:
type: string
required: true
description: TOKEN KEY
requestBody:
required: true
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/Body_files_cmnd__post'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/OCRCmnd'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/FailResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/ocr/passport/:
post:
tags:
- OCR
summary: 'OCR Passport'
description: 'Nhận ảnh Passport mặt trước hoặc sau, trích xuất thông tin của CMND'
operationId: ocr_passport__post
parameters:
- in: header
name: TOKEN-ID
schema:
type: string
required: true
description: TOKEN ID
- in: header
name: TOKEN-KEY
schema:
type: string
required: true
description: TOKEN KEY
requestBody:
required: true
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/Body_files_cmnd__post'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/OCRPassport'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/FailResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/face/compare/:
post:
tags:
- Face
summary: 'Face Compare'
description: 'So sánh khuôn mặt trên giấy tờ với khuôn mặt chân dung'
operationId: face_compare__post
parameters:
- in: header
name: TOKEN-ID
schema:
type: string
required: true
description: TOKEN ID
- in: header
name: TOKEN-KEY
schema:
type: string
required: true
description: TOKEN KEY
requestBody:
required: true
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/Body_face_compare__post'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/FaceCompare'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/FailResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/face/insert/:
post:
tags:
- Face
summary: 'Insert Face'
description: 'Thêm hình ảnh khuôn mặt của người dùng vào hệ thống'
operationId: face_insert__post
parameters:
- in: header
name: TOKEN-ID
schema:
type: string
required: true
description: TOKEN ID
- in: header
name: TOKEN-KEY
schema:
type: string
required: true
description: TOKEN KEY
requestBody:
required: true
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/Body_face_insert__post'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/FaceCompare'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/FailResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
components:
schemas:
Body_files_cmnd__post:
title: Body_files_cmnd_api_v1_ocr_cmnd__post
required:
- file
type: object
properties:
file:
title: File
type: string
format: binary
Body_face_compare__post:
title: Body face compare
required:
- file
type: object
properties:
img_front:
title: Ảnh trên giấy tờ
type: string
format: binary
img_face:
title: Ảnh chụp thực tế
type: string
format: binary
Body_face_insert__post:
title: Body face compare
type: object
properties:
cart_type:
title: Loại giấy tờ
card_id:
title: Số CMND/CCCD/Passport
type: string
full_name:
title: Tên trên giấy tờ
type: string
date_of_birth:
title: Ngày sinh truyền lên
type: string
format: "DD/MM/YYYY"
img_face:
title: Ảnh chụp thực tế
type: string
format: binary
required:
- cart_type
- card_id
- img_face
OCRCmnd:
type: object
properties:
success:
title: Success
type: boolean
data:
type: object
format: object
$ref: '#/components/schemas/OCRCmndData'
OCRCmndData:
type: object
properties:
id_number:
title: Số CMND
type: string
full_name:
title: Họ và tên
type: string
date_of_birth:
title: Ngày tháng năm sinh
type: string
place_of_origin:
title: Nguyên quán
type: string
place_of_residence:
title: Nơi ĐKHK thường trú
type: string
image:
title: Ảnh chân dung
type: string
format: base64
left_fingerprint:
title: Ảnh ngón trỏ trái
type: string
format: base64
right_fingerprint:
title: Ảnh ngón trỏ phải
type: string
format: base64
ethnicity:
title: Dân tộc
type: string
religion:
title: Tôn giáo
type: string
vestige:
title: Dấu vết riêng và dị hình
type: string
date_of_issue:
title: Ngày cấp
type: string
format: "DD/MM/YYYY"
place_of_issue:
title: Nơi cấp
type: string
gender:
title: Giới tính
type: string
OCRCccd:
type: object
properties:
success:
title: Success
type: boolean
data:
type: object
format: object
$ref: '#/components/schemas/OCRCccdData'
OCRCccdData:
type: object
properties:
nationality:
title: Quốc tịch
type: string
example: Việt Nam
date_of_expiry:
title: Ngày hết hạn
type: string
format: "DD/MM/YYYY"
example: "31/12/2030"
id_number:
title: Số CCCD
type: string
full_name:
title: Họ và tên
type: string
date_of_birth:
title: Ngày tháng năm sinh
type: string
place_of_origin:
title: Nguyên quán
type: string
place_of_residence:
title: Nơi ĐKHK thường trú
type: string
image:
title: Ảnh chân dung
type: string
format: base64
left_fingerprint:
title: Ảnh ngón trỏ trái
type: string
format: base64
right_fingerprint:
title: Ảnh ngón trỏ phải
type: string
format: base64
ethnicity:
title: Dân tộc
type: string
religion:
title: Tôn giáo
type: string
vestige:
title: Đặc điểm nhận dạng
type: string
date_of_issue:
title: Ngày cấp
type: string
format: "DD/MM/YYYY"
place_of_issue:
title: Nơi cấp
type: string
gender:
title: Giới tính
type: string
OCRPassport:
type: object
properties:
success:
title: Success
type: boolean
data:
type: object
format: object
$ref: '#/components/schemas/OCRPassportData'
FaceCompare:
type: object
properties:
success:
title: Success
type: boolean
data:
type: object
format: object
$ref: '#/components/schemas/FaceCompareData'
FaceCompareData:
type: object
properties:
code:
title: Code
type: string
example: "MATCH"
prob:
title: Tỉ lệ trùng khớp khuôn mặt
type: number
example: 80.00
maximum: 100
minimum: 1
OCRPassportData:
type: object
properties:
nationality:
title: Quốc tịch
type: string
example: Việt Nam
date_of_expiry:
title: Ngày hết hạn
type: string
format: "DD/MM/YYYY"
example: "31/12/2030"
FailResponse:
title: FailResponse
required:
- error_code
type: object
properties:
error_code:
title: Error Code
type: string
description:
title: Description
type: string
HTTPValidationError:
title: HTTPValidationError
type: object
properties:
errors:
title: Errors
type: array
items:
$ref: '#/components/schemas/ValidationError'
PermissionInCreateScheme:
title: PermissionInCreateScheme
required:
- type
type: object
properties:
user_id:
title: User Id
type: integer
type:
$ref: '#/components/schemas/PermissionTypeEnum'
unlock_password:
title: Unlock Password
type: string
example: password
repeat_unlock_password:
title: Repeat Unlock Password
type: string
example: repeat_password
expired_time:
title: Expired Time
type: string
example: 'dd/mm/YYYY HH:MM:SS'
PermissionScheme:
title: PermissionScheme
required:
- id
- type
type: object
properties:
created_at:
title: Created At
type: string
format: date-time
example: 'dd/mm/YYYY HH:MM:SS'
created_by:
title: Created By
type: string
updated_at:
title: Updated At
type: string
format: date-time
example: 'dd/mm/YYYY HH:MM:SS'
updated_by:
title: Updated By
type: string
id:
title: Id
type: integer
user_id:
title: User Id
type: integer
user_name:
title: User Name
type: string
type:
title: Type
type: integer
has_unlock_password:
title: Has Unlock Password
type: boolean
expired_time:
title: Expired Time
type: string
format: date-time
example: 'dd/mm/YYYY HH:MM:SS'
PermissionTypeEnum:
title: PermissionTypeEnum
enum:
- 1
- 2
- 4
- 3
type: integer
description: An enumeration.
UserInCreateScheme:
title: UserInCreateScheme
required:
- name
- password
- email
type: object
properties:
name:
title: Name
type: string
password:
title: Password
type: string
email:
title: Email
type: string
format: email
avatar_url:
title: Avatar Url
type: string
mobile:
title: Mobile
type: string
ValidationError:
title: ValidationError
required:
- loc
- msg
- type
type: object
properties:
loc:
title: Location
type: array
items:
type: string
msg:
title: Message
type: string
type:
title: Error Type
type: string
securitySchemes:
HTTPBearer:
type: http
scheme: bearer
TokenId:
type: apiKey
in: header
name: TOKEN-ID
TokenKey:
type: apiKey
in: header
name: TOKEN-KEY
tags:
- name: OCR
description: Optical Character Recognition (Trích xuất thông tin)
# - name: folders
# description: |-
# **Constants:**
# ITEM_TYPE_FOLDER = `1`
# ITEM_TYPE_FILE = `2`
# ROOT_FOLDER = `root`
# - name: files
# description: |-
# **Constants:**
# ITEM_TYPE_FOLDER = `1`
# ITEM_TYPE_FILE = `2`
# - name: permissions
# description: |-
# **Constants:**
# PERMISSION_TYPE_OWNER = `1` -> Master rule -> can do anything
# PERMISSION_TYPE_CREATE = `2` -> Create file or folder
# PERMISSION_TYPE_VIEW = `3` -> Public or specific for someone
# PERMISSION_TYPE_UPDATE = `4` -> Rename, update share permission