643 matches
34 actions
Credas
34 actions
- Add a liveness image (UAP) to the specified registration.POSTv1.0.0
- Add a selfie image to the registration.POSTv1.0.0
- Add an id document image to the specified registration.POSTv1.0.0
- Check includes identifying bankruptcy, insolvency, CCJ's or Company Directorship.POSTv1.0.0
- Checks if submitted documents are sufficient to complete registration.GETv1.0.0
- Creates new data check against a specified registration.POSTv1.0.0
- Creates new property registry check against the registration.POSTv1.0.0
- Creates new registration record, adds an ID document and optional selfie image in one go.POSTv1.0.0
- Creates new registration.POSTv1.0.0
- Finds a registration by the Id.GETv1.0.0
- Finds a registration by the RegCode.GETv1.0.0
- Finds registrations by the ReferenceId.GETv1.0.0
- Get a list of supported id document for the specified registration id.GETv1.0.0
- Get all id document images associated with a registration.GETv1.0.0
- GetCompanyGETv1.0.0
- Gets all available RegTypes.GETv1.0.0
- Gets paged registration list by search criteria or nothing if there are no matching fields. Optional parameters may be appended to the query string. Maximum page size is 50.GETv1.0.0
- Gets registration settings or nothing if there are no settings associated with the registration.GETv1.0.0
- Resends any invitation for the specified registration.POSTv1.0.0
- Retrieve the liveness action image (UAP) associated with a registration.GETv1.0.0
- Retrieve the liveness performed image associated with a registration.GETv1.0.0
- Retrieve the selfie image associated with a registration.GETv1.0.0
- Retrieves property registry check associated with the registration.GETv1.0.0
- Retrieves secure link to registration details page searching by the Registration Id.POSTv1.0.0
- Retrieves secure link to web verification page searching by the Registration Id.POSTv1.0.0
- Retrieves secure links to registration details pages searching by the Reference Id.POSTv1.0.0
- Retrieves secure links to web verification pages searching by the Reference Id.POSTv1.0.0
- Returns a detailed report on the analysis that has taken place of a scanned documentGETv1.0.0
- Searches for a company based on its Company Number and returns its details.POSTv1.0.0
- Sets an override for a specific check on the registration.PUTv1.0.0
- Updates a registration's contact details.PUTv1.0.0
- Updates registration settings.PUTv1.0.0
- Updates the status of the registration to one specified in the request.PUTv1.0.0
- Verifies bank account details.POSTv1.0.0
Security/Credas
Gets paged registration list by search criteria or nothing if there are no matching fields. Optional parameters may be appended to the query string. Maximum page size is 50.
v1.0.0Input
- 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
{
"type": "object",
"properties": {
"apikey": {
"type": "string"
},
"dob": {
"type": "string"
},
"email": {
"type": "string"
},
"forename": {
"type": "string"
},
"pageNum": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"surname": {
"type": "string"
}
},
"required": [
"apikey"
],
"additionalProperties": false
}Output
- 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
- 1001
- 1002
- 1003
- 1004
- 1005
- 1006
- 1007
- 1008
- 1009
- 1010
- 1011
- 1012
- 1013
- 1014
- 1015
- 1016
- 1017
- 1018
- 1019
- 1020
- 1021
- 1022
- 1023
- 1024
- 1025
- 1026
- 1027
- 1028
- 1029
- 1030
- 1031
- 1032
- 1033
- 1034
- 1035
- 1036
- 1037
- 1038
- 1039
- 1040
- 1041
- 1042
- 1043
- 1044
- 1045
- 1046
- 1047
- 1048
- 1049
- 1050
- 1051
- 1052
- 1053
- 1054
- 1055
- 1056
- 1057
- 1058
- 1059
- 1060
- 1061
- 1062
- 1063
- 1064
- 1065
- 1066
- 1067
- 1068
- 1069
- 1070
- 1071
- 1072
- 1073
- 1074
- 1075
- 1076
- 1077
- 1078
- 1079
- 1080
- 1081
- 1082
- 1083
- 1084
- 1085
- 1086
- 1087
- 1088
- 1089
- 1090
- 1091
- 1092
- 1093
- 1094
- 1095
- 1096
- 1097
- 1098
- 1099
- 1100
- 1101
- 1102
- 1103
- 1104
- 1105
- 1106
- 1107
- 1108
- 1109
- 1110
- 1111
- 1112
- 1113
- 1114
- 1115
- 1116
- 1117
- 1118
- 1119
- 1120
- 1121
- 1122
- 1123
- 1124
- 1125
- 1126
- 1127
- 1128
- 1129
- 1130
- 1131
- 1132
- 1133
- 1134
- 1135
- 1136
- 1137
- 1138
- 1139
- 1140
- 1141
- 1142
- 1143
- 1144
- 1145
- 1146
- 1147
- 1148
- 1149
- 1150
- 1151
- 1152
- 1153
- 1154
- 1155
- 1156
- 1157
- 1158
- 1159
- 1160
- 1161
- 1162
- 1163
- 1164
- 1165
- 1166
- 1167
- 1168
- 1169
- 1170
- 1171
- 1172
- 1173
- 1174
- 1175
- 1176
- 1177
- 1178
- 1179
- 1180
- 1181
- 1182
- 1183
- 1184
- 1185
- 1186
- 1187
- 1188
- 1189
- 1190
- 1191
- 1192
- 1193
- 1194
- 1195
- 1196
- 1197
- 1198
- 1199
- 1200
- 1201
- 1202
- 1203
- 1204
- 1205
- 1206
- 1207
- 1208
- 1209
- 1210
- 1211
- 1212
- 1213
- 1214
- 1215
- 1216
- 1217
- 1218
- 1219
- 1220
- 1221
- 1222
- 1223
- 1224
- 1225
- 1226
- 1227
- 1228
- 1229
- 1230
- 1231
- 1232
- 1233
- 1234
- 1235
- 1236
- 1237
- 1238
- 1239
- 1240
- 1241
- 1242
- 1243
- 1244
- 1245
- 1246
- 1247
- 1248
- 1249
- 1250
- 1251
- 1252
- 1253
- 1254
- 1255
- 1256
- 1257
- 1258
- 1259
- 1260
{
"type": "object",
"properties": {
"registrationSummaries": {
"type": "array",
"items": {
"type": "object",
"required": [
"dateCreated",
"status",
"livenessVerified",
"livenessStatus",
"rightToWorkDocumentsProvided",
"dataChecksPerformed",
"dataCheckResult",
"forename",
"surname",
"regTypeId",
"id",
"regCode"
],
"properties": {
"Comments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"checkType": {
"type": "integer",
"format": "int32",
"description": "IdDocuments = 1, StandardChecks = 2, InternationalSanctionsAndPep = 3, CreditStatusCheck = 4, BankAccountCheck = 5, ProofOfOwnership = 6, RightToWork = 7, RightToRent = 8",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8
]
},
"comment": {
"type": "string"
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"type": {
"type": "integer",
"format": "int32",
"description": "General = 0, CheckRelated = 1",
"enum": [
0,
1
]
}
}
}
},
"DITFDate": {
"type": "string",
"format": "date-time"
},
"DITFStatus": {
"type": "integer",
"format": "int32",
"description": "No = 0, Yes = 1, Pending = 2",
"enum": [
0,
1,
2
]
},
"bankAccountChecks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Address1": {
"type": "string"
},
"City": {
"type": "string"
},
"Forename": {
"type": "string"
},
"MiddleName": {
"type": "string"
},
"PostCode": {
"type": "string"
},
"Surname": {
"type": "string"
},
"accountNumber": {
"type": "string"
},
"accountNumberValidation": {
"type": "integer",
"format": "int32",
"description": "Unknown = 0, NoMatch = 1, Valid = 2, Invalid = 3, SevenDigitsMatched = 4, SixDigitsMatched = 5",
"enum": [
0,
1,
2,
3,
4,
5
]
},
"accountNumberValidationText": {
"type": "string"
},
"accountStatus": {
"type": "integer",
"format": "int32",
"description": "Unknown = 0, NoMatch = 1, Live = 2, ClosedOrSettled = 3",
"enum": [
0,
1,
2,
3
]
},
"accountStatusText": {
"type": "string"
},
"accountValid": {
"type": "boolean"
},
"addressValidation": {
"type": "integer",
"format": "int32",
"description": "Unknown = 0, NoMatch = 1, CurrentAddress = 2, PreviousAddress = 3, ForwardingAddress = 4",
"enum": [
0,
1,
2,
3,
4
]
},
"addressValidationText": {
"type": "string"
},
"checkDate": {
"type": "string",
"format": "date-time"
},
"checkId": {
"type": "string",
"format": "uuid"
},
"checkStatus": {
"type": "integer",
"format": "int32",
"description": "Unknown = 0, Pass = 1, Refer = 2, Fail = 3",
"enum": [
0,
1,
2,
3
]
},
"error": {
"type": "boolean"
},
"hasBeenOverridden": {
"type": "boolean"
},
"nameValidation": {
"type": "integer",
"format": "int32",
"description": "Unknown = 0, NoMatch = 1, Valid = 2",
"enum": [
0,
1,
2
]
},
"nameValidationText": {
"type": "string"
},
"referenceId": {
"type": "string"
},
"sortcode": {
"type": "string"
},
"sortcodeValidation": {
"type": "integer",
"format": "int32",
"description": "Unknown = 0, NoMatch = 1, Valid = 2, Invalid = 3, FiveDigitsMatched = 4",
"enum": [
0,
1,
2,
3,
4
]
},
"sortcodeValidationText": {
"type": "string"
}
}
}
},
"createdByAgencyUserId": {
"type": "string",
"format": "uuid"
},
"creditStatusCheck": {
"type": "object",
"properties": {
"address": {
"type": "object",
"required": [
"addressLine1",
"city",
"postcode",
"country"
],
"properties": {
"addressLine1": {
"type": "string"
},
"addressLine2": {
"type": "string"
},
"addressLine3": {
"type": "string"
},
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"county": {
"type": "string"
},
"postcode": {
"type": "string"
}
}
},
"ccj": {
"type": "array",
"items": {
"type": "object",
"properties": {
"address1": {
"type": "string"
},
"address2": {
"type": "string"
},
"address3": {
"type": "string"
},
"address4": {
"type": "string"
},
"address5": {
"type": "string"
},
"amount": {
"type": "string"
},
"caseNumber": {
"type": "string"
},
"courtName": {
"type": "string"
},
"dateEnd": {
"type": "string",
"format": "date-time"
},
"dob": {
"type": "string",
"format": "date-time"
},
"judgementDate": {
"type": "string",
"format": "date-time"
},
"judgementType": {
"type": "integer",
"format": "int32",
"description": "Unknown = 0, Judgement = 1, Satisfaction = 2, Revocation = 3, SetAside = 4, AdministrationOrder = 5",
"enum": [
0,
1,
2,
3,
4,
5
]
},
"judgementTypeText": {
"type": "string"
},
"name": {
"type": "string"
},
"postcode": {
"type": "string"
}
}
}
},
"checkDate": {
"type": "string",
"format": "date-time"
},
"companyDirector": {
"type": "array",
"items": {
"type": "object",
"properties": {
"companyAppointments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"address": {
"type": "object",
"additionalProperties": true
},
"appointmentDate": {
"type": "object",
"additionalProperties": true
},
"appointmentType": {
"type": "object",
"additionalProperties": true
},
"dob": {
"type": "object",
"additionalProperties": true
},
"name": {
"type": "object",
"additionalProperties": true
},
"nationality": {
"type": "object",
"additionalProperties": true
},
"occupation": {
"type": "object",
"additionalProperties": true
},
"title": {
"type": "object",
"additionalProperties": true
}
}
}
},
"companyName": {
"type": "string"
},
"companyRegNo": {
"type": "string"
},
"dateAppointed": {
"type": "string",
"format": "date-time"
},
"matchType": {
"type": "integer",
"format": "int32",
"description": "Unknown = 0, NameAndDateOfBirth = 1, NameAndAddress = 2, NameAndAddressAndDateOfBirth = 3",
"enum": [
0,
1,
2,
3
]
},
"matchTypeText": {
"type": "string"
},
"registeredOffice": {
"type": "string"
}
}
}
},
"hasBeenOverridden": {
"type": "boolean"
},
"insolvency": {
"type": "array",
"items": {
"type": "object",
"properties": {
"address": {
"type": "object",
"properties": {
"address1": {
"type": "string"
},
"address2": {
"type": "string"
},
"address3": {
"type": "string"
},
"address4": {
"type": "string"
},
"address5": {
"type": "string"
},
"dps": {
"type": "string"
},
"isEmpty": {
"type": "boolean"
},
"postcode": {
"type": "string"
}
}
},
"aliases": {
"type": "string"
},
"assetTotal": {
"type": "string"
},
"caseNo": {
"type": "string"
},
"caseType": {
"type": "string"
},
"court": {
"type": "string"
},
"debtTotal": {
"type": "string"
},
"description": {
"type": "string"
},
"dob": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string"
},
"occupation": {
"type": "string"
},
"presentationDate": {
"type": "string",
"format": "date-time"
},
"previousAddress": {
"type": "object",
"properties": {
"address1": {
"type": "string"
},
"address2": {
"type": "string"
},
"address3": {
"type": "string"
},
"address4": {
"type": "string"
},
"address5": {
"type": "string"
},
"dps": {
"type": "string"
},
"isEmpty": {
"type": "boolean"
},
"postcode": {
"type": "string"
}
}
},
"serviceOffice": {
"type": "string"
},
"startDate": {
"type": "string",
"format": "date-time"
},
"status": {
"type": "string"
},
"telephoneNumber": {
"type": "string"
},
"tradingNames": {
"type": "string"
},
"type": {
"type": "integer",
"format": "int32",
"description": "Unknown = 0, NorthernIrelandBankruptcy = 1, ScottishSequestrationBankruptcy = 2, EnglandAndWalesIVA = 3, EnglandAndWalesDRO = 4, EnglandAndWalesBankruptcy = 5",
"enum": [
0,
1,
2,
3,
4,
5
]
},
"typeText": {
"type": "string"
}
}
}
},
"person": {
"type": "object",
"required": [
"forename",
"surname",
"dateOfBirth"
],
"properties": {
"dateOfBirth": {
"type": "string",
"format": "date-time"
},
"forename": {
"type": "string"
},
"middleName": {
"type": "string"
},
"surname": {
"type": "string"
}
}
},
"status": {
"type": "integer",
"format": "int32",
"description": "Unknown = 0, Pass = 1, Refer = 2, Fail = 3",
"enum": [
0,
1,
2,
3
]
}
}
},
"customTermsAccepted": {
"type": "boolean"
},
"customTermsAcceptedDateTime": {
"type": "string",
"format": "date-time"
},
"customTermsAcceptedVersion": {
"type": "integer",
"format": "int32"
},
"dataCheckResult": {
"type": "integer",
"format": "int32",
"description": "Unknown = 0, Pass = 1, Refer = 2, Fail = 3",
"enum": [
0,
1,
2,
3
]
},
"dataCheckSources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"address": {
"type": "object",
"required": [
"addressLine1",
"city",
"postcode",
"country"
],
"properties": {
"addressLine1": {
"type": "string"
},
"addressLine2": {
"type": "string"
},
"addressLine3": {
"type": "string"
},
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"county": {
"type": "string"
},
"postcode": {
"type": "string"
}
}
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"hasBeenOverridden": {
"type": "boolean"
},
"hasPepSanctionsData": {
"type": "boolean"
},
"label": {
"type": "string"
},
"pepSanctionsData": {
"type": "array",
"items": {
"type": "object",
"properties": {
"addresses": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
"aliases": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
"fullName": {
"type": "string"
},
"id": {
"type": "string"
},
"positions": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
"sanctionBodies": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
"sanctionDates": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"person": {
"type": "object",
"required": [
"forename",
"surname",
"dateOfBirth"
],
"properties": {
"dateOfBirth": {
"type": "string",
"format": "date-time"
},
"forename": {
"type": "string"
},
"middleName": {
"type": "string"
},
"surname": {
"type": "string"
}
}
},
"remarks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"category": {
"type": "integer",
"format": "int32",
"description": "Match = 1, Mismatch = 2, Warning = 3, Comment = 4",
"enum": [
1,
2,
3,
4
]
},
"description": {
"type": "string"
}
}
}
},
"sourceType": {
"type": "integer",
"format": "int32",
"description": "Unknown = 0, EditedElectoralRollUk = 1, LandlineAppendUk = 2, MortalityUk = 3, CreaditHeaderAmlUk = 4, NcoaAlertFlagUk = 5, NcoaAlertFullUk = 6, SanctionsEnhancedInternational = 7, PepEnhancedInternational = 8, NationalIdentityRegisterUk = 9, LandRegistry = 10",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10
]
},
"status": {
"type": "integer",
"format": "int32",
"description": "Unknown = 0, Pass = 1, Refer = 2, Fail = 3",
"enum": [
0,
1,
2,
3
]
}
}
}
},
"dataChecksPerformed": {
"type": "boolean"
},
"dateCompleted": {
"type": "string",
"format": "date-time"
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"email": {
"type": "string"
},
"forename": {
"type": "string"
},
"hasLivenessPerformed": {
"type": "boolean"
},
"hasSelfie": {
"type": "boolean"
},
"id": {
"type": "string",
"format": "uuid"
},
"idDocuments": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"dateCreated",
"description",
"status",
"facialMatch",
"nameCheck",
"nameCheckMethod",
"nfcCheck",
"nfcReadStatus"
],
"properties": {
"addressCity": {
"type": "string"
},
"addressFull": {
"type": "string"
},
"addressPostcode": {
"type": "string"
},
"country": {
"type": "string"
},
"countryCode": {
"type": "string"
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"dateOfBirth": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string"
},
"documentAnalysisResult": {
"type": "integer",
"format": "int32",
"description": "Unknown = 0, Passed = 1, Refer = 2, Expired = 3, NotSupported = 4, Undefined = 5, Fail = 10, NotPerformed = 11",
"enum": [
0,
1,
2,
3,
4,
5,
10,
11
]
},
"documentNumber": {
"type": "string"
},
"documentSide": {
"type": "integer",
"format": "int32",
"description": "Front = 1, Back = 2",
"enum": [
0,
1,
2
]
},
"expiryDate": {
"type": "string",
"format": "date-time"
},
"facialMatch": {
"type": "boolean"
},
"forename": {
"type": "string"
},
"fullName": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"isUnderReview": {
"type": "boolean"
},
"manuallyVerified": {
"type": "boolean"
},
"middleName": {
"type": "string"
},
"mrz1": {
"type": "string"
},
"mrz2": {
"type": "string"
},
"mrz3": {
"type": "string"
},
"nameCheck": {
"type": "boolean"
},
"nameCheckMethod": {
"type": "integer",
"format": "int32",
"description": "Unknown = 0, Automatic = 1, Manual = 2",
"enum": [
0,
1,
2
]
},
"nfcCheck": {
"type": "boolean"
},
"nfcReadStatus": {
"type": "integer",
"format": "int32",
"description": "Unknown = 0, Passed = 1, Failed = 2, NotAttempted = 3, Skipped = 4, Unavailable = 5, NotAllowed = 6, NotTrusted = 7, NotApplicable = 8, Expired = 9, UnavailableWebJourney = 10",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10
]
},
"primaryScanId": {
"type": "string",
"format": "uuid"
},
"status": {
"type": "integer",
"format": "int32",
"description": "Indicates the verification status of the document itself by combining visual analysis and NFC verification results. </br>Note that this may be a pass even if facial or name matches have failed.<br /> values=> Unknown = 0, Pass = 1, Refer = 2, Fail = 3",
"enum": [
0,
1,
2,
3
]
},
"surname": {
"type": "string"
}
}
}
},
"idVerification": {
"type": "object",
"properties": {
"checkStatus": {
"type": "integer",
"format": "int32",
"description": "Unknown = 0, Pass = 1, Refer = 2, Fail = 3",
"enum": [
0,
1,
2,
3
]
},
"hasBeenOverridden": {
"type": "boolean"
}
}
},
"isAgentLed": {
"type": "boolean"
},
"livenessMethod": {
"type": "integer",
"format": "int32",
"description": "NotApplicable = 0, UniqueActionProcess = 1, Passive = 2",
"enum": [
0,
1,
2
]
},
"livenessStatus": {
"type": "integer",
"format": "int32",
"description": "NotSubmitted = 0, Verified = 1, Unverified = 2, Unknown = 3, RetakeRequested = 4",
"enum": [
0,
1,
2,
3,
4
]
},
"livenessVerified": {
"type": "boolean"
},
"middleName": {
"type": "string"
},
"personalDetails": {
"type": "object",
"properties": {
"address": {
"type": "object",
"required": [
"addressLine1",
"city",
"postcode",
"country"
],
"properties": {
"addressLine1": {
"type": "string"
},
"addressLine2": {
"type": "string"
},
"addressLine3": {
"type": "string"
},
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"county": {
"type": "string"
},
"postcode": {
"type": "string"
}
}
},
"dateOfBirth": {
"type": "string",
"format": "date-time"
},
"forename": {
"type": "string"
},
"surname": {
"type": "string"
}
}
},
"phoneNumber": {
"type": "string"
},
"proofOfOwnershipCheck": {
"type": "object",
"properties": {
"checkStatus": {
"type": "integer",
"format": "int32",
"description": "Unknown = 0, Pass = 1, Refer = 2, Fail = 3",
"enum": [
0,
1,
2,
3
]
},
"hasBeenOverridden": {
"type": "boolean"
},
"matchResult": {
"type": "integer",
"format": "int32",
"description": "Unknown = 0, FullNameMatch = 1, SurnameMatch = 2, NoNameMatch = 3, NoAddressMatch = 4, TitleNotRegistered = 5, Unavailable = 6, OutOfHours = 7",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7
]
},
"matchResultText": {
"type": "string"
},
"propertyOwnership": {
"type": "integer",
"format": "int32",
"description": "Unknown = 0, SoleOwnership = 1, JointOwnership = 2",
"enum": [
0,
1,
2
]
},
"propertyOwnershipText": {
"type": "string"
},
"titleNumber": {
"type": "string"
}
}
},
"referenceId": {
"type": "string"
},
"regCode": {
"type": "string"
},
"regTypeId": {
"type": "string",
"format": "uuid"
},
"rightToRentCheck": {
"type": "object",
"properties": {
"checkStatus": {
"type": "integer",
"format": "int32",
"description": "Unknown = 0, Pass = 1, Refer = 2, Fail = 3",
"enum": [
0,
1,
2,
3
]
},
"hasBeenOverridden": {
"type": "boolean"
},
"hasShareCodePdf": {
"type": "boolean"
},
"shareCodeFacialMatchStatus": {
"type": "integer",
"format": "int32",
"description": "Unknown = 0, Pass = 1, Refer = 2, Fail = 3",
"enum": [
0,
1,
2,
3
]
},
"shareCodeNameCheckStatus": {
"type": "integer",
"format": "int32",
"description": "Unknown = 0, Pass = 1, Refer = 2, Fail = 3",
"enum": [
0,
1,
2,
3
]
}
}
},
"rightToWorkCheck": {
"type": "object",
"properties": {
"checkStatus": {
"type": "integer",
"format": "int32",
"description": "Unknown = 0, Pass = 1, Refer = 2, Fail = 3",
"enum": [
0,
1,
2,
3
]
},
"hasBeenOverridden": {
"type": "boolean"
},
"hasShareCodePdf": {
"type": "boolean"
},
"shareCodeFacialMatchStatus": {
"type": "integer",
"format": "int32",
"description": "Unknown = 0, Pass = 1, Refer = 2, Fail = 3",
"enum": [
0,
1,
2,
3
]
},
"shareCodeNameCheckStatus": {
"type": "integer",
"format": "int32",
"description": "Unknown = 0, Pass = 1, Refer = 2, Fail = 3",
"enum": [
0,
1,
2,
3
]
}
}
},
"rightToWorkDocumentsProvided": {
"type": "integer",
"format": "int32",
"description": "This property is no longer supported. Right to work is now available as an individual check.<br /> values=> Pending = 0, Pass = 1, Fail = 2",
"enum": [
0,
1,
2
]
},
"safeHarbourVerifiedDate": {
"type": "string",
"format": "date-time"
},
"safeHarbourVerifiedStatus": {
"type": "integer",
"format": "int32",
"description": "No = 0, Yes = 1, UnderReview = 2",
"enum": [
0,
1,
2
]
},
"status": {
"type": "integer",
"format": "int32",
"description": "Unknown = 0, Submitted = 1, Approved = 2, Rejected = 3, Exported = 4, Invited = 6",
"enum": [
0,
1,
2,
3,
4,
6
]
},
"surname": {
"type": "string"
}
}
}
},
"totalCount": {
"type": "integer",
"format": "int32"
}
}
}