DocumentReader-web-openapi/rt-status.yml at develop · regulaforensics/DocumentReader-web-openapi · GitHub

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
openapi: 3.0.4
components:
  schemas:
    StatusItem:
      title: "StatusItem"
      type: object
      required:
        - Status
      properties:
        Status:
          $ref: "#/components/schemas/Status"

    Status:
      title: "Status"
      type: object
      required:
        - overallStatus
        - optical
        - portrait
        - rfid
        - stopList
        - detailsOptical
        - age
        - detailsAge
        - mDL
      properties:
        overallStatus:
          allOf:
            - $ref: "./common.yml#/components/schemas/CheckResult"
          description: "Overall checks status. Rootx status"
        optical:
          allOf:
            - $ref: "./common.yml#/components/schemas/CheckResult"
          description: "Overall optical checks combined status"
        portrait:
          allOf:
            - $ref: "./common.yml#/components/schemas/CheckResult"
          description: "Portrait comparison status"
        rfid:
          allOf:
            - $ref: "./common.yml#/components/schemas/CheckResult"
          description: "Overall RFID checks combined status"
        stopList:
          allOf:
            - $ref: "./common.yml#/components/schemas/CheckResult"
          description: "Stop list check status"
        detailsRFID:
          $ref: "#/components/schemas/detailsRFID"
        detailsOptical:
          $ref: "#/components/schemas/detailsOptical"
        age:
          $ref: "./common.yml#/components/schemas/CheckResult"
        detailsAge:
          $ref: "#/components/schemas/DetailsAge"
        mDL:
          $ref: "./common.yml#/components/schemas/CheckResult"

    detailsOptical:
      title: "detailsOptical"
      description: "Details on performed optical checks"
      type: object
      required:
        - overallStatus
        - docType
        - expiry
        - imageQA
        - mrz
        - pagesCount
        - security
        - text
      properties:
        overallStatus:
          allOf:
            - $ref: "./common.yml#/components/schemas/CheckResult"
          description: "Overall optical checks combined status"
        docType:
          allOf:
            - $ref: "./common.yml#/components/schemas/CheckResult"
          description: "Status of document type recognition"
        expiry:
          allOf:
            - $ref: "./common.yml#/components/schemas/CheckResult"
          description: "Status of document expiration"
        imageQA:
          allOf:
            - $ref: "./common.yml#/components/schemas/CheckResult"
          description: "Status of document image quality check"
        mrz:
          allOf:
            - $ref: "./common.yml#/components/schemas/CheckResult"
          description: "Status of document MRZ"
        pagesCount:
          description: "Number of processed pages in the document"
          type: integer
        security:
          allOf:
            - $ref: "./common.yml#/components/schemas/CheckResult"
          description: "Authenticity verification status"
        text:
          allOf:
            - $ref: "./common.yml#/components/schemas/CheckResult"
          description: "Status of text fields analysis"
        vds:
          type: integer

    detailsRFID:
      title: "detailsRFID"
      description: "Details on performed RFID checks"
      type: object
      required:
        - overallStatus
        - AA
        - BAC
        - CA
        - PA
        - PACE
        - TA
      properties:
        overallStatus:
          allOf:
            - $ref: "./common.yml#/components/schemas/CheckResult"
          description: "Overall RFID checks combined status"
        AA:
          allOf:
            - $ref: "./common.yml#/components/schemas/CheckResult"
          description: "Active Authentication status"
        BAC:
          allOf:
            - $ref: "./common.yml#/components/schemas/CheckResult"
          description: "Basic Access Control (BAC) status"
        CA:
          allOf:
            - $ref: "./common.yml#/components/schemas/CheckResult"
          description: "Chip Authentication status"
        PA:
          allOf:
            - $ref: "./common.yml#/components/schemas/CheckResult"
          description: "Passive Authentication status"
        PACE:
          allOf:
            - $ref: "./common.yml#/components/schemas/CheckResult"
          description: "Password Authenticated Connection Establishment (PACE) status"
        TA:
          allOf:
            - $ref: "./common.yml#/components/schemas/CheckResult"
          description: "Terminal Authentication status"

    DetailsAge:
      title: "DetailsAge"
      type: object
      required:
        - threshold
        - overThreshold
        - over18
        - over21
        - over25
        - over65
      properties:
        threshold:
          type: integer
        overThreshold:
          $ref: "./common.yml#/components/schemas/CheckResult"
        over18:
          $ref: "./common.yml#/components/schemas/CheckResult"
        over21:
          $ref: "./common.yml#/components/schemas/CheckResult"
        over25:
          $ref: "./common.yml#/components/schemas/CheckResult"
        over65:
          $ref: "./common.yml#/components/schemas/CheckResult"