-
Notifications
You must be signed in to change notification settings - Fork 1
/
developer.yaml
2121 lines (2121 loc) · 87.9 KB
/
developer.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.0
info:
version: 1.0.2-alpha.6
title: kent_test_identity_verification
description: |
To run tests transactions on our trial endpoint in postman:
[](https://www.getpostman.com/run-collection/a58f438d101278e2bc62)
servers:
- url: https://gateway.trulioo.com/trial
x-samples-languages:
- curl
- node
- javascript
- ruby
- python
paths:
/connection/v1/testauthentication:
get:
tags:
- Connection
summary: Test Authentication
description: This method enables you to check if your credentials are valid. You will
need to use ApiKeyAuth authentication to ensure a successful response.
operationId: TestAuthentication
responses:
"200":
description: Your username.
content:
application/json:
schema:
type: string
examples:
response:
value: Hello JoeNapoli_API_Demo
text/json:
schema:
type: string
"400":
description: Your request could not be processed, there should be more details in
the response.
"401":
description: The user name and password you provided is not valid or you are
using an account not configured to be an API user.
"408":
description: The request took longer to process than we waited.
"415":
description: You asked for a media type that we do not support. You should
request application/json in the Content-Type header.
"500":
description: An error happened on the server without a specific message.
security:
- ApiKeyAuth: []
"/configuration/v1/countrycodes/{configurationName}":
get:
tags:
- Configuration
summary: Get Country Codes
description: "This method retrieves all the countries that are available to perform a
verification. It returns an array of Alpha2 Country Codes"
operationId: GetCountryCodes
parameters:
- name: configurationName
in: path
description: The product configuration. Currently "Identity Verification" for all products.
required: true
schema:
type: string
default: Identity Verification
responses:
"200":
description: A collection of strings of all the countries that are available to perform a verification.
content:
application/json:
schema:
type: array
items:
type: string
examples:
response:
value:
- AU
- CA
- CN
- IN
- US
- GB
- IT
- MY
- NZ
- BE
text/json:
schema:
type: array
items:
type: string
"400":
description: Your request could not be processed, there should be more details in
the response.
"401":
description: The user name and password you provided is not valid or you are
using an account not configured to be an API user.
"408":
description: The request took longer to process than we waited.
"415":
description: You asked for a media type that we do not support. You should
request application/json in the Content-Type header.
"500":
description: An error happened on the server without a specific message.
security:
- ApiKeyAuth: []
"/configuration/v1/testentities/{configurationName}/{countryCode}":
get:
tags:
- Configuration
summary: Get Test Entities
description: Gets the test entities configured for your product and country.
operationId: GetTestEntities
parameters:
- name: configurationName
in: path
description: The product configuration. Currently "Identity Verification" for all
products.
required: true
schema:
type: string
default: Identity Verification
- name: countryCode
in: path
description: "Country alpha2 code"
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/DataFields"
examples:
response:
value:
- PersonInfo:
FirstGivenName: John
MiddleName: Henry
FirstSurName: Smith
DayOfBirth: "5"
MonthOfBirth: "3"
YearOfBirth: "1983"
Gender: M
Location:
BuildingNumber: "10"
UnitNumber: "3"
StreetName: Lawford
StreetType: st
Suburb: Doncaster
StateProvinceCode: VIC
PostalCode: "3108"
Communication:
Telephone: 03 9896 8785
EmailAddress: [email protected]
DriverLicence:
Number: "076310691"
State: VIC
DayOfExpiry: "3"
MonthOfExpiry: "4"
YearOfExpiry: "2021"
NationalIds:
- Number: "5643513953"
Type: Health
Passport:
Mrz1: P<SAGSMITH<<JOHN<HENRY<<<<<<<<<<<<<<<<<<<<<<
Mrz2: N1236548<1AUS8303052359438740809<<<<<<<<<<54
Number: N1236548
DayOfExpiry: 5
MonthOfExpiry: 12
YearOfExpiry: 2018
CountrySpecific:
AU:
AuImmiCardNumber: "EIS123456"
CitizenshipAcquisitionDay: "15"
CitizenshipAcquisitionMonth: "4"
CitizenshipAcquisitionYear: "1987"
CountryOfBirth: "Australia"
FamilyNameAtBirth: "Smith"
MedicareColor: "Blue"
MedicareMonthOfExpiry: "12"
MedicareReference: "2"
MedicareYearOfExpiry: "2017"
PassportCountry: "Australia"
PlaceOfBirth: "Melbourne"
RegistrationNumber: "565659"
RegistrationState: "NSW"
StockNumber: "ACD1234567"
"400":
description: Your request could not be processed, there should be more details in
the response.
"401":
description: The user name and password you provided is not valid or you are
using an account not configured to be an API user.
"408":
description: The request took longer to process than we waited.
"415":
description: You asked for a media type that we do not support. You should
request application/json in the Content-Type header.
"500":
description: An error happened on the server without a specific message.
security:
- ApiKeyAuth: []
"/configuration/v1/fields/{configurationName}/{countryCode}":
get:
tags:
- Configuration
summary: Get Fields
description: "Generates json schema for the API, the schema is dynamic based on the country and configuration you are using json-schema.org"
operationId: GetFields
parameters:
- name: countryCode
in: path
description: "Country alpha2 code"
required: true
schema:
type: string
- name: configurationName
in: path
description: The product configuration. Currently "Identity Verification" for all
products.
required: true
schema:
type: string
default: Identity Verification
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
examples:
response:
value:
title: DataFields
type: object
properties:
PersonInfo:
title: PersonInfo
type: object
properties:
FirstGivenName:
type: string
description: First name of the individual to be verified
label: First Name (名)
MiddleName:
type: string
description: Second given name of the individual to be verified
label: Middle Name
FirstSurName:
type: string
description: Last name of the individual to be verified
label: Last Name (姓)
ISOLatin1Name:
type: string
description: ISO Latin 1 Full name as it appears on passport
label: Passport Full Name
DayOfBirth:
type: int
description: Day of birth date (ie 23 for a date of birth of
23/11/1975)
label: Day Of Birth (日)
MonthOfBirth:
type: int
description: Month of birth date (ie 11 for a date of birth of
23/11/1975)
label: Month Of Birth (月)
YearOfBirth:
type: int
description: Year of birth date (ie 1975 for a date of birth of
23/11/1975)
label: Year Of Birth (年)
Gender:
type: string
description: Gender, may be 'M' for male or 'F' for female
label: Gender
AdditionalFields:
type: object
description: Family name and given names, together as found on
identification documents
label: Full Name (姓名)
properties:
title: AdditionalFields
type: object
properties:
FullName:
type: string
description: Family name and given names, together as
found on identification documents
label: Full Name (姓名)
required:
- FullName
required:
- FirstGivenName
- FirstGivenName
- FirstSurName
- FirstSurName
- AdditionalFields
- ISOLatin1Name
Location:
title: Location
type: object
properties:
BuildingNumber:
type: string
description: Building number of home address
label: Building Number (楼房号码)
BuildingName:
type: string
description: Building name of home address
label: Building Name (楼房名称)
UnitNumber:
type: string
description: Flat/Unit/Apartment number of primary residence
label: Unit Number
StreetName:
type: string
description: Street name of primary residence
label: Street Name (街道名称)
StreetType:
type: string
description: Street type of primary residence (Typically St, Rd
etc)
label: Street Type (街道种类)
City:
type: string
description: City of home address
label: City (城市)
Suburb:
type: string
description: City or Suburb of primary residence
label: Suburb
County:
type: string
description: County of home address
label: County (县)
StateProvinceCode:
type: string
description: State or Province
label: State Province
PostalCode:
type: string
description: ZIP Code or Postal Code of primary residence
label: Postal Code
POBox:
type: string
description: Post Office Box
label: PO Box
AdditionalFields:
type: object
description: Street address of primary residence
label: Address 1
properties:
title: AdditionalFields
type: object
properties:
Address1:
type: string
description: Street address of primary residence
label: Address 1
required: []
required: []
Communication:
title: Communication
type: object
properties:
Telephone:
type: string
description: Telephone number of the individual to be verified
label: Telephone (固定电话号码)
EmailAddress:
type: string
description: Email Address
label: Email Address
required:
- EmailAddress
NationalIds:
title: NationalIds
type: object
properties:
Number:
type: string
description: (National ID Number)
Type:
type: string
value: nationalid
DistrictOfIssue:
type: string
description: District where document was issued
label: District Of Issue (发证区)
CityOfIssue:
type: string
description: City where document was issued
label: City Of Issue (发证城市)
ProvinceOfIssue:
type: string
description: Province where document was issued
label: Province Of Issue (发证省)
CountyOfIssue:
type: string
description: County where document was issued
label: County Of Issue (发证县)
required:
- ProvinceOfIssue
- nationalid
Passport:
title: Passport
type: object
properties:
Mrz1:
type: string
description: First line of the Machine Readable Zone (MRZ) of
passport, 44 letters and digits, i.e. 'P<CZESPECIMEN<<VZOR<<<<<<<<<<<<<<<<<<<<<<<<<'
label: Passport MRZ Line 1 (护照第一行MRZ)
Mrz2:
type: string
description: Second line of the Machine Readable Zone (MRZ) of passport, 44 letters and digits, i.e. '99003853<1CZE1101018M1207046110101111<<<<<94'
label: Passport MRZ Line 2 (护照第二行MRZ)
Number:
type: string
description: Passport number of the individual to be verified
label: Passport Number (护照号)
DayOfExpiry:
type: int
description: Day of month of expiration of passport, 2 digits, i.e. '14'
label: Passport Day Of Expiry
MonthOfExpiry:
type: int
description: Month of year of expiration of passport, 2 digits, i.e. '08'
label: Passport Month Of Expiry
YearOfExpiry:
type: int
description: Year of expiration of passport, 4 digits, i.e. '1980'
label: Passport Year Of Expiry
required:
- Mrz1
- Mrz2
Business:
title: Business
type: object
properties:
BusinessName:
type: string
description: The Primary or Registered name of the business
label: Business Name
BusinessRegistrationNumber:
type: string
description: Registration number of a business to be verified
label: Business Registration Number
DayOfIncorporation:
type: int
description: Day of Incorporation date
label: Day Of Incorporation
MonthOfIncorporation:
type: int
description: Month of Incorporation date
label: Month Of Incorporation
YearOfIncorporation:
type: int
description: Year of Incorporation date
label: Year Of Incorporation
JurisdictionOfIncorporation:
type: string
description: Jurisdiction Of Incorporation
label: Jurisdiction Of Incorporation
ShareholderListDocument:
type: boolean
description: Retrieve the shareholder list document of a company from the Government Registry
label: Shareholder List Document
required:
- BusinessName
- BusinessRegistrationNumber
CountrySpecific:
title: CountrySpecific
type: object
properties:
CN:
title: CN
type: object
properties:
PassportMRZLine1:
type: string
description: First line of the Machine Readable Zone (MRZ) of
passport, 44 letters and digits, i.e. 'P<CZESPECIMEN<<VZOR<<<<<<<<<<<<<<<<<<<<<<<<<'
label: Passport MRZ Line 1 (护照第一行MRZ)
PassportMRZLine2:
type: string
description: Second line of the Machine Readable Zone (MRZ) of passport, 44 letters and digits, i.e. '99003853<1CZE1101018M1207046110101111<<<<<94'
label: Passport MRZ Line 2 (护照第二行MRZ)
PassportNumber:
type: string
description: Passport number of the individual to be verified
label: Passport Number (护照号)
PassportDayOfExpiry:
type: int
description: Day of month of expiration of passport, 2 digits, i.e. '14'
label: Passport Day Of Expiry
PassportMonthOfExpiry:
type: int
description: Month of year of expiration of passport, 2 digits, i.e. '08'
label: Passport Month Of Expiry
PassportYearOfExpiry:
type: int
description: Year of expiration of passport, 4 digits, i.e. '1980'
label: Passport Year Of Expiry
required:
- PassportMRZLine1
- PassportMRZLine2
"400":
description: Your request could not be processed, there should be more details in
the response.
"401":
description: The user name and password you provided is not valid or you are
using an account not configured to be an API user.
"408":
description: The request took longer to process than we waited.
"415":
description: You asked for a media type that we do not support. You should
request application/json in the Content-Type header.
"500":
description: An error happened on the server without a specific message.
security:
- ApiKeyAuth: []
"/configuration/v1/recommendedfields/{configurationName}/{countryCode}":
get:
tags:
- Configuration
summary: Get Recommended Fields
description: "Generates json schema for the API, the schema is dynamic based on the recommendedFields country and account you are using.\r\nhttp://json-schema.org/documentation.html"
operationId: GetRecommendedFields
parameters:
- name: countryCode
in: path
description: "Country alpha2 code"
required: true
schema:
type: string
- name: configurationName
in: path
description: The product configuration. Currently "Identity Verification" for all
products.
required: true
schema:
type: string
default: Identity Verification
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
examples:
response:
value:
title: DataFields
type: object
properties:
PersonInfo:
title: PersonInfo
type: object
properties:
FirstGivenName:
type: string
MiddleName:
type: string
FirstSurName:
type: string
DayOfBirth:
type: int
MonthOfBirth:
type: int
YearOfBirth:
type: int
Gender:
type: string
required:
- FirstGivenName
- FirstSurName
- DayOfBirth
- MonthOfBirth
- YearOfBirth
Location:
title: Location
type: object
properties:
BuildingNumber:
type: string
UnitNumber:
type: string
StreetName:
type: string
StreetType:
type: string
Suburb:
type: string
StateProvinceCode:
type: string
PostalCode:
type: string
required:
- BuildingNumber
- PostalCode
- StateProvinceCode
- StreetName
Communication:
title: Communication
type: object
properties:
MobileNumber:
type: string
Telephone:
type: string
EmailAddress:
type: string
required: []
DriverLicence:
title: DriverLicence
type: object
properties:
Number:
type: string
required:
- Number
NationalIds:
title: NationalIds
type: object
properties:
Number:
type: string
Type:
type: string
value: health
required:
- health
Passport:
title: Passport
type: object
properties:
Number:
type: string
required:
- Number
Document:
title: Document
type: object
properties:
DocumentFrontImage:
type: object
DocumentBackImage:
type: object
DocumentType:
type: string
required:
- DocumentFrontImage
- DocumentType
CountrySpecific:
title: CountrySpecific
type: object
properties:
AU:
title: AU
type: object
properties:
AuImmiCardNumber:
type: string
CitizenshipAcquisitionDay:
type: string
CitizenshipAcquisitionMonth:
type: string
CitizenshipAcquisitionYear:
type: string
CountryOfBirth:
type: string
DriverLicenceDayOfExpiry:
type: string
DriverLicenceMonthOfExpiry:
type: string
DriverLicenceState:
type: string
DriverLicenceYearOfExpiry:
type: string
FamilyNameAtBirth:
type: string
MedicareColor:
type: string
MedicareMonthOfExpiry:
type: string
MedicareReference:
type: string
MedicareYearOfExpiry:
type: string
PassportCountry:
type: string
PlaceOfBirth:
type: string
RegistrationNumber:
type: string
RegistrationState:
type: string
StockNumber:
type: string
CertificateNumber:
type: string
DayOfPrint:
type: string
FamilyNameAtCitizenship:
type: string
MedicareDayOfExpiry:
type: string
MonthOfPrint:
type: string
RTACardNumber:
type: string
RegistrationYear:
type: string
YearOfPrint:
type: string
required:
- AuImmiCardNumber
- CitizenshipAcquisitionDay
- CitizenshipAcquisitionMonth
- CitizenshipAcquisitionYear
- CountryOfBirth
- DriverLicenceDayOfExpiry
- DriverLicenceMonthOfExpiry
- DriverLicenceState
- DriverLicenceYearOfExpiry
- FamilyNameAtBirth
- MedicareColor
- MedicareMonthOfExpiry
- MedicareReference
- MedicareYearOfExpiry
- PassportCountry
- PlaceOfBirth
- RegistrationNumber
- RegistrationState
- StockNumber
"400":
description: Your request could not be processed, there should be more details in
the response.
"401":
description: The user name and password you provided is not valid or you are
using an account not configured to be an API user.
"408":
description: The request took longer to process than we waited.
"415":
description: You asked for a media type that we do not support. You should
request application/json in the Content-Type header.
"500":
description: An error happened on the server without a specific message.
security:
- ApiKeyAuth: []
"/configuration/v1/consents/{configurationName}/{countryCode}":
get:
tags:
- Configuration
summary: Get Consents
description: "This method retrieves the consents required for the data sources currently configured in your account
configuration. \r\nThe response for this method contains a collection of string that Verify method's
ConsentForDataSources field expects to perform a verification using those data sources. \r\nFailure to provide an
element from the string collection will lead to a 1005 service error"
operationId: GetConsents
parameters:
- name: countryCode
in: path
description: "Country alpha2 code"
required: true
schema:
type: string
- name: configurationName
in: path
description: The product configuration. Currently "Identity Verification" for all
products.
required: true
schema:
type: string
default: Identity Verification
responses:
"200":
description: A collection of strings that Verify method's ConsentForDataSources
field expects to perform a verification using those data sources.
content:
application/json:
schema:
type: array
items:
type: string
examples:
response:
value:
- Australia Driver Licence
- Australia Passport
- Birth Registry
- Visa Verification
- DVS Driver License Search
- DVS Medicare Search
- DVS Passport Search
- DVS Visa Search
- DVS ImmiCard Search
- DVS Citizenship Certificate Search
- DVS Certificate of Registration by Descent Search
- Credit Agency
text/json:
schema:
type: array
items:
type: string
"400":
description: Your request could not be processed, there should be more details in
the response.
"401":
description: The user name and password you provided is not valid or you are
using an account not configured to be an API user.
"408":
description: The request took longer to process than we waited.
"415":
description: You asked for a media type that we do not support. You should
request application/json in the Content-Type header.
"500":
description: An error happened on the server without a specific message.
security:
- ApiKeyAuth: []
"/configuration/v1/detailedConsents/{configurationName}/{countryCode}":
get:
tags:
- Configuration
summary: Get Detailed Consents
description: "This method retrieves details about consents required for data sources
currently configured in your account configuration. \r\nThe response for this method contains a collection of objects.\r\nEach object contains the Name of the data source, Text outlining
what the user is consenting to, and optionally a Url where the user can
find more information about how their data will be used. \r\nFailure to provide a Name from the object collection will lead
to a 1005 service error."
operationId: GetDetailedConsents
parameters:
- name: countryCode
in: path
description: Call CountryCodes to get the countries available to you.
required: true
schema:
type: string
- name: configurationName
in: path
description: Identity Verification
required: true
schema:
type: string
default: Identity Verification
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Consent"
examples:
response:
value:
- Name: Australia Passport
Text: The individual has given consent for their details to be
checked online with the Australian Passport Office.
Url: null
- Name: Visa Verification
Text: The individual has given consent for their details to be
checked online with the Australian Government -
Department of Immigration and Citizenship.
Url: null
text/json:
schema:
type: array
items:
$ref: "#/components/schemas/Consent"
"400":
description: Your request could not be processed, there should be more details in
the response.
"401":
description: The user name and password you provided is not valid or you are
using an account not configured to be an API user.
"408":
description: The request took longer to process than we waited.
"415":
description: You asked for a media type that we do not support. You should
request application/json in the Content-Type header.
"500":
description: An error happened on the server without a specific message.
security:
- ApiKeyAuth: []
"/configuration/v1/countrysubdivisions/{countryCode}":
get:
tags:
- Configuration
summary: Get Country Subdivisions
description: Gets the provinces states or other subdivisions for a country, mostly
matches ISO 3166-2
operationId: GetCountrySubdivisions
parameters:
- name: countryCode
in: path
description: "Country alpha2 code"
required: true
schema:
type: string
responses:
"200":
description: An array of the following object, where each object is the value of
a province, state or other subdivision for the given country.
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/CountrySubdivision"
examples:
response:
value:
- Name: Northern Territory
Code: NT
ParentCode: ""
- Name: Western Australia
Code: WA
ParentCode: ""
- Name: New South Wales
Code: NSW
ParentCode: ""
- Name: Queensland
Code: QLD
ParentCode: ""
- Name: South Australia
Code: SA
ParentCode: ""
- Name: Tasmania
Code: TAS
ParentCode: ""
- Name: Victoria
Code: VIC
ParentCode: ""
- Name: Australian Capital Territory
Code: ACT
ParentCode: ""
text/json:
schema:
type: array
items:
$ref: "#/components/schemas/CountrySubdivision"
"400":
description: Your request could not be processed, there should be more details in
the response.
"401":
description: The user name and password you provided is not valid or you are
using an account not configured to be an API user.
"408":
description: The request took longer to process than we waited.
"415":
description: You asked for a media type that we do not support. You should
request application/json in the Content-Type header.
"500":
description: An error happened on the server without a specific message.
security:
- ApiKeyAuth: []
"/configuration/v1/datasources/{configurationName}/{countryCode}":
get:
tags:
- Configuration
summary: Get Datasources
description: Gets datasource groups configured for your product and country.
operationId: GetDatasources
parameters:
- name: configurationName
in: path
description: The product configuration. Currently "Identity Verification" for all
products.
required: true
schema:
type: string
default: Identity Verification
- name: countryCode
in: path
description: "Country alpha2 code"
required: true
schema:
type: string
responses:
"200":
description: You will receive an array where each object represents one of the
Data source groups that you're configured for in the given country.
Each object will have the following structure.
content:
application/json:
schema: