forked from moov-io/watchman
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
1045 lines (1037 loc) · 31.1 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.2
info:
description: OFAC (Office of Foreign Assets Control) API is designed to facilitate the enforcement of US government economic sanctions programs required by federal law. This project implements a modern REST HTTP API for companies and organizations to obey federal law and use OFAC data in their applications.
version: v1
title: OFAC API
contact:
url: https://github.com/moov-io/ofac
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: http://localhost:8084
description: Local development
tags:
- name: OFAC
description: Endpoints for searching individuals and corporations which US government enforces economic sanctions against and adding webhook notifications for search criteria.
paths:
/ping:
get:
tags:
- OFAC
summary: Ping the OFAC service to check if running
operationId: ping
responses:
'200':
description: Service is running properly
# Company Endpoints
/companies/{companyID}:
get:
tags:
- OFAC
summary: Get information about a company, trust or organization such as addresses, alternate names, and remarks.
operationId: getOFACCompany
parameters:
- name: X-Request-ID
in: header
description: Optional Request ID allows application developer to trace requests through the systems logs
schema:
type: string
example: 94c825ee
- name: X-User-ID
in: header
description: Optional User ID used to perform this search
schema:
type: string
- name: companyID
in: path
description: Company ID
required: true
schema:
type: string
example: 1d1c824a
responses:
'200':
description: Company and associated metadata
content:
application/json:
schema:
$ref: '#/components/schemas/OFACCompany'
put:
tags:
- OFAC
summary: Update a Companies sanction status to always block or always allow transactions.
operationId: updateOFACCompanyStatus
parameters:
- name: X-Request-ID
in: header
description: Optional Request ID allows application developer to trace requests through the systems logs
schema:
type: string
example: 94c825ee
- name: X-User-ID
in: header
description: Optional User ID used to perform this search
schema:
type: string
- name: companyID
in: path
description: Company ID
required: true
schema:
type: string
example: 8d49fd61
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateCompanyStatus'
responses:
'200':
description: Company status updated
/companies/{companyID}/watch:
post:
tags:
- OFAC
summary: Add OFAC watch on a Company
operationId: addOFACCompanyWatch
parameters:
- name: X-Request-ID
in: header
description: Optional Request ID allows application developer to trace requests through the systems logs
schema:
type: string
example: 94c825ee
- name: X-User-ID
in: header
description: Optional User ID used to perform this search
schema:
type: string
- name: companyID
in: path
description: Company ID
required: true
schema:
type: string
example: c3cf0f66
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WatchRequest'
responses:
'200':
description: Company watch added
content:
application/json:
schema:
$ref: '#/components/schemas/Watch'
'404':
description: Company not found
/companies/{companyID}/watch/{watchID}:
delete:
tags:
- OFAC
summary: Remove company watch
operationId: removeOFACCompanyWatch
parameters:
- name: X-Request-ID
in: header
description: Optional Request ID allows application developer to trace requests through the systems logs
schema:
type: string
example: 94c825ee
- name: X-User-ID
in: header
description: Optional User ID used to perform this search
schema:
type: string
- name: companyID
in: path
description: Company ID
required: true
schema:
type: string
example: c3cf0f66
- name: watchID
in: path
description: Watch ID, used to identify a specific watch
required: true
schema:
type: string
example: 0c5e215c
responses:
'200':
description: Company watch removed
/companies/watch:
post:
tags:
- OFAC
summary: Add company watch by name. The match percentage will be included in the webhook's JSON payload.
operationId: addOFACCompanyNameWatch
parameters:
- name: X-Request-ID
in: header
description: Optional Request ID allows application developer to trace requests through the systems logs
schema:
type: string
example: 94c825ee
- name: X-User-ID
in: header
description: Optional User ID used to perform this search
schema:
type: string
- name: name
in: query
required: true
description: Company name used to match and send watch notifications
schema:
type: string
example: Jane Smith
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WatchRequest'
responses:
'200':
description: Company watch applied
content:
application/json:
schema:
$ref: '#/components/schemas/Watch'
/companies/watch/{watchID}:
delete:
tags:
- OFAC
summary: Remove a Company name watch
operationId: removeOFACCompanyNameWatch
parameters:
- name: X-Request-ID
in: header
description: Optional Request ID allows application developer to trace requests through the systems logs
schema:
type: string
example: 94c825ee
- name: X-User-ID
in: header
description: Optional User ID used to perform this search
schema:
type: string
- name: watchID
in: path
description: Watch ID, used to identify a specific watch
required: true
schema:
type: string
example: 0c5e215c
- name: name
in: query
description: Company name watch
required: true
schema:
type: string
example: Jane Smith
responses:
'200':
description: Company watch removed
# Customer Endpoints
/customers/{customerID}:
get:
tags:
- OFAC
summary: Get information about a customer, addresses, alternate names, and their SDN metadata.
operationId: getOFACCustomer
parameters:
- name: X-Request-ID
in: header
description: Optional Request ID allows application developer to trace requests through the systems logs
schema:
type: string
example: 94c825ee
- name: X-User-ID
in: header
description: Optional User ID used to perform this search
schema:
type: string
- name: customerID
in: path
description: Customer ID
required: true
schema:
type: string
example: c3cf0f66
responses:
'200':
description: Customer and associated metadata
content:
application/json:
schema:
$ref: '#/components/schemas/OFACCustomer'
put:
tags:
- OFAC
summary: Update a Customer's sanction status to always block or always allow transactions.
operationId: updateOFACCustomerStatus
parameters:
- name: X-Request-ID
in: header
description: Optional Request ID allows application developer to trace requests through the systems logs
schema:
type: string
example: 94c825ee
- name: X-User-ID
in: header
description: Optional User ID used to perform this search
schema:
type: string
- name: customerID
in: path
description: Customer ID
required: true
schema:
type: string
example: c3cf0f66
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateCustomerStatus'
responses:
'200':
description: Customer status updated
/customers/{customerID}/watch:
post:
tags:
- OFAC
summary: Add OFAC watch on a Customer
operationId: addOFACCustomerWatch
parameters:
- name: X-Request-ID
in: header
description: Optional Request ID allows application developer to trace requests through the systems logs
schema:
type: string
example: 94c825ee
- name: X-User-ID
in: header
description: Optional User ID used to perform this search
schema:
type: string
- name: customerID
in: path
description: Customer ID
required: true
schema:
type: string
example: c3cf0f66
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WatchRequest'
responses:
'200':
description: Customer watch added
content:
application/json:
schema:
$ref: '#/components/schemas/Watch'
'404':
description: Customer not found
/customers/{customerID}/watch/{watchID}:
delete:
tags:
- OFAC
summary: Remove customer watch
operationId: removeOFACCustomerWatch
parameters:
- name: X-Request-ID
in: header
description: Optional Request ID allows application developer to trace requests through the systems logs
schema:
type: string
example: 94c825ee
- name: X-User-ID
in: header
description: Optional User ID used to perform this search
schema:
type: string
- name: customerID
in: path
description: Customer ID
required: true
schema:
type: string
example: c3cf0f66
- name: watchID
in: path
description: Watch ID, used to identify a specific watch
required: true
schema:
type: string
example: 0c5e215c
responses:
'200':
description: Customer watch removed
/customers/watch:
post:
tags:
- OFAC
summary: Add customer watch by name. The match percentage will be included in the webhook's JSON payload.
operationId: addOFACCustomerNameWatch
parameters:
- name: X-Request-ID
in: header
description: Optional Request ID allows application developer to trace requests through the systems logs
schema:
type: string
example: 94c825ee
- name: X-User-ID
in: header
description: Optional User ID used to perform this search
schema:
type: string
- name: name
in: query
required: true
description: Individual name used to match and send watch notifications
schema:
type: string
example: Jane Smith
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WatchRequest'
responses:
'200':
description: Customer watch applied
content:
application/json:
schema:
$ref: '#/components/schemas/Watch'
/customers/watch/{watchID}:
delete:
tags:
- OFAC
summary: Remove a Customer name watch
operationId: removeOFACCustomerNameWatch
parameters:
- name: X-Request-ID
in: header
description: Optional Request ID allows application developer to trace requests through the systems logs
schema:
type: string
example: 94c825ee
- name: X-User-ID
in: header
description: Optional User ID used to perform this search
schema:
type: string
- name: watchID
in: path
description: Watch ID, used to identify a specific watch
required: true
schema:
type: string
example: 0c5e215c
- name: name
in: query
description: Customer or Company name watch
required: true
schema:
type: string
example: Jane Smith
responses:
'200':
description: Company or Customer watch removed
# SDN Endpoints
/sdn/{sdnID}:
get:
tags:
- OFAC
summary: Specially designated national
operationId: getSDN
parameters:
- name: X-Request-ID
in: header
description: Optional Request ID allows application developer to trace requests through the systems logs
schema:
type: string
example: 94c825ee
- name: X-User-ID
in: header
description: Optional User ID used to perform this search
schema:
type: string
- in: path
name: sdnID
required: true
description: SDN ID
schema:
type: string
example: 564dd7d1
responses:
'200':
description: SDN metadata
content:
application/json:
schema:
$ref: '#/components/schemas/SDN'
/sdn/{sdnID}/alts:
get:
tags:
- OFAC
summary: Get alternate names for a given SDN
operationId: getSDNAltNames
parameters:
- name: X-Request-ID
in: header
description: Optional Request ID allows application developer to trace requests through the systems logs
schema:
type: string
example: 94c825ee
- name: X-User-ID
in: header
description: Optional User ID used to perform this search
schema:
type: string
- in: path
name: sdnID
description: SDN ID
required: true
schema:
type: string
example: 564dd7d1
responses:
'200':
description: SDN alternate names
content:
application/json:
schema:
$ref: '#/components/schemas/SDNAltNames'
/sdn/{sdnID}/addresses:
get:
tags:
- OFAC
summary: Get addresses for a given SDN
operationId: getSDNAddresses
parameters:
- name: X-Request-ID
in: header
description: Optional Request ID allows application developer to trace requests through the systems logs
schema:
type: string
example: 94c825ee
- name: X-User-ID
in: header
description: Optional User ID used to perform this search
schema:
type: string
- in: path
name: sdnID
description: SDN ID
required: true
schema:
type: string
example: 564dd7d1
responses:
'200':
description: SDN addresses
content:
application/json:
schema:
$ref: '#/components/schemas/EntityAddresses'
# Search Endpoint
/search:
get:
tags:
- OFAC
summary: Search SDN names and metadata
operationId: search
parameters:
- name: X-Request-ID
in: header
description: Optional Request ID allows application developer to trace requests through the systems logs
schema:
type: string
example: 94c825ee
- name: X-User-ID
in: header
description: Optional User ID used to perform this search
schema:
type: string
- name: q
in: query
schema:
type: string
example: John Doe
description: Search across Name, Alt Names, and Address fields for all SDN entries. Entries may be returned in all response sub-objects.
- name: name
in: query
schema:
type: string
example: Jane Smith
description: Name which could correspond to a human on the SDN list. Only SDN results will be returned.
- name: address
in: query
schema:
type: string
example: 123 83rd Ave
description: Phsical address which could correspond to a human on the SDN list. Only Address results will be returned.
- name: city
in: query
schema:
type: string
example: USA
description: City name as desginated by SDN guidelines. Only Address results will be returned.
- name: state
in: query
schema:
type: string
example: USA
description: State name as desginated by SDN guidelines. Only Address results will be returned.
- name: providence
in: query
schema:
type: string
example: USA
description: Providence name as desginated by SDN guidelines. Only Address results will be returned.
- name: zip
in: query
schema:
type: string
example: USA
description: Zip code as desginated by SDN guidelines. Only Address results will be returned.
- name: country
in: query
schema:
type: string
example: USA
description: Country name as desginated by SDN guidelines. Only Address results will be returned.
- name: altName
in: query
schema:
type: string
example: Jane Smith
description: Alternate name which could correspond to a human on the SDN list. Only Alt name results will be returned.
- name: id
in: query
schema:
type: string
example: '10517860'
description: ID value often found in remarks property of an SDN. Takes the form of 'No. NNNNN' as an alphanumeric value.
- name: limit
in: query
schema:
type: integer
example: 25
description: Maximum results returned by a search
- name: sdnType
in: query
schema:
type: string
example: individual
description: Optional filter to only return SDNs whose type case-insensitively matches
- name: program
in: query
schema:
type: string
example: SDGT
description: Optional filter to only return SDNs whose program case-insensitively matches
responses:
'200':
description: SDNs returned from a search
content:
application/json:
schema:
$ref: '#/components/schemas/Search'
# Downloads endpoint
/downloads:
get:
tags:
- OFAC
summary: Return list of recent downloads of OFAC data
operationId: getLatestDownloads
parameters:
- name: X-Request-ID
in: header
description: Optional Request ID allows application developer to trace requests through the systems logs
schema:
type: string
example: 94c825ee
- name: X-User-ID
in: header
description: Optional User ID used to perform this search
schema:
type: string
- name: limit
in: query
schema:
type: integer
example: 25
description: Maximum results returned by a search
responses:
'200':
description: Recent timestamps and counts of parsed objects
content:
application/json:
schema:
$ref: '#/components/schemas/Downloads'
/ui/values/{key}:
get:
tags: ["OFAC"]
summary: Return an ordered distinct list of keys for an SDN property.
operationId: getUIValues
parameters:
- in: path
name: key
description: SDN property to lookup
required: true
schema:
type: string
example: sdnType
- name: limit
in: query
schema:
type: integer
example: 25
description: Maximum results returned by a search
responses:
'200':
description: Ordered and distinct list of values for an SDN property
content:
application/json:
schema:
$ref: '#/components/schemas/UIKeys'
'400':
description: Invalid key
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
Error:
required:
- error
properties:
error:
type: string
description: An error message describing the problem intended for humans.
example: Unknown key
OFACCompany:
description: OFAC Company and metadata
properties:
ID:
description: OFAC Company ID
type: string
example: 9574756b
sdn:
$ref: '#/components/schemas/SDN'
addresses:
type: array
items:
$ref: '#/components/schemas/EntityAddress'
alts:
type: array
items:
$ref: '#/components/schemas/Alt'
status:
$ref: '#/components/schemas/OFACCompanyStatus'
OFACCompanyStatus:
description: Status properties of an OFAC Company
properties:
userID:
description: User ID provided when updating status
type: string
example: 349661f9
note:
description: Optional note from updating status
type: string
example: 'Incorrect match'
status:
description: Manually applied status for OFAC Company
type: string
enum:
- unsafe
- exception
createdAt:
type: string
format: date-time
example: 2006-01-02T15:04:05Z07:00
OFACCustomer:
description: OFAC Customer and metadata
properties:
ID:
description: OFAC Customer ID
type: string
example: 9574756b
sdn:
$ref: '#/components/schemas/SDN'
addresses:
type: array
items:
$ref: '#/components/schemas/EntityAddress'
alts:
type: array
items:
$ref: '#/components/schemas/Alt'
status:
$ref: '#/components/schemas/OFACCustomerStatus'
OFACCustomerStatus:
description: Status properties of an OFAC Customer
properties:
userID:
description: User ID provided when updating status
type: string
example: 349661f9
note:
description: Optional note from updating status
type: string
example: 'Incorrect match'
status:
description: Manually applied status for OFAC Customer
type: string
enum:
- unsafe
- exception
createdAt:
type: string
format: date-time
example: 2006-01-02T15:04:05Z07:00
SDN:
description: Specially designated national from OFAC list
properties:
entityID:
type: string
example: 1231
sdnName:
type: string
example: BANCO NACIONAL DE CUBA
sdnType:
description: SDN's typically represent an individual (customer) or trust/company/organization. OFAC endpoints refer to customers or companies as different entities, but underlying both is the same SDN metadata.
type: string
example: individual
program:
type: string
example: CUBA
title:
type: string
example: Title of an individual
remarks:
type: string
match:
type: number
example: 0.91
description: Remarks on SDN and often additional information about the SDN
EntityAddresses:
type: array
items:
$ref: '#/components/schemas/EntityAddress'
EntityAddress:
description: Physical address from OFAC list
properties:
entityID:
type: string
example: 2112
addressID:
type: string
example: 201
address:
type: string
example: 123 73th St
cityStateProvincePostalCode:
type: string
example: Tokyo 103
country:
type: string
example: Japan
match:
type: number
example: 0.91
SDNAltNames:
type: array
items:
$ref: '#/components/schemas/Alt'
Alt:
description: Alternate name from OFAC list
properties:
entityID:
type: string
example: 306
alternateID:
type: string
example: 220
alternateType:
type: string
example: aka
alternateName:
type: string
example: NATIONAL BANK OF CUBA
alternateRemarks:
type: string
example: Extra information
match:
type: number
example: 0.91
DPL:
description: BIS Denied Persons List item
properties:
name:
type: string
description: Name of the Denied Person
example: ISMAEL RETA
streetAddress:
type: string
description: "Denied Person's street address"
example: 'REGISTER NUMBER: 78795-379, FEDERAL CORRECTIONAL INSTITUTION, P.O. BOX 4200'
city:
type: string
description: "Denied Person's city"
example: THREE RIVERS
state:
type: string
description: "Denied Person's state"
example: TX
country:
type: string
description: "Denied Person's country"
example: ""
postalCode:
type: string
description: "Denied Person's postal code"
example: 78071
effectiveDate:
type: string
description: Date when denial came into effect
example: '06/15/2016'
expirationDate:
type: string
description: Date when denial expires, if blank denial never expires
example: '06/15/2025'
standardOrder:
type: string
description: Denotes whether or not the Denied Person was added by a standard order
example: 'Y'
lastUpdate:
type: string
description: Most recent date when the Denied Person record was updated
example: '2016-06-22'
action:
type: string
description: Most recent action taken regarding the denial
example: FR NOTICE ADDED
frCitation:
type: string
description: Reference to the order's citation in the Federal Register
example: '81.F.R. 40658 6/22/2016'
match:
type: number
example: 0.92
UpdateCompanyStatus:
description: Request body to update a company status.
properties:
status:
description: manual override of company/SDN sanction status
type: string
enum:
- unsafe
- exception
notes:
description: Free form notes about manually changing the Company status
type: string
example: "False positive"
required:
- status
UpdateCustomerStatus:
description: Request body to update a customers status.
properties:
status:
description: manual override of customer/SDN sanction status
type: string
enum:
- unsafe
- exception
notes:
description: Free form notes about manually changing the Customer status
type: string
example: "False positive"
required:
- status
Search:
description: Search results containing SDNs, alternate names and/or addreses
properties:
SDNs:
type: array
items:
$ref: '#/components/schemas/SDN'
altNames:
type: array
items:
$ref: '#/components/schemas/Alt'
addresses:
type: array
items:
$ref: '#/components/schemas/EntityAddress'
deniedPersons:
type: array
items:
$ref: '#/components/schemas/DPL'
refreshedAt:
type: string
format: date-time
example: 2006-01-02T15:04:05Z07:00
Watch: