@fill-easy/api 1.0.12 → 1.0.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/openapi.d.ts +752 -541
- package/package.json +1 -1
package/dist/openapi.d.ts
CHANGED
|
@@ -34,15 +34,27 @@ export interface paths {
|
|
|
34
34
|
* Authentication
|
|
35
35
|
* @description Initialize user authentication with iAM Smart eID service.
|
|
36
36
|
*
|
|
37
|
+
*
|
|
37
38
|
* **Browser Flow:**
|
|
38
|
-
*
|
|
39
|
+
*
|
|
40
|
+
* Returns a TempAuthToken (store for subsequent calls) and a URL to iAM Smart's QR page.
|
|
41
|
+
* User scans the QR code with their iAM Smart mobile app, then the browser redirects
|
|
42
|
+
* to your specified redirect URL.
|
|
43
|
+
*
|
|
39
44
|
*
|
|
40
45
|
* **Mobile App Flow:**
|
|
41
|
-
*
|
|
46
|
+
*
|
|
47
|
+
* Returns a universal link to launch the iAM Smart authentication app.
|
|
48
|
+
* After authentication, iAM Smart returns an auth_code via GET request to your redirect URI.
|
|
49
|
+
* Your mobile app must handle this redirect URI and pass the auth_code to the token endpoint.
|
|
50
|
+
*
|
|
42
51
|
*
|
|
43
52
|
* **Redirect URI Requirements:**
|
|
44
|
-
*
|
|
53
|
+
*
|
|
54
|
+
* - Browser: Must be an HTTPS URL registered with iAM Smart
|
|
55
|
+
* - Mobile: Must be a universal link or custom scheme (e.g., `your-app://auth`)
|
|
45
56
|
* that your mobile app can handle
|
|
57
|
+
*
|
|
46
58
|
*/
|
|
47
59
|
post: operations["iamSmartAuthentication"];
|
|
48
60
|
delete?: never;
|
|
@@ -64,15 +76,27 @@ export interface paths {
|
|
|
64
76
|
* Form Filling
|
|
65
77
|
* @description Request form filling data from authenticated user.
|
|
66
78
|
*
|
|
67
|
-
* Pass the form details, source, and AuthToken (from Authentication endpoint) to initialize the form filling request.
|
|
68
79
|
*
|
|
69
|
-
*
|
|
80
|
+
* Pass the form details, source, and AuthToken (from Authentication endpoint)
|
|
81
|
+
* to initialize the form filling request.
|
|
82
|
+
*
|
|
83
|
+
*
|
|
84
|
+
* Returns a temporary token to be used with Poll Data endpoint to retrieve
|
|
85
|
+
* the requested form filling details.
|
|
86
|
+
*
|
|
70
87
|
*
|
|
71
88
|
* **Note on Profile Fields:**
|
|
72
|
-
*
|
|
89
|
+
*
|
|
90
|
+
* If you request overlapping fields in both `profileFields` and `formData.formFields`,
|
|
91
|
+
* the `profileFields` takes precedence. You must display a consent page per iAM Smart
|
|
92
|
+
* UI/UX requirements when using profile fields.
|
|
93
|
+
*
|
|
73
94
|
*
|
|
74
95
|
* **Note on Form Fields:**
|
|
75
|
-
*
|
|
96
|
+
*
|
|
97
|
+
* The `formFields` array specifies which detail fields to request from the user.
|
|
98
|
+
* All requested fields will be displayed to the user in their iAM Smart app for approval.
|
|
99
|
+
*
|
|
76
100
|
*/
|
|
77
101
|
post: operations["iamSmartFormFilling"];
|
|
78
102
|
delete?: never;
|
|
@@ -94,12 +118,22 @@ export interface paths {
|
|
|
94
118
|
* Signing
|
|
95
119
|
* @description Request digital signature for a document hash using iAM Smart.
|
|
96
120
|
*
|
|
97
|
-
* Pass the document details (name and SHA-256 hash), source platform, and the authenticated user token to initialize the signing request.
|
|
98
121
|
*
|
|
99
|
-
*
|
|
122
|
+
* Pass the document details (name and SHA-256 hash), source platform, and the
|
|
123
|
+
* authenticated user token to initialize the signing request.
|
|
124
|
+
*
|
|
125
|
+
*
|
|
126
|
+
* Returns a temporary token and HKIC check digits. Use the token with the Poll Data
|
|
127
|
+
* endpoint to retrieve the signature results after the user approves the signing
|
|
128
|
+
* request in their iAM Smart app.
|
|
129
|
+
*
|
|
100
130
|
*
|
|
101
131
|
* **Hash Requirements:**
|
|
102
|
-
*
|
|
132
|
+
*
|
|
133
|
+
* - Must be a SHA-256 hash of the document content
|
|
134
|
+
* - Must be exactly 64 hexadecimal characters
|
|
135
|
+
* - Use SHA256withRSA signature algorithm (default)
|
|
136
|
+
*
|
|
103
137
|
*/
|
|
104
138
|
post: operations["iamSmartHashSigning"];
|
|
105
139
|
delete?: never;
|
|
@@ -121,12 +155,22 @@ export interface paths {
|
|
|
121
155
|
* PDF Signing
|
|
122
156
|
* @description Request PDF document signing with embedded digital signature using iAM Smart.
|
|
123
157
|
*
|
|
124
|
-
* Pass the PDF document details (name and base64-encoded hash), service description, and the authenticated user token to initialize the PDF signing request.
|
|
125
158
|
*
|
|
126
|
-
*
|
|
159
|
+
* Pass the PDF document details (name and base64-encoded hash), service description,
|
|
160
|
+
* and the authenticated user token to initialize the PDF signing request.
|
|
161
|
+
*
|
|
162
|
+
*
|
|
163
|
+
* Returns a temporary token and HKIC check digits. Use the token with the Poll Data
|
|
164
|
+
* endpoint to retrieve the signed PDF after the user approves the signing request
|
|
165
|
+
* in their iAM Smart app.
|
|
166
|
+
*
|
|
127
167
|
*
|
|
128
168
|
* **File Hash Requirements:**
|
|
129
|
-
*
|
|
169
|
+
*
|
|
170
|
+
* - Must be a base64-encoded hash of the PDF file
|
|
171
|
+
* - The signed PDF will be returned with the signature embedded
|
|
172
|
+
* - PDF signature will be visible in PDF readers that support digital signatures
|
|
173
|
+
*
|
|
130
174
|
*/
|
|
131
175
|
post: operations["iamSmartPdfSigning"];
|
|
132
176
|
delete?: never;
|
|
@@ -148,12 +192,23 @@ export interface paths {
|
|
|
148
192
|
* Re-authentication
|
|
149
193
|
* @description Re-authenticate a previously authenticated user to verify their identity again.
|
|
150
194
|
*
|
|
151
|
-
* Pass the authenticated user token and source platform to initialize the re-authentication request. This is useful for high-security operations that require fresh user verification.
|
|
152
195
|
*
|
|
153
|
-
*
|
|
196
|
+
* Pass the authenticated user token and source platform to initialize the
|
|
197
|
+
* re-authentication request. This is useful for high-security operations that
|
|
198
|
+
* require fresh user verification.
|
|
199
|
+
*
|
|
200
|
+
*
|
|
201
|
+
* Returns a temporary token. Use this token with the Poll Data endpoint to
|
|
202
|
+
* retrieve the re-authentication results after the user approves the request
|
|
203
|
+
* in their iAM Smart app.
|
|
204
|
+
*
|
|
154
205
|
*
|
|
155
206
|
* **Use Cases:**
|
|
156
|
-
*
|
|
207
|
+
*
|
|
208
|
+
* - Verify user identity before sensitive operations
|
|
209
|
+
* - Refresh user authentication for extended sessions
|
|
210
|
+
* - Comply with security policies requiring periodic re-verification
|
|
211
|
+
*
|
|
157
212
|
*/
|
|
158
213
|
post: operations["iamSmartReauthentication"];
|
|
159
214
|
delete?: never;
|
|
@@ -191,10 +246,20 @@ export interface paths {
|
|
|
191
246
|
/**
|
|
192
247
|
* Anonymous Form Filling
|
|
193
248
|
* @description Request form filling data without requiring prior authentication.
|
|
194
|
-
*
|
|
195
|
-
*
|
|
249
|
+
*
|
|
250
|
+
* This endpoint combines authentication and form filling in a single flow.
|
|
251
|
+
* Pass the scope, language, source, redirect URL, and form details to initialize
|
|
252
|
+
* the anonymous form filling request.
|
|
253
|
+
*
|
|
254
|
+
* Returns a token and URL. The URL redirects users to iAM Smart where they can
|
|
255
|
+
* authenticate and approve the form filling request in one step.
|
|
256
|
+
*
|
|
196
257
|
* **Note on Profile Fields:**
|
|
197
|
-
*
|
|
258
|
+
*
|
|
259
|
+
* If you request overlapping fields in both `profileFields` and `formData.formFields`,
|
|
260
|
+
* the `profileFields` takes precedence. You must display a consent page per iAM Smart
|
|
261
|
+
* UI/UX requirements when using profile fields.
|
|
262
|
+
*
|
|
198
263
|
*/
|
|
199
264
|
post: operations["iamSmartAnonFormFilling"];
|
|
200
265
|
delete?: never;
|
|
@@ -215,10 +280,19 @@ export interface paths {
|
|
|
215
280
|
/**
|
|
216
281
|
* Anonymous Hash Signing
|
|
217
282
|
* @description Request digital signature for a document hash without requiring prior authentication.
|
|
218
|
-
*
|
|
219
|
-
*
|
|
283
|
+
*
|
|
284
|
+
* This endpoint combines authentication and signing in a single flow.
|
|
285
|
+
* Pass the scope, language, source, redirect URL, and document details to initialize
|
|
286
|
+
* the anonymous signing request.
|
|
287
|
+
*
|
|
288
|
+
* Returns a token, URL, and HKIC check digits. The URL redirects users to iAM Smart
|
|
289
|
+
* where they can authenticate and approve the signing request in one step.
|
|
290
|
+
*
|
|
220
291
|
* **Hash Requirements:**
|
|
221
|
-
*
|
|
292
|
+
*
|
|
293
|
+
* - Must be a SHA-256 hash of the document content
|
|
294
|
+
* - Must be exactly 64 hexadecimal characters
|
|
295
|
+
*
|
|
222
296
|
*/
|
|
223
297
|
post: operations["iamSmartAnonHashSigning"];
|
|
224
298
|
delete?: never;
|
|
@@ -239,9 +313,12 @@ export interface paths {
|
|
|
239
313
|
/**
|
|
240
314
|
* Anonymous PDF Signing
|
|
241
315
|
* @description Request digital signature for a PDF document without requiring prior authentication. This endpoint enables anonymous PDF signing where users can sign documents using their iAM Smart identity without a separate authentication step.
|
|
316
|
+
*
|
|
242
317
|
* The response includes a URL to the iAM Smart QR code page and a temporary token. Users scan the QR code with their iAM Smart mobile app (for desktop) or are redirected to the iAM Smart app (for mobile). After signing, users are redirected to the specified redirect URL.
|
|
243
318
|
*
|
|
319
|
+
*
|
|
244
320
|
* **Use the temporary token** with the polling endpoint to retrieve the signed document once the user completes the signing process.
|
|
321
|
+
*
|
|
245
322
|
*/
|
|
246
323
|
post: operations["iamSmartAnonPdfSigning"];
|
|
247
324
|
delete?: never;
|
|
@@ -267,7 +344,10 @@ export interface paths {
|
|
|
267
344
|
put?: never;
|
|
268
345
|
/**
|
|
269
346
|
* iAM Smart Government Callback
|
|
270
|
-
* @description This endpoint is called by iAM Smart government servers to deliver
|
|
347
|
+
* @description This endpoint is called by iAM Smart government servers to deliver
|
|
348
|
+
* the encrypted results of user authentication, form filling, or signing requests.
|
|
349
|
+
* The content is encrypted and must be decrypted using the CEK (Content Encryption Key).
|
|
350
|
+
*
|
|
271
351
|
*/
|
|
272
352
|
post: operations["govCallback"];
|
|
273
353
|
delete?: never;
|
|
@@ -291,7 +371,10 @@ export interface paths {
|
|
|
291
371
|
};
|
|
292
372
|
/**
|
|
293
373
|
* Redirect
|
|
294
|
-
* @description iAM Smart redirects the user to this endpoint after completing the authentication
|
|
374
|
+
* @description iAM Smart redirects the user to this endpoint after completing the authentication
|
|
375
|
+
* or service request flow. It processes the authorization code or error from
|
|
376
|
+
* iAM Smart and again redirects to the client's specified redirect URL.
|
|
377
|
+
*
|
|
295
378
|
*/
|
|
296
379
|
get: operations["iamSmartRedirect"];
|
|
297
380
|
put?: never;
|
|
@@ -587,15 +670,29 @@ export interface paths {
|
|
|
587
670
|
put?: never;
|
|
588
671
|
/**
|
|
589
672
|
* Request
|
|
590
|
-
* @description Initialize a verification session by passing your callback URLs and the
|
|
673
|
+
* @description Initialize a verification session by passing your callback URLs and the
|
|
674
|
+
* document type.
|
|
675
|
+
*
|
|
591
676
|
*
|
|
592
677
|
* **Browser Flow:**
|
|
593
|
-
*
|
|
678
|
+
*
|
|
679
|
+
* Returns a **launch URL** (open on a **mobile browser**) and a **JWT**
|
|
680
|
+
* **`token`** that you must keep for polling status.
|
|
681
|
+
* After the user completes or cancels the H5 flow, the browser is
|
|
682
|
+
* redirected to your provided callback URL.
|
|
683
|
+
*
|
|
594
684
|
*
|
|
595
685
|
* **Mobile App Flow:**
|
|
596
|
-
* Use the returned **`url`** to open an in-app web view or the system browser on the phone. Use the returned **`token`** later with `/ocr/poll` to check the final decision.
|
|
597
686
|
*
|
|
598
|
-
*
|
|
687
|
+
* Use the returned **`url`** to open an in-app web view or the system
|
|
688
|
+
* browser on the phone.
|
|
689
|
+
* Use the returned **`token`** later with `/ocr/poll` to check the final
|
|
690
|
+
* decision.
|
|
691
|
+
*
|
|
692
|
+
*
|
|
693
|
+
* **Note:** The redirect is **UX-only**; you still need to call `/ocr/poll` with the
|
|
694
|
+
* returned `token` to obtain the authoritative decision.
|
|
695
|
+
*
|
|
599
696
|
*/
|
|
600
697
|
post: operations["request1"];
|
|
601
698
|
delete?: never;
|
|
@@ -615,18 +712,24 @@ export interface paths {
|
|
|
615
712
|
put?: never;
|
|
616
713
|
/**
|
|
617
714
|
* Poll
|
|
618
|
-
* @description Check the status of a verification using the **`token`** returned by
|
|
715
|
+
* @description Check the status of a verification using the **`token`** returned by
|
|
716
|
+
* `/ocr/request`.
|
|
717
|
+
*
|
|
619
718
|
*
|
|
620
719
|
* - Returns **202 Accepted** while the verification is **in progress**.
|
|
621
720
|
*
|
|
622
|
-
* - Returns **200 OK** when the verification is **completed** (Success /
|
|
721
|
+
* - Returns **200 OK** when the verification is **completed** (Success /
|
|
722
|
+
* Failure / Void\*).
|
|
623
723
|
*
|
|
624
724
|
* - Always responds with a concise **`summary`** (no raw payloads needed).
|
|
625
725
|
*
|
|
626
726
|
*
|
|
627
|
-
* Send **only the** **`token`**. It already encapsulates the session
|
|
727
|
+
* Send **only the** **`token`**. It already encapsulates the session
|
|
728
|
+
* identifiers.
|
|
729
|
+
*
|
|
628
730
|
*
|
|
629
731
|
* **Terminal states:** `Success`, `Failure`, or `Void\*`.
|
|
732
|
+
*
|
|
630
733
|
*/
|
|
631
734
|
post: operations["ocrPoll"];
|
|
632
735
|
delete?: never;
|
|
@@ -646,10 +749,29 @@ export interface paths {
|
|
|
646
749
|
put?: never;
|
|
647
750
|
/**
|
|
648
751
|
* Request
|
|
649
|
-
* @description This endpoint
|
|
650
|
-
*
|
|
651
|
-
*
|
|
652
|
-
*
|
|
752
|
+
* @description This endpoint may retrieve the company JSON and document via two methods:
|
|
753
|
+
*
|
|
754
|
+
* #### Automated retrieval using Company ID for supported countries
|
|
755
|
+
*
|
|
756
|
+
* If the country supplied in `countryCode` is in the [AutomatedCountry](/models) Model,
|
|
757
|
+
* and the supplied `companyId` is valid, the system will automatically fetch the document.
|
|
758
|
+
*
|
|
759
|
+
* In order to ensure a valid `companyId`, please validate using `/cra/{countryCode}/search/companies`.
|
|
760
|
+
*
|
|
761
|
+
* In this case, `/cra/poll` will resolve in around 5 minutes.
|
|
762
|
+
*
|
|
763
|
+
* The `/cra/{countryCode}/search/companies` endpoint will not return a
|
|
764
|
+
* companyId for certain countries (empty string). In that case please
|
|
765
|
+
* refer to the information in the section below.
|
|
766
|
+
*
|
|
767
|
+
* #### Manual request for unsupported countries or missing Company ID
|
|
768
|
+
*
|
|
769
|
+
* In case of unsupported countries or missing `companyId`, Fill Easy will manually process the request.
|
|
770
|
+
* Retrieving this information may take longer (up to several days).
|
|
771
|
+
*
|
|
772
|
+
* In any case, the endpoint returns a JWT token that should be used with the
|
|
773
|
+
* `/cra/poll` endpoint to retrieve the document when ready.
|
|
774
|
+
*
|
|
653
775
|
*/
|
|
654
776
|
post: operations["craRequest"];
|
|
655
777
|
delete?: never;
|
|
@@ -658,7 +780,7 @@ export interface paths {
|
|
|
658
780
|
patch?: never;
|
|
659
781
|
trace?: never;
|
|
660
782
|
};
|
|
661
|
-
"/cra/
|
|
783
|
+
"/cra/poll": {
|
|
662
784
|
parameters: {
|
|
663
785
|
query?: never;
|
|
664
786
|
header?: never;
|
|
@@ -668,14 +790,21 @@ export interface paths {
|
|
|
668
790
|
get?: never;
|
|
669
791
|
put?: never;
|
|
670
792
|
/**
|
|
671
|
-
*
|
|
672
|
-
* @description
|
|
793
|
+
* Poll Report
|
|
794
|
+
* @description Poll this endpoint to check the status of a company registry report
|
|
795
|
+
* request. Keep polling until you receive a successful response with the
|
|
796
|
+
* message "CRA ready" and a presigned URL to download the document.
|
|
797
|
+
*
|
|
798
|
+
*
|
|
799
|
+
* If the report is not ready yet, you will receive a 202 status code with
|
|
800
|
+
* the message "Report is pending".
|
|
801
|
+
*
|
|
673
802
|
*
|
|
674
|
-
*
|
|
803
|
+
* Once the report is ready, the endpoint will bill the service and return
|
|
804
|
+
* a presigned URL valid for 1 hour to download the PDF document.
|
|
675
805
|
*
|
|
676
|
-
* Document categories include: Annual Return, Director / Secretary Changes, Charges Filed, Incorporation & Name Change, Liquidation & Deregistration, Registered Office / Address, Share Capital, and Other.
|
|
677
806
|
*/
|
|
678
|
-
post: operations["
|
|
807
|
+
post: operations["craPoll"];
|
|
679
808
|
delete?: never;
|
|
680
809
|
options?: never;
|
|
681
810
|
head?: never;
|
|
@@ -693,9 +822,22 @@ export interface paths {
|
|
|
693
822
|
put?: never;
|
|
694
823
|
/**
|
|
695
824
|
* Search Companies by Name
|
|
696
|
-
* @description This endpoint performs a
|
|
825
|
+
* @description This endpoint performs a search for companies in the respective country's
|
|
826
|
+
* Companies Registry by company name. It supports both English and Chinese
|
|
827
|
+
* company names and returns a list of matching companies.
|
|
828
|
+
*
|
|
829
|
+
* Certain countries are unable to return a companyId - in those cases the
|
|
830
|
+
* idType in the response will be "Unavailable" and companyId will be an
|
|
831
|
+
* empty string.
|
|
832
|
+
*
|
|
833
|
+
* The search will automatically detect if the input is in Chinese
|
|
834
|
+
* characters and adjust the search parameters accordingly.
|
|
835
|
+
*
|
|
836
|
+
* The type of search is dependent on the country:
|
|
837
|
+
* Substring search: KY
|
|
838
|
+
* Tokenized search (e.g. searching "PLE" will not result in "APPLE"): AU, SG
|
|
839
|
+
* Left partial search: HK,
|
|
697
840
|
*
|
|
698
|
-
* The search will automatically detect if the input is in Chinese characters and adjust the search parameters accordingly.
|
|
699
841
|
*/
|
|
700
842
|
post: operations["searchCompanies"];
|
|
701
843
|
delete?: never;
|
|
@@ -704,7 +846,7 @@ export interface paths {
|
|
|
704
846
|
patch?: never;
|
|
705
847
|
trace?: never;
|
|
706
848
|
};
|
|
707
|
-
"/cra/{countryCode}/search/
|
|
849
|
+
"/cra/{countryCode}/search/documents": {
|
|
708
850
|
parameters: {
|
|
709
851
|
query?: never;
|
|
710
852
|
header?: never;
|
|
@@ -714,19 +856,29 @@ export interface paths {
|
|
|
714
856
|
get?: never;
|
|
715
857
|
put?: never;
|
|
716
858
|
/**
|
|
717
|
-
*
|
|
718
|
-
* @description This endpoint
|
|
859
|
+
* Search Company Documents
|
|
860
|
+
* @description This endpoint searches for and returns documents filed by a company with
|
|
861
|
+
* the Companies Registry. Documents are grouped by category (e.g., Annual
|
|
862
|
+
* Return, Director/Secretary Changes, Charges Filed, etc.).
|
|
863
|
+
*
|
|
864
|
+
*
|
|
865
|
+
* You can optionally filter by document type and year to narrow down the
|
|
866
|
+
* results.
|
|
867
|
+
*
|
|
868
|
+
*
|
|
869
|
+
* Document categories include: Annual Return, Director / Secretary
|
|
870
|
+
* Changes, Charges Filed, Incorporation & Name Change, Liquidation &
|
|
871
|
+
* Deregistration, Registered Office / Address, Share Capital, and Other.
|
|
719
872
|
*
|
|
720
|
-
* The information includes company names (English and Chinese), status, type, category, incorporation date, dissolution date (if applicable), and any remarks.
|
|
721
873
|
*/
|
|
722
|
-
post: operations["
|
|
874
|
+
post: operations["searchDocuments"];
|
|
723
875
|
delete?: never;
|
|
724
876
|
options?: never;
|
|
725
877
|
head?: never;
|
|
726
878
|
patch?: never;
|
|
727
879
|
trace?: never;
|
|
728
880
|
};
|
|
729
|
-
"/cra/
|
|
881
|
+
"/cra/{countryCode}/search/company": {
|
|
730
882
|
parameters: {
|
|
731
883
|
query?: never;
|
|
732
884
|
header?: never;
|
|
@@ -736,14 +888,21 @@ export interface paths {
|
|
|
736
888
|
get?: never;
|
|
737
889
|
put?: never;
|
|
738
890
|
/**
|
|
739
|
-
*
|
|
740
|
-
* @description
|
|
891
|
+
* Get Company Base Information
|
|
892
|
+
* @description This endpoint retrieves the base information for a specific company from
|
|
893
|
+
* the Companies Registry using its Company ID.
|
|
741
894
|
*
|
|
742
|
-
*
|
|
895
|
+
* For Hong Kong Companies, the information includes company name (English and Chinese), status,
|
|
896
|
+
* type, category, incorporation date, dissolution date (if applicable),
|
|
897
|
+
* and any remarks.
|
|
898
|
+
*
|
|
899
|
+
* For other countries, the information includes company name, status, category, incorporation date,
|
|
900
|
+
* and other available details such as entity type, registration address, and remarks where
|
|
901
|
+
* applicable. The exact fields returned may vary depending on the data provided by each
|
|
902
|
+
* country’s registry.
|
|
743
903
|
*
|
|
744
|
-
* Once the report is ready, the endpoint will bill the service and return a presigned URL valid for 1 hour to download the PDF document.
|
|
745
904
|
*/
|
|
746
|
-
post: operations["
|
|
905
|
+
post: operations["searchCompany"];
|
|
747
906
|
delete?: never;
|
|
748
907
|
options?: never;
|
|
749
908
|
head?: never;
|
|
@@ -907,6 +1066,11 @@ export interface paths {
|
|
|
907
1066
|
export type webhooks = Record<string, never>;
|
|
908
1067
|
export interface components {
|
|
909
1068
|
schemas: {
|
|
1069
|
+
/**
|
|
1070
|
+
* @description [ISO 3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-2) country code for regions with fully automated support.
|
|
1071
|
+
* @enum {string}
|
|
1072
|
+
*/
|
|
1073
|
+
AutomatedCountry: "HK" | "AU" | "CN";
|
|
910
1074
|
Error: {
|
|
911
1075
|
/**
|
|
912
1076
|
* @description Error message
|
|
@@ -943,36 +1107,16 @@ export interface components {
|
|
|
943
1107
|
*/
|
|
944
1108
|
IamSmartLanguage: "en-US" | "zh-HK" | "zh-CN";
|
|
945
1109
|
/**
|
|
946
|
-
*
|
|
947
|
-
*
|
|
1110
|
+
* @description Redirect URI after user authorization.
|
|
1111
|
+
*
|
|
1112
|
+
* Browser: https URL to your website.
|
|
1113
|
+
*
|
|
1114
|
+
* Mobile: Universal link (your-app://) or app scheme.
|
|
1115
|
+
*
|
|
948
1116
|
* @example https://www.yourwebsite.com/callback
|
|
1117
|
+
* @example com.filleasy.app
|
|
949
1118
|
*/
|
|
950
1119
|
RedirectUri: string;
|
|
951
|
-
/** @example {
|
|
952
|
-
* "lang": "en-US",
|
|
953
|
-
* "redirect": "fill-easy://auth",
|
|
954
|
-
* "source": "android"
|
|
955
|
-
* } */
|
|
956
|
-
IamSmartAuthRequest: {
|
|
957
|
-
lang?: components["schemas"]["IamSmartLanguage"];
|
|
958
|
-
source: components["schemas"]["IamSmartSource"];
|
|
959
|
-
redirect: components["schemas"]["RedirectUri"];
|
|
960
|
-
scope?: components["schemas"]["IamSmartScope"];
|
|
961
|
-
};
|
|
962
|
-
/** @example {
|
|
963
|
-
* "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIn0.dozjgNryP4J3jVmNHl0w5N_XgL0n3I9PlFUP0THsR8U",
|
|
964
|
-
* "url": "https://hk.gov.iamsmart.testapp://auth?clientID=7688ff3048ff49b2b64578cf40867d1d&responseType=code&source=App_Link&redirectURI=fill-easy%3A%2F%2Fauth&scope=eidapi_auth%20eidapi_formFilling%20eidapi_sign%20eidapi_fr&lang=en-US&state=0aZwsZfcCxCJgRY9AHG6c0un3UZotMDjNqSF&brokerPage=true"
|
|
965
|
-
* } */
|
|
966
|
-
IamSmartAuthResponse: {
|
|
967
|
-
/** @description Store this token for subsequent API calls */
|
|
968
|
-
token: components["schemas"]["Token"];
|
|
969
|
-
/**
|
|
970
|
-
* Format: uri
|
|
971
|
-
* @description Browser: URL to iAM Smart QR page for scanning. Mobile: Universal link to launch iAM Smart app.
|
|
972
|
-
* @example https://hk.gov.iamsmart.testapp://auth?clientID=...
|
|
973
|
-
*/
|
|
974
|
-
url: string;
|
|
975
|
-
};
|
|
976
1120
|
FormData: {
|
|
977
1121
|
/**
|
|
978
1122
|
* @description Form title displayed to user in iAM Smart app
|
|
@@ -1001,7 +1145,10 @@ export interface components {
|
|
|
1001
1145
|
formFields?: ("idNo" | "enName" | "chName" | "gender" | "prefix" | "maritalStatus" | "homeTelNumber" | "officeTelNumber" | "mobileNumber" | "emailAddress" | "residentialAddress" | "postalAddress" | "educationLevel" | "addressDocInfo" | "addressDocFile")[];
|
|
1002
1146
|
};
|
|
1003
1147
|
/**
|
|
1004
|
-
* @description Mandatorily obtain specific profile fields.
|
|
1148
|
+
* @description Mandatorily obtain specific profile fields.
|
|
1149
|
+
* Note: You must display a consent page per iAM Smart UI/UX requirements when using these fields.
|
|
1150
|
+
* If fields overlap between `profileFields` and `formData.formFields`, `profileFields` takes precedence.
|
|
1151
|
+
*
|
|
1005
1152
|
* @example [
|
|
1006
1153
|
* "idNo",
|
|
1007
1154
|
* "enName",
|
|
@@ -1010,281 +1157,17 @@ export interface components {
|
|
|
1010
1157
|
* ]
|
|
1011
1158
|
*/
|
|
1012
1159
|
ProfileFields: ("idNo" | "enName" | "chName" | "birthDate" | "gender")[];
|
|
1013
|
-
/** @example {
|
|
1014
|
-
* "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIn0.dozjgNryP4J3jVmNHl0w5N_XgL0n3I9PlFUP0THsR8U",
|
|
1015
|
-
* "source": "PC_Browser",
|
|
1016
|
-
* "profileFields": [
|
|
1017
|
-
* "idNo",
|
|
1018
|
-
* "enName",
|
|
1019
|
-
* "chName",
|
|
1020
|
-
* "gender"
|
|
1021
|
-
* ],
|
|
1022
|
-
* "formData": {
|
|
1023
|
-
* "formName": "Fill Easy Contact Form",
|
|
1024
|
-
* "formNum": "FE_001",
|
|
1025
|
-
* "formDesc": "Contact Fill Easy",
|
|
1026
|
-
* "formFields": [
|
|
1027
|
-
* "prefix",
|
|
1028
|
-
* "maritalStatus",
|
|
1029
|
-
* "mobileNumber",
|
|
1030
|
-
* "emailAddress",
|
|
1031
|
-
* "residentialAddress"
|
|
1032
|
-
* ]
|
|
1033
|
-
* }
|
|
1034
|
-
* } */
|
|
1035
|
-
IamSmartFormFillingRequest: {
|
|
1036
|
-
/** @description The authenticated user token from the Authentication workflow */
|
|
1037
|
-
token: components["schemas"]["Token"];
|
|
1038
|
-
source: components["schemas"]["IamSmartSource"];
|
|
1039
|
-
profileFields?: components["schemas"]["ProfileFields"];
|
|
1040
|
-
formData: components["schemas"]["FormData"];
|
|
1041
|
-
};
|
|
1042
|
-
/** @example {
|
|
1043
|
-
* "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIn0.dozjgNryP4J3jVmNHl0w5N_XgL0n3I9PlFUP0THsR8U"
|
|
1044
|
-
* } */
|
|
1045
|
-
IamSmartFormFillingResponse: {
|
|
1046
|
-
/** @description Use this token in Poll Data to retrieve form filling results */
|
|
1047
|
-
token: components["schemas"]["Token"];
|
|
1048
|
-
};
|
|
1049
|
-
/** @example {
|
|
1050
|
-
* "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIn0.dozjgNryP4J3jVmNHl0w5N_XgL0n3I9PlFUP0THsR8U",
|
|
1051
|
-
* "source": "PC_Browser",
|
|
1052
|
-
* "name": "Fill Easy Contact Form",
|
|
1053
|
-
* "hash": "af8b6f626242f214be360fa7d412e42dacb2f48bc11bb089019a912930019300",
|
|
1054
|
-
* "service": "Digital Signing of Application Form"
|
|
1055
|
-
* } */
|
|
1056
|
-
IamSmartHashSignRequest: {
|
|
1057
|
-
/** @description The authenticated user token from the Authentication workflow */
|
|
1058
|
-
token: components["schemas"]["Token"];
|
|
1059
|
-
source: components["schemas"]["IamSmartSource"];
|
|
1060
|
-
/**
|
|
1061
|
-
* @description Document title displayed to user
|
|
1062
|
-
* @example Sample Credit Card Application Form
|
|
1063
|
-
*/
|
|
1064
|
-
name: string;
|
|
1065
|
-
/**
|
|
1066
|
-
* @description SHA-256 hash of the document file's content (64 hex characters)
|
|
1067
|
-
* @example af8b6f626242f214be360fa7d412e42dacb2f48bc11bb089019a912930019300
|
|
1068
|
-
*/
|
|
1069
|
-
hash: string;
|
|
1070
|
-
/**
|
|
1071
|
-
* @description Service description to be displayed to user
|
|
1072
|
-
* @example Digital Signing of Application Form
|
|
1073
|
-
*/
|
|
1074
|
-
service?: string;
|
|
1075
|
-
/**
|
|
1076
|
-
* @description Organisation name
|
|
1077
|
-
* @example Fill Easy Limited
|
|
1078
|
-
*/
|
|
1079
|
-
organisation?: string;
|
|
1080
|
-
};
|
|
1081
|
-
/** @example {
|
|
1082
|
-
* "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIn0.dozjgNryP4J3jVmNHl0w5N_XgL0n3I9PlFUP0THsR8U",
|
|
1083
|
-
* "hkic": 1524
|
|
1084
|
-
* } */
|
|
1085
|
-
IamSmartHashSignResponse: {
|
|
1086
|
-
/** @description Use this token in Poll Data to retrieve signing results */
|
|
1087
|
-
token: components["schemas"]["Token"];
|
|
1088
|
-
/**
|
|
1089
|
-
* @description HKIC check digits for verification
|
|
1090
|
-
* @example 1524
|
|
1091
|
-
*/
|
|
1092
|
-
hkic: number;
|
|
1093
|
-
};
|
|
1094
|
-
/** @example {
|
|
1095
|
-
* "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIn0.dozjgNryP4J3jVmNHl0w5N_XgL0n3I9PlFUP0THsR8U",
|
|
1096
|
-
* "source": "PC_Browser",
|
|
1097
|
-
* "name": "Landsurvey Purchase Form",
|
|
1098
|
-
* "fileHash": "R3fJTKFPwkRw019fLk+L19y91DVgI9hy/G7u6+YiECk=",
|
|
1099
|
-
* "service": "Digital PDF Signing Powered by Fill Easy"
|
|
1100
|
-
* } */
|
|
1101
|
-
IamSmartPdfSignRequest: {
|
|
1102
|
-
/** @description The authenticated user token from the Authentication workflow */
|
|
1103
|
-
token: components["schemas"]["Token"];
|
|
1104
|
-
source: components["schemas"]["IamSmartSource"];
|
|
1105
|
-
/**
|
|
1106
|
-
* @description Document title displayed to user
|
|
1107
|
-
* @example Landsurvey Purchase Form
|
|
1108
|
-
*/
|
|
1109
|
-
name: string;
|
|
1110
|
-
/**
|
|
1111
|
-
* Format: byte
|
|
1112
|
-
* @description Base64-encoded hash of the PDF file
|
|
1113
|
-
* @example R3fJTKFPwkRw019fLk+L19y91DVgI9hy/G7u6+YiECk=
|
|
1114
|
-
*/
|
|
1115
|
-
fileHash: string;
|
|
1116
|
-
/**
|
|
1117
|
-
* @description Service description to be displayed to user
|
|
1118
|
-
* @example Digital PDF Signing Powered by Fill Easy
|
|
1119
|
-
*/
|
|
1120
|
-
service: string;
|
|
1121
|
-
/** @description Hash of HKIC for verification (optional) */
|
|
1122
|
-
hkicHash?: string;
|
|
1123
|
-
/** @description Department name (optional) */
|
|
1124
|
-
department?: string;
|
|
1125
|
-
};
|
|
1126
|
-
/** @example {
|
|
1127
|
-
* "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIn0.dozjgNryP4J3jVmNHl0w5N_XgL0n3I9PlFUP0THsR8U",
|
|
1128
|
-
* "hkic": 4303
|
|
1129
|
-
* } */
|
|
1130
|
-
IamSmartPdfSignResponse: {
|
|
1131
|
-
/** @description Use this token in Poll Data to retrieve PDF signing results */
|
|
1132
|
-
token: components["schemas"]["Token"];
|
|
1133
|
-
/**
|
|
1134
|
-
* @description HKIC check digits for verification
|
|
1135
|
-
* @example 4303
|
|
1136
|
-
*/
|
|
1137
|
-
hkic: number;
|
|
1138
|
-
};
|
|
1139
|
-
/** @example {
|
|
1140
|
-
* "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIn0.dozjgNryP4J3jVmNHl0w5N_XgL0n3I9PlFUP0THsR8U",
|
|
1141
|
-
* "source": "PC_Browser"
|
|
1142
|
-
* } */
|
|
1143
|
-
IamSmartReauthRequest: {
|
|
1144
|
-
/** @description The authenticated user token to re-validate */
|
|
1145
|
-
token: components["schemas"]["Token"];
|
|
1146
|
-
source: components["schemas"]["IamSmartSource"];
|
|
1147
|
-
};
|
|
1148
|
-
/** @example {
|
|
1149
|
-
* "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIn0.dozjgNryP4J3jVmNHl0w5N_XgL0n3I9PlFUP0THsR8U"
|
|
1150
|
-
* } */
|
|
1151
|
-
IamSmartReauthResponse: {
|
|
1152
|
-
/** @description Use this token in Poll Data to check re-authentication status */
|
|
1153
|
-
token: components["schemas"]["Token"];
|
|
1154
|
-
};
|
|
1155
|
-
/** @example {
|
|
1156
|
-
* "lang": "en-US",
|
|
1157
|
-
* "source": "android",
|
|
1158
|
-
* "redirect": "fill-easy://formfilling",
|
|
1159
|
-
* "profileFields": [
|
|
1160
|
-
* "idNo",
|
|
1161
|
-
* "enName"
|
|
1162
|
-
* ],
|
|
1163
|
-
* "formData": {
|
|
1164
|
-
* "formName": "Anonymous Form",
|
|
1165
|
-
* "formNum": "AF_001",
|
|
1166
|
-
* "formDesc": "Anonymous form filling request",
|
|
1167
|
-
* "formFields": [
|
|
1168
|
-
* "mobileNumber",
|
|
1169
|
-
* "emailAddress"
|
|
1170
|
-
* ]
|
|
1171
|
-
* }
|
|
1172
|
-
* } */
|
|
1173
|
-
IamSmartAnonFormFillingRequest: {
|
|
1174
|
-
lang?: components["schemas"]["IamSmartLanguage"];
|
|
1175
|
-
source: components["schemas"]["IamSmartSource"];
|
|
1176
|
-
redirect: components["schemas"]["RedirectUri"];
|
|
1177
|
-
scope?: components["schemas"]["IamSmartScope"];
|
|
1178
|
-
profileFields?: components["schemas"]["ProfileFields"];
|
|
1179
|
-
formData?: components["schemas"]["FormData"];
|
|
1180
|
-
/**
|
|
1181
|
-
* @description Android activity class (Android only)
|
|
1182
|
-
* @example com.filleasy.app.MainActivity
|
|
1183
|
-
*/
|
|
1184
|
-
activityClass?: string;
|
|
1185
|
-
/** @description Additional activity parameters (Android only) */
|
|
1186
|
-
activityParams?: string;
|
|
1187
|
-
};
|
|
1188
|
-
/** @example {
|
|
1189
|
-
* "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIn0.dozjgNryP4J3jVmNHl0w5N_XgL0n3I9PlFUP0THsR8U",
|
|
1190
|
-
* "url": "https://apigw-isit.staging-eid.gov.hk/..."
|
|
1191
|
-
* } */
|
|
1192
|
-
IamSmartAnonFormFillingResponse: {
|
|
1193
|
-
token: components["schemas"]["Token"];
|
|
1194
|
-
/**
|
|
1195
|
-
* Format: uri
|
|
1196
|
-
* @description URL to redirect user for anonymous form filling
|
|
1197
|
-
*/
|
|
1198
|
-
url: string;
|
|
1199
|
-
};
|
|
1200
|
-
/** @example {
|
|
1201
|
-
* "lang": "en-US",
|
|
1202
|
-
* "source": "android",
|
|
1203
|
-
* "redirect": "fill-easy://signing",
|
|
1204
|
-
* "name": "Document to Sign",
|
|
1205
|
-
* "fileHash": "af8b6f626242f214be360fa7d412e42dacb2f48bc11bb089019a912930019300",
|
|
1206
|
-
* "hkicHash": "1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
|
|
1207
|
-
* "service": "Anonymous Digital Signing"
|
|
1208
|
-
* } */
|
|
1209
|
-
IamSmartAnonHashSignRequest: {
|
|
1210
|
-
lang?: components["schemas"]["IamSmartLanguage"];
|
|
1211
|
-
source: components["schemas"]["IamSmartSource"];
|
|
1212
|
-
redirect: components["schemas"]["RedirectUri"];
|
|
1213
|
-
scope?: components["schemas"]["IamSmartScope"];
|
|
1214
|
-
/** @description Document title */
|
|
1215
|
-
name: string;
|
|
1216
|
-
/** @description SHA-256 hash of document (64 hex characters) */
|
|
1217
|
-
fileHash: string;
|
|
1218
|
-
/** @description Hash of HKIC for verification */
|
|
1219
|
-
hkicHash?: string;
|
|
1220
|
-
/** @description Service description */
|
|
1221
|
-
service: string;
|
|
1222
|
-
/** @description Organisation name */
|
|
1223
|
-
organisation?: string;
|
|
1224
|
-
};
|
|
1225
|
-
/** @example {
|
|
1226
|
-
* "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIn0.dozjgNryP4J3jVmNHl0w5N_XgL0n3I9PlFUP0THsR8U",
|
|
1227
|
-
* "url": "https://apigw-isit.staging-eid.gov.hk/...",
|
|
1228
|
-
* "hkic": 1524
|
|
1229
|
-
* } */
|
|
1230
|
-
IamSmartAnonHashSignResponse: {
|
|
1231
|
-
token: components["schemas"]["Token"];
|
|
1232
|
-
/**
|
|
1233
|
-
* Format: uri
|
|
1234
|
-
* @description URL to redirect user for anonymous signing
|
|
1235
|
-
*/
|
|
1236
|
-
url: string;
|
|
1237
|
-
/** @description HKIC check digits */
|
|
1238
|
-
hkic: number;
|
|
1239
|
-
};
|
|
1240
|
-
/** @example {
|
|
1241
|
-
* "lang": "en-US",
|
|
1242
|
-
* "source": "PC_Browser",
|
|
1243
|
-
* "redirect": "https://yourapp.com/callback",
|
|
1244
|
-
* "name": "PDF Document",
|
|
1245
|
-
* "fileHash": "R3fJTKFPwkRw019fLk+L19y91DVgI9hy/G7u6+YiECk=",
|
|
1246
|
-
* "hkicHash": "1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
|
|
1247
|
-
* "service": "Anonymous PDF Signing"
|
|
1248
|
-
* } */
|
|
1249
|
-
IamSmartAnonPdfSignRequest: {
|
|
1250
|
-
lang?: components["schemas"]["IamSmartLanguage"];
|
|
1251
|
-
source: components["schemas"]["IamSmartSource"];
|
|
1252
|
-
redirect: components["schemas"]["RedirectUri"];
|
|
1253
|
-
scope?: components["schemas"]["IamSmartScope"];
|
|
1254
|
-
/** @description PDF document title */
|
|
1255
|
-
name: string;
|
|
1256
|
-
/**
|
|
1257
|
-
* Format: byte
|
|
1258
|
-
* @description Base64-encoded hash of PDF
|
|
1259
|
-
*/
|
|
1260
|
-
fileHash: string;
|
|
1261
|
-
/** @description Hash of HKIC for verification */
|
|
1262
|
-
hkicHash?: string;
|
|
1263
|
-
/** @description Service description */
|
|
1264
|
-
service: string;
|
|
1265
|
-
};
|
|
1266
|
-
/** @example {
|
|
1267
|
-
* "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIn0.dozjgNryP4J3jVmNHl0w5N_XgL0n3I9PlFUP0THsR8U",
|
|
1268
|
-
* "url": "https://apigw-isit.staging-eid.gov.hk/...",
|
|
1269
|
-
* "hkic": 4303
|
|
1270
|
-
* } */
|
|
1271
|
-
IamSmartAnonPdfSignResponse: {
|
|
1272
|
-
token: components["schemas"]["Token"];
|
|
1273
|
-
/** Format: uri */
|
|
1274
|
-
url: string;
|
|
1275
|
-
hkic: number;
|
|
1276
|
-
};
|
|
1277
1160
|
GlobalSESFields: {
|
|
1278
|
-
/** @description Email
|
|
1161
|
+
/** @description Email participants of the CorpVerify e-mail thread */
|
|
1279
1162
|
emailList?: string[];
|
|
1280
|
-
/** @description
|
|
1163
|
+
/** @description Client's reference ID (for invoicing and tracking) */
|
|
1281
1164
|
externalRefId?: string;
|
|
1282
1165
|
/** @description Additional request details */
|
|
1283
1166
|
requestDetails?: string;
|
|
1284
1167
|
/** @description Request express processing */
|
|
1285
1168
|
express?: boolean;
|
|
1286
1169
|
};
|
|
1287
|
-
|
|
1170
|
+
Company: {
|
|
1288
1171
|
/** @description Company ID (use this value in other endpoints) */
|
|
1289
1172
|
companyId: string;
|
|
1290
1173
|
/** @description Type of company identifier (e.g., "BRN" for Hong Kong, "ACN" for Australia) */
|
|
@@ -1310,13 +1193,6 @@ export interface components {
|
|
|
1310
1193
|
/** @description Registered address of the company */
|
|
1311
1194
|
address?: string;
|
|
1312
1195
|
};
|
|
1313
|
-
poll: {
|
|
1314
|
-
/**
|
|
1315
|
-
* @description The JWT token obtained from the previous request.
|
|
1316
|
-
* @example {{token}}
|
|
1317
|
-
*/
|
|
1318
|
-
token: string;
|
|
1319
|
-
};
|
|
1320
1196
|
};
|
|
1321
1197
|
responses: {
|
|
1322
1198
|
/** @description Unauthorized - Token is missing, invalid, or expired */
|
|
@@ -1354,13 +1230,7 @@ export interface components {
|
|
|
1354
1230
|
*/
|
|
1355
1231
|
IamSmartServicePath: "auth" | "formfilling" | "formfilling-anonymous" | "signing" | "signing-anonymous" | "pdf-signing" | "pdf-signing-anonymous" | "reauth" | "ccic";
|
|
1356
1232
|
};
|
|
1357
|
-
requestBodies:
|
|
1358
|
-
poll: {
|
|
1359
|
-
content: {
|
|
1360
|
-
"application/json": components["schemas"]["poll"];
|
|
1361
|
-
};
|
|
1362
|
-
};
|
|
1363
|
-
};
|
|
1233
|
+
requestBodies: never;
|
|
1364
1234
|
headers: never;
|
|
1365
1235
|
pathItems: never;
|
|
1366
1236
|
}
|
|
@@ -1393,17 +1263,35 @@ export interface operations {
|
|
|
1393
1263
|
};
|
|
1394
1264
|
requestBody: {
|
|
1395
1265
|
content: {
|
|
1396
|
-
"application/json":
|
|
1266
|
+
"application/json": {
|
|
1267
|
+
lang?: components["schemas"]["IamSmartLanguage"];
|
|
1268
|
+
source: components["schemas"]["IamSmartSource"];
|
|
1269
|
+
redirect: components["schemas"]["RedirectUri"];
|
|
1270
|
+
scope?: components["schemas"]["IamSmartScope"];
|
|
1271
|
+
};
|
|
1397
1272
|
};
|
|
1398
1273
|
};
|
|
1399
1274
|
responses: {
|
|
1400
|
-
/** @description Authentication request successfully initialized.
|
|
1275
|
+
/** @description Authentication request successfully initialized.
|
|
1276
|
+
* Store the token for subsequent API calls.
|
|
1277
|
+
* */
|
|
1401
1278
|
200: {
|
|
1402
1279
|
headers: {
|
|
1403
1280
|
[name: string]: unknown;
|
|
1404
1281
|
};
|
|
1405
1282
|
content: {
|
|
1406
|
-
"application/json":
|
|
1283
|
+
"application/json": {
|
|
1284
|
+
/** @description Store this token for subsequent API calls */
|
|
1285
|
+
token: components["schemas"]["Token"];
|
|
1286
|
+
/**
|
|
1287
|
+
* Format: uri
|
|
1288
|
+
* @description Browser: URL to iAM Smart QR page for scanning.
|
|
1289
|
+
* Mobile: Universal link to launch iAM Smart app.
|
|
1290
|
+
*
|
|
1291
|
+
* @example https://hk.gov.iamsmart.testapp://auth?clientID=...
|
|
1292
|
+
*/
|
|
1293
|
+
url: string;
|
|
1294
|
+
};
|
|
1407
1295
|
};
|
|
1408
1296
|
};
|
|
1409
1297
|
400: components["responses"]["BadRequest"];
|
|
@@ -1420,17 +1308,28 @@ export interface operations {
|
|
|
1420
1308
|
};
|
|
1421
1309
|
requestBody: {
|
|
1422
1310
|
content: {
|
|
1423
|
-
"application/json":
|
|
1311
|
+
"application/json": {
|
|
1312
|
+
/** @description The authenticated user token from the Authentication workflow */
|
|
1313
|
+
token: components["schemas"]["Token"];
|
|
1314
|
+
source: components["schemas"]["IamSmartSource"];
|
|
1315
|
+
profileFields?: components["schemas"]["ProfileFields"];
|
|
1316
|
+
formData: components["schemas"]["FormData"];
|
|
1317
|
+
};
|
|
1424
1318
|
};
|
|
1425
1319
|
};
|
|
1426
1320
|
responses: {
|
|
1427
|
-
/** @description Form filling request successfully initialized.
|
|
1321
|
+
/** @description Form filling request successfully initialized.
|
|
1322
|
+
* Poll with the returned token to retrieve form data when ready.
|
|
1323
|
+
* */
|
|
1428
1324
|
200: {
|
|
1429
1325
|
headers: {
|
|
1430
1326
|
[name: string]: unknown;
|
|
1431
1327
|
};
|
|
1432
1328
|
content: {
|
|
1433
|
-
"application/json":
|
|
1329
|
+
"application/json": {
|
|
1330
|
+
/** @description Use this token in Poll Data to retrieve form filling results */
|
|
1331
|
+
token: components["schemas"]["Token"];
|
|
1332
|
+
};
|
|
1434
1333
|
};
|
|
1435
1334
|
};
|
|
1436
1335
|
400: components["responses"]["BadRequest"];
|
|
@@ -1447,17 +1346,51 @@ export interface operations {
|
|
|
1447
1346
|
};
|
|
1448
1347
|
requestBody: {
|
|
1449
1348
|
content: {
|
|
1450
|
-
"application/json":
|
|
1349
|
+
"application/json": {
|
|
1350
|
+
/** @description The authenticated user token from the Authentication workflow */
|
|
1351
|
+
token: components["schemas"]["Token"];
|
|
1352
|
+
source: components["schemas"]["IamSmartSource"];
|
|
1353
|
+
/**
|
|
1354
|
+
* @description Document title displayed to user
|
|
1355
|
+
* @example Sample Credit Card Application Form
|
|
1356
|
+
*/
|
|
1357
|
+
name: string;
|
|
1358
|
+
/**
|
|
1359
|
+
* @description SHA-256 hash of the document file's content (64 hex characters)
|
|
1360
|
+
* @example af8b6f626242f214be360fa7d412e42dacb2f48bc11bb089019a912930019300
|
|
1361
|
+
*/
|
|
1362
|
+
hash: string;
|
|
1363
|
+
/**
|
|
1364
|
+
* @description Service description to be displayed to user
|
|
1365
|
+
* @example Digital Signing of Application Form
|
|
1366
|
+
*/
|
|
1367
|
+
service?: string;
|
|
1368
|
+
/**
|
|
1369
|
+
* @description Organisation name
|
|
1370
|
+
* @example Fill Easy Limited
|
|
1371
|
+
*/
|
|
1372
|
+
organisation?: string;
|
|
1373
|
+
};
|
|
1451
1374
|
};
|
|
1452
1375
|
};
|
|
1453
1376
|
responses: {
|
|
1454
|
-
/** @description Signing request successfully initialized.
|
|
1377
|
+
/** @description Signing request successfully initialized.
|
|
1378
|
+
* Poll with the returned token to get signature results.
|
|
1379
|
+
* */
|
|
1455
1380
|
200: {
|
|
1456
1381
|
headers: {
|
|
1457
1382
|
[name: string]: unknown;
|
|
1458
1383
|
};
|
|
1459
1384
|
content: {
|
|
1460
|
-
"application/json":
|
|
1385
|
+
"application/json": {
|
|
1386
|
+
/** @description Use this token in Poll Data to retrieve signing results */
|
|
1387
|
+
token: components["schemas"]["Token"];
|
|
1388
|
+
/**
|
|
1389
|
+
* @description HKIC check digits for verification
|
|
1390
|
+
* @example 1524
|
|
1391
|
+
*/
|
|
1392
|
+
hkic: number;
|
|
1393
|
+
};
|
|
1461
1394
|
};
|
|
1462
1395
|
};
|
|
1463
1396
|
400: components["responses"]["BadRequest"];
|
|
@@ -1474,17 +1407,51 @@ export interface operations {
|
|
|
1474
1407
|
};
|
|
1475
1408
|
requestBody: {
|
|
1476
1409
|
content: {
|
|
1477
|
-
"application/json":
|
|
1410
|
+
"application/json": {
|
|
1411
|
+
/** @description The authenticated user token from the Authentication workflow */
|
|
1412
|
+
token: components["schemas"]["Token"];
|
|
1413
|
+
source: components["schemas"]["IamSmartSource"];
|
|
1414
|
+
/**
|
|
1415
|
+
* @description Document title displayed to user
|
|
1416
|
+
* @example Landsurvey Purchase Form
|
|
1417
|
+
*/
|
|
1418
|
+
name: string;
|
|
1419
|
+
/**
|
|
1420
|
+
* Format: byte
|
|
1421
|
+
* @description Base64-encoded hash of the PDF file
|
|
1422
|
+
* @example R3fJTKFPwkRw019fLk+L19y91DVgI9hy/G7u6+YiECk=
|
|
1423
|
+
*/
|
|
1424
|
+
fileHash: string;
|
|
1425
|
+
/**
|
|
1426
|
+
* @description Service description to be displayed to user
|
|
1427
|
+
* @example Digital PDF Signing Powered by Fill Easy
|
|
1428
|
+
*/
|
|
1429
|
+
service: string;
|
|
1430
|
+
/** @description Hash of HKIC for verification (optional) */
|
|
1431
|
+
hkicHash?: string;
|
|
1432
|
+
/** @description Department name (optional) */
|
|
1433
|
+
department?: string;
|
|
1434
|
+
};
|
|
1478
1435
|
};
|
|
1479
1436
|
};
|
|
1480
1437
|
responses: {
|
|
1481
|
-
/** @description PDF signing request successfully initialized.
|
|
1438
|
+
/** @description PDF signing request successfully initialized.
|
|
1439
|
+
* Poll with the returned token to retrieve signed PDF when ready.
|
|
1440
|
+
* */
|
|
1482
1441
|
200: {
|
|
1483
1442
|
headers: {
|
|
1484
1443
|
[name: string]: unknown;
|
|
1485
1444
|
};
|
|
1486
1445
|
content: {
|
|
1487
|
-
"application/json":
|
|
1446
|
+
"application/json": {
|
|
1447
|
+
/** @description Use this token in Poll Data to retrieve PDF signing results */
|
|
1448
|
+
token: components["schemas"]["Token"];
|
|
1449
|
+
/**
|
|
1450
|
+
* @description HKIC check digits for verification
|
|
1451
|
+
* @example 4303
|
|
1452
|
+
*/
|
|
1453
|
+
hkic: number;
|
|
1454
|
+
};
|
|
1488
1455
|
};
|
|
1489
1456
|
};
|
|
1490
1457
|
400: components["responses"]["BadRequest"];
|
|
@@ -1501,17 +1468,26 @@ export interface operations {
|
|
|
1501
1468
|
};
|
|
1502
1469
|
requestBody: {
|
|
1503
1470
|
content: {
|
|
1504
|
-
"application/json":
|
|
1471
|
+
"application/json": {
|
|
1472
|
+
/** @description The authenticated user token to re-validate */
|
|
1473
|
+
token: components["schemas"]["Token"];
|
|
1474
|
+
source: components["schemas"]["IamSmartSource"];
|
|
1475
|
+
};
|
|
1505
1476
|
};
|
|
1506
1477
|
};
|
|
1507
1478
|
responses: {
|
|
1508
|
-
/** @description Re-authentication request successfully initialized.
|
|
1479
|
+
/** @description Re-authentication request successfully initialized.
|
|
1480
|
+
* Poll with the returned token to get re-authentication results.
|
|
1481
|
+
* */
|
|
1509
1482
|
200: {
|
|
1510
1483
|
headers: {
|
|
1511
1484
|
[name: string]: unknown;
|
|
1512
1485
|
};
|
|
1513
1486
|
content: {
|
|
1514
|
-
"application/json":
|
|
1487
|
+
"application/json": {
|
|
1488
|
+
/** @description Use this token in Poll Data to check re-authentication status */
|
|
1489
|
+
token: components["schemas"]["Token"];
|
|
1490
|
+
};
|
|
1515
1491
|
};
|
|
1516
1492
|
};
|
|
1517
1493
|
400: components["responses"]["BadRequest"];
|
|
@@ -1546,17 +1522,40 @@ export interface operations {
|
|
|
1546
1522
|
};
|
|
1547
1523
|
requestBody: {
|
|
1548
1524
|
content: {
|
|
1549
|
-
"application/json":
|
|
1525
|
+
"application/json": {
|
|
1526
|
+
lang?: components["schemas"]["IamSmartLanguage"];
|
|
1527
|
+
source: components["schemas"]["IamSmartSource"];
|
|
1528
|
+
redirect: components["schemas"]["RedirectUri"];
|
|
1529
|
+
scope?: components["schemas"]["IamSmartScope"];
|
|
1530
|
+
profileFields?: components["schemas"]["ProfileFields"];
|
|
1531
|
+
formData?: components["schemas"]["FormData"];
|
|
1532
|
+
/**
|
|
1533
|
+
* @description Android activity class (required if source is android)
|
|
1534
|
+
* @example com.filleasy.app.MainActivity
|
|
1535
|
+
*/
|
|
1536
|
+
activityClass?: string | null;
|
|
1537
|
+
/** @description Additional activity parameters (optional if source is android) */
|
|
1538
|
+
activityParams?: string | null;
|
|
1539
|
+
};
|
|
1550
1540
|
};
|
|
1551
1541
|
};
|
|
1552
1542
|
responses: {
|
|
1553
|
-
/** @description Anonymous form filling request successfully initialized.
|
|
1543
|
+
/** @description Anonymous form filling request successfully initialized.
|
|
1544
|
+
* Redirect user to the URL, then poll with the token to retrieve form data.
|
|
1545
|
+
* */
|
|
1554
1546
|
200: {
|
|
1555
1547
|
headers: {
|
|
1556
1548
|
[name: string]: unknown;
|
|
1557
1549
|
};
|
|
1558
1550
|
content: {
|
|
1559
|
-
"application/json":
|
|
1551
|
+
"application/json": {
|
|
1552
|
+
token: components["schemas"]["Token"];
|
|
1553
|
+
/**
|
|
1554
|
+
* Format: uri
|
|
1555
|
+
* @description URL to redirect user for anonymous form filling
|
|
1556
|
+
*/
|
|
1557
|
+
url: string;
|
|
1558
|
+
};
|
|
1560
1559
|
};
|
|
1561
1560
|
};
|
|
1562
1561
|
400: components["responses"]["BadRequest"];
|
|
@@ -1573,17 +1572,43 @@ export interface operations {
|
|
|
1573
1572
|
};
|
|
1574
1573
|
requestBody: {
|
|
1575
1574
|
content: {
|
|
1576
|
-
"application/json":
|
|
1575
|
+
"application/json": {
|
|
1576
|
+
lang?: components["schemas"]["IamSmartLanguage"];
|
|
1577
|
+
source: components["schemas"]["IamSmartSource"];
|
|
1578
|
+
redirect: components["schemas"]["RedirectUri"];
|
|
1579
|
+
scope?: components["schemas"]["IamSmartScope"];
|
|
1580
|
+
/** @description Document title */
|
|
1581
|
+
name: string;
|
|
1582
|
+
/** @description SHA-256 hash of document (64 hex characters) */
|
|
1583
|
+
fileHash: string;
|
|
1584
|
+
/** @description Hash of HKIC for verification */
|
|
1585
|
+
hkicHash?: string;
|
|
1586
|
+
/** @description Service description */
|
|
1587
|
+
service: string;
|
|
1588
|
+
/** @description Organisation name */
|
|
1589
|
+
organisation?: string;
|
|
1590
|
+
};
|
|
1577
1591
|
};
|
|
1578
1592
|
};
|
|
1579
1593
|
responses: {
|
|
1580
|
-
/** @description Anonymous signing request successfully initialized.
|
|
1594
|
+
/** @description Anonymous signing request successfully initialized.
|
|
1595
|
+
* Redirect user to the URL, then poll with the token to retrieve signature.
|
|
1596
|
+
* */
|
|
1581
1597
|
200: {
|
|
1582
1598
|
headers: {
|
|
1583
1599
|
[name: string]: unknown;
|
|
1584
1600
|
};
|
|
1585
1601
|
content: {
|
|
1586
|
-
"application/json":
|
|
1602
|
+
"application/json": {
|
|
1603
|
+
token: components["schemas"]["Token"];
|
|
1604
|
+
/**
|
|
1605
|
+
* Format: uri
|
|
1606
|
+
* @description URL to redirect user for anonymous signing
|
|
1607
|
+
*/
|
|
1608
|
+
url: string;
|
|
1609
|
+
/** @description HKIC check digits */
|
|
1610
|
+
hkic: number;
|
|
1611
|
+
};
|
|
1587
1612
|
};
|
|
1588
1613
|
};
|
|
1589
1614
|
400: components["responses"]["BadRequest"];
|
|
@@ -1600,7 +1625,23 @@ export interface operations {
|
|
|
1600
1625
|
};
|
|
1601
1626
|
requestBody: {
|
|
1602
1627
|
content: {
|
|
1603
|
-
"application/json":
|
|
1628
|
+
"application/json": {
|
|
1629
|
+
lang?: components["schemas"]["IamSmartLanguage"];
|
|
1630
|
+
source: components["schemas"]["IamSmartSource"];
|
|
1631
|
+
redirect: components["schemas"]["RedirectUri"];
|
|
1632
|
+
scope?: components["schemas"]["IamSmartScope"];
|
|
1633
|
+
/** @description PDF document title */
|
|
1634
|
+
name: string;
|
|
1635
|
+
/**
|
|
1636
|
+
* Format: byte
|
|
1637
|
+
* @description Base64-encoded hash of PDF
|
|
1638
|
+
*/
|
|
1639
|
+
fileHash: string;
|
|
1640
|
+
/** @description Hash of HKIC for verification */
|
|
1641
|
+
hkicHash?: string;
|
|
1642
|
+
/** @description Service description */
|
|
1643
|
+
service: string;
|
|
1644
|
+
};
|
|
1604
1645
|
};
|
|
1605
1646
|
};
|
|
1606
1647
|
responses: {
|
|
@@ -1610,7 +1651,12 @@ export interface operations {
|
|
|
1610
1651
|
[name: string]: unknown;
|
|
1611
1652
|
};
|
|
1612
1653
|
content: {
|
|
1613
|
-
"application/json":
|
|
1654
|
+
"application/json": {
|
|
1655
|
+
token: components["schemas"]["Token"];
|
|
1656
|
+
/** Format: uri */
|
|
1657
|
+
url: string;
|
|
1658
|
+
hkic: number;
|
|
1659
|
+
};
|
|
1614
1660
|
};
|
|
1615
1661
|
};
|
|
1616
1662
|
400: components["responses"]["BadRequest"];
|
|
@@ -1790,11 +1836,7 @@ export interface operations {
|
|
|
1790
1836
|
requestBody: {
|
|
1791
1837
|
content: {
|
|
1792
1838
|
"application/json": {
|
|
1793
|
-
|
|
1794
|
-
* Format: uri
|
|
1795
|
-
* @description Callback URL to redirect after verification
|
|
1796
|
-
*/
|
|
1797
|
-
redirect: string;
|
|
1839
|
+
redirect: components["schemas"]["RedirectUri"];
|
|
1798
1840
|
/**
|
|
1799
1841
|
* @description QR code type
|
|
1800
1842
|
* @enum {string}
|
|
@@ -1853,8 +1895,7 @@ export interface operations {
|
|
|
1853
1895
|
"application/json": {
|
|
1854
1896
|
/** @description attributes to be requested from user */
|
|
1855
1897
|
attributes: string[];
|
|
1856
|
-
|
|
1857
|
-
redirect: string;
|
|
1898
|
+
redirect: components["schemas"]["RedirectUri"];
|
|
1858
1899
|
};
|
|
1859
1900
|
};
|
|
1860
1901
|
};
|
|
@@ -1896,8 +1937,7 @@ export interface operations {
|
|
|
1896
1937
|
"application/json": {
|
|
1897
1938
|
/** @description attributes to be requested from user */
|
|
1898
1939
|
attributes?: string[];
|
|
1899
|
-
|
|
1900
|
-
redirect?: string;
|
|
1940
|
+
redirect?: components["schemas"]["RedirectUri"];
|
|
1901
1941
|
};
|
|
1902
1942
|
};
|
|
1903
1943
|
};
|
|
@@ -2104,7 +2144,7 @@ export interface operations {
|
|
|
2104
2144
|
requestBody: {
|
|
2105
2145
|
content: {
|
|
2106
2146
|
"application/json": {
|
|
2107
|
-
redirect:
|
|
2147
|
+
redirect: components["schemas"]["RedirectUri"];
|
|
2108
2148
|
};
|
|
2109
2149
|
};
|
|
2110
2150
|
};
|
|
@@ -2165,18 +2205,25 @@ export interface operations {
|
|
|
2165
2205
|
"application/json": {
|
|
2166
2206
|
/**
|
|
2167
2207
|
* Format: uri
|
|
2168
|
-
* @description Where to redirect the user **after success**.
|
|
2208
|
+
* @description Where to redirect the user **after success**.
|
|
2209
|
+
* Must be publicly reachable over **https**.
|
|
2210
|
+
*
|
|
2169
2211
|
* @example https://example.com/ocr/complete
|
|
2170
2212
|
*/
|
|
2171
2213
|
completeCallbackUrl: string;
|
|
2172
2214
|
/**
|
|
2173
2215
|
* Format: uri
|
|
2174
|
-
* @description Where to redirect the user if they **cancel/exit**.
|
|
2216
|
+
* @description Where to redirect the user if they **cancel/exit**.
|
|
2217
|
+
* Must be publicly reachable over **https**.
|
|
2218
|
+
*
|
|
2175
2219
|
* @example https://example.com/ocr/interrupt
|
|
2176
2220
|
*/
|
|
2177
2221
|
interruptCallbackUrl: string;
|
|
2178
2222
|
/**
|
|
2179
|
-
* @description The identity document type to verify.
|
|
2223
|
+
* @description The identity document type to verify.
|
|
2224
|
+
* `00000001003` (Passport), `08520000002` (HKID New), `08520000001` (HKID Old).
|
|
2225
|
+
* Use the exact code for your target document.
|
|
2226
|
+
*
|
|
2180
2227
|
* @example 08520000002
|
|
2181
2228
|
* @enum {string}
|
|
2182
2229
|
*/
|
|
@@ -2194,11 +2241,15 @@ export interface operations {
|
|
|
2194
2241
|
"application/json": {
|
|
2195
2242
|
/**
|
|
2196
2243
|
* Format: uri
|
|
2197
|
-
* @description Launch URL to open on a mobile browser or in an in-app web view.
|
|
2244
|
+
* @description Launch URL to open on a mobile browser or in an in-app web view.
|
|
2245
|
+
* This URL contains the configuration for the H5 verification flow.
|
|
2246
|
+
*
|
|
2198
2247
|
* @example https://<cdn>/page/realid-fe/index.html?clientcfg=eyJ...
|
|
2199
2248
|
*/
|
|
2200
2249
|
url: string;
|
|
2201
|
-
/** @description JWT token carrying bizId and transactionId.
|
|
2250
|
+
/** @description JWT token carrying bizId and transactionId.
|
|
2251
|
+
* Store this token to poll for verification results using `/ocr/poll`.
|
|
2252
|
+
* */
|
|
2202
2253
|
token: components["schemas"]["Token"];
|
|
2203
2254
|
};
|
|
2204
2255
|
};
|
|
@@ -2430,11 +2481,11 @@ export interface operations {
|
|
|
2430
2481
|
content: {
|
|
2431
2482
|
"application/json": {
|
|
2432
2483
|
/** @description Name of the company */
|
|
2433
|
-
companyName
|
|
2484
|
+
companyName?: string;
|
|
2434
2485
|
/** @description Company ID (e.g., BRN for Hong Kong, ACN for Australia) */
|
|
2435
2486
|
companyId?: string;
|
|
2436
|
-
/** @description ISO 3166
|
|
2437
|
-
countryCode: string;
|
|
2487
|
+
/** @description [ISO 3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-2) country code. */
|
|
2488
|
+
countryCode: components["schemas"]["AutomatedCountry"] | string;
|
|
2438
2489
|
/** @description Type of document */
|
|
2439
2490
|
documentType: string;
|
|
2440
2491
|
/** @description Year of the document */
|
|
@@ -2476,78 +2527,231 @@ export interface operations {
|
|
|
2476
2527
|
};
|
|
2477
2528
|
};
|
|
2478
2529
|
};
|
|
2479
|
-
|
|
2530
|
+
craPoll: {
|
|
2480
2531
|
parameters: {
|
|
2481
2532
|
query?: never;
|
|
2482
2533
|
header?: never;
|
|
2483
|
-
path
|
|
2484
|
-
/** @description ISO 3166-1 alpha-2 country code. Supported values are "HK" (Hong Kong) and "AU" (Australia) */
|
|
2485
|
-
countryCode: "hk" | "au";
|
|
2486
|
-
};
|
|
2534
|
+
path?: never;
|
|
2487
2535
|
cookie?: never;
|
|
2488
2536
|
};
|
|
2489
2537
|
requestBody: {
|
|
2490
2538
|
content: {
|
|
2491
2539
|
"application/json": {
|
|
2492
|
-
|
|
2493
|
-
companyId: string;
|
|
2494
|
-
/**
|
|
2495
|
-
* @description Optional filter by document type
|
|
2496
|
-
* @enum {string}
|
|
2497
|
-
*/
|
|
2498
|
-
documentType?: "financialStatement" | "annualReturn";
|
|
2499
|
-
/** @description Optional filter by year */
|
|
2500
|
-
documentYear?: number;
|
|
2540
|
+
token: components["schemas"]["Token"];
|
|
2501
2541
|
};
|
|
2502
2542
|
};
|
|
2503
2543
|
};
|
|
2504
2544
|
responses: {
|
|
2505
|
-
/** @description
|
|
2545
|
+
/** @description Report is ready */
|
|
2506
2546
|
200: {
|
|
2507
2547
|
headers: {
|
|
2508
2548
|
[name: string]: unknown;
|
|
2509
2549
|
};
|
|
2510
2550
|
content: {
|
|
2511
2551
|
"application/json": {
|
|
2512
|
-
/**
|
|
2513
|
-
|
|
2514
|
-
|
|
2515
|
-
|
|
2516
|
-
|
|
2517
|
-
|
|
2518
|
-
|
|
2519
|
-
|
|
2520
|
-
|
|
2521
|
-
|
|
2522
|
-
|
|
2523
|
-
|
|
2524
|
-
|
|
2525
|
-
|
|
2526
|
-
|
|
2527
|
-
|
|
2528
|
-
|
|
2529
|
-
|
|
2530
|
-
filingDateForDisplay?: string;
|
|
2531
|
-
/** @description Unique document identifier */
|
|
2532
|
-
documentId?: string;
|
|
2533
|
-
/** @description Company ID */
|
|
2534
|
-
companyId?: string;
|
|
2535
|
-
/** @description Whether the document has linked files */
|
|
2536
|
-
hasLinked?: boolean;
|
|
2537
|
-
}[];
|
|
2552
|
+
/** @description Metadata about the report generation */
|
|
2553
|
+
reportMetadata: {
|
|
2554
|
+
/**
|
|
2555
|
+
* Format: date
|
|
2556
|
+
* @description Date when the report was generated
|
|
2557
|
+
*/
|
|
2558
|
+
reportDate?: string;
|
|
2559
|
+
/**
|
|
2560
|
+
* @description [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-2) of the report source
|
|
2561
|
+
* @example CN
|
|
2562
|
+
*/
|
|
2563
|
+
countryCode: string;
|
|
2564
|
+
/**
|
|
2565
|
+
* @description Status of the report generation
|
|
2566
|
+
* @example completed
|
|
2567
|
+
* @enum {string}
|
|
2568
|
+
*/
|
|
2569
|
+
status: "completed" | "processing";
|
|
2538
2570
|
};
|
|
2571
|
+
/** @description Array of original documents with presigned URLs (valid for 7 days). Only populated for non-unified document types. */
|
|
2572
|
+
originalDocuments?: {
|
|
2573
|
+
/**
|
|
2574
|
+
* Format: uri
|
|
2575
|
+
* @description Presigned URL to download the document
|
|
2576
|
+
*/
|
|
2577
|
+
link?: string | null;
|
|
2578
|
+
/** @description Name of the document file */
|
|
2579
|
+
fileName?: string | null;
|
|
2580
|
+
}[] | null;
|
|
2581
|
+
/** @description Company identification details with bilingual support */
|
|
2582
|
+
companyIdentification?: {
|
|
2583
|
+
companyName?: {
|
|
2584
|
+
english?: string | null;
|
|
2585
|
+
local?: string;
|
|
2586
|
+
};
|
|
2587
|
+
/** @description Company registration number */
|
|
2588
|
+
companyId?: string | null;
|
|
2589
|
+
/** @description Type of company number (e.g., USCC, BRN) */
|
|
2590
|
+
idType?: string | null;
|
|
2591
|
+
previousCompanyNames?: {
|
|
2592
|
+
english?: string | null;
|
|
2593
|
+
local?: string;
|
|
2594
|
+
}[];
|
|
2595
|
+
} | null;
|
|
2596
|
+
/** @description Company registration details with bilingual support */
|
|
2597
|
+
registrationDetails?: {
|
|
2598
|
+
/** Format: date */
|
|
2599
|
+
incorporationDate?: string | null;
|
|
2600
|
+
status?: {
|
|
2601
|
+
english?: string;
|
|
2602
|
+
local?: string;
|
|
2603
|
+
} | null;
|
|
2604
|
+
companyType?: {
|
|
2605
|
+
english?: string;
|
|
2606
|
+
local?: string;
|
|
2607
|
+
} | null;
|
|
2608
|
+
jurisdiction?: string;
|
|
2609
|
+
} | null;
|
|
2610
|
+
/** @description Company location information with bilingual support */
|
|
2611
|
+
location?: {
|
|
2612
|
+
registeredAddress?: {
|
|
2613
|
+
english?: string | null;
|
|
2614
|
+
local?: string;
|
|
2615
|
+
} | null;
|
|
2616
|
+
principalPlaceOfBusiness?: {
|
|
2617
|
+
english?: string | null;
|
|
2618
|
+
local?: string | null;
|
|
2619
|
+
} | null;
|
|
2620
|
+
} | null;
|
|
2621
|
+
/** @description Company management structure with bilingual support */
|
|
2622
|
+
management?: {
|
|
2623
|
+
directors?: {
|
|
2624
|
+
name?: {
|
|
2625
|
+
english?: string | null;
|
|
2626
|
+
local?: string;
|
|
2627
|
+
};
|
|
2628
|
+
role?: {
|
|
2629
|
+
english?: string;
|
|
2630
|
+
local?: string;
|
|
2631
|
+
};
|
|
2632
|
+
identityDocuments?: string[];
|
|
2633
|
+
address?: string | null;
|
|
2634
|
+
/** Format: date */
|
|
2635
|
+
appointmentDate?: string | null;
|
|
2636
|
+
}[];
|
|
2637
|
+
companySecretary?: {
|
|
2638
|
+
name?: {
|
|
2639
|
+
english?: string | null;
|
|
2640
|
+
local?: string;
|
|
2641
|
+
};
|
|
2642
|
+
address?: string | null;
|
|
2643
|
+
} | null;
|
|
2644
|
+
legalRepresentative?: {
|
|
2645
|
+
name?: {
|
|
2646
|
+
english?: string | null;
|
|
2647
|
+
local?: string;
|
|
2648
|
+
};
|
|
2649
|
+
isCorporate?: boolean;
|
|
2650
|
+
} | null;
|
|
2651
|
+
} | null;
|
|
2652
|
+
/** @description Company ownership/shareholder information with bilingual support */
|
|
2653
|
+
ownership?: {
|
|
2654
|
+
shareholders?: {
|
|
2655
|
+
name?: {
|
|
2656
|
+
english?: string | null;
|
|
2657
|
+
local?: string;
|
|
2658
|
+
};
|
|
2659
|
+
isCorporate?: boolean;
|
|
2660
|
+
address?: string | null;
|
|
2661
|
+
sharesHeld?: {
|
|
2662
|
+
class?: {
|
|
2663
|
+
english?: string | null;
|
|
2664
|
+
local?: string;
|
|
2665
|
+
};
|
|
2666
|
+
count?: number;
|
|
2667
|
+
}[];
|
|
2668
|
+
totalShares?: number;
|
|
2669
|
+
ownershipPercentage?: number;
|
|
2670
|
+
}[];
|
|
2671
|
+
ultimateHoldingCompany?: {
|
|
2672
|
+
name?: {
|
|
2673
|
+
english?: string | null;
|
|
2674
|
+
local?: string;
|
|
2675
|
+
};
|
|
2676
|
+
jurisdiction?: string | null;
|
|
2677
|
+
} | null;
|
|
2678
|
+
} | null;
|
|
2679
|
+
/** @description Share capital information with bilingual support */
|
|
2680
|
+
shareCapital?: {
|
|
2681
|
+
issuedCapital?: {
|
|
2682
|
+
amount?: number;
|
|
2683
|
+
currency?: string;
|
|
2684
|
+
} | null;
|
|
2685
|
+
paidUpCapital?: {
|
|
2686
|
+
amount?: number;
|
|
2687
|
+
currency?: string;
|
|
2688
|
+
} | null;
|
|
2689
|
+
authorizedCapital?: {
|
|
2690
|
+
amount?: number;
|
|
2691
|
+
currency?: string;
|
|
2692
|
+
} | null;
|
|
2693
|
+
} | null;
|
|
2694
|
+
/** @description Company operations details with bilingual support */
|
|
2695
|
+
operations?: {
|
|
2696
|
+
businessActivity?: {
|
|
2697
|
+
english?: string;
|
|
2698
|
+
local?: string;
|
|
2699
|
+
} | null;
|
|
2700
|
+
financialYearEnd?: string | null;
|
|
2701
|
+
} | null;
|
|
2702
|
+
/** @description Company compliance and filing history with bilingual support */
|
|
2703
|
+
compliance?: {
|
|
2704
|
+
registeredAgent?: {
|
|
2705
|
+
name?: string;
|
|
2706
|
+
address?: string;
|
|
2707
|
+
} | null;
|
|
2708
|
+
filingHistory?: {
|
|
2709
|
+
totalDocuments?: number;
|
|
2710
|
+
summary?: {
|
|
2711
|
+
category?: {
|
|
2712
|
+
english?: string;
|
|
2713
|
+
local?: string;
|
|
2714
|
+
};
|
|
2715
|
+
count?: number;
|
|
2716
|
+
}[];
|
|
2717
|
+
} | null;
|
|
2718
|
+
riskInformation?: Record<string, never> | null;
|
|
2719
|
+
intellectualProperty?: Record<string, never> | null;
|
|
2720
|
+
} | null;
|
|
2539
2721
|
};
|
|
2540
2722
|
};
|
|
2541
2723
|
};
|
|
2542
|
-
/** @description
|
|
2543
|
-
|
|
2724
|
+
/** @description Report is still being processed */
|
|
2725
|
+
202: {
|
|
2544
2726
|
headers: {
|
|
2545
2727
|
[name: string]: unknown;
|
|
2546
2728
|
};
|
|
2547
|
-
content
|
|
2729
|
+
content: {
|
|
2730
|
+
"application/json": {
|
|
2731
|
+
/** @description Metadata about the report generation */
|
|
2732
|
+
reportMetadata: {
|
|
2733
|
+
/**
|
|
2734
|
+
* Format: date
|
|
2735
|
+
* @description Date when the report was generated
|
|
2736
|
+
*/
|
|
2737
|
+
reportDate?: string;
|
|
2738
|
+
/**
|
|
2739
|
+
* @description [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-2) of the report source
|
|
2740
|
+
* @example CN
|
|
2741
|
+
*/
|
|
2742
|
+
countryCode: string;
|
|
2743
|
+
/**
|
|
2744
|
+
* @description Status of the report generation
|
|
2745
|
+
* @example completed
|
|
2746
|
+
* @enum {string}
|
|
2747
|
+
*/
|
|
2748
|
+
status: "completed" | "processing";
|
|
2749
|
+
};
|
|
2750
|
+
};
|
|
2751
|
+
};
|
|
2548
2752
|
};
|
|
2549
|
-
/** @description
|
|
2550
|
-
|
|
2753
|
+
/** @description Invalid token */
|
|
2754
|
+
400: {
|
|
2551
2755
|
headers: {
|
|
2552
2756
|
[name: string]: unknown;
|
|
2553
2757
|
};
|
|
@@ -2567,8 +2771,8 @@ export interface operations {
|
|
|
2567
2771
|
query?: never;
|
|
2568
2772
|
header?: never;
|
|
2569
2773
|
path: {
|
|
2570
|
-
/** @description ISO 3166
|
|
2571
|
-
countryCode: "hk" | "cn" | "au";
|
|
2774
|
+
/** @description [ISO 3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-2) country code in lowercase. */
|
|
2775
|
+
countryCode: "hk" | "cn" | "au" | "sg" | "ky";
|
|
2572
2776
|
};
|
|
2573
2777
|
cookie?: never;
|
|
2574
2778
|
};
|
|
@@ -2591,7 +2795,7 @@ export interface operations {
|
|
|
2591
2795
|
/** @description Response message */
|
|
2592
2796
|
message: string;
|
|
2593
2797
|
/** @description Array of companies matching the search criteria */
|
|
2594
|
-
result?: components["schemas"]["
|
|
2798
|
+
result?: components["schemas"]["Company"][];
|
|
2595
2799
|
};
|
|
2596
2800
|
};
|
|
2597
2801
|
};
|
|
@@ -2618,13 +2822,13 @@ export interface operations {
|
|
|
2618
2822
|
};
|
|
2619
2823
|
};
|
|
2620
2824
|
};
|
|
2621
|
-
|
|
2825
|
+
searchDocuments: {
|
|
2622
2826
|
parameters: {
|
|
2623
2827
|
query?: never;
|
|
2624
2828
|
header?: never;
|
|
2625
2829
|
path: {
|
|
2626
|
-
/** @description ISO 3166
|
|
2627
|
-
countryCode: "hk" | "au";
|
|
2830
|
+
/** @description [ISO 3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-2) country code. */
|
|
2831
|
+
countryCode: "hk" | "au" | "sg";
|
|
2628
2832
|
};
|
|
2629
2833
|
cookie?: never;
|
|
2630
2834
|
};
|
|
@@ -2633,11 +2837,18 @@ export interface operations {
|
|
|
2633
2837
|
"application/json": {
|
|
2634
2838
|
/** @description Company ID (e.g., BRN for Hong Kong, ACN for Australia) */
|
|
2635
2839
|
companyId: string;
|
|
2840
|
+
/**
|
|
2841
|
+
* @description Optional filter by document type
|
|
2842
|
+
* @enum {string}
|
|
2843
|
+
*/
|
|
2844
|
+
documentType?: "financialStatement" | "annualReturn";
|
|
2845
|
+
/** @description Optional filter by year */
|
|
2846
|
+
documentYear?: number;
|
|
2636
2847
|
};
|
|
2637
2848
|
};
|
|
2638
2849
|
};
|
|
2639
2850
|
responses: {
|
|
2640
|
-
/** @description Successfully retrieved
|
|
2851
|
+
/** @description Successfully retrieved documents as a flat array */
|
|
2641
2852
|
200: {
|
|
2642
2853
|
headers: {
|
|
2643
2854
|
[name: string]: unknown;
|
|
@@ -2649,40 +2860,31 @@ export interface operations {
|
|
|
2649
2860
|
* @enum {string}
|
|
2650
2861
|
*/
|
|
2651
2862
|
message: "success" | "search error";
|
|
2652
|
-
/** @description
|
|
2863
|
+
/** @description array of documents filed by the company. */
|
|
2653
2864
|
result?: {
|
|
2654
|
-
/** @description Business Registration Number / Company ID */
|
|
2655
|
-
brn?: string;
|
|
2656
|
-
/** @description English company name */
|
|
2657
|
-
enName?: string;
|
|
2658
|
-
/** @description Chinese company name */
|
|
2659
|
-
cnName?: string;
|
|
2660
2865
|
/**
|
|
2661
|
-
* @description
|
|
2866
|
+
* @description Document category (e.g., Annual Return, Director / Secretary Changes)
|
|
2662
2867
|
* @enum {string}
|
|
2663
2868
|
*/
|
|
2664
|
-
|
|
2665
|
-
/** @description
|
|
2666
|
-
|
|
2667
|
-
/** @description
|
|
2668
|
-
|
|
2669
|
-
/**
|
|
2670
|
-
|
|
2671
|
-
* @description Date of dissolution (YYYY-MM-DD format, empty if not dissolved)
|
|
2672
|
-
*/
|
|
2673
|
-
dissolutionDate?: string;
|
|
2869
|
+
category: "Annual Return" | "Director / Secretary Changes" | "Charges Filed" | "Incorporation & Name Change" | "Liquidation & Deregistration" | "Registered Office / Address" | "Share Capital" | "Other";
|
|
2870
|
+
/** @description Accounting year (for annual returns) */
|
|
2871
|
+
documentYear?: string;
|
|
2872
|
+
/** @description English name of the document */
|
|
2873
|
+
documentName: string;
|
|
2874
|
+
/** @description Number of pages */
|
|
2875
|
+
pages?: string;
|
|
2674
2876
|
/**
|
|
2675
2877
|
* Format: date
|
|
2676
|
-
* @description
|
|
2878
|
+
* @description Filing date (YYYY-MM-DD format)
|
|
2677
2879
|
*/
|
|
2678
|
-
|
|
2679
|
-
/** @description
|
|
2680
|
-
|
|
2681
|
-
/** @description
|
|
2682
|
-
|
|
2683
|
-
/** @description
|
|
2684
|
-
|
|
2685
|
-
};
|
|
2880
|
+
filingDate?: string;
|
|
2881
|
+
/** @description Unique document identifier */
|
|
2882
|
+
documentId: string;
|
|
2883
|
+
/** @description Company ID */
|
|
2884
|
+
companyId: string;
|
|
2885
|
+
/** @description Whether the document has linked files */
|
|
2886
|
+
hasLinked?: boolean;
|
|
2887
|
+
}[];
|
|
2686
2888
|
};
|
|
2687
2889
|
};
|
|
2688
2890
|
};
|
|
@@ -2693,7 +2895,7 @@ export interface operations {
|
|
|
2693
2895
|
};
|
|
2694
2896
|
content?: never;
|
|
2695
2897
|
};
|
|
2696
|
-
/** @description
|
|
2898
|
+
/** @description No documents found */
|
|
2697
2899
|
404: {
|
|
2698
2900
|
headers: {
|
|
2699
2901
|
[name: string]: unknown;
|
|
@@ -2709,53 +2911,83 @@ export interface operations {
|
|
|
2709
2911
|
};
|
|
2710
2912
|
};
|
|
2711
2913
|
};
|
|
2712
|
-
|
|
2914
|
+
searchCompany: {
|
|
2713
2915
|
parameters: {
|
|
2714
2916
|
query?: never;
|
|
2715
2917
|
header?: never;
|
|
2716
|
-
path
|
|
2918
|
+
path: {
|
|
2919
|
+
/** @description [ISO 3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-2) country code. */
|
|
2920
|
+
countryCode: "hk" | "au" | "sg";
|
|
2921
|
+
};
|
|
2717
2922
|
cookie?: never;
|
|
2718
2923
|
};
|
|
2719
2924
|
requestBody: {
|
|
2720
2925
|
content: {
|
|
2721
2926
|
"application/json": {
|
|
2722
|
-
/** @description
|
|
2723
|
-
|
|
2927
|
+
/** @description Company ID (e.g., BRN for Hong Kong, ACN for Australia) */
|
|
2928
|
+
companyId: string;
|
|
2724
2929
|
};
|
|
2725
2930
|
};
|
|
2726
2931
|
};
|
|
2727
2932
|
responses: {
|
|
2728
|
-
/** @description
|
|
2933
|
+
/** @description Successfully retrieved company information */
|
|
2729
2934
|
200: {
|
|
2730
2935
|
headers: {
|
|
2731
2936
|
[name: string]: unknown;
|
|
2732
2937
|
};
|
|
2733
2938
|
content: {
|
|
2734
2939
|
"application/json": {
|
|
2735
|
-
/** @example CRA ready */
|
|
2736
|
-
message?: string;
|
|
2737
2940
|
/**
|
|
2738
|
-
*
|
|
2739
|
-
* @
|
|
2941
|
+
* @description Status of the operation
|
|
2942
|
+
* @enum {string}
|
|
2740
2943
|
*/
|
|
2741
|
-
|
|
2944
|
+
message: "success" | "search error";
|
|
2945
|
+
/** @description Company object (Other Countries) or Company base information object (HK) */
|
|
2946
|
+
result?: components["schemas"]["Company"][] | {
|
|
2947
|
+
/** @description Business Registration Number / Company ID */
|
|
2948
|
+
brn?: string;
|
|
2949
|
+
/** @description English company name */
|
|
2950
|
+
enName?: string;
|
|
2951
|
+
/** @description Chinese company name */
|
|
2952
|
+
cnName?: string;
|
|
2953
|
+
/**
|
|
2954
|
+
* @description Current status of the company
|
|
2955
|
+
* @enum {string}
|
|
2956
|
+
*/
|
|
2957
|
+
status?: "Live" | "Dissolved";
|
|
2958
|
+
/** @description Type of company */
|
|
2959
|
+
type?: string;
|
|
2960
|
+
/** @description Category of entity */
|
|
2961
|
+
category?: string;
|
|
2962
|
+
/**
|
|
2963
|
+
* Format: date
|
|
2964
|
+
* @description Date of dissolution (YYYY-MM-DD format, empty if not dissolved)
|
|
2965
|
+
*/
|
|
2966
|
+
dissolutionDate?: string;
|
|
2967
|
+
/**
|
|
2968
|
+
* Format: date
|
|
2969
|
+
* @description Date of incorporation/registration (YYYY-MM-DD format)
|
|
2970
|
+
*/
|
|
2971
|
+
incorporationDate?: string;
|
|
2972
|
+
/** @description English remarks */
|
|
2973
|
+
enRemarks?: string;
|
|
2974
|
+
/** @description Simplified Chinese remarks */
|
|
2975
|
+
scRemarks?: string;
|
|
2976
|
+
/** @description Traditional Chinese remarks */
|
|
2977
|
+
tcRemarks?: string;
|
|
2978
|
+
};
|
|
2742
2979
|
};
|
|
2743
2980
|
};
|
|
2744
2981
|
};
|
|
2745
|
-
/** @description
|
|
2746
|
-
|
|
2982
|
+
/** @description Bad Request - Invalid input parameters */
|
|
2983
|
+
400: {
|
|
2747
2984
|
headers: {
|
|
2748
2985
|
[name: string]: unknown;
|
|
2749
2986
|
};
|
|
2750
|
-
content
|
|
2751
|
-
"application/json": {
|
|
2752
|
-
/** @example Report is pending */
|
|
2753
|
-
message?: string;
|
|
2754
|
-
};
|
|
2755
|
-
};
|
|
2987
|
+
content?: never;
|
|
2756
2988
|
};
|
|
2757
|
-
/** @description
|
|
2758
|
-
|
|
2989
|
+
/** @description Company not found */
|
|
2990
|
+
404: {
|
|
2759
2991
|
headers: {
|
|
2760
2992
|
[name: string]: unknown;
|
|
2761
2993
|
};
|
|
@@ -2780,14 +3012,13 @@ export interface operations {
|
|
|
2780
3012
|
requestBody: {
|
|
2781
3013
|
content: {
|
|
2782
3014
|
"application/json": {
|
|
3015
|
+
redirect: components["schemas"]["RedirectUri"];
|
|
2783
3016
|
/**
|
|
2784
|
-
*
|
|
2785
|
-
*
|
|
2786
|
-
*
|
|
2787
|
-
|
|
2788
|
-
|
|
2789
|
-
/**
|
|
2790
|
-
* @description List of values, separated by spaces, that represent the scope of the authorization that the application wants to obtain. It queries the scopes required for accessing the resources or services in question. Available scopes: sub, fullnameAR, gender, mobile, lastnameEN, fullnameEN, uuid, lastnameAR, idn, nationalityEN, firstnameEN, userType, nationalityAR, firstnameAR, email. (To be shared by UAEPASS Team if its value is other than specified in sample above)
|
|
3017
|
+
* @description List of values, separated by spaces, that represent the scope of the authorization that the application wants to obtain.
|
|
3018
|
+
* It queries the scopes required for accessing the resources or services in question.
|
|
3019
|
+
* Available scopes: sub, fullnameAR, gender, mobile, lastnameEN, fullnameEN, uuid, lastnameAR, idn, nationalityEN, firstnameEN, userType, nationalityAR, firstnameAR, email.
|
|
3020
|
+
* (To be shared by UAEPASS Team if its value is other than specified in sample above)
|
|
3021
|
+
*
|
|
2791
3022
|
* @example sub fullnameEN email mobile
|
|
2792
3023
|
*/
|
|
2793
3024
|
scope?: string;
|
|
@@ -2835,7 +3066,13 @@ export interface operations {
|
|
|
2835
3066
|
path?: never;
|
|
2836
3067
|
cookie?: never;
|
|
2837
3068
|
};
|
|
2838
|
-
requestBody:
|
|
3069
|
+
requestBody: {
|
|
3070
|
+
content: {
|
|
3071
|
+
"application/json": {
|
|
3072
|
+
token: components["schemas"]["Token"];
|
|
3073
|
+
};
|
|
3074
|
+
};
|
|
3075
|
+
};
|
|
2839
3076
|
responses: {
|
|
2840
3077
|
/** @description Success */
|
|
2841
3078
|
200: {
|
|
@@ -2845,29 +3082,7 @@ export interface operations {
|
|
|
2845
3082
|
content: {
|
|
2846
3083
|
"application/json": {
|
|
2847
3084
|
message?: string;
|
|
2848
|
-
token?:
|
|
2849
|
-
};
|
|
2850
|
-
};
|
|
2851
|
-
};
|
|
2852
|
-
/** @description Result pending */
|
|
2853
|
-
202: {
|
|
2854
|
-
headers: {
|
|
2855
|
-
[name: string]: unknown;
|
|
2856
|
-
};
|
|
2857
|
-
content: {
|
|
2858
|
-
"application/json": {
|
|
2859
|
-
message?: string;
|
|
2860
|
-
};
|
|
2861
|
-
};
|
|
2862
|
-
};
|
|
2863
|
-
/** @description 401 Authentication / 401 FormFilling / 401 Signing / 401 PDF Signing / 401 Re-authentication reject / 401 Re-authentication failed verification / 401 FormFilling Anonymous / 401 Signing Anonymous reject / 401 Signing Anonymous failed verification / 401 PDF Signing Anonymous reject / 401 PDF Signing Anonymous failed verification */
|
|
2864
|
-
401: {
|
|
2865
|
-
headers: {
|
|
2866
|
-
[name: string]: unknown;
|
|
2867
|
-
};
|
|
2868
|
-
content: {
|
|
2869
|
-
"application/json": {
|
|
2870
|
-
message?: string;
|
|
3085
|
+
token?: components["schemas"]["Token"];
|
|
2871
3086
|
};
|
|
2872
3087
|
};
|
|
2873
3088
|
};
|
|
@@ -2901,11 +3116,7 @@ export interface operations {
|
|
|
2901
3116
|
requestBody: {
|
|
2902
3117
|
content: {
|
|
2903
3118
|
"application/json": {
|
|
2904
|
-
|
|
2905
|
-
* Format: uri
|
|
2906
|
-
* @description URL to redirect after logout
|
|
2907
|
-
*/
|
|
2908
|
-
redirect: string;
|
|
3119
|
+
redirect: components["schemas"]["RedirectUri"];
|
|
2909
3120
|
};
|
|
2910
3121
|
};
|
|
2911
3122
|
};
|