-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
3384 lines (3341 loc) · 105 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
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
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.1
info:
title: Resistant Documents API
description: >-
Resistant Documents provides this API to programmatically interact with its
document analysis engine.
Interaction with the API can be divided into three phases:
1. Creating document submission
2. Uploading a file for for analysis to an address returned from step 1.
3. Fetching analysis results
In the first step, the submission is created by posting to the
`/v2/submission` endpoint. The response contains a `submission_id` uniquely
identifying the document to be analyzed throughout the entire interaction,
and is used to fetch analysis results later.
Submission response also returns `upload_url` containing a pre-signed URL.
This URL should be used to upload the actual document to be analyzed in the
second step. Please note the document has to be uploaded using HTTP `PUT`
method with `Content-Type` HTTP header set to `application/octet-stream`.
In the last step, client should repeatedly poll using the
`/v2/submission/{submission_id}/fraud` endpoint for analysis results. The
best practice is to use polling with an [exponential
back-off](https://en.wikipedia.org/wiki/Exponential_backoff) to reduce load
on the API.
# Authentication
<SecurityDefinitions />
version: 2.0.0b
x-konfig-ignore:
potential-incorrect-type: true
servers:
- url: https://api.documents.resistant.ai
tags:
- name: Submission
- name: Fraud
- name: Quality
- name: Decision
- name: Report
paths:
/v2/submission:
post:
tags:
- Submission
summary: Create a submission
operationId: Submission_analyzeDocument
security:
- OAuth2:
- submissions.write
description: Create a new submission for a document to be analyzed
requestBody:
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/SubmissionRequest'
responses:
'200':
description: Submission created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/SubmissionResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'415':
$ref: '#/components/responses/UnsupportedMediaType'
'429':
$ref: '#/components/responses/TooManyRequests'
/v2/submission/{submission_id}/characteristics:
put:
tags:
- Submission
summary: Add submission characteristics
operationId: Submission_attachCharacteristics
security:
- OAuth2:
- submissions.write
description: >-
Attach submission characteristics to the submission. Submission
characteristics are properties associated with the <i>original</i>
submission of the document (i.e., from the end user).
In descriptions of the properties, "user" refers to the person who
initially submitted the document, "customer" refers to a customer of
Resistant.ai using this API.
Calling this endpoint is only allowed if
`enable_submission_characteristics` is set to `true` when creating the
submission. When submission characteristics are enabled for the
submission, submitting then is <b>required</b> (the document will not be
analyzed without them).
parameters:
- in: path
name: submission_id
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SubmissionCharacteristicsRequest'
responses:
'204':
description: Submission characteristics were submitted successfully
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'415':
$ref: '#/components/responses/UnsupportedMediaType'
'429':
$ref: '#/components/responses/TooManyRequests'
/v2/submission/{submission_id}/fraud:
get:
tags:
- Fraud
summary: Fetch fraud result
operationId: Fraud_getResult
security:
- OAuth2:
- submissions.read
description: Fetch fraud analysis result
parameters:
- description: Enables indicator medatadata in the response object
in: query
name: with_metadata
required: false
schema:
type: boolean
default: false
- in: path
name: submission_id
required: true
schema:
type: string
responses:
'200':
description: >-
Asynchronous processing finished (either with a success or an
error). Result of the processing is described by the specific
response object.
content:
application/json:
schema:
$ref: '#/components/schemas/AnalysisResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'415':
$ref: '#/components/responses/UnsupportedMediaType'
'429':
$ref: '#/components/responses/TooManyRequests'
/v2/submission/{submission_id}/content:
get:
tags:
- Submission
summary: Fetch content result
operationId: Submission_getContentResult
security:
- OAuth2:
- submissions.read
description: Fetch content extraction result
parameters:
- in: path
name: submission_id
required: true
schema:
type: string
responses:
'200':
description: >-
Asynchronous processing finished (either with a success or an
error). Result of the processing is described by specific response
object.
content:
application/json:
schema:
$ref: '#/components/schemas/ContentResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'415':
$ref: '#/components/responses/UnsupportedMediaType'
'429':
$ref: '#/components/responses/TooManyRequests'
/v2/submission/{submission_id}/quality:
get:
tags:
- Quality
summary: Fetch quality result
operationId: Quality_resultFetch
security:
- OAuth2:
- submissions.read
parameters:
- in: path
name: submission_id
required: true
schema:
type: string
responses:
'200':
description: >-
Asynchronous processing finished (either with a success or an
error). Result of the processing is described by specific response
object.
content:
application/json:
schema:
$ref: '#/components/schemas/QualityResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'415':
$ref: '#/components/responses/UnsupportedMediaType'
'429':
$ref: '#/components/responses/TooManyRequests'
/v2/submission/{submission_id}/decision:
get:
tags:
- Decision
summary: Fetch Adaptive Decision result
operationId: Decision_getResult
security:
- OAuth2:
- submissions.read
description: >-
Fetch Adaptive Decision result. Note that if the response is too large,
the endpoint may send a 302 FOUND response with a `Location` header
pointing to result download location. Clients must follow such redirect.
parameters:
- in: path
name: submission_id
required: true
schema:
type: string
- description: >-
Coma-separated list of `decision_inputs` that should include the
full data in its `data` attribute, e.g. `?embed=fraud`.
in: query
name: embed
example: fraud
required: false
schema:
type: string
responses:
'200':
description: >-
Results of Adaptive Decision if Adaptive Decision was enabled for
the submission.
content:
application/json:
schema:
$ref: '#/components/schemas/AdaptiveDecisionResponse'
'302':
description: >-
Response too large. The full response can be downloaded from the URL
returned in the `Location` header.
'400':
description: >-
Bad request. Submission must be created with `enable_decision` flag
set to `true`.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
description: Not found. Submission doesn't exist or verdict is not ready yet.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'415':
$ref: '#/components/responses/UnsupportedMediaType'
'429':
$ref: '#/components/responses/TooManyRequests'
/v2/submission/{submission_id}/classification:
get:
tags:
- Submission
summary: Fetch document classification [preview]
operationId: Submission_getClassificationPreview
security:
- OAuth2:
- submissions.read
description: Fetch classification of the type of the submitted document
parameters:
- in: path
name: submission_id
required: true
schema:
type: string
responses:
'200':
description: >-
Results of document type classification if classification analysis
was enabled for the submission.
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
/v2/submission/{submission_id}/report:
get:
tags:
- Report
summary: Fetch report [preview]
operationId: Report_getFraudAnalysis
security:
- OAuth2:
- submissions.read
description: Fetch fraud analysis report of the submitted document
parameters:
- in: path
name: submission_id
required: true
schema:
type: string
responses:
'200':
description: Download URL to get the fraud analysis report.
content:
application/json:
schema:
$ref: '#/components/schemas/ReportResponse'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'409':
description: >-
The report cannot be downloaded because the fraud analysis was not
completed successfully or was skipped.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
$ref: '#/components/responses/TooManyRequests'
/v2/submission/{submission_id}:
delete:
tags:
- Submission
summary: Delete submission
operationId: Submission_remove
security:
- OAuth2:
- submissions.write
description: >-
Permanently deletes the submission. Can be used, e.g., to remove a
document before the configured retention period.
parameters:
- in: path
name: submission_id
required: true
schema:
type: string
responses:
'204':
description: Submission deleted.
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
description: Submission doesn't exist.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: >-
Submission cannot be deleted while it is being processed. Retry the
request later.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'415':
$ref: '#/components/responses/UnsupportedMediaType'
'429':
$ref: '#/components/responses/TooManyRequests'
/v2/submission/{submission_id}/feedback:
put:
tags:
- Submission
summary: Add analysis feedback
operationId: Submission_addFeedback
security:
- OAuth2:
- submissions.write
description: >-
Add custom feedback for the document analysis result. Comment value is
sanitized.
parameters:
- in: path
name: submission_id
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/FeedbackRequest'
responses:
'200':
description: Custom feedback for fraud analysis.
content:
application/json:
schema:
$ref: '#/components/schemas/FeedbackResponse'
'400':
description: Bad request. Feedback must be sent with all required properties.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
description: Not found. Submission doesn't exist.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'415':
$ref: '#/components/responses/UnsupportedMediaType'
'429':
$ref: '#/components/responses/TooManyRequests'
get:
tags:
- Submission
summary: Get analysis feedback
operationId: Submission_getFeedback
security:
- OAuth2:
- submissions.read
description: >-
Get custom feedback for the document analysis result previously stored
with a PUT request to this endpoint.
parameters:
- in: path
name: submission_id
required: true
schema:
type: string
responses:
'200':
description: Custom feedback for fraud analysis.
content:
application/json:
schema:
$ref: '#/components/schemas/FeedbackResponse'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
description: Not found. Submission or feedback doesn't exist.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'415':
$ref: '#/components/responses/UnsupportedMediaType'
'429':
$ref: '#/components/responses/TooManyRequests'
components:
responses:
UnsupportedMediaType:
description: Unsupported media type.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
BadRequest:
description: Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
NotFound:
description: The requested resource was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
Unauthorized:
description: Missing valid authentication credentials.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
Forbidden:
description: Access to the requested resource is forbidden.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
TooManyRequests:
description: Request quota was exceeded
schemas:
SubmissionResponse:
title: SubmissionResponse
type: object
properties:
upload_url:
title: Presigned URL
description: >
Presigned URL to AWS S3 service where the actual file will
be uploaded using the PUT method. Note that the content type in the
PUT request
has to be set to `application/octet-stream`.
Example file upload request using `curl`:
```
curl --request PUT \
--url $UPLOAD_URL \
--header 'content-type: application/octet-stream' \
--data @path_to_file
```
type: string
format: uri
submission_id:
title: Submission ID
description: >-
Unique submission ID generated by Documents service that uniquely
identifies the submitted file.
minLength: 24
maxLength: 36
type: string
submission_characteristics_upload_url:
title: Submission characteristics upload URL
description: >-
URL where submission characteristics can be attached to this
submission - see the
`/v2/submission/{submission_id}/characteristics` endpoint. Note that
this URL is not pre-signed and requires access token in headers. The
URL may be relative.
type: string
format: uri
required:
- upload_url
- submission_id
PipelineConfiguration:
title: PipelineConfiguration
description: Type of analysis pipeline to execute.
enum:
- FRAUD_ONLY
- CLASSIFICATION_ONLY
- QUALITY_ONLY
- QUALITY_AND_FRAUD
- FRAUD_AFTER_QUALITY
type: string
SubmissionRequest:
title: SubmissionRequest
type: object
properties:
query_id:
title: Query ID
description: >-
User-defined ID of analyzed file - typically refers to internal ID
of the analyzed document in user's CMS. Please ensure the query_id
of any document is reviewed prior to submitting to ensure no PII is
shared. Query_id is used for subsequent indexing of outputs from the
document forensics analysis.
minLength: 0
maxLength: 1024
type: string
nullable: true
pipeline_configuration:
$ref: '#/components/schemas/PipelineConfiguration'
enable_decision:
title: Adaptive Decision enable flag
description: >-
`true` to enable Adaptive Decision for the submitted document,
`false` to disable it
default: false
type: boolean
enable_submission_characteristics:
title: Submission characteristics enable flag.
description: >-
`true` to enable attachment of submission characteristics for the
submitted document, `false` to disable it (see
`submission_characteristics_upload_url` field in the response
object)
default: false
type: boolean
x-konfig-properties:
pipeline_configuration:
title: Pipeline configuration enum
description: Type of analysis pipeline to execute.
default: FRAUD_ONLY
SubmissionCharacteristicsRequest:
title: SubmissionCharacteristicsRequest
description: >-
Properties associated with the <i>original</i> submission of the
document (i.e., from the actual end client).
type: object
properties:
document_characteristics:
title: Document characteristics
description: Properties associated with the analyzed document.
type: object
nullable: true
properties:
document_type:
title: Document type enum
description: >-
Type of the document, e.g. ID card, passport, account statement,
...
type: string
enum:
- unknown
- id_card
- drivers_license
- birth_certificate
- health_insurance_card
- id_certificate
- passport
- residence_permit
- account_confirmation
- account_statement
- bank_details
- delivery_note
- company_detail
- earnings_confirmation
- employer_identification_number
- fees_statement
- government_registry_confirmation
- incorporation_certificate
- insurance_claim
- insurance_documentation
- invoice
- order
- order_confirmation
- payment
- payment_confirmation
- payslip
- proof_of_address
- receipt
- registration_certificate
- rental_agreement
- report
- residence_certificate
- tax_form
- tax_information
- ticket
- tracking_note
- transaction_detail
- transaction_history
- transport_order
- utility_bill
- vehicle_appraisal
- vehicle_registration_certificate
maxLength: 1024
nullable: true
document_type_string:
title: Document type string
description: >-
Unconstrained value for type of document, e.g. customer-specific
naming not mapped to document types defined in document_type
attribute
type: string
maxLength: 1024
nullable: true
issuing_country_code:
$ref: '#/components/schemas/CountryCode'
document_id:
title: Document ID assigned by customer
description: >-
Document identifier assigned by the customer (e.g., scan
reference).
type: string
maxLength: 1024
nullable: true
document_score:
title: >-
Internal document score or classification computed by the
customer
type: string
maxLength: 1024
nullable: true
status:
title: Document submission status computed by the customer
description: >-
Document status computed by the customer, e.g., `accepted`,
`rejected`, `sms verification needed`, ...
type: string
maxLength: 1024
nullable: true
document_position_on_image:
title: Document position on image
description: Position of a document (e.g., ID card) on the submitted image
type: object
nullable: true
properties:
corner_1:
title: First corner (e.g., top-left) of the document
description: >-
Coordinates of a first corner of the document on the
submitted image.
type: object
properties:
x:
$ref: '#/components/schemas/XCoordinate'
'y':
$ref: '#/components/schemas/YCoordinate'
required:
- x
- 'y'
corner_2:
title: Second corner (e.g., top-right) of the document
description: >-
Coordinates of a second corner of the document on the
submitted image.
type: object
properties:
x:
$ref: '#/components/schemas/XCoordinate'
'y':
$ref: '#/components/schemas/YCoordinate'
required:
- x
- 'y'
corner_3:
title: Third corner (e.g., bottom-right) of the document
description: >-
Coordinates of a third corner of the document on the
submitted image.
type: object
properties:
x:
$ref: '#/components/schemas/XCoordinate'
'y':
$ref: '#/components/schemas/YCoordinate'
required:
- x
- 'y'
corner_4:
title: Fourth corner (e.g., bottom-left) of the document
description: >-
Coordinates of a fourth corner of the document on the
submitted image.
type: object
properties:
x:
$ref: '#/components/schemas/XCoordinate'
'y':
$ref: '#/components/schemas/YCoordinate'
required:
- x
- 'y'
required:
- corner_1
- corner_2
- corner_3
- corner_4
source_channel:
title: Channel that the document originated from
description: >-
Identification of source that document came form eg. mobile
device, Web UI etc.
type: string
enum:
- api
- web
- mobile
nullable: true
maxLength: 1024
document_side:
title: Document side
description: Side of the document, e.g. front or back side of an ID card.
type: string
enum:
- front
- back
nullable: true
maxLength: 1024
device_characteristics:
title: Device characteristics
description: Properties associated with the device used to submit the document.
type: object
nullable: true
properties:
device_ip_address:
title: >-
Public IP address of the end-user's device used to submit the
document
type: string
maxLength: 39
nullable: true
server_ip_address:
title: IP address of the server where the document was submitted
type: string
maxLength: 39
nullable: true
country_code:
title: Code of the country from where to document was submitted
description: >-
[ISO 3166-1 alpha-3
code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3#Officially_assigned_code_elements)
of the country from where the document was submitted.
type: string
maxLength: 1024
nullable: true
example: GBR
country_name:
title: Country name
description: Name of the country from where the document was submitted.
type: string
maxLength: 1024
nullable: true
city:
title: City, from where the document was submitted
type: string
maxLength: 1024
nullable: true
postal_code:
title: >-
Postal code of the location from where the document was
submitted
type: string
maxLength: 1024
nullable: true
gcs_latitude:
title: >-
Latitude of the location from where the document was submitted
in decimal degrees (e.g. `38.775546` or `32.30642° N`).
type: string
maxLength: 1024
nullable: true
example: 38.77554692
gcs_longitude:
title: >-
Longitude of the location from where the document was submitted
in decimal degrees (e.g. `-75.1396939` or `75.1396939° E`).
type: string
maxLength: 1024
nullable: true
example: -75.1396939
isp:
title: >-
Name of the internet service provider of the connection used to
submit the document
type: string
maxLength: 1024
nullable: true
referer:
title: Browser referer url related to the submission
type: string
maxLength: 1024
nullable: true
user_agent:
title: User agent of the browser used to submit the document
type: string
maxLength: 1024
nullable: true
example: >-
Mozilla/5.0 (Android 4.4; Mobile; rv:41.0) Gecko/41.0
Firefox/41.0
browser_description:
title: Browser, e.g., Chrome, Safari, ...
type: string
maxLength: 1024
nullable: true
device_platform:
title: Device platform, e.g., Windows 10, Android, ...
type: string
maxLength: 1024
nullable: true
device_language:
title: Device language
description: >-
Device language in [ISO
639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
format
type: string
maxLength: 1024
nullable: true
example: en
screen_height:
title: Screen height in pixels
type: integer
nullable: true
screen_width:
title: Screen width in pixels
type: integer
nullable: true
device_fingerprint:
title: >-
Unique identifier of the device assigned by customer, e.g.,
fingerprint hash. The same device should have the same
device_fingerprint for all submissions.
type: string
maxLength: 1024
nullable: true
identity_characteristics:
title: User identity characteristics
description: Properties identifying the user who submitted the document.
type: object
nullable: true
properties:
first_name:
title: First name
type: string
maxLength: 1024
nullable: true
last_name:
title: Last name
type: string
maxLength: 1024
nullable: true
email:
title: Email address
type: string
maxLength: 1024
nullable: true
user_id:
title: User ID assigned by customer
description: >-
Customer-assigned identifier of the user who originally
submitted the document (or the entity that created the account
under which the document was submitted, e.g., "account holder
ID")
type: string
maxLength: 1024
nullable: true
user_group_id:
title: User grouping ID assigned by customer
description: >-
ID assigned by customer to group several users acting as a
single entity
type: string