forked from moov-io/fincen
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
243 lines (239 loc) · 11.2 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
openapi: 3.0.2
info:
description: Moov's fincen project implements a reader, writer, and validator for Fincen BSA forms in an HTTP server and Go library. Fincen (Financial crimes enforcment network) BSA data transmission methods for the the BSA E-Filing System.
version: v1
title: FINCEN API
contact:
url: https://github.com/moov-io/fincen
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: http://localhost:8206
description: Local development
tags:
- name: 'fincen report'
description: |
Fincen is a financial reporting for the United States. There are many fincen BSA forms.
paths:
/ping:
get:
tags: ['fincen report']
summary: Ping fincen service
description: Check if the fincen service is running.
operationId: ping
responses:
'200':
description: Service is running properly
/validator:
post:
tags: ['fincen report']
summary: Validate fincen report
description: Validating fincen xml batch report.
operationId: validator
requestBody:
content:
multipart/form-data:
schema:
properties:
disable_attrs:
type: boolean
description: Disable to validate attributes
default: false
input:
type: string
description: xml report form
format: binary
example:
<?xml version="1.0" encoding="UTF-8"?>
<EFilingBatchXML SeqNum="1" StatusCode="A">
<EFilingSubmissionXML SeqNum="1" StatusCode="A">
<EFilingActivityXML SeqNum="1">
<BSAID>31000055053784</BSAID>
<EFilingActivityErrorXML SeqNum="1">
<ErrorContextText>EFilingBatchXML/Activity[1]/Party[25]/PartyIdentification[49]/PartyIdentificationNumberText</ErrorContextText>
<ErrorElementNameText>PartyIdentificationNumberText</ErrorElementNameText>
<ErrorLevelText>WARN</ErrorLevelText>
<ErrorText>The value recorded for the EIN or SSN/ITIN is an invalid number string.</ErrorText>
<ErrorTypeCode>C21</ErrorTypeCode>
</EFilingActivityErrorXML>
<EFilingActivityErrorXML SeqNum="2">
<ErrorContextText>EFilingBatchXML/Activity[1]/Party[78]/PartyName[84]/RawIndividualFirstName</ErrorContextText>
<ErrorElementNameText>RawIndividualFirstName</ErrorElementNameText>
<ErrorLevelText>WARN</ErrorLevelText>
<ErrorText>The element is not recorded or does not contain a value for an individual Subject and unknown is not indicated.</ErrorText>
<ErrorTypeCode>C4</ErrorTypeCode>
</EFilingActivityErrorXML>
</EFilingActivityXML>
<EFilingActivityXML SeqNum="2">
<BSAID>31000055053785</BSAID>
<EFilingActivityErrorXML SeqNum="1"/>
</EFilingActivityXML>
<EFilingActivityXML SeqNum="3">
<BSAID>31000055053786</BSAID>
<EFilingActivityErrorXML SeqNum="1"/>
</EFilingActivityXML>
</EFilingSubmissionXML>
</EFilingBatchXML>
encoding:
file:
contentType: text/plain
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Success'
'400':
description: bad request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: failed operation
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/reformat:
post:
tags: ['fincen report']
summary: Convert fincen report
description: Reformat fincen xml batch report.
operationId: reformat
requestBody:
content:
multipart/form-data:
schema:
properties:
format:
type: string
description: refomat report type
default: xml
example: xml
enum:
- json
- xml
generate_attrs:
type: boolean
description: Enable to generate attributes
default: false
input:
type: string
description: fincen report
format: binary
example:
<?xml version="1.0" encoding="UTF-8"?>
<EFilingBatchXML SeqNum="1" StatusCode="A">
<EFilingSubmissionXML SeqNum="1" StatusCode="A">
<EFilingActivityXML SeqNum="1">
<BSAID>31000055053784</BSAID>
<EFilingActivityErrorXML SeqNum="1">
<ErrorContextText>EFilingBatchXML/Activity[1]/Party[25]/PartyIdentification[49]/PartyIdentificationNumberText</ErrorContextText>
<ErrorElementNameText>PartyIdentificationNumberText</ErrorElementNameText>
<ErrorLevelText>WARN</ErrorLevelText>
<ErrorText>The value recorded for the EIN or SSN/ITIN is an invalid number string.</ErrorText>
<ErrorTypeCode>C21</ErrorTypeCode>
</EFilingActivityErrorXML>
<EFilingActivityErrorXML SeqNum="2">
<ErrorContextText>EFilingBatchXML/Activity[1]/Party[78]/PartyName[84]/RawIndividualFirstName</ErrorContextText>
<ErrorElementNameText>RawIndividualFirstName</ErrorElementNameText>
<ErrorLevelText>WARN</ErrorLevelText>
<ErrorText>The element is not recorded or does not contain a value for an individual Subject and unknown is not indicated.</ErrorText>
<ErrorTypeCode>C4</ErrorTypeCode>
</EFilingActivityErrorXML>
</EFilingActivityXML>
<EFilingActivityXML SeqNum="2">
<BSAID>31000055053785</BSAID>
<EFilingActivityErrorXML SeqNum="1"/>
</EFilingActivityXML>
<EFilingActivityXML SeqNum="3">
<BSAID>31000055053786</BSAID>
<EFilingActivityErrorXML SeqNum="1"/>
</EFilingActivityXML>
</EFilingSubmissionXML>
</EFilingBatchXML>
encoding:
file:
contentType: text/plain
responses:
'200':
description: successful operation
content:
application/octet-stream:
schema:
type: string
description: fincen report
format: binary
example:
<?xml version="1.0" encoding="UTF-8"?>
<EFilingBatchXML SeqNum="1" StatusCode="A">
<EFilingSubmissionXML SeqNum="1" StatusCode="A">
<EFilingActivityXML SeqNum="1">
<BSAID>31000055053784</BSAID>
<EFilingActivityErrorXML SeqNum="1">
<ErrorContextText>EFilingBatchXML/Activity[1]/Party[25]/PartyIdentification[49]/PartyIdentificationNumberText</ErrorContextText>
<ErrorElementNameText>PartyIdentificationNumberText</ErrorElementNameText>
<ErrorLevelText>WARN</ErrorLevelText>
<ErrorText>The value recorded for the EIN or SSN/ITIN is an invalid number string.</ErrorText>
<ErrorTypeCode>C21</ErrorTypeCode>
</EFilingActivityErrorXML>
<EFilingActivityErrorXML SeqNum="2">
<ErrorContextText>EFilingBatchXML/Activity[1]/Party[78]/PartyName[84]/RawIndividualFirstName</ErrorContextText>
<ErrorElementNameText>RawIndividualFirstName</ErrorElementNameText>
<ErrorLevelText>WARN</ErrorLevelText>
<ErrorText>The element is not recorded or does not contain a value for an individual Subject and unknown is not indicated.</ErrorText>
<ErrorTypeCode>C4</ErrorTypeCode>
</EFilingActivityErrorXML>
</EFilingActivityXML>
<EFilingActivityXML SeqNum="2">
<BSAID>31000055053785</BSAID>
<EFilingActivityErrorXML SeqNum="1"/>
</EFilingActivityXML>
<EFilingActivityXML SeqNum="3">
<BSAID>31000055053786</BSAID>
<EFilingActivityErrorXML SeqNum="1"/>
</EFilingActivityXML>
</EFilingSubmissionXML>
</EFilingBatchXML>
application/json:
schema:
$ref: '#/components/schemas/BatchReport'
application/xml:
schema:
$ref: '#/components/schemas/BatchReport'
'400':
description: bad request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: failed operation
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
BatchReport:
properties:
XMLName:
type: string
SeqNum:
type: integer
Activity:
type: object
EFilingSubmissionXML:
type: object
description: "https://bsaefiling.fincen.treas.gov/FilingInformation.html"
Error:
properties:
error:
type: string
Success:
properties:
status:
type: string