account-lookup-service 15.6.0-iso.7 → 15.6.0-snapshot.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -20,269 +20,307 @@ servers:
|
|
|
20
20
|
paths:
|
|
21
21
|
/parties/{Type}/{ID}:
|
|
22
22
|
parameters:
|
|
23
|
-
- $ref:
|
|
24
|
-
- $ref:
|
|
25
|
-
- $ref:
|
|
26
|
-
- $ref:
|
|
27
|
-
- $ref:
|
|
28
|
-
- $ref:
|
|
29
|
-
- $ref:
|
|
30
|
-
- $ref:
|
|
31
|
-
- $ref:
|
|
32
|
-
- $ref:
|
|
33
|
-
- $ref:
|
|
23
|
+
- $ref: "#/components/parameters/Type"
|
|
24
|
+
- $ref: "#/components/parameters/ID"
|
|
25
|
+
- $ref: "#/components/parameters/Content-Type"
|
|
26
|
+
- $ref: "#/components/parameters/Date"
|
|
27
|
+
- $ref: "#/components/parameters/X-Forwarded-For"
|
|
28
|
+
- $ref: "#/components/parameters/FSPIOP-Source"
|
|
29
|
+
- $ref: "#/components/parameters/FSPIOP-Destination"
|
|
30
|
+
- $ref: "#/components/parameters/FSPIOP-Encryption"
|
|
31
|
+
- $ref: "#/components/parameters/FSPIOP-Signature"
|
|
32
|
+
- $ref: "#/components/parameters/FSPIOP-URI"
|
|
33
|
+
- $ref: "#/components/parameters/FSPIOP-HTTP-Method"
|
|
34
34
|
get:
|
|
35
|
-
description:
|
|
35
|
+
description: >-
|
|
36
|
+
The HTTP request `GET /parties/{Type}/{ID}` (or `GET
|
|
37
|
+
/parties/{Type}/{ID}/{SubId}`) is used to look up information regarding
|
|
38
|
+
the requested Party, defined by `{Type}`, `{ID}` and optionally
|
|
39
|
+
`{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET
|
|
40
|
+
/parties/BUSINESS/shoecompany/employee1`).
|
|
36
41
|
summary: Look up party information
|
|
37
42
|
tags:
|
|
38
43
|
- parties
|
|
39
44
|
operationId: PartiesByTypeAndID
|
|
40
45
|
parameters:
|
|
41
|
-
- $ref:
|
|
46
|
+
- $ref: "#/components/parameters/Accept"
|
|
42
47
|
responses:
|
|
43
|
-
|
|
44
|
-
$ref:
|
|
45
|
-
|
|
46
|
-
$ref:
|
|
47
|
-
|
|
48
|
-
$ref:
|
|
49
|
-
|
|
50
|
-
$ref:
|
|
51
|
-
|
|
52
|
-
$ref:
|
|
53
|
-
|
|
54
|
-
$ref:
|
|
55
|
-
|
|
56
|
-
$ref:
|
|
57
|
-
|
|
58
|
-
$ref:
|
|
59
|
-
|
|
60
|
-
$ref:
|
|
48
|
+
"202":
|
|
49
|
+
$ref: "#/components/responses/202"
|
|
50
|
+
"400":
|
|
51
|
+
$ref: "#/components/responses/400"
|
|
52
|
+
"401":
|
|
53
|
+
$ref: "#/components/responses/401"
|
|
54
|
+
"403":
|
|
55
|
+
$ref: "#/components/responses/403"
|
|
56
|
+
"404":
|
|
57
|
+
$ref: "#/components/responses/404"
|
|
58
|
+
"405":
|
|
59
|
+
$ref: "#/components/responses/405"
|
|
60
|
+
"406":
|
|
61
|
+
$ref: "#/components/responses/406"
|
|
62
|
+
"501":
|
|
63
|
+
$ref: "#/components/responses/501"
|
|
64
|
+
"503":
|
|
65
|
+
$ref: "#/components/responses/503"
|
|
61
66
|
put:
|
|
62
|
-
description:
|
|
67
|
+
description: >-
|
|
68
|
+
The callback `PUT /parties/{Type}/{ID}` (or `PUT
|
|
69
|
+
/parties/{Type}/{ID}/{SubId}`) is used to inform the client of a
|
|
70
|
+
successful result of the Party information lookup.
|
|
63
71
|
summary: Return party information
|
|
64
72
|
tags:
|
|
65
73
|
- parties
|
|
66
74
|
operationId: PartiesByTypeAndID2
|
|
67
75
|
parameters:
|
|
68
|
-
- $ref:
|
|
76
|
+
- $ref: "#/components/parameters/Content-Length"
|
|
69
77
|
requestBody:
|
|
70
78
|
description: Party information returned.
|
|
71
79
|
required: true
|
|
72
80
|
content:
|
|
73
81
|
application/json:
|
|
74
82
|
schema:
|
|
75
|
-
$ref:
|
|
83
|
+
$ref: >-
|
|
84
|
+
#/components/schemas/GetParties_IdentificationVerificationReportV03
|
|
76
85
|
responses:
|
|
77
|
-
|
|
78
|
-
$ref:
|
|
79
|
-
|
|
80
|
-
$ref:
|
|
81
|
-
|
|
82
|
-
$ref:
|
|
83
|
-
|
|
84
|
-
$ref:
|
|
85
|
-
|
|
86
|
-
$ref:
|
|
87
|
-
|
|
88
|
-
$ref:
|
|
89
|
-
|
|
90
|
-
$ref:
|
|
91
|
-
|
|
92
|
-
$ref:
|
|
93
|
-
|
|
94
|
-
$ref:
|
|
86
|
+
"200":
|
|
87
|
+
$ref: "#/components/responses/200"
|
|
88
|
+
"400":
|
|
89
|
+
$ref: "#/components/responses/400"
|
|
90
|
+
"401":
|
|
91
|
+
$ref: "#/components/responses/401"
|
|
92
|
+
"403":
|
|
93
|
+
$ref: "#/components/responses/403"
|
|
94
|
+
"404":
|
|
95
|
+
$ref: "#/components/responses/404"
|
|
96
|
+
"405":
|
|
97
|
+
$ref: "#/components/responses/405"
|
|
98
|
+
"406":
|
|
99
|
+
$ref: "#/components/responses/406"
|
|
100
|
+
"501":
|
|
101
|
+
$ref: "#/components/responses/501"
|
|
102
|
+
"503":
|
|
103
|
+
$ref: "#/components/responses/503"
|
|
95
104
|
/parties/{Type}/{ID}/error:
|
|
96
105
|
put:
|
|
97
|
-
description:
|
|
106
|
+
description: >-
|
|
107
|
+
If the server is unable to find Party information of the provided
|
|
108
|
+
identity, or another processing error occurred, the error callback `PUT
|
|
109
|
+
/parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubI}/error`)
|
|
110
|
+
is used.
|
|
98
111
|
summary: Return party information error
|
|
99
112
|
tags:
|
|
100
113
|
- parties
|
|
101
114
|
operationId: PartiesErrorByTypeAndID
|
|
102
115
|
parameters:
|
|
103
|
-
- $ref:
|
|
104
|
-
- $ref:
|
|
105
|
-
- $ref:
|
|
106
|
-
- $ref:
|
|
107
|
-
- $ref:
|
|
108
|
-
- $ref:
|
|
109
|
-
- $ref:
|
|
110
|
-
- $ref:
|
|
111
|
-
- $ref:
|
|
112
|
-
- $ref:
|
|
113
|
-
- $ref:
|
|
114
|
-
- $ref:
|
|
116
|
+
- $ref: "#/components/parameters/Type"
|
|
117
|
+
- $ref: "#/components/parameters/ID"
|
|
118
|
+
- $ref: "#/components/parameters/Content-Length"
|
|
119
|
+
- $ref: "#/components/parameters/Content-Type"
|
|
120
|
+
- $ref: "#/components/parameters/Date"
|
|
121
|
+
- $ref: "#/components/parameters/X-Forwarded-For"
|
|
122
|
+
- $ref: "#/components/parameters/FSPIOP-Source"
|
|
123
|
+
- $ref: "#/components/parameters/FSPIOP-Destination"
|
|
124
|
+
- $ref: "#/components/parameters/FSPIOP-Encryption"
|
|
125
|
+
- $ref: "#/components/parameters/FSPIOP-Signature"
|
|
126
|
+
- $ref: "#/components/parameters/FSPIOP-URI"
|
|
127
|
+
- $ref: "#/components/parameters/FSPIOP-HTTP-Method"
|
|
115
128
|
requestBody:
|
|
116
129
|
description: Details of the error returned.
|
|
117
130
|
required: true
|
|
118
131
|
content:
|
|
119
132
|
application/json:
|
|
120
133
|
schema:
|
|
121
|
-
$ref:
|
|
134
|
+
$ref: >-
|
|
135
|
+
#/components/schemas/GetPartiesError_IdentificationVerificationReportV03
|
|
122
136
|
responses:
|
|
123
|
-
|
|
124
|
-
$ref:
|
|
125
|
-
|
|
126
|
-
$ref:
|
|
127
|
-
|
|
128
|
-
$ref:
|
|
129
|
-
|
|
130
|
-
$ref:
|
|
131
|
-
|
|
132
|
-
$ref:
|
|
133
|
-
|
|
134
|
-
$ref:
|
|
135
|
-
|
|
136
|
-
$ref:
|
|
137
|
-
|
|
138
|
-
$ref:
|
|
139
|
-
|
|
140
|
-
$ref:
|
|
137
|
+
"200":
|
|
138
|
+
$ref: "#/components/responses/200"
|
|
139
|
+
"400":
|
|
140
|
+
$ref: "#/components/responses/400"
|
|
141
|
+
"401":
|
|
142
|
+
$ref: "#/components/responses/401"
|
|
143
|
+
"403":
|
|
144
|
+
$ref: "#/components/responses/403"
|
|
145
|
+
"404":
|
|
146
|
+
$ref: "#/components/responses/404"
|
|
147
|
+
"405":
|
|
148
|
+
$ref: "#/components/responses/405"
|
|
149
|
+
"406":
|
|
150
|
+
$ref: "#/components/responses/406"
|
|
151
|
+
"501":
|
|
152
|
+
$ref: "#/components/responses/501"
|
|
153
|
+
"503":
|
|
154
|
+
$ref: "#/components/responses/503"
|
|
141
155
|
/parties/{Type}/{ID}/{SubId}:
|
|
142
156
|
parameters:
|
|
143
|
-
- $ref:
|
|
144
|
-
- $ref:
|
|
145
|
-
- $ref:
|
|
146
|
-
- $ref:
|
|
147
|
-
- $ref:
|
|
148
|
-
- $ref:
|
|
149
|
-
- $ref:
|
|
150
|
-
- $ref:
|
|
151
|
-
- $ref:
|
|
152
|
-
- $ref:
|
|
153
|
-
- $ref:
|
|
154
|
-
- $ref:
|
|
157
|
+
- $ref: "#/components/parameters/Type"
|
|
158
|
+
- $ref: "#/components/parameters/ID"
|
|
159
|
+
- $ref: "#/components/parameters/SubId"
|
|
160
|
+
- $ref: "#/components/parameters/Content-Type"
|
|
161
|
+
- $ref: "#/components/parameters/Date"
|
|
162
|
+
- $ref: "#/components/parameters/X-Forwarded-For"
|
|
163
|
+
- $ref: "#/components/parameters/FSPIOP-Source"
|
|
164
|
+
- $ref: "#/components/parameters/FSPIOP-Destination"
|
|
165
|
+
- $ref: "#/components/parameters/FSPIOP-Encryption"
|
|
166
|
+
- $ref: "#/components/parameters/FSPIOP-Signature"
|
|
167
|
+
- $ref: "#/components/parameters/FSPIOP-URI"
|
|
168
|
+
- $ref: "#/components/parameters/FSPIOP-HTTP-Method"
|
|
155
169
|
get:
|
|
156
|
-
description:
|
|
170
|
+
description: >-
|
|
171
|
+
The HTTP request `GET /parties/{Type}/{ID}` (or `GET
|
|
172
|
+
/parties/{Type}/{ID}/{SubId}`) is used to look up information regarding
|
|
173
|
+
the requested Party, defined by `{Type}`, `{ID}` and optionally
|
|
174
|
+
`{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET
|
|
175
|
+
/parties/BUSINESS/shoecompany/employee1`).
|
|
157
176
|
summary: Look up party information
|
|
158
177
|
tags:
|
|
159
178
|
- parties
|
|
160
179
|
operationId: PartiesSubIdByTypeAndID
|
|
161
180
|
parameters:
|
|
162
|
-
- $ref:
|
|
181
|
+
- $ref: "#/components/parameters/Accept"
|
|
163
182
|
responses:
|
|
164
|
-
|
|
165
|
-
$ref:
|
|
166
|
-
|
|
167
|
-
$ref:
|
|
168
|
-
|
|
169
|
-
$ref:
|
|
170
|
-
|
|
171
|
-
$ref:
|
|
172
|
-
|
|
173
|
-
$ref:
|
|
174
|
-
|
|
175
|
-
$ref:
|
|
176
|
-
|
|
177
|
-
$ref:
|
|
178
|
-
|
|
179
|
-
$ref:
|
|
180
|
-
|
|
181
|
-
$ref:
|
|
183
|
+
"202":
|
|
184
|
+
$ref: "#/components/responses/202"
|
|
185
|
+
"400":
|
|
186
|
+
$ref: "#/components/responses/400"
|
|
187
|
+
"401":
|
|
188
|
+
$ref: "#/components/responses/401"
|
|
189
|
+
"403":
|
|
190
|
+
$ref: "#/components/responses/403"
|
|
191
|
+
"404":
|
|
192
|
+
$ref: "#/components/responses/404"
|
|
193
|
+
"405":
|
|
194
|
+
$ref: "#/components/responses/405"
|
|
195
|
+
"406":
|
|
196
|
+
$ref: "#/components/responses/406"
|
|
197
|
+
"501":
|
|
198
|
+
$ref: "#/components/responses/501"
|
|
199
|
+
"503":
|
|
200
|
+
$ref: "#/components/responses/503"
|
|
182
201
|
put:
|
|
183
|
-
description:
|
|
202
|
+
description: >-
|
|
203
|
+
The callback `PUT /parties/{Type}/{ID}` (or `PUT
|
|
204
|
+
/parties/{Type}/{ID}/{SubId}`) is used to inform the client of a
|
|
205
|
+
successful result of the Party information lookup.
|
|
184
206
|
summary: Return party information
|
|
185
207
|
tags:
|
|
186
208
|
- parties
|
|
187
209
|
operationId: PartiesSubIdByTypeAndIDPut
|
|
188
210
|
parameters:
|
|
189
|
-
- $ref:
|
|
211
|
+
- $ref: "#/components/parameters/Content-Length"
|
|
190
212
|
requestBody:
|
|
191
213
|
description: Party information returned.
|
|
192
214
|
required: true
|
|
193
215
|
content:
|
|
194
216
|
application/json:
|
|
195
217
|
schema:
|
|
196
|
-
$ref:
|
|
218
|
+
$ref: >-
|
|
219
|
+
#/components/schemas/GetParties_IdentificationVerificationReportV03
|
|
197
220
|
responses:
|
|
198
|
-
|
|
199
|
-
$ref:
|
|
200
|
-
|
|
201
|
-
$ref:
|
|
202
|
-
|
|
203
|
-
$ref:
|
|
204
|
-
|
|
205
|
-
$ref:
|
|
206
|
-
|
|
207
|
-
$ref:
|
|
208
|
-
|
|
209
|
-
$ref:
|
|
210
|
-
|
|
211
|
-
$ref:
|
|
212
|
-
|
|
213
|
-
$ref:
|
|
214
|
-
|
|
215
|
-
$ref:
|
|
221
|
+
"200":
|
|
222
|
+
$ref: "#/components/responses/200"
|
|
223
|
+
"400":
|
|
224
|
+
$ref: "#/components/responses/400"
|
|
225
|
+
"401":
|
|
226
|
+
$ref: "#/components/responses/401"
|
|
227
|
+
"403":
|
|
228
|
+
$ref: "#/components/responses/403"
|
|
229
|
+
"404":
|
|
230
|
+
$ref: "#/components/responses/404"
|
|
231
|
+
"405":
|
|
232
|
+
$ref: "#/components/responses/405"
|
|
233
|
+
"406":
|
|
234
|
+
$ref: "#/components/responses/406"
|
|
235
|
+
"501":
|
|
236
|
+
$ref: "#/components/responses/501"
|
|
237
|
+
"503":
|
|
238
|
+
$ref: "#/components/responses/503"
|
|
216
239
|
/parties/{Type}/{ID}/{SubId}/error:
|
|
217
240
|
put:
|
|
218
|
-
description:
|
|
241
|
+
description: >-
|
|
242
|
+
If the server is unable to find Party information of the provided
|
|
243
|
+
identity, or another processing error occurred, the error callback `PUT
|
|
244
|
+
/parties/{Type}/{ID}/error` (or `PUT
|
|
245
|
+
/parties/{Type}/{ID}/{SubId}/error`) is used.
|
|
219
246
|
summary: Return party information error
|
|
220
247
|
tags:
|
|
221
248
|
- parties
|
|
222
249
|
operationId: PartiesSubIdErrorByTypeAndID
|
|
223
250
|
parameters:
|
|
224
|
-
- $ref:
|
|
225
|
-
- $ref:
|
|
226
|
-
- $ref:
|
|
227
|
-
- $ref:
|
|
228
|
-
- $ref:
|
|
229
|
-
- $ref:
|
|
230
|
-
- $ref:
|
|
231
|
-
- $ref:
|
|
232
|
-
- $ref:
|
|
233
|
-
- $ref:
|
|
234
|
-
- $ref:
|
|
235
|
-
- $ref:
|
|
236
|
-
- $ref:
|
|
251
|
+
- $ref: "#/components/parameters/Type"
|
|
252
|
+
- $ref: "#/components/parameters/ID"
|
|
253
|
+
- $ref: "#/components/parameters/SubId"
|
|
254
|
+
- $ref: "#/components/parameters/Content-Length"
|
|
255
|
+
- $ref: "#/components/parameters/Content-Type"
|
|
256
|
+
- $ref: "#/components/parameters/Date"
|
|
257
|
+
- $ref: "#/components/parameters/X-Forwarded-For"
|
|
258
|
+
- $ref: "#/components/parameters/FSPIOP-Source"
|
|
259
|
+
- $ref: "#/components/parameters/FSPIOP-Destination"
|
|
260
|
+
- $ref: "#/components/parameters/FSPIOP-Encryption"
|
|
261
|
+
- $ref: "#/components/parameters/FSPIOP-Signature"
|
|
262
|
+
- $ref: "#/components/parameters/FSPIOP-URI"
|
|
263
|
+
- $ref: "#/components/parameters/FSPIOP-HTTP-Method"
|
|
237
264
|
requestBody:
|
|
238
265
|
description: Details of the error returned.
|
|
239
266
|
required: true
|
|
240
267
|
content:
|
|
241
268
|
application/json:
|
|
242
269
|
schema:
|
|
243
|
-
$ref:
|
|
270
|
+
$ref: >-
|
|
271
|
+
#/components/schemas/GetPartiesError_IdentificationVerificationReportV03
|
|
244
272
|
responses:
|
|
245
|
-
|
|
246
|
-
$ref:
|
|
247
|
-
|
|
248
|
-
$ref:
|
|
249
|
-
|
|
250
|
-
$ref:
|
|
251
|
-
|
|
252
|
-
$ref:
|
|
253
|
-
|
|
254
|
-
$ref:
|
|
255
|
-
|
|
256
|
-
$ref:
|
|
257
|
-
|
|
258
|
-
$ref:
|
|
259
|
-
|
|
260
|
-
$ref:
|
|
261
|
-
|
|
262
|
-
$ref:
|
|
273
|
+
"200":
|
|
274
|
+
$ref: "#/components/responses/200"
|
|
275
|
+
"400":
|
|
276
|
+
$ref: "#/components/responses/400"
|
|
277
|
+
"401":
|
|
278
|
+
$ref: "#/components/responses/401"
|
|
279
|
+
"403":
|
|
280
|
+
$ref: "#/components/responses/403"
|
|
281
|
+
"404":
|
|
282
|
+
$ref: "#/components/responses/404"
|
|
283
|
+
"405":
|
|
284
|
+
$ref: "#/components/responses/405"
|
|
285
|
+
"406":
|
|
286
|
+
$ref: "#/components/responses/406"
|
|
287
|
+
"501":
|
|
288
|
+
$ref: "#/components/responses/501"
|
|
289
|
+
"503":
|
|
290
|
+
$ref: "#/components/responses/503"
|
|
263
291
|
components:
|
|
264
292
|
parameters:
|
|
265
|
-
|
|
266
|
-
name:
|
|
267
|
-
in:
|
|
293
|
+
Accept:
|
|
294
|
+
name: Accept
|
|
295
|
+
in: header
|
|
268
296
|
required: true
|
|
269
297
|
schema:
|
|
270
298
|
type: string
|
|
271
|
-
description:
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
299
|
+
description: >-
|
|
300
|
+
The `Accept` header field indicates the version of the API the client
|
|
301
|
+
would like the server to use.
|
|
302
|
+
Content-Length:
|
|
303
|
+
name: Content-Length
|
|
304
|
+
in: header
|
|
305
|
+
required: false
|
|
276
306
|
schema:
|
|
277
|
-
type:
|
|
278
|
-
description:
|
|
307
|
+
type: integer
|
|
308
|
+
description: >-
|
|
309
|
+
The `Content-Length` header field indicates the anticipated size of the
|
|
310
|
+
payload body. Only sent if there is a body.
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
**Note:** The API supports a maximum size of 5242880 bytes (5
|
|
314
|
+
Megabytes).
|
|
279
315
|
Content-Type:
|
|
280
316
|
name: Content-Type
|
|
281
317
|
in: header
|
|
282
318
|
schema:
|
|
283
319
|
type: string
|
|
284
320
|
required: true
|
|
285
|
-
description:
|
|
321
|
+
description: >-
|
|
322
|
+
The `Content-Type` header indicates the specific version of the API used
|
|
323
|
+
to send the payload body.
|
|
286
324
|
Date:
|
|
287
325
|
name: Date
|
|
288
326
|
in: header
|
|
@@ -290,301 +328,470 @@ components:
|
|
|
290
328
|
type: string
|
|
291
329
|
required: true
|
|
292
330
|
description: The `Date` header field indicates the date when the request was sent.
|
|
293
|
-
X-Forwarded-For:
|
|
294
|
-
name: X-Forwarded-For
|
|
295
|
-
in: header
|
|
296
|
-
schema:
|
|
297
|
-
type: string
|
|
298
|
-
required: false
|
|
299
|
-
description: |-
|
|
300
|
-
The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
|
301
|
-
|
|
302
|
-
**Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
|
303
|
-
FSPIOP-Source:
|
|
304
|
-
name: FSPIOP-Source
|
|
305
|
-
in: header
|
|
306
|
-
schema:
|
|
307
|
-
type: string
|
|
308
|
-
required: true
|
|
309
|
-
description: The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`).
|
|
310
331
|
FSPIOP-Destination:
|
|
311
332
|
name: FSPIOP-Destination
|
|
312
333
|
in: header
|
|
313
334
|
schema:
|
|
314
335
|
type: string
|
|
315
336
|
required: false
|
|
316
|
-
description:
|
|
337
|
+
description: >-
|
|
338
|
+
The `FSPIOP-Destination` header field is a non-HTTP standard field used
|
|
339
|
+
by the API for HTTP header based routing of requests and responses to
|
|
340
|
+
the destination. The field must be set by the original sender of the
|
|
341
|
+
request if the destination is known (valid for all services except GET
|
|
342
|
+
/parties) so that any entities between the client and the server do not
|
|
343
|
+
need to parse the payload for routing purposes. If the destination is
|
|
344
|
+
not known (valid for service GET /parties), the field should be left
|
|
345
|
+
empty.
|
|
317
346
|
FSPIOP-Encryption:
|
|
318
347
|
name: FSPIOP-Encryption
|
|
319
348
|
in: header
|
|
320
349
|
schema:
|
|
321
350
|
type: string
|
|
322
351
|
required: false
|
|
323
|
-
description:
|
|
324
|
-
|
|
325
|
-
|
|
352
|
+
description: >-
|
|
353
|
+
The `FSPIOP-Encryption` header field is a non-HTTP standard field used
|
|
354
|
+
by the API for applying end-to-end encryption of the request.
|
|
355
|
+
FSPIOP-HTTP-Method:
|
|
356
|
+
name: FSPIOP-HTTP-Method
|
|
326
357
|
in: header
|
|
327
358
|
schema:
|
|
328
359
|
type: string
|
|
329
360
|
required: false
|
|
330
|
-
description:
|
|
331
|
-
|
|
332
|
-
|
|
361
|
+
description: >-
|
|
362
|
+
The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used
|
|
363
|
+
by the API for signature verification, should contain the service HTTP
|
|
364
|
+
method. Required if signature verification is used, for more
|
|
365
|
+
information, see [the API Signature
|
|
366
|
+
document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
|
|
367
|
+
FSPIOP-Signature:
|
|
368
|
+
name: FSPIOP-Signature
|
|
333
369
|
in: header
|
|
334
370
|
schema:
|
|
335
371
|
type: string
|
|
336
372
|
required: false
|
|
337
|
-
description:
|
|
338
|
-
|
|
339
|
-
|
|
373
|
+
description: >-
|
|
374
|
+
The `FSPIOP-Signature` header field is a non-HTTP standard field used by
|
|
375
|
+
the API for applying an end-to-end request signature.
|
|
376
|
+
FSPIOP-Source:
|
|
377
|
+
name: FSPIOP-Source
|
|
340
378
|
in: header
|
|
341
379
|
schema:
|
|
342
380
|
type: string
|
|
343
|
-
required: false
|
|
344
|
-
description: The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
|
|
345
|
-
Accept:
|
|
346
|
-
name: Accept
|
|
347
|
-
in: header
|
|
348
381
|
required: true
|
|
382
|
+
description: >-
|
|
383
|
+
The `FSPIOP-Source` header field is a non-HTTP standard field used by
|
|
384
|
+
the API for identifying the sender of the HTTP request. The field should
|
|
385
|
+
be set by the original sender of the request. Required for routing and
|
|
386
|
+
signature verification (see header field `FSPIOP-Signature`).
|
|
387
|
+
FSPIOP-URI:
|
|
388
|
+
name: FSPIOP-URI
|
|
389
|
+
in: header
|
|
349
390
|
schema:
|
|
350
391
|
type: string
|
|
351
|
-
description: The `Accept` header field indicates the version of the API the client would like the server to use.
|
|
352
|
-
Content-Length:
|
|
353
|
-
name: Content-Length
|
|
354
|
-
in: header
|
|
355
392
|
required: false
|
|
393
|
+
description: >-
|
|
394
|
+
The `FSPIOP-URI` header field is a non-HTTP standard field used by the
|
|
395
|
+
API for signature verification, should contain the service URI. Required
|
|
396
|
+
if signature verification is used, for more information, see [the API
|
|
397
|
+
Signature
|
|
398
|
+
document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
|
|
399
|
+
ID:
|
|
400
|
+
name: ID
|
|
401
|
+
in: path
|
|
402
|
+
required: true
|
|
356
403
|
schema:
|
|
357
|
-
type:
|
|
358
|
-
description:
|
|
359
|
-
The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
|
360
|
-
|
|
361
|
-
**Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
|
404
|
+
type: string
|
|
405
|
+
description: The identifier value.
|
|
362
406
|
SubId:
|
|
363
407
|
name: SubId
|
|
364
408
|
in: path
|
|
365
409
|
required: true
|
|
366
410
|
schema:
|
|
367
411
|
type: string
|
|
368
|
-
description:
|
|
412
|
+
description: >-
|
|
413
|
+
A sub-identifier of the party identifier, or a sub-type of the party
|
|
414
|
+
identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`.
|
|
415
|
+
Type:
|
|
416
|
+
name: Type
|
|
417
|
+
in: path
|
|
418
|
+
required: true
|
|
419
|
+
schema:
|
|
420
|
+
type: string
|
|
421
|
+
description: The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`.
|
|
422
|
+
X-Forwarded-For:
|
|
423
|
+
name: X-Forwarded-For
|
|
424
|
+
in: header
|
|
425
|
+
schema:
|
|
426
|
+
type: string
|
|
427
|
+
required: false
|
|
428
|
+
description: >-
|
|
429
|
+
The `X-Forwarded-For` header field is an unofficially accepted standard
|
|
430
|
+
used for informational purposes of the originating client IP address, as
|
|
431
|
+
a request might pass multiple proxies, firewalls, and so on. Multiple
|
|
432
|
+
`X-Forwarded-For` values should be expected and supported by
|
|
433
|
+
implementers of the API.
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
**Note:** An alternative to `X-Forwarded-For` is defined in [RFC
|
|
437
|
+
7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC
|
|
438
|
+
7239 is less-used and supported than `X-Forwarded-For`.
|
|
369
439
|
responses:
|
|
370
|
-
|
|
440
|
+
"200":
|
|
371
441
|
description: OK
|
|
372
|
-
|
|
442
|
+
"202":
|
|
373
443
|
description: Accepted
|
|
374
|
-
|
|
444
|
+
"400":
|
|
375
445
|
description: Bad Request
|
|
376
446
|
content:
|
|
377
447
|
application/json:
|
|
378
448
|
schema:
|
|
379
|
-
$ref:
|
|
449
|
+
$ref: "#/components/schemas/ErrorInformationResponse"
|
|
380
450
|
headers:
|
|
381
451
|
Content-Length:
|
|
382
|
-
$ref:
|
|
452
|
+
$ref: "#/components/headers/Content-Length"
|
|
383
453
|
Content-Type:
|
|
384
|
-
$ref:
|
|
385
|
-
|
|
454
|
+
$ref: "#/components/headers/Content-Type"
|
|
455
|
+
"401":
|
|
386
456
|
description: Unauthorized
|
|
387
457
|
content:
|
|
388
458
|
application/json:
|
|
389
459
|
schema:
|
|
390
|
-
$ref:
|
|
460
|
+
$ref: "#/components/schemas/ErrorInformationResponse"
|
|
391
461
|
headers:
|
|
392
462
|
Content-Length:
|
|
393
|
-
$ref:
|
|
463
|
+
$ref: "#/components/headers/Content-Length"
|
|
394
464
|
Content-Type:
|
|
395
|
-
$ref:
|
|
396
|
-
|
|
465
|
+
$ref: "#/components/headers/Content-Type"
|
|
466
|
+
"403":
|
|
397
467
|
description: Forbidden
|
|
398
468
|
content:
|
|
399
469
|
application/json:
|
|
400
470
|
schema:
|
|
401
|
-
$ref:
|
|
471
|
+
$ref: "#/components/schemas/ErrorInformationResponse"
|
|
402
472
|
headers:
|
|
403
473
|
Content-Length:
|
|
404
|
-
$ref:
|
|
474
|
+
$ref: "#/components/headers/Content-Length"
|
|
405
475
|
Content-Type:
|
|
406
|
-
$ref:
|
|
407
|
-
|
|
476
|
+
$ref: "#/components/headers/Content-Type"
|
|
477
|
+
"404":
|
|
408
478
|
description: Not Found
|
|
409
479
|
content:
|
|
410
480
|
application/json:
|
|
411
481
|
schema:
|
|
412
|
-
$ref:
|
|
482
|
+
$ref: "#/components/schemas/ErrorInformationResponse"
|
|
413
483
|
headers:
|
|
414
484
|
Content-Length:
|
|
415
|
-
$ref:
|
|
485
|
+
$ref: "#/components/headers/Content-Length"
|
|
416
486
|
Content-Type:
|
|
417
|
-
$ref:
|
|
418
|
-
|
|
487
|
+
$ref: "#/components/headers/Content-Type"
|
|
488
|
+
"405":
|
|
419
489
|
description: Method Not Allowed
|
|
420
490
|
content:
|
|
421
491
|
application/json:
|
|
422
492
|
schema:
|
|
423
|
-
$ref:
|
|
493
|
+
$ref: "#/components/schemas/ErrorInformationResponse"
|
|
424
494
|
headers:
|
|
425
495
|
Content-Length:
|
|
426
|
-
$ref:
|
|
496
|
+
$ref: "#/components/headers/Content-Length"
|
|
427
497
|
Content-Type:
|
|
428
|
-
$ref:
|
|
429
|
-
|
|
498
|
+
$ref: "#/components/headers/Content-Type"
|
|
499
|
+
"406":
|
|
430
500
|
description: Not Acceptable
|
|
431
501
|
content:
|
|
432
502
|
application/json:
|
|
433
503
|
schema:
|
|
434
|
-
$ref:
|
|
504
|
+
$ref: "#/components/schemas/ErrorInformationResponse"
|
|
435
505
|
headers:
|
|
436
506
|
Content-Length:
|
|
437
|
-
$ref:
|
|
507
|
+
$ref: "#/components/headers/Content-Length"
|
|
438
508
|
Content-Type:
|
|
439
|
-
$ref:
|
|
440
|
-
|
|
509
|
+
$ref: "#/components/headers/Content-Type"
|
|
510
|
+
"501":
|
|
441
511
|
description: Not Implemented
|
|
442
512
|
content:
|
|
443
513
|
application/json:
|
|
444
514
|
schema:
|
|
445
|
-
$ref:
|
|
515
|
+
$ref: "#/components/schemas/ErrorInformationResponse"
|
|
446
516
|
headers:
|
|
447
517
|
Content-Length:
|
|
448
|
-
$ref:
|
|
518
|
+
$ref: "#/components/headers/Content-Length"
|
|
449
519
|
Content-Type:
|
|
450
|
-
$ref:
|
|
451
|
-
|
|
520
|
+
$ref: "#/components/headers/Content-Type"
|
|
521
|
+
"503":
|
|
452
522
|
description: Service Unavailable
|
|
453
523
|
content:
|
|
454
524
|
application/json:
|
|
455
525
|
schema:
|
|
456
|
-
$ref:
|
|
526
|
+
$ref: "#/components/schemas/ErrorInformationResponse"
|
|
457
527
|
headers:
|
|
458
528
|
Content-Length:
|
|
459
|
-
$ref:
|
|
529
|
+
$ref: "#/components/headers/Content-Length"
|
|
460
530
|
Content-Type:
|
|
461
|
-
$ref:
|
|
531
|
+
$ref: "#/components/headers/Content-Type"
|
|
462
532
|
headers:
|
|
463
533
|
Content-Length:
|
|
464
534
|
required: false
|
|
465
535
|
schema:
|
|
466
536
|
type: integer
|
|
467
|
-
description:
|
|
468
|
-
The `Content-Length` header field indicates the anticipated size of the
|
|
537
|
+
description: >-
|
|
538
|
+
The `Content-Length` header field indicates the anticipated size of the
|
|
539
|
+
payload body. Only sent if there is a body.
|
|
469
540
|
|
|
470
|
-
|
|
541
|
+
|
|
542
|
+
**Note:** The API supports a maximum size of 5242880 bytes (5
|
|
543
|
+
Megabytes).
|
|
471
544
|
Content-Type:
|
|
472
545
|
schema:
|
|
473
546
|
type: string
|
|
474
547
|
required: true
|
|
475
|
-
description:
|
|
548
|
+
description: >-
|
|
549
|
+
The `Content-Type` header indicates the specific version of the API used
|
|
550
|
+
to send the payload body.
|
|
476
551
|
schemas:
|
|
477
|
-
|
|
478
|
-
title:
|
|
479
|
-
type: string
|
|
480
|
-
pattern: ^[1-9]\d{3}$
|
|
481
|
-
description: The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.
|
|
482
|
-
example: '5100'
|
|
483
|
-
ErrorDescription:
|
|
484
|
-
title: ErrorDescription
|
|
485
|
-
type: string
|
|
486
|
-
minLength: 1
|
|
487
|
-
maxLength: 128
|
|
488
|
-
description: Error description string.
|
|
489
|
-
ExtensionKey:
|
|
490
|
-
title: ExtensionKey
|
|
491
|
-
type: string
|
|
492
|
-
minLength: 1
|
|
493
|
-
maxLength: 32
|
|
494
|
-
description: Extension key.
|
|
495
|
-
ExtensionValue:
|
|
496
|
-
title: ExtensionValue
|
|
497
|
-
type: string
|
|
498
|
-
minLength: 1
|
|
499
|
-
maxLength: 128
|
|
500
|
-
description: Extension value.
|
|
501
|
-
Extension:
|
|
502
|
-
title: Extension
|
|
503
|
-
type: object
|
|
504
|
-
description: Data model for the complex type Extension.
|
|
505
|
-
properties:
|
|
506
|
-
key:
|
|
507
|
-
$ref: '#/components/schemas/ExtensionKey'
|
|
508
|
-
value:
|
|
509
|
-
$ref: '#/components/schemas/ExtensionValue'
|
|
510
|
-
required:
|
|
511
|
-
- key
|
|
512
|
-
- value
|
|
513
|
-
ExtensionList:
|
|
514
|
-
title: ExtensionList
|
|
515
|
-
type: object
|
|
516
|
-
description: |
|
|
517
|
-
Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
|
|
518
|
-
properties:
|
|
519
|
-
extension:
|
|
520
|
-
type: array
|
|
521
|
-
items:
|
|
522
|
-
$ref: '#/components/schemas/Extension'
|
|
523
|
-
minItems: 1
|
|
524
|
-
maxItems: 16
|
|
525
|
-
description: Number of Extension elements.
|
|
526
|
-
required:
|
|
527
|
-
- extension
|
|
528
|
-
ErrorInformation:
|
|
529
|
-
title: ErrorInformation
|
|
530
|
-
type: object
|
|
531
|
-
description: Data model for the complex type ErrorInformation.
|
|
532
|
-
properties:
|
|
533
|
-
errorCode:
|
|
534
|
-
$ref: '#/components/schemas/ErrorCode'
|
|
535
|
-
errorDescription:
|
|
536
|
-
$ref: '#/components/schemas/ErrorDescription'
|
|
537
|
-
extensionList:
|
|
538
|
-
$ref: '#/components/schemas/ExtensionList'
|
|
539
|
-
required:
|
|
540
|
-
- errorCode
|
|
541
|
-
- errorDescription
|
|
542
|
-
ErrorInformationResponse:
|
|
543
|
-
title: ErrorInformationResponse
|
|
552
|
+
AccountIdentification4Choice:
|
|
553
|
+
title: AccountIdentification4Choice
|
|
544
554
|
type: object
|
|
545
|
-
description:
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
minLength: 1
|
|
556
|
-
maxLength: 35
|
|
557
|
-
example: 1.234567890123457e+34
|
|
558
|
-
ISODateTime:
|
|
559
|
-
title: ISODateTime
|
|
560
|
-
description: |
|
|
561
|
-
A particular point in the progression of time defined by a mandatory
|
|
562
|
-
date and a mandatory time component, expressed in either UTC time
|
|
563
|
-
format (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format
|
|
564
|
-
(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format
|
|
565
|
-
(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in
|
|
566
|
-
"XML Schema Part 2: Datatypes Second Edition -
|
|
567
|
-
W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
|
|
555
|
+
description: >
|
|
556
|
+
Specifies the unique identification of an account as assigned by the
|
|
557
|
+
account servicer.
|
|
558
|
+
anyOf:
|
|
559
|
+
- properties:
|
|
560
|
+
IBAN:
|
|
561
|
+
allOf:
|
|
562
|
+
- $ref: "#/components/schemas/IBAN2007Identifier"
|
|
563
|
+
- description: >
|
|
564
|
+
IBAN
|
|
568
565
|
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
566
|
+
International Bank Account Number (IBAN) - identifier used
|
|
567
|
+
internationally by financial institutions to uniquely
|
|
568
|
+
identify the account of a customer. Further specifications
|
|
569
|
+
of the format and content of the IBAN can be found in the
|
|
570
|
+
standard ISO 13616 "Banking and related financial services -
|
|
571
|
+
International Bank Account Number (IBAN)" version
|
|
572
|
+
1997-10-01, or later revisions.
|
|
573
|
+
required:
|
|
574
|
+
- IBAN
|
|
575
|
+
- properties:
|
|
576
|
+
Othr:
|
|
577
|
+
allOf:
|
|
578
|
+
- $ref: "#/components/schemas/GenericAccountIdentification1"
|
|
579
|
+
- description: >
|
|
580
|
+
Other
|
|
573
581
|
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
title:
|
|
582
|
+
Unique identification of an account, as assigned by the
|
|
583
|
+
account servicer, using an identification scheme.
|
|
584
|
+
required:
|
|
585
|
+
- Othr
|
|
586
|
+
example:
|
|
587
|
+
IBAN: BE71096123456769
|
|
588
|
+
AccountSchemeName1Choice:
|
|
589
|
+
title: AccountSchemeName1Choice
|
|
590
|
+
type: object
|
|
582
591
|
description: |
|
|
583
|
-
|
|
592
|
+
Sets of elements to identify a name of the identification scheme.
|
|
593
|
+
anyOf:
|
|
594
|
+
- properties:
|
|
595
|
+
Cd:
|
|
596
|
+
allOf:
|
|
597
|
+
- $ref: "#/components/schemas/ExternalAccountIdentification1Code"
|
|
598
|
+
- description: >
|
|
599
|
+
Code
|
|
600
|
+
|
|
601
|
+
Name of the identification scheme, in a coded form as
|
|
602
|
+
published in an external list.
|
|
603
|
+
required:
|
|
604
|
+
- Cd
|
|
605
|
+
- properties:
|
|
606
|
+
Prtry:
|
|
607
|
+
allOf:
|
|
608
|
+
- $ref: "#/components/schemas/Max35Text"
|
|
609
|
+
- description: |
|
|
610
|
+
Proprietary
|
|
611
|
+
Name of the identification scheme, in a free text form.
|
|
612
|
+
required:
|
|
613
|
+
- Prtry
|
|
614
|
+
example:
|
|
615
|
+
Cd: 1111
|
|
616
|
+
ActiveOrHistoricCurrencyCode:
|
|
617
|
+
title: ActiveOrHistoricCurrencyCode
|
|
584
618
|
type: string
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
619
|
+
description: >
|
|
620
|
+
A code allocated to a currency by a Maintenance Agency under an
|
|
621
|
+
international identification scheme, as described in the latest edition
|
|
622
|
+
of the international standard ISO 4217 "Codes for the representation of
|
|
623
|
+
currencies and funds".
|
|
624
|
+
|
|
625
|
+
NOTE: This has been modified away from the original ISO20022 pattern to
|
|
626
|
+
enums.
|
|
627
|
+
example: USD
|
|
628
|
+
minLength: 3
|
|
629
|
+
maxLength: 3
|
|
630
|
+
enum:
|
|
631
|
+
- AED
|
|
632
|
+
- AFN
|
|
633
|
+
- ALL
|
|
634
|
+
- AMD
|
|
635
|
+
- ANG
|
|
636
|
+
- AOA
|
|
637
|
+
- ARS
|
|
638
|
+
- AUD
|
|
639
|
+
- AWG
|
|
640
|
+
- AZN
|
|
641
|
+
- BAM
|
|
642
|
+
- BBD
|
|
643
|
+
- BDT
|
|
644
|
+
- BGN
|
|
645
|
+
- BHD
|
|
646
|
+
- BIF
|
|
647
|
+
- BMD
|
|
648
|
+
- BND
|
|
649
|
+
- BOB
|
|
650
|
+
- BRL
|
|
651
|
+
- BSD
|
|
652
|
+
- BTN
|
|
653
|
+
- BWP
|
|
654
|
+
- BYN
|
|
655
|
+
- BZD
|
|
656
|
+
- CAD
|
|
657
|
+
- CDF
|
|
658
|
+
- CHF
|
|
659
|
+
- CLP
|
|
660
|
+
- CNY
|
|
661
|
+
- COP
|
|
662
|
+
- CRC
|
|
663
|
+
- CUC
|
|
664
|
+
- CUP
|
|
665
|
+
- CVE
|
|
666
|
+
- CZK
|
|
667
|
+
- DJF
|
|
668
|
+
- DKK
|
|
669
|
+
- DOP
|
|
670
|
+
- DZD
|
|
671
|
+
- EGP
|
|
672
|
+
- ERN
|
|
673
|
+
- ETB
|
|
674
|
+
- EUR
|
|
675
|
+
- FJD
|
|
676
|
+
- FKP
|
|
677
|
+
- GBP
|
|
678
|
+
- GEL
|
|
679
|
+
- GGP
|
|
680
|
+
- GHS
|
|
681
|
+
- GIP
|
|
682
|
+
- GMD
|
|
683
|
+
- GNF
|
|
684
|
+
- GTQ
|
|
685
|
+
- GYD
|
|
686
|
+
- HKD
|
|
687
|
+
- HNL
|
|
688
|
+
- HRK
|
|
689
|
+
- HTG
|
|
690
|
+
- HUF
|
|
691
|
+
- IDR
|
|
692
|
+
- ILS
|
|
693
|
+
- IMP
|
|
694
|
+
- INR
|
|
695
|
+
- IQD
|
|
696
|
+
- IRR
|
|
697
|
+
- ISK
|
|
698
|
+
- JEP
|
|
699
|
+
- JMD
|
|
700
|
+
- JOD
|
|
701
|
+
- JPY
|
|
702
|
+
- KES
|
|
703
|
+
- KGS
|
|
704
|
+
- KHR
|
|
705
|
+
- KMF
|
|
706
|
+
- KPW
|
|
707
|
+
- KRW
|
|
708
|
+
- KWD
|
|
709
|
+
- KYD
|
|
710
|
+
- KZT
|
|
711
|
+
- LAK
|
|
712
|
+
- LBP
|
|
713
|
+
- LKR
|
|
714
|
+
- LRD
|
|
715
|
+
- LSL
|
|
716
|
+
- LYD
|
|
717
|
+
- MAD
|
|
718
|
+
- MDL
|
|
719
|
+
- MGA
|
|
720
|
+
- MKD
|
|
721
|
+
- MMK
|
|
722
|
+
- MNT
|
|
723
|
+
- MOP
|
|
724
|
+
- MRO
|
|
725
|
+
- MUR
|
|
726
|
+
- MVR
|
|
727
|
+
- MWK
|
|
728
|
+
- MXN
|
|
729
|
+
- MYR
|
|
730
|
+
- MZN
|
|
731
|
+
- NAD
|
|
732
|
+
- NGN
|
|
733
|
+
- NIO
|
|
734
|
+
- NOK
|
|
735
|
+
- NPR
|
|
736
|
+
- NZD
|
|
737
|
+
- OMR
|
|
738
|
+
- PAB
|
|
739
|
+
- PEN
|
|
740
|
+
- PGK
|
|
741
|
+
- PHP
|
|
742
|
+
- PKR
|
|
743
|
+
- PLN
|
|
744
|
+
- PYG
|
|
745
|
+
- QAR
|
|
746
|
+
- RON
|
|
747
|
+
- RSD
|
|
748
|
+
- RUB
|
|
749
|
+
- RWF
|
|
750
|
+
- SAR
|
|
751
|
+
- SBD
|
|
752
|
+
- SCR
|
|
753
|
+
- SDG
|
|
754
|
+
- SEK
|
|
755
|
+
- SGD
|
|
756
|
+
- SHP
|
|
757
|
+
- SLL
|
|
758
|
+
- SOS
|
|
759
|
+
- SPL
|
|
760
|
+
- SRD
|
|
761
|
+
- STD
|
|
762
|
+
- SVC
|
|
763
|
+
- SYP
|
|
764
|
+
- SZL
|
|
765
|
+
- THB
|
|
766
|
+
- TJS
|
|
767
|
+
- TMT
|
|
768
|
+
- TND
|
|
769
|
+
- TOP
|
|
770
|
+
- TRY
|
|
771
|
+
- TTD
|
|
772
|
+
- TVD
|
|
773
|
+
- TWD
|
|
774
|
+
- TZS
|
|
775
|
+
- UAH
|
|
776
|
+
- UGX
|
|
777
|
+
- USD
|
|
778
|
+
- UYU
|
|
779
|
+
- UZS
|
|
780
|
+
- VEF
|
|
781
|
+
- VND
|
|
782
|
+
- VUV
|
|
783
|
+
- WST
|
|
784
|
+
- XAF
|
|
785
|
+
- XCD
|
|
786
|
+
- XDR
|
|
787
|
+
- XOF
|
|
788
|
+
- XPF
|
|
789
|
+
- XTS
|
|
790
|
+
- XXX
|
|
791
|
+
- YER
|
|
792
|
+
- ZAR
|
|
793
|
+
- ZMW
|
|
794
|
+
- ZWD
|
|
588
795
|
AddressType2Code:
|
|
589
796
|
description: |
|
|
590
797
|
AddressType2Code
|
|
@@ -604,44 +811,6 @@ components:
|
|
|
604
811
|
- DLVY
|
|
605
812
|
type: string
|
|
606
813
|
example: ADDR
|
|
607
|
-
Exact4AlphaNumericText:
|
|
608
|
-
title: Exact4AlphaNumericText
|
|
609
|
-
description: |
|
|
610
|
-
Specifies an alphanumeric string with a length of 4 characters.
|
|
611
|
-
type: string
|
|
612
|
-
pattern: ^[a-zA-Z0-9]{4}$
|
|
613
|
-
example: 1234
|
|
614
|
-
GenericIdentification30:
|
|
615
|
-
title: GenericIdentification30
|
|
616
|
-
type: object
|
|
617
|
-
description: |
|
|
618
|
-
Generic scheme identification for a party.
|
|
619
|
-
properties:
|
|
620
|
-
Id:
|
|
621
|
-
allOf:
|
|
622
|
-
- $ref: '#/components/schemas/Exact4AlphaNumericText'
|
|
623
|
-
- description: |
|
|
624
|
-
Identification
|
|
625
|
-
Proprietary information, often a code, issued by the data source scheme issuer.
|
|
626
|
-
Issr:
|
|
627
|
-
allOf:
|
|
628
|
-
- $ref: '#/components/schemas/Max35Text'
|
|
629
|
-
- description: |
|
|
630
|
-
Issuer
|
|
631
|
-
Entity that assigns the identification.
|
|
632
|
-
SchmeNm:
|
|
633
|
-
allOf:
|
|
634
|
-
- $ref: '#/components/schemas/Max35Text'
|
|
635
|
-
- description: |
|
|
636
|
-
SchemeName
|
|
637
|
-
Short textual description of the scheme.
|
|
638
|
-
required:
|
|
639
|
-
- Id
|
|
640
|
-
- Issr
|
|
641
|
-
example:
|
|
642
|
-
Id: 1234
|
|
643
|
-
Issr: BIC
|
|
644
|
-
SchmeNm: BICFI
|
|
645
814
|
AddressType3Choice:
|
|
646
815
|
title: AddressType3Choice
|
|
647
816
|
type: object
|
|
@@ -651,7 +820,7 @@ components:
|
|
|
651
820
|
- properties:
|
|
652
821
|
Cd:
|
|
653
822
|
allOf:
|
|
654
|
-
- $ref:
|
|
823
|
+
- $ref: "#/components/schemas/AddressType2Code"
|
|
655
824
|
- description: |
|
|
656
825
|
Code
|
|
657
826
|
Type of address expressed as a code.
|
|
@@ -660,7 +829,7 @@ components:
|
|
|
660
829
|
- properties:
|
|
661
830
|
Prtry:
|
|
662
831
|
allOf:
|
|
663
|
-
- $ref:
|
|
832
|
+
- $ref: "#/components/schemas/GenericIdentification30"
|
|
664
833
|
- description: |
|
|
665
834
|
Proprietary
|
|
666
835
|
Type of address expressed as a proprietary code.
|
|
@@ -668,452 +837,280 @@ components:
|
|
|
668
837
|
- Prtry
|
|
669
838
|
example:
|
|
670
839
|
Cd: ADDR
|
|
671
|
-
|
|
672
|
-
title:
|
|
673
|
-
description: |
|
|
674
|
-
Specifies a character string with a maximum length of 70 characters.
|
|
840
|
+
AnyBICDec2014Identifier:
|
|
841
|
+
title: AnyBICDec2014Identifier
|
|
675
842
|
type: string
|
|
676
|
-
|
|
677
|
-
maxLength: 70
|
|
678
|
-
example: 1.2345678901234567e+99
|
|
679
|
-
Max16Text:
|
|
680
|
-
title: Max16Text
|
|
681
|
-
description: |
|
|
682
|
-
Specifies a character string with a maximum length of 16 characters.
|
|
683
|
-
type: string
|
|
684
|
-
minLength: 1
|
|
685
|
-
maxLength: 16
|
|
686
|
-
example: 1234567890123456
|
|
687
|
-
CountryCode:
|
|
688
|
-
title: CountryCode
|
|
689
|
-
type: string
|
|
690
|
-
pattern: ^[A-Z]{2,2}$
|
|
691
|
-
example: US
|
|
692
|
-
description: |
|
|
693
|
-
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
|
|
694
|
-
PostalAddress24:
|
|
695
|
-
title: PostalAddress24
|
|
696
|
-
type: object
|
|
697
|
-
description: |
|
|
698
|
-
Information that locates and identifies a specific address, as defined by postal services.
|
|
699
|
-
properties:
|
|
700
|
-
AdrTp:
|
|
701
|
-
$ref: '#/components/schemas/AddressType3Choice'
|
|
702
|
-
Dept:
|
|
703
|
-
$ref: '#/components/schemas/Max70Text'
|
|
704
|
-
SubDept:
|
|
705
|
-
$ref: '#/components/schemas/Max70Text'
|
|
706
|
-
StrtNm:
|
|
707
|
-
$ref: '#/components/schemas/Max70Text'
|
|
708
|
-
BldgNb:
|
|
709
|
-
$ref: '#/components/schemas/Max16Text'
|
|
710
|
-
BldgNm:
|
|
711
|
-
$ref: '#/components/schemas/Max35Text'
|
|
712
|
-
Flr:
|
|
713
|
-
$ref: '#/components/schemas/Max70Text'
|
|
714
|
-
PstBx:
|
|
715
|
-
$ref: '#/components/schemas/Max16Text'
|
|
716
|
-
Room:
|
|
717
|
-
$ref: '#/components/schemas/Max70Text'
|
|
718
|
-
PstCd:
|
|
719
|
-
$ref: '#/components/schemas/Max16Text'
|
|
720
|
-
TwnNm:
|
|
721
|
-
$ref: '#/components/schemas/Max35Text'
|
|
722
|
-
TwnLctnNm:
|
|
723
|
-
$ref: '#/components/schemas/Max35Text'
|
|
724
|
-
DstrctNm:
|
|
725
|
-
$ref: '#/components/schemas/Max35Text'
|
|
726
|
-
CtrySubDvsn:
|
|
727
|
-
$ref: '#/components/schemas/Max35Text'
|
|
728
|
-
Ctry:
|
|
729
|
-
$ref: '#/components/schemas/CountryCode'
|
|
730
|
-
AdrLine:
|
|
731
|
-
$ref: '#/components/schemas/Max70Text'
|
|
732
|
-
example:
|
|
733
|
-
AdrTp: ADDR
|
|
734
|
-
Dept: Dept
|
|
735
|
-
SubDept: SubDept
|
|
736
|
-
StrtNm: StrtNm
|
|
737
|
-
BldgNb: BldgNb
|
|
738
|
-
BldgNm: BldgNm
|
|
739
|
-
Flr: Flr
|
|
740
|
-
PstBx: PstBx
|
|
741
|
-
Room: Room
|
|
742
|
-
PstCd: PstCd
|
|
743
|
-
TwnNm: TwnNm
|
|
744
|
-
TwnLctnNm: TwnLctnNm
|
|
745
|
-
DstrctNm: DstrctNm
|
|
746
|
-
CtrySubDvsn: CtrySubDvsn
|
|
747
|
-
Ctry: Ctry
|
|
748
|
-
AdrLine: AdrLine
|
|
749
|
-
AnyBICDec2014Identifier:
|
|
750
|
-
title: AnyBICDec2014Identifier
|
|
751
|
-
type: string
|
|
752
|
-
description: |
|
|
843
|
+
description: >
|
|
753
844
|
AnyBICDec2014Identifier
|
|
845
|
+
|
|
754
846
|
Code allocated to a financial or non-financial institution by the
|
|
847
|
+
|
|
755
848
|
ISO 9362 Registration Authority, as described in ISO 9362: 2014
|
|
756
|
-
|
|
849
|
+
|
|
850
|
+
- "Banking - Banking telecommunication messages - Business identifier
|
|
851
|
+
code (BIC)".
|
|
757
852
|
pattern: ^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$
|
|
758
853
|
example: J5BMVH7D
|
|
759
|
-
|
|
760
|
-
title:
|
|
761
|
-
description: |
|
|
762
|
-
Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)". ^([0-9A-Z]{18,18}[0-9]{2,2})$
|
|
763
|
-
type: string
|
|
764
|
-
pattern: ^[A-Z0-9]{18,18}[0-9]{2,2}$
|
|
765
|
-
example: 529900T8BM49AURSDO55
|
|
766
|
-
ExternalOrganisationIdentification1Code:
|
|
767
|
-
title: ExternalOrganisationIdentification1Code
|
|
768
|
-
description: Specifies the external organisation identification code.
|
|
854
|
+
BICFIDec2014Identifier:
|
|
855
|
+
title: BICFIDec2014Identifier
|
|
769
856
|
type: string
|
|
770
|
-
|
|
771
|
-
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
857
|
+
description: >
|
|
858
|
+
Code allocated to a financial institution by the ISO 9362 Registration
|
|
859
|
+
|
|
860
|
+
|
|
861
|
+
Authority as described in ISO 9362: 2014
|
|
862
|
+
|
|
863
|
+
|
|
864
|
+
- "Banking - Banking telecommunication messages - Business identifier
|
|
865
|
+
code (BIC)".
|
|
866
|
+
pattern: ^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$
|
|
867
|
+
example: J5BMVH7D
|
|
868
|
+
BranchAndFinancialInstitutionIdentification6:
|
|
869
|
+
title: BranchAndFinancialInstitutionIdentification6
|
|
777
870
|
type: object
|
|
871
|
+
description: >
|
|
872
|
+
Unique and unambiguous identification of a financial institution or a
|
|
873
|
+
branch of a financial institution.
|
|
778
874
|
properties:
|
|
779
|
-
|
|
875
|
+
FinInstnId:
|
|
780
876
|
allOf:
|
|
781
|
-
- $ref:
|
|
782
|
-
- description:
|
|
783
|
-
|
|
784
|
-
|
|
785
|
-
|
|
877
|
+
- $ref: "#/components/schemas/FinancialInstitutionIdentification18"
|
|
878
|
+
- description: >
|
|
879
|
+
FinancialInstitutionIdentification
|
|
880
|
+
|
|
881
|
+
Unique and unambiguous identification of a financial
|
|
882
|
+
institution, as assigned under an internationally recognised or
|
|
883
|
+
proprietary identification scheme.
|
|
884
|
+
BrnchId:
|
|
786
885
|
allOf:
|
|
787
|
-
- $ref:
|
|
788
|
-
- description:
|
|
789
|
-
|
|
790
|
-
|
|
791
|
-
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
|
|
795
|
-
|
|
886
|
+
- $ref: "#/components/schemas/BranchData3"
|
|
887
|
+
- description: >
|
|
888
|
+
BranchIdentification
|
|
889
|
+
|
|
890
|
+
Definition: Identifies a specific branch of a financial
|
|
891
|
+
institution.
|
|
892
|
+
|
|
893
|
+
Usage: This component should be used in case the identification
|
|
894
|
+
information in the financial institution component does not
|
|
895
|
+
provide identification up to branch level.
|
|
896
|
+
required:
|
|
897
|
+
- FinInstnId
|
|
796
898
|
example:
|
|
797
|
-
|
|
798
|
-
|
|
799
|
-
|
|
899
|
+
FinInstnId:
|
|
900
|
+
BICFI: J5BMVH7D
|
|
901
|
+
BrnchId:
|
|
902
|
+
Id: 123
|
|
903
|
+
Nm: Name
|
|
904
|
+
PstlAdr:
|
|
905
|
+
AdrTp: ADDR
|
|
906
|
+
Dept: Department
|
|
907
|
+
SubDept: Sub department
|
|
908
|
+
StrtNm: Street name
|
|
909
|
+
BldgNb: Building number
|
|
910
|
+
PstCd: Post code
|
|
911
|
+
TwnNm: Town name
|
|
912
|
+
CtrySubDvsn: Country subdivision
|
|
913
|
+
Ctry: Country
|
|
914
|
+
AdrLine: Address line
|
|
915
|
+
BranchData3:
|
|
916
|
+
title: BranchData3
|
|
800
917
|
type: object
|
|
801
|
-
description:
|
|
802
|
-
Information that locates and identifies
|
|
918
|
+
description: >
|
|
919
|
+
Information that locates and identifies a specific branch of a financial
|
|
920
|
+
institution.
|
|
803
921
|
properties:
|
|
804
922
|
Id:
|
|
805
923
|
allOf:
|
|
806
|
-
- $ref:
|
|
807
|
-
- description:
|
|
808
|
-
Identification
|
|
809
|
-
|
|
924
|
+
- $ref: "#/components/schemas/Max35Text"
|
|
925
|
+
- description: >
|
|
926
|
+
Identification
|
|
927
|
+
|
|
928
|
+
Unique and unambiguous identification of a branch of a financial
|
|
929
|
+
institution.
|
|
930
|
+
LEI:
|
|
810
931
|
allOf:
|
|
811
|
-
- $ref:
|
|
812
|
-
- description:
|
|
813
|
-
|
|
814
|
-
|
|
815
|
-
|
|
932
|
+
- $ref: "#/components/schemas/LEIIdentifier"
|
|
933
|
+
- description: >
|
|
934
|
+
Legal Entity Identifier
|
|
935
|
+
|
|
936
|
+
Legal entity identification for the branch of the financial
|
|
937
|
+
institution.
|
|
938
|
+
Nm:
|
|
816
939
|
allOf:
|
|
817
|
-
- $ref:
|
|
818
|
-
- description:
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
|
|
822
|
-
|
|
940
|
+
- $ref: "#/components/schemas/Max140Text"
|
|
941
|
+
- description: >
|
|
942
|
+
Name
|
|
943
|
+
|
|
944
|
+
Name by which an agent is known and which is usually used to
|
|
945
|
+
identify that agent.
|
|
946
|
+
PstlAdr:
|
|
947
|
+
allOf:
|
|
948
|
+
- $ref: "#/components/schemas/PostalAddress24"
|
|
949
|
+
- description: >
|
|
950
|
+
Postal Address
|
|
951
|
+
|
|
952
|
+
Information that locates and identifies a specific address, as
|
|
953
|
+
defined by postal services.
|
|
823
954
|
example:
|
|
824
955
|
Id: 123
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
|
|
956
|
+
Nm: Name
|
|
957
|
+
PstlAdr:
|
|
958
|
+
AdrTp: ADDR
|
|
959
|
+
Dept: Department
|
|
960
|
+
SubDept: Sub department
|
|
961
|
+
StrtNm: Street name
|
|
962
|
+
BldgNb: Building number
|
|
963
|
+
PstCd: Post code
|
|
964
|
+
TwnNm: Town name
|
|
965
|
+
CtrySubDvsn: Country subdivision
|
|
966
|
+
Ctry: Country
|
|
967
|
+
AdrLine: Address line
|
|
968
|
+
CashAccount40:
|
|
969
|
+
title: CashAccount40
|
|
832
970
|
type: object
|
|
971
|
+
description: |
|
|
972
|
+
Provides the details to identify an account.
|
|
833
973
|
properties:
|
|
834
|
-
|
|
974
|
+
Id:
|
|
835
975
|
allOf:
|
|
836
|
-
- $ref:
|
|
837
|
-
- description:
|
|
838
|
-
|
|
839
|
-
|
|
840
|
-
|
|
976
|
+
- $ref: "#/components/schemas/AccountIdentification4Choice"
|
|
977
|
+
- description: >
|
|
978
|
+
Identification
|
|
979
|
+
|
|
980
|
+
Unique and unambiguous identification for the account between
|
|
981
|
+
the account owner and the account servicer.
|
|
982
|
+
Tp:
|
|
841
983
|
allOf:
|
|
842
|
-
- $ref:
|
|
984
|
+
- $ref: "#/components/schemas/CashAccountType2Choice"
|
|
843
985
|
- description: |
|
|
844
|
-
|
|
845
|
-
|
|
846
|
-
|
|
986
|
+
Type
|
|
987
|
+
Specifies the nature, or use of the account.
|
|
988
|
+
Ccy:
|
|
847
989
|
allOf:
|
|
848
|
-
- $ref:
|
|
849
|
-
- description:
|
|
850
|
-
|
|
851
|
-
|
|
990
|
+
- $ref: "#/components/schemas/ActiveOrHistoricCurrencyCode"
|
|
991
|
+
- description: >
|
|
992
|
+
Currency
|
|
993
|
+
|
|
994
|
+
Identification of the currency in which the account is held.
|
|
995
|
+
|
|
996
|
+
Usage: Currency should only be used in case one and the same
|
|
997
|
+
account number covers several currencies and the initiating
|
|
998
|
+
party needs to identify which currency needs to be used for
|
|
999
|
+
settlement on the account.
|
|
1000
|
+
Nm:
|
|
1001
|
+
allOf:
|
|
1002
|
+
- $ref: "#/components/schemas/Max70Text"
|
|
1003
|
+
- description: >
|
|
1004
|
+
Name
|
|
1005
|
+
|
|
1006
|
+
Name of the account, as assigned by the account servicing
|
|
1007
|
+
institution, in agreement with the account owner in order to
|
|
1008
|
+
provide an additional means of identification of the account.
|
|
1009
|
+
|
|
1010
|
+
Usage: The account name is different from the account owner
|
|
1011
|
+
name. The account name is used in certain user communities to
|
|
1012
|
+
provide a means of identifying the account, in addition to the
|
|
1013
|
+
account owner's identity and the account number.
|
|
1014
|
+
Prxy:
|
|
1015
|
+
allOf:
|
|
1016
|
+
- $ref: "#/components/schemas/ProxyAccountIdentification1"
|
|
1017
|
+
- description: >
|
|
1018
|
+
Proxy
|
|
1019
|
+
|
|
1020
|
+
Specifies an alternate assumed name for the identification of
|
|
1021
|
+
the account.
|
|
852
1022
|
example:
|
|
853
|
-
|
|
854
|
-
|
|
855
|
-
|
|
856
|
-
|
|
857
|
-
|
|
858
|
-
|
|
859
|
-
|
|
860
|
-
|
|
861
|
-
|
|
1023
|
+
Id:
|
|
1024
|
+
IBAN: BE71096123456769
|
|
1025
|
+
Tp:
|
|
1026
|
+
Cd: CACC
|
|
1027
|
+
Ccy: EUR
|
|
1028
|
+
Nm: My account
|
|
1029
|
+
Prxy:
|
|
1030
|
+
Id: 12345
|
|
1031
|
+
CashAccountType2Choice:
|
|
1032
|
+
title: CashAccountType2Choice
|
|
862
1033
|
description: |
|
|
863
|
-
|
|
864
|
-
type:
|
|
865
|
-
|
|
866
|
-
|
|
867
|
-
|
|
868
|
-
|
|
1034
|
+
Specifies the nature, or use of the account.
|
|
1035
|
+
type: object
|
|
1036
|
+
anyOf:
|
|
1037
|
+
- properties:
|
|
1038
|
+
Cd:
|
|
1039
|
+
allOf:
|
|
1040
|
+
- $ref: "#/components/schemas/ExternalCashAccountType1Code"
|
|
1041
|
+
- description: |
|
|
1042
|
+
Code
|
|
1043
|
+
Account type, in a coded form.
|
|
1044
|
+
required:
|
|
1045
|
+
- Cd
|
|
1046
|
+
- properties:
|
|
1047
|
+
Prtry:
|
|
1048
|
+
allOf:
|
|
1049
|
+
- $ref: "#/components/schemas/Max35Text"
|
|
1050
|
+
- description: |
|
|
1051
|
+
Proprietary
|
|
1052
|
+
Nature or use of the account in a proprietary form.
|
|
1053
|
+
required:
|
|
1054
|
+
- Prtry
|
|
1055
|
+
example:
|
|
1056
|
+
Cd: CACC
|
|
1057
|
+
ClearingSystemIdentification2Choice:
|
|
1058
|
+
title: ClearingSystemIdentification2Choice
|
|
869
1059
|
description: |
|
|
870
|
-
|
|
871
|
-
type: object
|
|
872
|
-
properties:
|
|
873
|
-
BirthDt:
|
|
874
|
-
allOf:
|
|
875
|
-
- $ref: '#/components/schemas/ISODate'
|
|
876
|
-
- description: |
|
|
877
|
-
BirthDate
|
|
878
|
-
Date on which a person was born.
|
|
879
|
-
PrvcOfBirth:
|
|
880
|
-
allOf:
|
|
881
|
-
- $ref: '#/components/schemas/Max35Text'
|
|
882
|
-
- description: |
|
|
883
|
-
ProvinceOfBirth
|
|
884
|
-
Province where a person was born.
|
|
885
|
-
CityOfBirth:
|
|
886
|
-
allOf:
|
|
887
|
-
- $ref: '#/components/schemas/Max35Text'
|
|
888
|
-
- description: |
|
|
889
|
-
CityOfBirth
|
|
890
|
-
City where a person was born.
|
|
891
|
-
CtryOfBirth:
|
|
892
|
-
allOf:
|
|
893
|
-
- $ref: '#/components/schemas/CountryCode'
|
|
894
|
-
- description: |
|
|
895
|
-
CountryOfBirth
|
|
896
|
-
Country where a person was born.
|
|
897
|
-
required:
|
|
898
|
-
- BirthDt
|
|
899
|
-
- CityOfBirth
|
|
900
|
-
- CtryOfBirth
|
|
901
|
-
example:
|
|
902
|
-
BirthDt: '1970-01-01'
|
|
903
|
-
PrvcOfBirth: 'ON'
|
|
904
|
-
CityOfBirth: Ottawa
|
|
905
|
-
CtryOfBirth: CA
|
|
906
|
-
ExternalPersonIdentification1Code:
|
|
907
|
-
title: ExternalPersonIdentification1Code
|
|
908
|
-
description: Specifies the external person identification code.
|
|
909
|
-
type: string
|
|
910
|
-
minLength: 1
|
|
911
|
-
maxLength: 4
|
|
912
|
-
example: 1234
|
|
913
|
-
PersonIdentificationSchemeName1Choice:
|
|
914
|
-
title: PersonIdentificationSchemeName1Choice
|
|
915
|
-
description: |
|
|
916
|
-
Sets of elements to identify a name of the identification scheme.
|
|
1060
|
+
Specifies the clearing system identification.
|
|
917
1061
|
type: object
|
|
918
1062
|
anyOf:
|
|
919
1063
|
- properties:
|
|
920
1064
|
Cd:
|
|
921
1065
|
allOf:
|
|
922
|
-
- $ref:
|
|
923
|
-
|
|
1066
|
+
- $ref: >-
|
|
1067
|
+
#/components/schemas/ExternalClearingSystemIdentification1Code
|
|
1068
|
+
- description: >
|
|
924
1069
|
Code
|
|
925
|
-
|
|
1070
|
+
|
|
1071
|
+
Clearing system identification code, as published in an
|
|
1072
|
+
external list.
|
|
926
1073
|
required:
|
|
927
1074
|
- Cd
|
|
928
1075
|
- properties:
|
|
929
1076
|
Prtry:
|
|
930
1077
|
allOf:
|
|
931
|
-
- $ref:
|
|
1078
|
+
- $ref: "#/components/schemas/Max35Text"
|
|
932
1079
|
- description: |
|
|
933
1080
|
Proprietary
|
|
934
|
-
|
|
1081
|
+
Proprietary identification of the clearing system.
|
|
935
1082
|
required:
|
|
936
1083
|
- Prtry
|
|
937
1084
|
example:
|
|
938
|
-
Cd:
|
|
939
|
-
|
|
940
|
-
title:
|
|
941
|
-
|
|
942
|
-
|
|
943
|
-
|
|
944
|
-
Information that locates and identifies a specific person.
|
|
945
|
-
properties:
|
|
946
|
-
Id:
|
|
947
|
-
allOf:
|
|
948
|
-
- $ref: '#/components/schemas/Max35Text'
|
|
949
|
-
- description: |
|
|
950
|
-
Identification
|
|
951
|
-
Unique and unambiguous identification of a person.
|
|
952
|
-
SchmeNm:
|
|
953
|
-
allOf:
|
|
954
|
-
- $ref: '#/components/schemas/PersonIdentificationSchemeName1Choice'
|
|
955
|
-
- description: |
|
|
956
|
-
SchemeName
|
|
957
|
-
Name of the identification scheme.
|
|
958
|
-
Issr:
|
|
959
|
-
allOf:
|
|
960
|
-
- $ref: '#/components/schemas/Max35Text'
|
|
961
|
-
- description: |
|
|
962
|
-
Issuer
|
|
963
|
-
Entity that assigns the identification.
|
|
964
|
-
required:
|
|
965
|
-
- Id
|
|
966
|
-
example:
|
|
967
|
-
Id: 123
|
|
968
|
-
SchmeNm:
|
|
969
|
-
Cd: DRLC
|
|
970
|
-
Issr: BIC
|
|
971
|
-
PersonIdentification13:
|
|
972
|
-
title: PersonIdentification13
|
|
973
|
-
description: |
|
|
974
|
-
Unique and unambiguous way to identify a person.
|
|
1085
|
+
Cd: CHIPS
|
|
1086
|
+
ClearingSystemMemberIdentification2:
|
|
1087
|
+
title: ClearingSystemMemberIdentification2
|
|
1088
|
+
description: >
|
|
1089
|
+
Unique identification, as assigned by a clearing system, to
|
|
1090
|
+
unambiguously identify a member of the clearing system.
|
|
975
1091
|
type: object
|
|
976
1092
|
properties:
|
|
977
|
-
|
|
978
|
-
allOf:
|
|
979
|
-
- $ref: '#/components/schemas/DateAndPlaceOfBirth1'
|
|
980
|
-
- description: |
|
|
981
|
-
DateAndPlaceOfBirth
|
|
982
|
-
Date and place of birth of a person.
|
|
983
|
-
Othr:
|
|
1093
|
+
ClrSysId:
|
|
984
1094
|
allOf:
|
|
985
|
-
- $ref:
|
|
986
|
-
- description:
|
|
987
|
-
|
|
988
|
-
Unique identification of a person, as assigned by an institution, using an identification scheme.
|
|
989
|
-
example:
|
|
990
|
-
DtAndPlcOfBirth:
|
|
991
|
-
Dt: '2018-01-01'
|
|
992
|
-
CityOfBirth: City
|
|
993
|
-
Othr:
|
|
994
|
-
Id: 123
|
|
995
|
-
SchmeNm:
|
|
996
|
-
Cd: CUST
|
|
997
|
-
Prtry: 1
|
|
998
|
-
Party38Choice:
|
|
999
|
-
title: Party38Choice
|
|
1000
|
-
description: |
|
|
1001
|
-
Nature or use of the account.
|
|
1002
|
-
type: object
|
|
1003
|
-
anyOf:
|
|
1004
|
-
- properties:
|
|
1005
|
-
OrgId:
|
|
1006
|
-
allOf:
|
|
1007
|
-
- $ref: '#/components/schemas/OrganisationIdentification29'
|
|
1008
|
-
- description: |
|
|
1009
|
-
Organisation
|
|
1010
|
-
Unique and unambiguous way to identify an organisation.
|
|
1011
|
-
required:
|
|
1012
|
-
- OrgId
|
|
1013
|
-
- properties:
|
|
1014
|
-
PrvtId:
|
|
1015
|
-
allOf:
|
|
1016
|
-
- $ref: '#/components/schemas/PersonIdentification13'
|
|
1017
|
-
- description: |
|
|
1018
|
-
PrivateIdentification
|
|
1019
|
-
Unique and unambiguous identification of a person, for example a passport.
|
|
1020
|
-
required:
|
|
1021
|
-
- PrvtId
|
|
1022
|
-
example:
|
|
1023
|
-
OrgId:
|
|
1024
|
-
AnyBIC: BIC
|
|
1025
|
-
PrvtId:
|
|
1026
|
-
DtAndPlcOfBirth:
|
|
1027
|
-
Dt: '2018-01-01'
|
|
1028
|
-
CityOfBirth: City
|
|
1029
|
-
NamePrefix2Code:
|
|
1030
|
-
description: |
|
|
1031
|
-
Specifies the terms used to formally address a person.
|
|
1095
|
+
- $ref: "#/components/schemas/ClearingSystemIdentification2Choice"
|
|
1096
|
+
- description: >
|
|
1097
|
+
ClearingSystemIdentification
|
|
1032
1098
|
|
|
1033
|
-
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
MIKS: Mx
|
|
1038
|
-
enum:
|
|
1039
|
-
- DOCT
|
|
1040
|
-
- MADM
|
|
1041
|
-
- MISS
|
|
1042
|
-
- MIST
|
|
1043
|
-
- MIKS
|
|
1044
|
-
type: string
|
|
1045
|
-
example: DOCT
|
|
1046
|
-
PhoneNumber:
|
|
1047
|
-
title: PhoneNumber
|
|
1048
|
-
type: string
|
|
1049
|
-
description: |
|
|
1050
|
-
Double check this regex.
|
|
1051
|
-
pattern: ^\+[0-9]{1,3}-[0-9()+\-]{1,30}$
|
|
1052
|
-
Max2048Text:
|
|
1053
|
-
title: Max2048Text
|
|
1054
|
-
description: |
|
|
1055
|
-
Specifies a character string with a maximum length of 2048 characters.
|
|
1056
|
-
type: string
|
|
1057
|
-
minLength: 1
|
|
1058
|
-
maxLength: 2048
|
|
1059
|
-
example: 2048
|
|
1060
|
-
Max4Text:
|
|
1061
|
-
title: Max4Text
|
|
1062
|
-
description: |
|
|
1063
|
-
Specifies a character string with a maximum length of 4 characters.
|
|
1064
|
-
type: string
|
|
1065
|
-
minLength: 1
|
|
1066
|
-
maxLength: 4
|
|
1067
|
-
example: 1234
|
|
1068
|
-
Max128Text:
|
|
1069
|
-
title: Max128Text
|
|
1070
|
-
description: |
|
|
1071
|
-
Specifies a character string with a maximum length of 128 characters.
|
|
1072
|
-
type: string
|
|
1073
|
-
minLength: 1
|
|
1074
|
-
maxLength: 128
|
|
1075
|
-
example: 12345
|
|
1076
|
-
OtherContact1:
|
|
1077
|
-
title: OtherContact1
|
|
1078
|
-
description: |
|
|
1079
|
-
Communication device number or electronic address used for communication.
|
|
1080
|
-
type: object
|
|
1081
|
-
properties:
|
|
1082
|
-
ChanlTp:
|
|
1083
|
-
allOf:
|
|
1084
|
-
- $ref: '#/components/schemas/Max4Text'
|
|
1085
|
-
- description: |
|
|
1086
|
-
ChannelType
|
|
1087
|
-
Method used to contact the financial institution's contact for the specific tax region.
|
|
1088
|
-
Id:
|
|
1099
|
+
Specification of a pre-agreed offering between clearing agents
|
|
1100
|
+
or the channel through which the payment instruction is
|
|
1101
|
+
processed.
|
|
1102
|
+
MmbId:
|
|
1089
1103
|
allOf:
|
|
1090
|
-
- $ref:
|
|
1104
|
+
- $ref: "#/components/schemas/Max35Text"
|
|
1091
1105
|
- description: |
|
|
1092
|
-
|
|
1093
|
-
|
|
1106
|
+
MemberIdentification
|
|
1107
|
+
Identification of a member of a clearing system.
|
|
1094
1108
|
required:
|
|
1095
|
-
-
|
|
1109
|
+
- MmbId
|
|
1096
1110
|
example:
|
|
1097
|
-
|
|
1098
|
-
|
|
1099
|
-
|
|
1100
|
-
title: PreferredContactMethod1Code
|
|
1101
|
-
description: |
|
|
1102
|
-
Preferred method used to reach the individual contact within an organisation.
|
|
1103
|
-
|
|
1104
|
-
LETT: Letter
|
|
1105
|
-
MAIL: Email
|
|
1106
|
-
PHON: Phone
|
|
1107
|
-
FAXX: Fax
|
|
1108
|
-
CELL: Mobile phone
|
|
1109
|
-
type: string
|
|
1110
|
-
enum:
|
|
1111
|
-
- LETT
|
|
1112
|
-
- MAIL
|
|
1113
|
-
- PHON
|
|
1114
|
-
- FAXX
|
|
1115
|
-
- CELL
|
|
1116
|
-
example: CELL
|
|
1111
|
+
ClrSysId:
|
|
1112
|
+
Cd: CHQB
|
|
1113
|
+
MmbId: 123456789
|
|
1117
1114
|
Contact4:
|
|
1118
1115
|
title: Contact4
|
|
1119
1116
|
description: |
|
|
@@ -1122,73 +1119,83 @@ components:
|
|
|
1122
1119
|
properties:
|
|
1123
1120
|
NmPrfx:
|
|
1124
1121
|
allOf:
|
|
1125
|
-
- $ref:
|
|
1122
|
+
- $ref: "#/components/schemas/NamePrefix2Code"
|
|
1126
1123
|
- description: |
|
|
1127
1124
|
NamePrefix
|
|
1128
1125
|
Name prefix to be used before the name of the person.
|
|
1129
1126
|
Nm:
|
|
1130
1127
|
allOf:
|
|
1131
|
-
- $ref:
|
|
1132
|
-
- description:
|
|
1128
|
+
- $ref: "#/components/schemas/Max140Text"
|
|
1129
|
+
- description: >
|
|
1133
1130
|
Name
|
|
1134
|
-
|
|
1131
|
+
|
|
1132
|
+
Name by which a party is known and which is usually used to
|
|
1133
|
+
identify that party.
|
|
1135
1134
|
PhneNb:
|
|
1136
1135
|
allOf:
|
|
1137
|
-
- $ref:
|
|
1138
|
-
- description:
|
|
1136
|
+
- $ref: "#/components/schemas/PhoneNumber"
|
|
1137
|
+
- description: >
|
|
1139
1138
|
PhoneNumber
|
|
1140
|
-
|
|
1139
|
+
|
|
1140
|
+
Collection of information that identifies a phone number, as
|
|
1141
|
+
defined by telecom services.
|
|
1141
1142
|
MobNb:
|
|
1142
1143
|
allOf:
|
|
1143
|
-
- $ref:
|
|
1144
|
-
- description:
|
|
1144
|
+
- $ref: "#/components/schemas/PhoneNumber"
|
|
1145
|
+
- description: >
|
|
1145
1146
|
MobilePhoneNumber
|
|
1146
|
-
|
|
1147
|
+
|
|
1148
|
+
Collection of information that identifies a mobile phone number,
|
|
1149
|
+
as defined by telecom services.
|
|
1147
1150
|
FaxNb:
|
|
1148
1151
|
allOf:
|
|
1149
|
-
- $ref:
|
|
1150
|
-
- description:
|
|
1152
|
+
- $ref: "#/components/schemas/PhoneNumber"
|
|
1153
|
+
- description: >
|
|
1151
1154
|
FaxNumber
|
|
1152
|
-
|
|
1155
|
+
|
|
1156
|
+
Collection of information that identifies a fax number, as
|
|
1157
|
+
defined by telecom services.
|
|
1153
1158
|
EmailAdr:
|
|
1154
1159
|
allOf:
|
|
1155
|
-
- $ref:
|
|
1160
|
+
- $ref: "#/components/schemas/Max2048Text"
|
|
1156
1161
|
- description: |
|
|
1157
1162
|
EmailAddress
|
|
1158
1163
|
Address for electronic mail (e-mail).
|
|
1159
1164
|
EmailPurp:
|
|
1160
1165
|
allOf:
|
|
1161
|
-
- $ref:
|
|
1166
|
+
- $ref: "#/components/schemas/Max35Text"
|
|
1162
1167
|
- description: |
|
|
1163
1168
|
EmailPurpose
|
|
1164
1169
|
Purpose for which an email address may be used.
|
|
1165
1170
|
JobTitl:
|
|
1166
1171
|
allOf:
|
|
1167
|
-
- $ref:
|
|
1172
|
+
- $ref: "#/components/schemas/Max35Text"
|
|
1168
1173
|
- description: |
|
|
1169
1174
|
JobTitle
|
|
1170
1175
|
Title of the function.
|
|
1171
1176
|
Rspnsblty:
|
|
1172
1177
|
allOf:
|
|
1173
|
-
- $ref:
|
|
1178
|
+
- $ref: "#/components/schemas/Max35Text"
|
|
1174
1179
|
- description: |
|
|
1175
1180
|
Responsibility
|
|
1176
1181
|
Role of a person in an organisation.
|
|
1177
1182
|
Dept:
|
|
1178
1183
|
allOf:
|
|
1179
|
-
- $ref:
|
|
1180
|
-
- description:
|
|
1184
|
+
- $ref: "#/components/schemas/Max70Text"
|
|
1185
|
+
- description: >
|
|
1181
1186
|
Department
|
|
1182
|
-
|
|
1187
|
+
|
|
1188
|
+
Identification of a division of a large organisation or
|
|
1189
|
+
building.
|
|
1183
1190
|
Othr:
|
|
1184
1191
|
allOf:
|
|
1185
|
-
- $ref:
|
|
1192
|
+
- $ref: "#/components/schemas/OtherContact1"
|
|
1186
1193
|
- description: |
|
|
1187
1194
|
Other
|
|
1188
1195
|
Contact details in another form.
|
|
1189
1196
|
PrefrdMtd:
|
|
1190
1197
|
allOf:
|
|
1191
|
-
- $ref:
|
|
1198
|
+
- $ref: "#/components/schemas/PreferredContactMethod1Code"
|
|
1192
1199
|
- description: |
|
|
1193
1200
|
PreferredMethod
|
|
1194
1201
|
Preferred method used to reach the contact.
|
|
@@ -1199,88 +1206,161 @@ components:
|
|
|
1199
1206
|
MobNb: +123-123-321
|
|
1200
1207
|
FaxNb: +123-123-321
|
|
1201
1208
|
EmailAdr: example@example.com
|
|
1202
|
-
|
|
1203
|
-
title:
|
|
1209
|
+
CountryCode:
|
|
1210
|
+
title: CountryCode
|
|
1211
|
+
type: string
|
|
1212
|
+
pattern: ^[A-Z]{2,2}$
|
|
1213
|
+
example: US
|
|
1214
|
+
description: >
|
|
1215
|
+
Code to identify a country, a dependency, or another area of particular
|
|
1216
|
+
geopolitical interest, on the basis of country names obtained from the
|
|
1217
|
+
United Nations (ISO 3166, Alpha-2 code).
|
|
1218
|
+
DateAndPlaceOfBirth1:
|
|
1219
|
+
title: DateAndPlaceOfBirth1
|
|
1204
1220
|
description: |
|
|
1205
|
-
|
|
1221
|
+
Details about date and place of birth of a person.
|
|
1206
1222
|
type: object
|
|
1207
1223
|
properties:
|
|
1208
|
-
|
|
1209
|
-
allOf:
|
|
1210
|
-
- $ref: '#/components/schemas/Max140Text'
|
|
1211
|
-
- description: |
|
|
1212
|
-
Name
|
|
1213
|
-
Name by which a party is known and which is usually used to identify that party.
|
|
1214
|
-
PstlAdr:
|
|
1224
|
+
BirthDt:
|
|
1215
1225
|
allOf:
|
|
1216
|
-
- $ref:
|
|
1226
|
+
- $ref: "#/components/schemas/ISODate"
|
|
1217
1227
|
- description: |
|
|
1218
|
-
|
|
1219
|
-
|
|
1220
|
-
|
|
1228
|
+
BirthDate
|
|
1229
|
+
Date on which a person was born.
|
|
1230
|
+
PrvcOfBirth:
|
|
1221
1231
|
allOf:
|
|
1222
|
-
- $ref:
|
|
1232
|
+
- $ref: "#/components/schemas/Max35Text"
|
|
1223
1233
|
- description: |
|
|
1224
|
-
|
|
1225
|
-
|
|
1226
|
-
|
|
1234
|
+
ProvinceOfBirth
|
|
1235
|
+
Province where a person was born.
|
|
1236
|
+
CityOfBirth:
|
|
1227
1237
|
allOf:
|
|
1228
|
-
- $ref:
|
|
1238
|
+
- $ref: "#/components/schemas/Max35Text"
|
|
1229
1239
|
- description: |
|
|
1230
|
-
|
|
1231
|
-
|
|
1232
|
-
|
|
1240
|
+
CityOfBirth
|
|
1241
|
+
City where a person was born.
|
|
1242
|
+
CtryOfBirth:
|
|
1233
1243
|
allOf:
|
|
1234
|
-
- $ref:
|
|
1244
|
+
- $ref: "#/components/schemas/CountryCode"
|
|
1235
1245
|
- description: |
|
|
1236
|
-
|
|
1237
|
-
|
|
1238
|
-
required:
|
|
1239
|
-
-
|
|
1246
|
+
CountryOfBirth
|
|
1247
|
+
Country where a person was born.
|
|
1248
|
+
required:
|
|
1249
|
+
- BirthDt
|
|
1250
|
+
- CityOfBirth
|
|
1251
|
+
- CtryOfBirth
|
|
1240
1252
|
example:
|
|
1241
|
-
|
|
1242
|
-
|
|
1243
|
-
|
|
1244
|
-
|
|
1245
|
-
|
|
1246
|
-
|
|
1247
|
-
|
|
1248
|
-
|
|
1249
|
-
|
|
1250
|
-
|
|
1251
|
-
|
|
1252
|
-
|
|
1253
|
-
|
|
1254
|
-
|
|
1255
|
-
|
|
1256
|
-
|
|
1257
|
-
|
|
1258
|
-
|
|
1259
|
-
|
|
1260
|
-
OrgId:
|
|
1261
|
-
Othr:
|
|
1262
|
-
Id: 123
|
|
1263
|
-
SchmeNm:
|
|
1264
|
-
Prtry: DfspId
|
|
1265
|
-
CtryOfRes: BE
|
|
1266
|
-
CtctDtls:
|
|
1267
|
-
NmPrfx: Mr
|
|
1268
|
-
Nm: John Doe
|
|
1269
|
-
PhneNb: +123-123-321
|
|
1270
|
-
MobNb: +123-123-321
|
|
1271
|
-
FaxNb: +123-123-321
|
|
1272
|
-
EmailAdr: example@example.com
|
|
1273
|
-
BICFIDec2014Identifier:
|
|
1274
|
-
title: BICFIDec2014Identifier
|
|
1253
|
+
BirthDt: "1970-01-01"
|
|
1254
|
+
PrvcOfBirth: "ON"
|
|
1255
|
+
CityOfBirth: Ottawa
|
|
1256
|
+
CtryOfBirth: CA
|
|
1257
|
+
ErrorCode:
|
|
1258
|
+
title: ErrorCode
|
|
1259
|
+
type: string
|
|
1260
|
+
pattern: ^[1-9]\d{3}$
|
|
1261
|
+
description: >-
|
|
1262
|
+
The API data type ErrorCode is a JSON String of four characters,
|
|
1263
|
+
consisting of digits only. Negative numbers are not allowed. A leading
|
|
1264
|
+
zero is not allowed. Each error code in the API is a four-digit number,
|
|
1265
|
+
for example, 1234, where the first number (1 in the example) represents
|
|
1266
|
+
the high-level error category, the second number (2 in the example)
|
|
1267
|
+
represents the low-level error category, and the last two numbers (34 in
|
|
1268
|
+
the example) represent the specific error.
|
|
1269
|
+
example: "5100"
|
|
1270
|
+
ErrorDescription:
|
|
1271
|
+
title: ErrorDescription
|
|
1275
1272
|
type: string
|
|
1273
|
+
minLength: 1
|
|
1274
|
+
maxLength: 128
|
|
1275
|
+
description: Error description string.
|
|
1276
|
+
ErrorInformation:
|
|
1277
|
+
title: ErrorInformation
|
|
1278
|
+
type: object
|
|
1279
|
+
description: Data model for the complex type ErrorInformation.
|
|
1280
|
+
properties:
|
|
1281
|
+
errorCode:
|
|
1282
|
+
$ref: "#/components/schemas/ErrorCode"
|
|
1283
|
+
errorDescription:
|
|
1284
|
+
$ref: "#/components/schemas/ErrorDescription"
|
|
1285
|
+
extensionList:
|
|
1286
|
+
$ref: "#/components/schemas/ExtensionList"
|
|
1287
|
+
required:
|
|
1288
|
+
- errorCode
|
|
1289
|
+
- errorDescription
|
|
1290
|
+
ErrorInformationResponse:
|
|
1291
|
+
title: ErrorInformationResponse
|
|
1292
|
+
type: object
|
|
1293
|
+
description: >
|
|
1294
|
+
Data model for the complex type object that contains an optional element
|
|
1295
|
+
ErrorInformation used along with 4xx and 5xx responses.
|
|
1296
|
+
properties:
|
|
1297
|
+
errorInformation:
|
|
1298
|
+
$ref: "#/components/schemas/ErrorInformation"
|
|
1299
|
+
Exact4AlphaNumericText:
|
|
1300
|
+
title: Exact4AlphaNumericText
|
|
1276
1301
|
description: |
|
|
1277
|
-
|
|
1278
|
-
|
|
1279
|
-
|
|
1280
|
-
|
|
1281
|
-
|
|
1282
|
-
|
|
1283
|
-
|
|
1302
|
+
Specifies an alphanumeric string with a length of 4 characters.
|
|
1303
|
+
type: string
|
|
1304
|
+
pattern: ^[a-zA-Z0-9]{4}$
|
|
1305
|
+
example: 1234
|
|
1306
|
+
Extension:
|
|
1307
|
+
title: Extension
|
|
1308
|
+
type: object
|
|
1309
|
+
description: Data model for the complex type Extension.
|
|
1310
|
+
properties:
|
|
1311
|
+
key:
|
|
1312
|
+
$ref: "#/components/schemas/ExtensionKey"
|
|
1313
|
+
value:
|
|
1314
|
+
$ref: "#/components/schemas/ExtensionValue"
|
|
1315
|
+
required:
|
|
1316
|
+
- key
|
|
1317
|
+
- value
|
|
1318
|
+
ExtensionKey:
|
|
1319
|
+
title: ExtensionKey
|
|
1320
|
+
type: string
|
|
1321
|
+
minLength: 1
|
|
1322
|
+
maxLength: 32
|
|
1323
|
+
description: Extension key.
|
|
1324
|
+
ExtensionList:
|
|
1325
|
+
title: ExtensionList
|
|
1326
|
+
type: object
|
|
1327
|
+
description: >
|
|
1328
|
+
Data model for the complex type ExtensionList. An optional list of
|
|
1329
|
+
extensions, specific to deployment.
|
|
1330
|
+
properties:
|
|
1331
|
+
extension:
|
|
1332
|
+
type: array
|
|
1333
|
+
items:
|
|
1334
|
+
$ref: "#/components/schemas/Extension"
|
|
1335
|
+
minItems: 1
|
|
1336
|
+
maxItems: 16
|
|
1337
|
+
description: Number of Extension elements.
|
|
1338
|
+
required:
|
|
1339
|
+
- extension
|
|
1340
|
+
ExtensionValue:
|
|
1341
|
+
title: ExtensionValue
|
|
1342
|
+
type: string
|
|
1343
|
+
minLength: 1
|
|
1344
|
+
maxLength: 128
|
|
1345
|
+
description: Extension value.
|
|
1346
|
+
ExternalAccountIdentification1Code:
|
|
1347
|
+
title: ExternalAccountIdentification1Code
|
|
1348
|
+
description: >
|
|
1349
|
+
Specifies the external account identification scheme name code in the
|
|
1350
|
+
format of character string with a maximum length of 4 characters.
|
|
1351
|
+
type: string
|
|
1352
|
+
minLength: 1
|
|
1353
|
+
maxLength: 4
|
|
1354
|
+
example: 1234
|
|
1355
|
+
ExternalCashAccountType1Code:
|
|
1356
|
+
title: ExternalCashAccountType1Code
|
|
1357
|
+
description: >
|
|
1358
|
+
Specifies the nature, or use, of the cash account in the format of
|
|
1359
|
+
character string with a maximum length of 4 characters.
|
|
1360
|
+
type: string
|
|
1361
|
+
minLength: 1
|
|
1362
|
+
maxLength: 4
|
|
1363
|
+
example: 1234
|
|
1284
1364
|
ExternalClearingSystemIdentification1Code:
|
|
1285
1365
|
title: ExternalClearingSystemIdentification1Code
|
|
1286
1366
|
description: |
|
|
@@ -1289,56 +1369,6 @@ components:
|
|
|
1289
1369
|
minLength: 1
|
|
1290
1370
|
maxLength: 5
|
|
1291
1371
|
example: 12345
|
|
1292
|
-
ClearingSystemIdentification2Choice:
|
|
1293
|
-
title: ClearingSystemIdentification2Choice
|
|
1294
|
-
description: |
|
|
1295
|
-
Specifies the clearing system identification.
|
|
1296
|
-
type: object
|
|
1297
|
-
anyOf:
|
|
1298
|
-
- properties:
|
|
1299
|
-
Cd:
|
|
1300
|
-
allOf:
|
|
1301
|
-
- $ref: '#/components/schemas/ExternalClearingSystemIdentification1Code'
|
|
1302
|
-
- description: |
|
|
1303
|
-
Code
|
|
1304
|
-
Clearing system identification code, as published in an external list.
|
|
1305
|
-
required:
|
|
1306
|
-
- Cd
|
|
1307
|
-
- properties:
|
|
1308
|
-
Prtry:
|
|
1309
|
-
allOf:
|
|
1310
|
-
- $ref: '#/components/schemas/Max35Text'
|
|
1311
|
-
- description: |
|
|
1312
|
-
Proprietary
|
|
1313
|
-
Proprietary identification of the clearing system.
|
|
1314
|
-
required:
|
|
1315
|
-
- Prtry
|
|
1316
|
-
example:
|
|
1317
|
-
Cd: CHIPS
|
|
1318
|
-
ClearingSystemMemberIdentification2:
|
|
1319
|
-
title: ClearingSystemMemberIdentification2
|
|
1320
|
-
description: |
|
|
1321
|
-
Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.
|
|
1322
|
-
type: object
|
|
1323
|
-
properties:
|
|
1324
|
-
ClrSysId:
|
|
1325
|
-
allOf:
|
|
1326
|
-
- $ref: '#/components/schemas/ClearingSystemIdentification2Choice'
|
|
1327
|
-
- description: |
|
|
1328
|
-
ClearingSystemIdentification
|
|
1329
|
-
Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.
|
|
1330
|
-
MmbId:
|
|
1331
|
-
allOf:
|
|
1332
|
-
- $ref: '#/components/schemas/Max35Text'
|
|
1333
|
-
- description: |
|
|
1334
|
-
MemberIdentification
|
|
1335
|
-
Identification of a member of a clearing system.
|
|
1336
|
-
required:
|
|
1337
|
-
- MmbId
|
|
1338
|
-
example:
|
|
1339
|
-
ClrSysId:
|
|
1340
|
-
Cd: CHQB
|
|
1341
|
-
MmbId: 123456789
|
|
1342
1372
|
ExternalFinancialInstitutionIdentification1Code:
|
|
1343
1373
|
title: ExternalFinancialInstitutionIdentification1Code
|
|
1344
1374
|
description: Specifies the external financial institution identification code.
|
|
@@ -1346,6 +1376,34 @@ components:
|
|
|
1346
1376
|
minLength: 1
|
|
1347
1377
|
maxLength: 4
|
|
1348
1378
|
example: 1234
|
|
1379
|
+
ExternalOrganisationIdentification1Code:
|
|
1380
|
+
title: ExternalOrganisationIdentification1Code
|
|
1381
|
+
description: Specifies the external organisation identification code.
|
|
1382
|
+
type: string
|
|
1383
|
+
minLength: 1
|
|
1384
|
+
maxLength: 4
|
|
1385
|
+
example: 1234
|
|
1386
|
+
ExternalPersonIdentification1Code:
|
|
1387
|
+
title: ExternalPersonIdentification1Code
|
|
1388
|
+
description: Specifies the external person identification code.
|
|
1389
|
+
type: string
|
|
1390
|
+
minLength: 1
|
|
1391
|
+
maxLength: 4
|
|
1392
|
+
example: 1234
|
|
1393
|
+
ExternalProxyAccountType1Code:
|
|
1394
|
+
title: ExternalProxyAccountType1Code
|
|
1395
|
+
description: Specifies the external proxy account type code.
|
|
1396
|
+
type: string
|
|
1397
|
+
minLength: 1
|
|
1398
|
+
maxLength: 4
|
|
1399
|
+
example: 1234
|
|
1400
|
+
ExternalVerificationReason1Code:
|
|
1401
|
+
title: ExternalVerificationReason1Code
|
|
1402
|
+
description: Specifies the external verification reason code.
|
|
1403
|
+
type: string
|
|
1404
|
+
minLength: 1
|
|
1405
|
+
maxLength: 4
|
|
1406
|
+
example: 1234
|
|
1349
1407
|
FinancialIdentificationSchemeName1Choice:
|
|
1350
1408
|
title: FinancialIdentificationSchemeName1Choice
|
|
1351
1409
|
type: object
|
|
@@ -1355,16 +1413,19 @@ components:
|
|
|
1355
1413
|
- properties:
|
|
1356
1414
|
Cd:
|
|
1357
1415
|
allOf:
|
|
1358
|
-
- $ref:
|
|
1359
|
-
|
|
1416
|
+
- $ref: >-
|
|
1417
|
+
#/components/schemas/ExternalFinancialInstitutionIdentification1Code
|
|
1418
|
+
- description: >
|
|
1360
1419
|
Code
|
|
1361
|
-
|
|
1420
|
+
|
|
1421
|
+
Name of the identification scheme, in a coded form as
|
|
1422
|
+
published in an external list.
|
|
1362
1423
|
required:
|
|
1363
1424
|
- Cd
|
|
1364
1425
|
- properties:
|
|
1365
1426
|
Prtry:
|
|
1366
1427
|
allOf:
|
|
1367
|
-
- $ref:
|
|
1428
|
+
- $ref: "#/components/schemas/Max35Text"
|
|
1368
1429
|
- description: |
|
|
1369
1430
|
Proprietary
|
|
1370
1431
|
Name of the identification scheme, in a free text form.
|
|
@@ -1372,38 +1433,6 @@ components:
|
|
|
1372
1433
|
- Prtry
|
|
1373
1434
|
example:
|
|
1374
1435
|
Cd: BIC
|
|
1375
|
-
GenericFinancialIdentification1:
|
|
1376
|
-
title: GenericFinancialIdentification1
|
|
1377
|
-
type: object
|
|
1378
|
-
description: |
|
|
1379
|
-
GenericFinancialIdentification
|
|
1380
|
-
Unique and unambiguous identification of a person, which is used to refer to a person in a financial context.
|
|
1381
|
-
properties:
|
|
1382
|
-
Id:
|
|
1383
|
-
allOf:
|
|
1384
|
-
- $ref: '#/components/schemas/Max35Text'
|
|
1385
|
-
- description: |
|
|
1386
|
-
Identification
|
|
1387
|
-
Unique and unambiguous identification of a person.
|
|
1388
|
-
SchmeNm:
|
|
1389
|
-
allOf:
|
|
1390
|
-
- $ref: '#/components/schemas/FinancialIdentificationSchemeName1Choice'
|
|
1391
|
-
- description: |
|
|
1392
|
-
SchemeName
|
|
1393
|
-
Name of the identification scheme.
|
|
1394
|
-
Issr:
|
|
1395
|
-
allOf:
|
|
1396
|
-
- $ref: '#/components/schemas/Max35Text'
|
|
1397
|
-
- description: |
|
|
1398
|
-
Issuer
|
|
1399
|
-
Entity that assigns the identification.
|
|
1400
|
-
required:
|
|
1401
|
-
- Id
|
|
1402
|
-
example:
|
|
1403
|
-
Id: 123
|
|
1404
|
-
SchmeNm:
|
|
1405
|
-
Cd: IBAN
|
|
1406
|
-
Issr: BIC
|
|
1407
1436
|
FinancialInstitutionIdentification18:
|
|
1408
1437
|
title: FinancialInstitutionIdentification18
|
|
1409
1438
|
type: object
|
|
@@ -1412,40 +1441,50 @@ components:
|
|
|
1412
1441
|
properties:
|
|
1413
1442
|
BICFI:
|
|
1414
1443
|
allOf:
|
|
1415
|
-
- $ref:
|
|
1416
|
-
- description:
|
|
1417
|
-
BICFI
|
|
1418
|
-
|
|
1444
|
+
- $ref: "#/components/schemas/BICFIDec2014Identifier"
|
|
1445
|
+
- description: >
|
|
1446
|
+
BICFI
|
|
1447
|
+
|
|
1448
|
+
Code allocated to a financial institution by the ISO 9362
|
|
1449
|
+
Registration Authority as described in ISO 9362 "Banking -
|
|
1450
|
+
Banking telecommunication messages - Business identifier code
|
|
1451
|
+
(BIC)"
|
|
1419
1452
|
ClrSysMmbId:
|
|
1420
1453
|
allOf:
|
|
1421
|
-
- $ref:
|
|
1454
|
+
- $ref: "#/components/schemas/ClearingSystemMemberIdentification2"
|
|
1422
1455
|
- description: |
|
|
1423
1456
|
ClearingSystemMemberIdentification
|
|
1424
1457
|
Information used to identify a member within a clearing system
|
|
1425
1458
|
LEI:
|
|
1426
1459
|
allOf:
|
|
1427
|
-
- $ref:
|
|
1460
|
+
- $ref: "#/components/schemas/LEIIdentifier"
|
|
1428
1461
|
- description: |
|
|
1429
1462
|
LEI
|
|
1430
1463
|
Legal entity identifier of the financial institution.
|
|
1431
1464
|
Nm:
|
|
1432
1465
|
allOf:
|
|
1433
|
-
- $ref:
|
|
1434
|
-
- description:
|
|
1466
|
+
- $ref: "#/components/schemas/Max140Text"
|
|
1467
|
+
- description: >
|
|
1435
1468
|
Name
|
|
1436
|
-
|
|
1469
|
+
|
|
1470
|
+
Name by which an agent is known and which is usually used to
|
|
1471
|
+
identify that agent
|
|
1437
1472
|
PstlAdr:
|
|
1438
1473
|
allOf:
|
|
1439
|
-
- $ref:
|
|
1440
|
-
- description:
|
|
1474
|
+
- $ref: "#/components/schemas/PostalAddress24"
|
|
1475
|
+
- description: >
|
|
1441
1476
|
PostalAddress
|
|
1442
|
-
|
|
1477
|
+
|
|
1478
|
+
Information that locates and identifies a specific address, as
|
|
1479
|
+
defined by postal services.
|
|
1443
1480
|
Othr:
|
|
1444
1481
|
allOf:
|
|
1445
|
-
- $ref:
|
|
1446
|
-
- description:
|
|
1482
|
+
- $ref: "#/components/schemas/GenericFinancialIdentification1"
|
|
1483
|
+
- description: >
|
|
1447
1484
|
Other
|
|
1448
|
-
|
|
1485
|
+
|
|
1486
|
+
Unique identification of an agent, as assigned by an
|
|
1487
|
+
institution, using an identification scheme.
|
|
1449
1488
|
required: []
|
|
1450
1489
|
example:
|
|
1451
1490
|
BICFI: J5BMVH7D
|
|
@@ -1471,88 +1510,724 @@ components:
|
|
|
1471
1510
|
Cd: 123
|
|
1472
1511
|
Prtry: 123
|
|
1473
1512
|
Issr: 123
|
|
1474
|
-
|
|
1475
|
-
title:
|
|
1513
|
+
GenericAccountIdentification1:
|
|
1514
|
+
title: GenericAccountIdentification1
|
|
1476
1515
|
type: object
|
|
1516
|
+
description: >
|
|
1517
|
+
GenericAccountIdentification
|
|
1518
|
+
|
|
1519
|
+
Unique and unambiguous identification of an account, as assigned by the
|
|
1520
|
+
account servicer.
|
|
1521
|
+
properties:
|
|
1522
|
+
Id:
|
|
1523
|
+
allOf:
|
|
1524
|
+
- $ref: "#/components/schemas/Max34Text"
|
|
1525
|
+
- description: |
|
|
1526
|
+
Identification
|
|
1527
|
+
Identification assigned by an institution.
|
|
1528
|
+
SchmeNm:
|
|
1529
|
+
allOf:
|
|
1530
|
+
- $ref: "#/components/schemas/AccountSchemeName1Choice"
|
|
1531
|
+
- description: |
|
|
1532
|
+
SchemeName
|
|
1533
|
+
Name of the identification scheme.
|
|
1534
|
+
Issr:
|
|
1535
|
+
allOf:
|
|
1536
|
+
- $ref: "#/components/schemas/Max35Text"
|
|
1537
|
+
- description: |
|
|
1538
|
+
Issuer
|
|
1539
|
+
Entity that assigns the identification.
|
|
1540
|
+
required:
|
|
1541
|
+
- Id
|
|
1542
|
+
example:
|
|
1543
|
+
Id: 123
|
|
1544
|
+
SchmeNm:
|
|
1545
|
+
Cd: IBAN
|
|
1546
|
+
Issr: BIC
|
|
1547
|
+
GenericFinancialIdentification1:
|
|
1548
|
+
title: GenericFinancialIdentification1
|
|
1549
|
+
type: object
|
|
1550
|
+
description: >
|
|
1551
|
+
GenericFinancialIdentification
|
|
1552
|
+
|
|
1553
|
+
Unique and unambiguous identification of a person, which is used to
|
|
1554
|
+
refer to a person in a financial context.
|
|
1555
|
+
properties:
|
|
1556
|
+
Id:
|
|
1557
|
+
allOf:
|
|
1558
|
+
- $ref: "#/components/schemas/Max35Text"
|
|
1559
|
+
- description: |
|
|
1560
|
+
Identification
|
|
1561
|
+
Unique and unambiguous identification of a person.
|
|
1562
|
+
SchmeNm:
|
|
1563
|
+
allOf:
|
|
1564
|
+
- $ref: "#/components/schemas/FinancialIdentificationSchemeName1Choice"
|
|
1565
|
+
- description: |
|
|
1566
|
+
SchemeName
|
|
1567
|
+
Name of the identification scheme.
|
|
1568
|
+
Issr:
|
|
1569
|
+
allOf:
|
|
1570
|
+
- $ref: "#/components/schemas/Max35Text"
|
|
1571
|
+
- description: |
|
|
1572
|
+
Issuer
|
|
1573
|
+
Entity that assigns the identification.
|
|
1574
|
+
required:
|
|
1575
|
+
- Id
|
|
1576
|
+
example:
|
|
1577
|
+
Id: 123
|
|
1578
|
+
SchmeNm:
|
|
1579
|
+
Cd: IBAN
|
|
1580
|
+
Issr: BIC
|
|
1581
|
+
GenericIdentification30:
|
|
1582
|
+
title: GenericIdentification30
|
|
1583
|
+
type: object
|
|
1584
|
+
description: |
|
|
1585
|
+
Generic scheme identification for a party.
|
|
1586
|
+
properties:
|
|
1587
|
+
Id:
|
|
1588
|
+
allOf:
|
|
1589
|
+
- $ref: "#/components/schemas/Exact4AlphaNumericText"
|
|
1590
|
+
- description: >
|
|
1591
|
+
Identification
|
|
1592
|
+
|
|
1593
|
+
Proprietary information, often a code, issued by the data source
|
|
1594
|
+
scheme issuer.
|
|
1595
|
+
Issr:
|
|
1596
|
+
allOf:
|
|
1597
|
+
- $ref: "#/components/schemas/Max35Text"
|
|
1598
|
+
- description: |
|
|
1599
|
+
Issuer
|
|
1600
|
+
Entity that assigns the identification.
|
|
1601
|
+
SchmeNm:
|
|
1602
|
+
allOf:
|
|
1603
|
+
- $ref: "#/components/schemas/Max35Text"
|
|
1604
|
+
- description: |
|
|
1605
|
+
SchemeName
|
|
1606
|
+
Short textual description of the scheme.
|
|
1607
|
+
required:
|
|
1608
|
+
- Id
|
|
1609
|
+
- Issr
|
|
1610
|
+
example:
|
|
1611
|
+
Id: 1234
|
|
1612
|
+
Issr: BIC
|
|
1613
|
+
SchmeNm: BICFI
|
|
1614
|
+
GenericOrganisationIdentification1:
|
|
1615
|
+
title: GenericOrganisationIdentification1
|
|
1616
|
+
type: object
|
|
1617
|
+
description: |
|
|
1618
|
+
Information that locates and identifies an organisation.
|
|
1619
|
+
properties:
|
|
1620
|
+
Id:
|
|
1621
|
+
allOf:
|
|
1622
|
+
- $ref: "#/components/schemas/Max35Text"
|
|
1623
|
+
- description: >
|
|
1624
|
+
Identification for an organisation. FSPIOP equivalent to Party
|
|
1625
|
+
Identifier for an organisation in ISO 20022. Identification
|
|
1626
|
+
assigned by an institution.
|
|
1627
|
+
SchmeNm:
|
|
1628
|
+
allOf:
|
|
1629
|
+
- $ref: "#/components/schemas/OrganisationIdentificationSchemeName1Choice"
|
|
1630
|
+
- description: |
|
|
1631
|
+
SchemeName
|
|
1632
|
+
Name of the identification scheme.
|
|
1633
|
+
Issr:
|
|
1634
|
+
allOf:
|
|
1635
|
+
- $ref: "#/components/schemas/Max35Text"
|
|
1636
|
+
- description: |
|
|
1637
|
+
Issuer
|
|
1638
|
+
Entity that assigns the identification.
|
|
1639
|
+
required:
|
|
1640
|
+
- Id
|
|
1641
|
+
example:
|
|
1642
|
+
Id: 123
|
|
1643
|
+
SchmeNm:
|
|
1644
|
+
Cd: BIC
|
|
1645
|
+
Issr: BIC
|
|
1646
|
+
GenericPersonIdentification1:
|
|
1647
|
+
title: GenericPersonIdentification1
|
|
1648
|
+
type: object
|
|
1649
|
+
description: |
|
|
1650
|
+
GenericPersonIdentification1
|
|
1651
|
+
Information that locates and identifies a specific person.
|
|
1652
|
+
properties:
|
|
1653
|
+
Id:
|
|
1654
|
+
allOf:
|
|
1655
|
+
- $ref: "#/components/schemas/Max35Text"
|
|
1656
|
+
- description: |
|
|
1657
|
+
Identification
|
|
1658
|
+
Unique and unambiguous identification of a person.
|
|
1659
|
+
SchmeNm:
|
|
1660
|
+
allOf:
|
|
1661
|
+
- $ref: "#/components/schemas/PersonIdentificationSchemeName1Choice"
|
|
1662
|
+
- description: |
|
|
1663
|
+
SchemeName
|
|
1664
|
+
Name of the identification scheme.
|
|
1665
|
+
Issr:
|
|
1666
|
+
allOf:
|
|
1667
|
+
- $ref: "#/components/schemas/Max35Text"
|
|
1668
|
+
- description: |
|
|
1669
|
+
Issuer
|
|
1670
|
+
Entity that assigns the identification.
|
|
1671
|
+
required:
|
|
1672
|
+
- Id
|
|
1673
|
+
example:
|
|
1674
|
+
Id: 123
|
|
1675
|
+
SchmeNm:
|
|
1676
|
+
Cd: DRLC
|
|
1677
|
+
Issr: BIC
|
|
1678
|
+
GetPartiesError_IdentificationVerificationReportV03:
|
|
1679
|
+
title: GetPartiesError_IdentificationVerificationReportV03
|
|
1680
|
+
type: object
|
|
1681
|
+
properties:
|
|
1682
|
+
Assgnmt:
|
|
1683
|
+
allOf:
|
|
1684
|
+
- $ref: "#/components/schemas/IdentificationAssignment3"
|
|
1685
|
+
- description: |
|
|
1686
|
+
Assignment
|
|
1687
|
+
Information related to the identification assignment.
|
|
1688
|
+
Rpt:
|
|
1689
|
+
allOf:
|
|
1690
|
+
- $ref: "#/components/schemas/VerificationReport4"
|
|
1691
|
+
- description: >
|
|
1692
|
+
Report
|
|
1693
|
+
|
|
1694
|
+
Information concerning the verification of the identification
|
|
1695
|
+
data for which verification was requested.
|
|
1696
|
+
SplmtryData:
|
|
1697
|
+
allOf:
|
|
1698
|
+
- $ref: "#/components/schemas/SupplementaryData1"
|
|
1699
|
+
- description: >
|
|
1700
|
+
SupplementaryData
|
|
1701
|
+
|
|
1702
|
+
Additional information that cannot be captured in the structured
|
|
1703
|
+
elements and/or any other specific block.
|
|
1704
|
+
required:
|
|
1705
|
+
- Assgnmt
|
|
1706
|
+
- Rpt
|
|
1707
|
+
example:
|
|
1708
|
+
Assgnmt:
|
|
1709
|
+
Id: 123
|
|
1710
|
+
CreDtTm: "2020-01-01T00:00:00Z"
|
|
1711
|
+
Assgnr:
|
|
1712
|
+
Id:
|
|
1713
|
+
Id: 123
|
|
1714
|
+
SchmeNm:
|
|
1715
|
+
Cd: IBAN
|
|
1716
|
+
Issr: BIC
|
|
1717
|
+
Assgne:
|
|
1718
|
+
Id:
|
|
1719
|
+
Id: 123
|
|
1720
|
+
SchmeNm:
|
|
1721
|
+
Cd: IBAN
|
|
1722
|
+
Issr: BIC
|
|
1723
|
+
Rpt:
|
|
1724
|
+
Id: 123
|
|
1725
|
+
CreDtTm: "2020-01-01T00:00:00Z"
|
|
1726
|
+
RptgPty:
|
|
1727
|
+
Id:
|
|
1728
|
+
Id: 123
|
|
1729
|
+
SchmeNm:
|
|
1730
|
+
Cd: IBAN
|
|
1731
|
+
Issr: BIC
|
|
1732
|
+
RptdPty:
|
|
1733
|
+
Id:
|
|
1734
|
+
Id: 123
|
|
1735
|
+
SchmeNm:
|
|
1736
|
+
Cd: IBAN
|
|
1737
|
+
Issr: BIC
|
|
1738
|
+
RptdDoc:
|
|
1739
|
+
Nb: 123
|
|
1740
|
+
RltdDt: "2013-03-07"
|
|
1741
|
+
RltdDtTp:
|
|
1742
|
+
Cd: 123
|
|
1743
|
+
Rsn:
|
|
1744
|
+
Cd: 123
|
|
1745
|
+
Prtry: 123
|
|
1746
|
+
SplmtryData:
|
|
1747
|
+
PlcAndNm: 123
|
|
1748
|
+
Envlp: 123
|
|
1749
|
+
RltdDt: "2013-03-07"
|
|
1750
|
+
RltdDtTp:
|
|
1751
|
+
Cd: 123
|
|
1752
|
+
GetParties_IdentificationVerificationReportV03:
|
|
1753
|
+
title: GetParties_IdentificationVerificationReportV03
|
|
1754
|
+
type: object
|
|
1755
|
+
properties:
|
|
1756
|
+
Assgnmt:
|
|
1757
|
+
allOf:
|
|
1758
|
+
- $ref: "#/components/schemas/IdentificationAssignment3"
|
|
1759
|
+
- description: |
|
|
1760
|
+
Assignment
|
|
1761
|
+
Identifies the identification assignment.
|
|
1762
|
+
Rpt:
|
|
1763
|
+
allOf:
|
|
1764
|
+
- $ref: "#/components/schemas/VerificationReport4"
|
|
1765
|
+
- description: >
|
|
1766
|
+
Report
|
|
1767
|
+
|
|
1768
|
+
Information concerning the verification of the identification
|
|
1769
|
+
data for which verification was requested.
|
|
1770
|
+
SplmtryData:
|
|
1771
|
+
allOf:
|
|
1772
|
+
- $ref: "#/components/schemas/SupplementaryData1"
|
|
1773
|
+
- description: >
|
|
1774
|
+
SupplementaryData
|
|
1775
|
+
|
|
1776
|
+
Additional information that cannot be captured in the structured
|
|
1777
|
+
elements and/or any other specific block.
|
|
1778
|
+
required:
|
|
1779
|
+
- Assgnmt
|
|
1780
|
+
- Rpt
|
|
1781
|
+
example:
|
|
1782
|
+
Assgnmt:
|
|
1783
|
+
MsgId: 123
|
|
1784
|
+
CreDtTm: "2020-01-01T00:00:00Z"
|
|
1785
|
+
Assgnr:
|
|
1786
|
+
OrgId:
|
|
1787
|
+
Othr:
|
|
1788
|
+
Id: 123
|
|
1789
|
+
SchmeNm:
|
|
1790
|
+
Cd: BIC
|
|
1791
|
+
Issr: BIC
|
|
1792
|
+
Assgne:
|
|
1793
|
+
OrgId:
|
|
1794
|
+
Othr:
|
|
1795
|
+
Id: DFSPID
|
|
1796
|
+
Rpt:
|
|
1797
|
+
OrgnlId: 12345678
|
|
1798
|
+
Vrfctn: true
|
|
1799
|
+
UpdtdPtyAndAcctId:
|
|
1800
|
+
Pty:
|
|
1801
|
+
Nm: John Doe
|
|
1802
|
+
PstlAdr:
|
|
1803
|
+
AdrTp: ADDR
|
|
1804
|
+
Dept: Dept
|
|
1805
|
+
SubDept: SubDept
|
|
1806
|
+
StrtNm: StrtNm
|
|
1807
|
+
BldgNb: BldgNb
|
|
1808
|
+
BldgNm: BldgNm
|
|
1809
|
+
Flr: Flr
|
|
1810
|
+
PstBx: PstBx
|
|
1811
|
+
Room: Room
|
|
1812
|
+
PstCd: PstCd
|
|
1813
|
+
TwnNm: TwnNm
|
|
1814
|
+
TwnLctnNm: TwnLctnNm
|
|
1815
|
+
DstrctNm: DstrctNm
|
|
1816
|
+
CtrySubDvsn: CtrySubDvsn
|
|
1817
|
+
Ctry: Ctry
|
|
1818
|
+
AdrLine: AdrLine
|
|
1819
|
+
Id:
|
|
1820
|
+
OrgId:
|
|
1821
|
+
Othr:
|
|
1822
|
+
Id: 18761231234
|
|
1823
|
+
SchmeNm:
|
|
1824
|
+
Prtry: MSISDN
|
|
1825
|
+
CtryOfRes: BE
|
|
1826
|
+
CtctDtls:
|
|
1827
|
+
NmPrfx: Mr
|
|
1828
|
+
Nm: John Doe
|
|
1829
|
+
PhneNb: +123-123-321
|
|
1830
|
+
MobNb: +123-123-321
|
|
1831
|
+
FaxNb: +123-123-321
|
|
1832
|
+
EmailAdr: example@example.com
|
|
1833
|
+
IBAN2007Identifier:
|
|
1834
|
+
title: IBAN2007Identifier
|
|
1835
|
+
description: >
|
|
1836
|
+
The International Bank Account Number is a code used internationally by
|
|
1837
|
+
financial institutions to uniquely identify the account of a customer at
|
|
1838
|
+
a financial institution as described in the 2007 edition of the ISO
|
|
1839
|
+
13616 standard "Banking and related financial services -
|
|
1840
|
+
|
|
1841
|
+
International Bank Account Number (IBAN)" and replaced by the more
|
|
1842
|
+
recent edition of the standard.
|
|
1843
|
+
type: string
|
|
1844
|
+
example: FR1420041010050500013M02606
|
|
1845
|
+
pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$
|
|
1846
|
+
ISODate:
|
|
1847
|
+
title: ISODate
|
|
1848
|
+
description: >
|
|
1849
|
+
A particular point in the progression of time in a calendar year
|
|
1850
|
+
expressed in the YYYY-MM-DD format. This representation is defined in
|
|
1851
|
+
"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28
|
|
1852
|
+
October 2004" which is aligned with ISO 8601.
|
|
1853
|
+
type: string
|
|
1854
|
+
example: "2013-03-07"
|
|
1855
|
+
ISODateTime:
|
|
1856
|
+
title: ISODateTime
|
|
1857
|
+
description: >
|
|
1858
|
+
A particular point in the progression of time defined by a mandatory
|
|
1859
|
+
|
|
1860
|
+
date and a mandatory time component, expressed in either UTC time
|
|
1861
|
+
|
|
1862
|
+
format (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format
|
|
1863
|
+
|
|
1864
|
+
(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format
|
|
1865
|
+
|
|
1866
|
+
(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in
|
|
1867
|
+
|
|
1868
|
+
"XML Schema Part 2: Datatypes Second Edition -
|
|
1869
|
+
|
|
1870
|
+
W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
|
|
1871
|
+
|
|
1872
|
+
|
|
1873
|
+
Note on the time format:
|
|
1874
|
+
|
|
1875
|
+
1) beginning / end of calendar day
|
|
1876
|
+
|
|
1877
|
+
00:00:00 = the beginning of a calendar day
|
|
1878
|
+
|
|
1879
|
+
24:00:00 = the end of a calendar day
|
|
1880
|
+
|
|
1881
|
+
|
|
1882
|
+
2) fractions of second in time format
|
|
1883
|
+
|
|
1884
|
+
Decimal fractions of seconds may be included. In this case, the
|
|
1885
|
+
|
|
1886
|
+
involved parties shall agree on the maximum number of digits that are
|
|
1887
|
+
allowed.
|
|
1888
|
+
type: string
|
|
1889
|
+
pattern: >-
|
|
1890
|
+
^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:(\.\d{3}))(?:Z|[+-][01]\d:[0-5]\d)$
|
|
1891
|
+
example: "2013-03-07T14:44:30.000Z"
|
|
1892
|
+
IdentificationAssignment3:
|
|
1893
|
+
title: IdentificationAssignment3
|
|
1894
|
+
type: object
|
|
1895
|
+
description: >
|
|
1896
|
+
IdentificationAssignment
|
|
1897
|
+
|
|
1898
|
+
Information that unambiguously identifies a message, as assigned by the
|
|
1899
|
+
assignor to the assignee.
|
|
1900
|
+
properties:
|
|
1901
|
+
MsgId:
|
|
1902
|
+
allOf:
|
|
1903
|
+
- $ref: "#/components/schemas/Max35Text"
|
|
1904
|
+
- description: >
|
|
1905
|
+
MessageIdentification
|
|
1906
|
+
|
|
1907
|
+
Unique identification, as assigned by the assigner, to
|
|
1908
|
+
unambiguously identify the message.
|
|
1909
|
+
CreDtTm:
|
|
1910
|
+
allOf:
|
|
1911
|
+
- $ref: "#/components/schemas/ISODateTime"
|
|
1912
|
+
- description: >
|
|
1913
|
+
CreationDateTime
|
|
1914
|
+
|
|
1915
|
+
Date and time at which the identification assignment was
|
|
1916
|
+
created.
|
|
1917
|
+
Assgnr:
|
|
1918
|
+
allOf:
|
|
1919
|
+
- $ref: "#/components/schemas/Party40Choice"
|
|
1920
|
+
- description: >
|
|
1921
|
+
Assignor
|
|
1922
|
+
|
|
1923
|
+
Party that assigns the identification assignment to another
|
|
1924
|
+
party. This is also the sender of the message.
|
|
1925
|
+
Assgne:
|
|
1926
|
+
allOf:
|
|
1927
|
+
- $ref: "#/components/schemas/Party40Choice"
|
|
1928
|
+
- description: >
|
|
1929
|
+
Assignee
|
|
1930
|
+
|
|
1931
|
+
Party that the identification assignment is assigned to. This is
|
|
1932
|
+
also the receiver of the message.
|
|
1933
|
+
required:
|
|
1934
|
+
- MsgId
|
|
1935
|
+
- CreDtTm
|
|
1936
|
+
- Assgnr
|
|
1937
|
+
- Assgne
|
|
1938
|
+
example:
|
|
1939
|
+
MsgId: 123
|
|
1940
|
+
CreDtTm: "2020-01-01T00:00:00Z"
|
|
1941
|
+
Assgnr:
|
|
1942
|
+
OrgId:
|
|
1943
|
+
Othr:
|
|
1944
|
+
Id: 123
|
|
1945
|
+
SchmeNm:
|
|
1946
|
+
Cd: BIC
|
|
1947
|
+
Issr: BIC
|
|
1948
|
+
Assgne:
|
|
1949
|
+
OrgId:
|
|
1950
|
+
Othr:
|
|
1951
|
+
Id: 123
|
|
1952
|
+
SchmeNm:
|
|
1953
|
+
Cd: BIC
|
|
1954
|
+
Issr: BIC
|
|
1955
|
+
IdentificationInformation4:
|
|
1956
|
+
title: IdentificationInformation4
|
|
1957
|
+
type: object
|
|
1958
|
+
description: |
|
|
1959
|
+
Information that locates and identifies a specific party or account.
|
|
1960
|
+
properties:
|
|
1961
|
+
Pty:
|
|
1962
|
+
allOf:
|
|
1963
|
+
- $ref: "#/components/schemas/PartyIdentification135"
|
|
1964
|
+
- description: >
|
|
1965
|
+
Party
|
|
1966
|
+
|
|
1967
|
+
Account owner that owes an amount of money or to whom an amount
|
|
1968
|
+
of money is due.
|
|
1969
|
+
Acct:
|
|
1970
|
+
allOf:
|
|
1971
|
+
- $ref: "#/components/schemas/CashAccount40"
|
|
1972
|
+
- description: |
|
|
1973
|
+
Account
|
|
1974
|
+
Unambiguous identification of the account of a party.
|
|
1975
|
+
Agt:
|
|
1976
|
+
allOf:
|
|
1977
|
+
- $ref: >-
|
|
1978
|
+
#/components/schemas/BranchAndFinancialInstitutionIdentification6
|
|
1979
|
+
- description: |
|
|
1980
|
+
Agent
|
|
1981
|
+
Financial institution servicing an account for a party.
|
|
1982
|
+
required:
|
|
1983
|
+
- Pty
|
|
1984
|
+
example:
|
|
1985
|
+
Pty:
|
|
1986
|
+
Id:
|
|
1987
|
+
OrgId:
|
|
1988
|
+
AnyBIC:
|
|
1989
|
+
BICFI: BICFI
|
|
1990
|
+
CtryOfRes: FI
|
|
1991
|
+
Acct:
|
|
1992
|
+
Id:
|
|
1993
|
+
IBAN: FI2112345600000785
|
|
1994
|
+
Agt:
|
|
1995
|
+
FinInstnId:
|
|
1996
|
+
BICFI: BICFI
|
|
1997
|
+
IdentificationVerificationIndicator:
|
|
1998
|
+
title: IdentificationVerificationIndicator
|
|
1999
|
+
type: boolean
|
|
2000
|
+
example: true
|
|
2001
|
+
description: >
|
|
2002
|
+
Definition: Identifies whether the party and/or account information
|
|
2003
|
+
received is correct.
|
|
2004
|
+
|
|
2005
|
+
|
|
2006
|
+
• Meaning When True: Indicates that the identification information
|
|
2007
|
+
received is correct.
|
|
2008
|
+
|
|
2009
|
+
• Meaning When False: Indicates that the identification information
|
|
2010
|
+
received is incorrect
|
|
2011
|
+
LEIIdentifier:
|
|
2012
|
+
title: LEIIdentifier
|
|
2013
|
+
description: >
|
|
2014
|
+
Legal Entity Identifier is a code allocated to a party as described in
|
|
2015
|
+
ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
|
|
2016
|
+
^([0-9A-Z]{18,18}[0-9]{2,2})$
|
|
2017
|
+
type: string
|
|
2018
|
+
pattern: ^[A-Z0-9]{18,18}[0-9]{2,2}$
|
|
2019
|
+
example: 529900T8BM49AURSDO55
|
|
2020
|
+
Max128Text:
|
|
2021
|
+
title: Max128Text
|
|
2022
|
+
description: |
|
|
2023
|
+
Specifies a character string with a maximum length of 128 characters.
|
|
2024
|
+
type: string
|
|
2025
|
+
minLength: 1
|
|
2026
|
+
maxLength: 128
|
|
2027
|
+
example: 12345
|
|
2028
|
+
Max140Text:
|
|
2029
|
+
title: Max140Text
|
|
2030
|
+
description: |
|
|
2031
|
+
Specifies a character string with a maximum length of 140 characters.
|
|
2032
|
+
type: string
|
|
2033
|
+
minLength: 1
|
|
2034
|
+
maxLength: 140
|
|
2035
|
+
example: 12345
|
|
2036
|
+
Max16Text:
|
|
2037
|
+
title: Max16Text
|
|
2038
|
+
description: |
|
|
2039
|
+
Specifies a character string with a maximum length of 16 characters.
|
|
2040
|
+
type: string
|
|
2041
|
+
minLength: 1
|
|
2042
|
+
maxLength: 16
|
|
2043
|
+
example: 1234567890123456
|
|
2044
|
+
Max2048Text:
|
|
2045
|
+
title: Max2048Text
|
|
2046
|
+
description: |
|
|
2047
|
+
Specifies a character string with a maximum length of 2048 characters.
|
|
2048
|
+
type: string
|
|
2049
|
+
minLength: 1
|
|
2050
|
+
maxLength: 2048
|
|
2051
|
+
example: 2048
|
|
2052
|
+
Max34Text:
|
|
2053
|
+
title: Max34Text
|
|
2054
|
+
description: |
|
|
2055
|
+
Specifies a character string with a maximum length of 34 characters.
|
|
2056
|
+
type: string
|
|
2057
|
+
minLength: 1
|
|
2058
|
+
maxLength: 34
|
|
2059
|
+
example: 1.2345678901234568e+33
|
|
2060
|
+
Max350Text:
|
|
2061
|
+
title: Max350Text
|
|
2062
|
+
description: |
|
|
2063
|
+
Specifies a character string with a maximum length of 350 characters.
|
|
2064
|
+
type: string
|
|
2065
|
+
minLength: 1
|
|
2066
|
+
maxLength: 350
|
|
2067
|
+
example: 350
|
|
2068
|
+
Max35Text:
|
|
2069
|
+
title: Max35Text
|
|
2070
|
+
description: |
|
|
2071
|
+
Specifies a character string with a maximum length of 35 characters.
|
|
2072
|
+
type: string
|
|
2073
|
+
minLength: 1
|
|
2074
|
+
maxLength: 35
|
|
2075
|
+
example: 1.234567890123457e+34
|
|
2076
|
+
Max4Text:
|
|
2077
|
+
title: Max4Text
|
|
2078
|
+
description: |
|
|
2079
|
+
Specifies a character string with a maximum length of 4 characters.
|
|
2080
|
+
type: string
|
|
2081
|
+
minLength: 1
|
|
2082
|
+
maxLength: 4
|
|
2083
|
+
example: 1234
|
|
2084
|
+
Max70Text:
|
|
2085
|
+
title: Max70Text
|
|
2086
|
+
description: |
|
|
2087
|
+
Specifies a character string with a maximum length of 70 characters.
|
|
2088
|
+
type: string
|
|
2089
|
+
minLength: 1
|
|
2090
|
+
maxLength: 70
|
|
2091
|
+
example: 1.2345678901234567e+99
|
|
2092
|
+
NamePrefix2Code:
|
|
2093
|
+
description: |
|
|
2094
|
+
Specifies the terms used to formally address a person.
|
|
2095
|
+
|
|
2096
|
+
DOCT: Doctor or Dr
|
|
2097
|
+
MADM: Madam
|
|
2098
|
+
MISS: Miss
|
|
2099
|
+
MIST: Mistress
|
|
2100
|
+
MIKS: Mx
|
|
2101
|
+
enum:
|
|
2102
|
+
- DOCT
|
|
2103
|
+
- MADM
|
|
2104
|
+
- MISS
|
|
2105
|
+
- MIST
|
|
2106
|
+
- MIKS
|
|
2107
|
+
type: string
|
|
2108
|
+
example: DOCT
|
|
2109
|
+
OrganisationIdentification29:
|
|
2110
|
+
title: OrganisationIdentification29
|
|
1477
2111
|
description: |
|
|
1478
|
-
|
|
2112
|
+
Unique and unambiguous way to identify an organisation.
|
|
2113
|
+
type: object
|
|
1479
2114
|
properties:
|
|
1480
|
-
|
|
2115
|
+
AnyBIC:
|
|
1481
2116
|
allOf:
|
|
1482
|
-
- $ref:
|
|
2117
|
+
- $ref: "#/components/schemas/AnyBICDec2014Identifier"
|
|
1483
2118
|
- description: |
|
|
1484
|
-
|
|
1485
|
-
|
|
2119
|
+
AnyBIC
|
|
2120
|
+
Business identification code of the organisation.
|
|
1486
2121
|
LEI:
|
|
1487
2122
|
allOf:
|
|
1488
|
-
- $ref:
|
|
1489
|
-
- description:
|
|
1490
|
-
|
|
1491
|
-
|
|
1492
|
-
|
|
2123
|
+
- $ref: "#/components/schemas/LEIIdentifier"
|
|
2124
|
+
- description: >
|
|
2125
|
+
LEI
|
|
2126
|
+
|
|
2127
|
+
Legal entity identification as an alternate identification for a
|
|
2128
|
+
party.
|
|
2129
|
+
Othr:
|
|
1493
2130
|
allOf:
|
|
1494
|
-
- $ref:
|
|
1495
|
-
- description:
|
|
1496
|
-
|
|
1497
|
-
|
|
1498
|
-
|
|
2131
|
+
- $ref: "#/components/schemas/GenericOrganisationIdentification1"
|
|
2132
|
+
- description: >
|
|
2133
|
+
Other
|
|
2134
|
+
|
|
2135
|
+
Unique identification of an organisation, as assigned by an
|
|
2136
|
+
institution, using an identification scheme.
|
|
2137
|
+
example:
|
|
2138
|
+
AnyBIC: BICFI
|
|
2139
|
+
LEI: 529900T8BM49AURSDO55
|
|
2140
|
+
Othr:
|
|
2141
|
+
Id: 123
|
|
2142
|
+
SchmeNm:
|
|
2143
|
+
Cd: BIC
|
|
2144
|
+
Issr: BIC
|
|
2145
|
+
OrganisationIdentificationSchemeName1Choice:
|
|
2146
|
+
title: OrganisationIdentificationSchemeName1Choice
|
|
2147
|
+
description: |
|
|
2148
|
+
Choice of format for the organisation identification.
|
|
2149
|
+
type: object
|
|
2150
|
+
properties:
|
|
2151
|
+
Cd:
|
|
2152
|
+
allOf:
|
|
2153
|
+
- $ref: "#/components/schemas/ExternalOrganisationIdentification1Code"
|
|
2154
|
+
- description: >
|
|
2155
|
+
Code
|
|
2156
|
+
|
|
2157
|
+
Name of the identification scheme, in a coded form as published
|
|
2158
|
+
in an external list.
|
|
2159
|
+
Prtry:
|
|
1499
2160
|
allOf:
|
|
1500
|
-
- $ref:
|
|
2161
|
+
- $ref: "#/components/schemas/Max35Text"
|
|
1501
2162
|
- description: |
|
|
1502
|
-
|
|
1503
|
-
|
|
2163
|
+
Proprietary
|
|
2164
|
+
Name of the identification scheme, in a free text form.
|
|
2165
|
+
anyOf:
|
|
2166
|
+
- properties:
|
|
2167
|
+
Cd: {}
|
|
2168
|
+
- properties:
|
|
2169
|
+
Prtry: {}
|
|
1504
2170
|
example:
|
|
1505
|
-
|
|
1506
|
-
|
|
1507
|
-
|
|
1508
|
-
|
|
1509
|
-
|
|
1510
|
-
|
|
1511
|
-
StrtNm: Street name
|
|
1512
|
-
BldgNb: Building number
|
|
1513
|
-
PstCd: Post code
|
|
1514
|
-
TwnNm: Town name
|
|
1515
|
-
CtrySubDvsn: Country subdivision
|
|
1516
|
-
Ctry: Country
|
|
1517
|
-
AdrLine: Address line
|
|
1518
|
-
BranchAndFinancialInstitutionIdentification6:
|
|
1519
|
-
title: BranchAndFinancialInstitutionIdentification6
|
|
2171
|
+
Cd: BIC
|
|
2172
|
+
OtherContact1:
|
|
2173
|
+
title: OtherContact1
|
|
2174
|
+
description: >
|
|
2175
|
+
Communication device number or electronic address used for
|
|
2176
|
+
communication.
|
|
1520
2177
|
type: object
|
|
1521
|
-
description: |
|
|
1522
|
-
Unique and unambiguous identification of a financial institution or a branch of a financial institution.
|
|
1523
2178
|
properties:
|
|
1524
|
-
|
|
2179
|
+
ChanlTp:
|
|
1525
2180
|
allOf:
|
|
1526
|
-
- $ref:
|
|
1527
|
-
- description:
|
|
1528
|
-
|
|
1529
|
-
|
|
1530
|
-
|
|
2181
|
+
- $ref: "#/components/schemas/Max4Text"
|
|
2182
|
+
- description: >
|
|
2183
|
+
ChannelType
|
|
2184
|
+
|
|
2185
|
+
Method used to contact the financial institution's contact for
|
|
2186
|
+
the specific tax region.
|
|
2187
|
+
Id:
|
|
1531
2188
|
allOf:
|
|
1532
|
-
- $ref:
|
|
2189
|
+
- $ref: "#/components/schemas/Max128Text"
|
|
1533
2190
|
- description: |
|
|
1534
|
-
|
|
1535
|
-
|
|
1536
|
-
Usage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.
|
|
2191
|
+
Identifier
|
|
2192
|
+
Communication value such as phone number or email address.
|
|
1537
2193
|
required:
|
|
1538
|
-
-
|
|
2194
|
+
- ChanlTp
|
|
1539
2195
|
example:
|
|
1540
|
-
|
|
1541
|
-
|
|
1542
|
-
|
|
1543
|
-
|
|
1544
|
-
|
|
1545
|
-
|
|
1546
|
-
|
|
1547
|
-
|
|
1548
|
-
|
|
1549
|
-
|
|
1550
|
-
|
|
1551
|
-
|
|
1552
|
-
|
|
1553
|
-
|
|
1554
|
-
|
|
1555
|
-
|
|
2196
|
+
ChanlTp: PHON
|
|
2197
|
+
Id: 1234567890
|
|
2198
|
+
Party38Choice:
|
|
2199
|
+
title: Party38Choice
|
|
2200
|
+
description: |
|
|
2201
|
+
Nature or use of the account.
|
|
2202
|
+
type: object
|
|
2203
|
+
anyOf:
|
|
2204
|
+
- properties:
|
|
2205
|
+
OrgId:
|
|
2206
|
+
allOf:
|
|
2207
|
+
- $ref: "#/components/schemas/OrganisationIdentification29"
|
|
2208
|
+
- description: |
|
|
2209
|
+
Organisation
|
|
2210
|
+
Unique and unambiguous way to identify an organisation.
|
|
2211
|
+
required:
|
|
2212
|
+
- OrgId
|
|
2213
|
+
- properties:
|
|
2214
|
+
PrvtId:
|
|
2215
|
+
allOf:
|
|
2216
|
+
- $ref: "#/components/schemas/PersonIdentification13"
|
|
2217
|
+
- description: >
|
|
2218
|
+
PrivateIdentification
|
|
2219
|
+
|
|
2220
|
+
Unique and unambiguous identification of a person, for
|
|
2221
|
+
example a passport.
|
|
2222
|
+
required:
|
|
2223
|
+
- PrvtId
|
|
2224
|
+
example:
|
|
2225
|
+
OrgId:
|
|
2226
|
+
AnyBIC: BIC
|
|
2227
|
+
PrvtId:
|
|
2228
|
+
DtAndPlcOfBirth:
|
|
2229
|
+
Dt: "2018-01-01"
|
|
2230
|
+
CityOfBirth: City
|
|
1556
2231
|
Party40Choice:
|
|
1557
2232
|
title: Party40Choice
|
|
1558
2233
|
description: |
|
|
@@ -1562,7 +2237,7 @@ components:
|
|
|
1562
2237
|
- properties:
|
|
1563
2238
|
Pty:
|
|
1564
2239
|
allOf:
|
|
1565
|
-
- $ref:
|
|
2240
|
+
- $ref: "#/components/schemas/PartyIdentification135"
|
|
1566
2241
|
- description: |
|
|
1567
2242
|
Party
|
|
1568
2243
|
Identification of a person or an organisation.
|
|
@@ -1571,7 +2246,8 @@ components:
|
|
|
1571
2246
|
- properties:
|
|
1572
2247
|
Agt:
|
|
1573
2248
|
allOf:
|
|
1574
|
-
- $ref:
|
|
2249
|
+
- $ref: >-
|
|
2250
|
+
#/components/schemas/BranchAndFinancialInstitutionIdentification6
|
|
1575
2251
|
- description: |
|
|
1576
2252
|
Agent
|
|
1577
2253
|
Identification of a financial institution.
|
|
@@ -1600,284 +2276,227 @@ components:
|
|
|
1600
2276
|
- 1 Oxford Street
|
|
1601
2277
|
- London
|
|
1602
2278
|
- UK
|
|
1603
|
-
|
|
1604
|
-
title:
|
|
1605
|
-
type: object
|
|
1606
|
-
description: |
|
|
1607
|
-
IdentificationAssignment
|
|
1608
|
-
Information that unambiguously identifies a message, as assigned by the assignor to the assignee.
|
|
1609
|
-
properties:
|
|
1610
|
-
MsgId:
|
|
1611
|
-
allOf:
|
|
1612
|
-
- $ref: '#/components/schemas/Max35Text'
|
|
1613
|
-
- description: |
|
|
1614
|
-
MessageIdentification
|
|
1615
|
-
Unique identification, as assigned by the assigner, to unambiguously identify the message.
|
|
1616
|
-
CreDtTm:
|
|
1617
|
-
allOf:
|
|
1618
|
-
- $ref: '#/components/schemas/ISODateTime'
|
|
1619
|
-
- description: |
|
|
1620
|
-
CreationDateTime
|
|
1621
|
-
Date and time at which the identification assignment was created.
|
|
1622
|
-
Assgnr:
|
|
1623
|
-
allOf:
|
|
1624
|
-
- $ref: '#/components/schemas/Party40Choice'
|
|
1625
|
-
- description: |
|
|
1626
|
-
Assignor
|
|
1627
|
-
Party that assigns the identification assignment to another party. This is also the sender of the message.
|
|
1628
|
-
Assgne:
|
|
1629
|
-
allOf:
|
|
1630
|
-
- $ref: '#/components/schemas/Party40Choice'
|
|
1631
|
-
- description: |
|
|
1632
|
-
Assignee
|
|
1633
|
-
Party that the identification assignment is assigned to. This is also the receiver of the message.
|
|
1634
|
-
required:
|
|
1635
|
-
- MsgId
|
|
1636
|
-
- CreDtTm
|
|
1637
|
-
- Assgnr
|
|
1638
|
-
- Assgne
|
|
1639
|
-
example:
|
|
1640
|
-
MsgId: 123
|
|
1641
|
-
CreDtTm: '2020-01-01T00:00:00Z'
|
|
1642
|
-
Assgnr:
|
|
1643
|
-
OrgId:
|
|
1644
|
-
Othr:
|
|
1645
|
-
Id: 123
|
|
1646
|
-
SchmeNm:
|
|
1647
|
-
Cd: BIC
|
|
1648
|
-
Issr: BIC
|
|
1649
|
-
Assgne:
|
|
1650
|
-
OrgId:
|
|
1651
|
-
Othr:
|
|
1652
|
-
Id: 123
|
|
1653
|
-
SchmeNm:
|
|
1654
|
-
Cd: BIC
|
|
1655
|
-
Issr: BIC
|
|
1656
|
-
IdentificationVerificationIndicator:
|
|
1657
|
-
title: IdentificationVerificationIndicator
|
|
1658
|
-
type: boolean
|
|
1659
|
-
example: true
|
|
1660
|
-
description: |
|
|
1661
|
-
Definition: Identifies whether the party and/or account information received is correct.
|
|
1662
|
-
|
|
1663
|
-
• Meaning When True: Indicates that the identification information received is correct.
|
|
1664
|
-
• Meaning When False: Indicates that the identification information received is incorrect
|
|
1665
|
-
ExternalVerificationReason1Code:
|
|
1666
|
-
title: ExternalVerificationReason1Code
|
|
1667
|
-
description: Specifies the external verification reason code.
|
|
1668
|
-
type: string
|
|
1669
|
-
minLength: 1
|
|
1670
|
-
maxLength: 4
|
|
1671
|
-
example: 1234
|
|
1672
|
-
VerificationReason1Choice:
|
|
1673
|
-
title: VerificationReason1Choice
|
|
1674
|
-
type: object
|
|
1675
|
-
description: |
|
|
1676
|
-
Choice of format for the verification reason.
|
|
1677
|
-
Only one, between the coded and the proprietary, can be chosen.
|
|
1678
|
-
anyOf:
|
|
1679
|
-
- properties:
|
|
1680
|
-
Cd:
|
|
1681
|
-
allOf:
|
|
1682
|
-
- $ref: '#/components/schemas/ExternalVerificationReason1Code'
|
|
1683
|
-
- description: |
|
|
1684
|
-
Code
|
|
1685
|
-
Reason why the verified identification information is incorrect, as published in an external reason code list.
|
|
1686
|
-
required:
|
|
1687
|
-
- Cd
|
|
1688
|
-
- properties:
|
|
1689
|
-
Prtry:
|
|
1690
|
-
allOf:
|
|
1691
|
-
- $ref: '#/components/schemas/Max35Text'
|
|
1692
|
-
- description: |
|
|
1693
|
-
Proprietary
|
|
1694
|
-
Reason why the verified identification information is incorrect, in a free text form.
|
|
1695
|
-
required:
|
|
1696
|
-
- Prtry
|
|
1697
|
-
example:
|
|
1698
|
-
Cd: AGNT
|
|
1699
|
-
IBAN2007Identifier:
|
|
1700
|
-
title: IBAN2007Identifier
|
|
1701
|
-
description: |
|
|
1702
|
-
The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard "Banking and related financial services -
|
|
1703
|
-
International Bank Account Number (IBAN)" and replaced by the more recent edition of the standard.
|
|
1704
|
-
type: string
|
|
1705
|
-
example: FR1420041010050500013M02606
|
|
1706
|
-
pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$
|
|
1707
|
-
Max34Text:
|
|
1708
|
-
title: Max34Text
|
|
1709
|
-
description: |
|
|
1710
|
-
Specifies a character string with a maximum length of 34 characters.
|
|
1711
|
-
type: string
|
|
1712
|
-
minLength: 1
|
|
1713
|
-
maxLength: 34
|
|
1714
|
-
example: 1.2345678901234568e+33
|
|
1715
|
-
ExternalAccountIdentification1Code:
|
|
1716
|
-
title: ExternalAccountIdentification1Code
|
|
1717
|
-
description: |
|
|
1718
|
-
Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.
|
|
1719
|
-
type: string
|
|
1720
|
-
minLength: 1
|
|
1721
|
-
maxLength: 4
|
|
1722
|
-
example: 1234
|
|
1723
|
-
AccountSchemeName1Choice:
|
|
1724
|
-
title: AccountSchemeName1Choice
|
|
1725
|
-
type: object
|
|
2279
|
+
PartyIdentification135:
|
|
2280
|
+
title: PartyIdentification135
|
|
1726
2281
|
description: |
|
|
1727
|
-
|
|
1728
|
-
anyOf:
|
|
1729
|
-
- properties:
|
|
1730
|
-
Cd:
|
|
1731
|
-
allOf:
|
|
1732
|
-
- $ref: '#/components/schemas/ExternalAccountIdentification1Code'
|
|
1733
|
-
- description: |
|
|
1734
|
-
Code
|
|
1735
|
-
Name of the identification scheme, in a coded form as published in an external list.
|
|
1736
|
-
required:
|
|
1737
|
-
- Cd
|
|
1738
|
-
- properties:
|
|
1739
|
-
Prtry:
|
|
1740
|
-
allOf:
|
|
1741
|
-
- $ref: '#/components/schemas/Max35Text'
|
|
1742
|
-
- description: |
|
|
1743
|
-
Proprietary
|
|
1744
|
-
Name of the identification scheme, in a free text form.
|
|
1745
|
-
required:
|
|
1746
|
-
- Prtry
|
|
1747
|
-
example:
|
|
1748
|
-
Cd: 1111
|
|
1749
|
-
GenericAccountIdentification1:
|
|
1750
|
-
title: GenericAccountIdentification1
|
|
2282
|
+
Specifies the identification of a person or an organisation.
|
|
1751
2283
|
type: object
|
|
1752
|
-
description: |
|
|
1753
|
-
GenericAccountIdentification
|
|
1754
|
-
Unique and unambiguous identification of an account, as assigned by the account servicer.
|
|
1755
2284
|
properties:
|
|
2285
|
+
Nm:
|
|
2286
|
+
allOf:
|
|
2287
|
+
- $ref: "#/components/schemas/Max140Text"
|
|
2288
|
+
- description: >
|
|
2289
|
+
Name
|
|
2290
|
+
|
|
2291
|
+
Name by which a party is known and which is usually used to
|
|
2292
|
+
identify that party.
|
|
2293
|
+
PstlAdr:
|
|
2294
|
+
allOf:
|
|
2295
|
+
- $ref: "#/components/schemas/PostalAddress24"
|
|
2296
|
+
- description: >
|
|
2297
|
+
PostalAddress
|
|
2298
|
+
|
|
2299
|
+
Information that locates and identifies a specific address, as
|
|
2300
|
+
defined by postal services.
|
|
1756
2301
|
Id:
|
|
1757
2302
|
allOf:
|
|
1758
|
-
- $ref:
|
|
2303
|
+
- $ref: "#/components/schemas/Party38Choice"
|
|
1759
2304
|
- description: |
|
|
1760
2305
|
Identification
|
|
1761
|
-
|
|
1762
|
-
|
|
2306
|
+
Unique and unambiguous way to identify an organisation.
|
|
2307
|
+
CtryOfRes:
|
|
1763
2308
|
allOf:
|
|
1764
|
-
- $ref:
|
|
1765
|
-
- description:
|
|
1766
|
-
|
|
1767
|
-
|
|
1768
|
-
|
|
2309
|
+
- $ref: "#/components/schemas/CountryCode"
|
|
2310
|
+
- description: >
|
|
2311
|
+
CountryOfResidence
|
|
2312
|
+
|
|
2313
|
+
Country in which a person resides (the place of a person's
|
|
2314
|
+
home). In the case of a company, it is the country from which
|
|
2315
|
+
the affairs of that company are directed.
|
|
2316
|
+
CtctDtls:
|
|
1769
2317
|
allOf:
|
|
1770
|
-
- $ref:
|
|
2318
|
+
- $ref: "#/components/schemas/Contact4"
|
|
1771
2319
|
- description: |
|
|
1772
|
-
|
|
1773
|
-
|
|
2320
|
+
ContactDetails
|
|
2321
|
+
Set of elements used to indicate how to contact the party.
|
|
1774
2322
|
required:
|
|
1775
2323
|
- Id
|
|
1776
2324
|
example:
|
|
1777
|
-
|
|
1778
|
-
|
|
1779
|
-
|
|
1780
|
-
|
|
1781
|
-
|
|
1782
|
-
|
|
1783
|
-
|
|
1784
|
-
|
|
1785
|
-
|
|
1786
|
-
|
|
1787
|
-
|
|
1788
|
-
|
|
1789
|
-
|
|
1790
|
-
|
|
1791
|
-
|
|
1792
|
-
|
|
1793
|
-
|
|
1794
|
-
|
|
1795
|
-
|
|
1796
|
-
|
|
2325
|
+
Nm: John Doe
|
|
2326
|
+
PstlAdr:
|
|
2327
|
+
AdrTp: ADDR
|
|
2328
|
+
Dept: Dept
|
|
2329
|
+
SubDept: SubDept
|
|
2330
|
+
StrtNm: StrtNm
|
|
2331
|
+
BldgNb: BldgNb
|
|
2332
|
+
BldgNm: BldgNm
|
|
2333
|
+
Flr: Flr
|
|
2334
|
+
PstBx: PstBx
|
|
2335
|
+
Room: Room
|
|
2336
|
+
PstCd: PstCd
|
|
2337
|
+
TwnNm: TwnNm
|
|
2338
|
+
TwnLctnNm: TwnLctnNm
|
|
2339
|
+
DstrctNm: DstrctNm
|
|
2340
|
+
CtrySubDvsn: CtrySubDvsn
|
|
2341
|
+
Ctry: Ctry
|
|
2342
|
+
AdrLine: AdrLine
|
|
2343
|
+
Id:
|
|
2344
|
+
OrgId:
|
|
1797
2345
|
Othr:
|
|
1798
|
-
|
|
1799
|
-
|
|
1800
|
-
|
|
1801
|
-
|
|
1802
|
-
|
|
1803
|
-
|
|
1804
|
-
|
|
1805
|
-
|
|
1806
|
-
|
|
1807
|
-
|
|
1808
|
-
|
|
2346
|
+
Id: 123
|
|
2347
|
+
SchmeNm:
|
|
2348
|
+
Prtry: DfspId
|
|
2349
|
+
CtryOfRes: BE
|
|
2350
|
+
CtctDtls:
|
|
2351
|
+
NmPrfx: Mr
|
|
2352
|
+
Nm: John Doe
|
|
2353
|
+
PhneNb: +123-123-321
|
|
2354
|
+
MobNb: +123-123-321
|
|
2355
|
+
FaxNb: +123-123-321
|
|
2356
|
+
EmailAdr: example@example.com
|
|
2357
|
+
PersonIdentification13:
|
|
2358
|
+
title: PersonIdentification13
|
|
1809
2359
|
description: |
|
|
1810
|
-
|
|
1811
|
-
type:
|
|
1812
|
-
|
|
1813
|
-
|
|
1814
|
-
|
|
1815
|
-
|
|
1816
|
-
|
|
2360
|
+
Unique and unambiguous way to identify a person.
|
|
2361
|
+
type: object
|
|
2362
|
+
properties:
|
|
2363
|
+
DtAndPlcOfBirth:
|
|
2364
|
+
allOf:
|
|
2365
|
+
- $ref: "#/components/schemas/DateAndPlaceOfBirth1"
|
|
2366
|
+
- description: |
|
|
2367
|
+
DateAndPlaceOfBirth
|
|
2368
|
+
Date and place of birth of a person.
|
|
2369
|
+
Othr:
|
|
2370
|
+
allOf:
|
|
2371
|
+
- $ref: "#/components/schemas/GenericPersonIdentification1"
|
|
2372
|
+
- description: >
|
|
2373
|
+
Other
|
|
2374
|
+
|
|
2375
|
+
Unique identification of a person, as assigned by an
|
|
2376
|
+
institution, using an identification scheme.
|
|
2377
|
+
example:
|
|
2378
|
+
DtAndPlcOfBirth:
|
|
2379
|
+
Dt: "2018-01-01"
|
|
2380
|
+
CityOfBirth: City
|
|
2381
|
+
Othr:
|
|
2382
|
+
Id: 123
|
|
2383
|
+
SchmeNm:
|
|
2384
|
+
Cd: CUST
|
|
2385
|
+
Prtry: 1
|
|
2386
|
+
PersonIdentificationSchemeName1Choice:
|
|
2387
|
+
title: PersonIdentificationSchemeName1Choice
|
|
1817
2388
|
description: |
|
|
1818
|
-
|
|
2389
|
+
Sets of elements to identify a name of the identification scheme.
|
|
1819
2390
|
type: object
|
|
1820
2391
|
anyOf:
|
|
1821
2392
|
- properties:
|
|
1822
2393
|
Cd:
|
|
1823
2394
|
allOf:
|
|
1824
|
-
- $ref:
|
|
1825
|
-
- description:
|
|
2395
|
+
- $ref: "#/components/schemas/ExternalPersonIdentification1Code"
|
|
2396
|
+
- description: >
|
|
1826
2397
|
Code
|
|
1827
|
-
|
|
2398
|
+
|
|
2399
|
+
Name of the identification scheme, in a coded form as
|
|
2400
|
+
published in an external list.
|
|
1828
2401
|
required:
|
|
1829
2402
|
- Cd
|
|
1830
2403
|
- properties:
|
|
1831
2404
|
Prtry:
|
|
1832
2405
|
allOf:
|
|
1833
|
-
- $ref:
|
|
2406
|
+
- $ref: "#/components/schemas/Max35Text"
|
|
1834
2407
|
- description: |
|
|
1835
2408
|
Proprietary
|
|
1836
|
-
|
|
2409
|
+
Name of the identification scheme, in a free text form.
|
|
1837
2410
|
required:
|
|
1838
2411
|
- Prtry
|
|
1839
2412
|
example:
|
|
1840
|
-
Cd:
|
|
1841
|
-
|
|
1842
|
-
title:
|
|
1843
|
-
type: string
|
|
1844
|
-
description: |
|
|
1845
|
-
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
|
|
1846
|
-
pattern: ^[A-Z]{3,3}$
|
|
1847
|
-
example: USD
|
|
1848
|
-
ExternalProxyAccountType1Code:
|
|
1849
|
-
title: ExternalProxyAccountType1Code
|
|
1850
|
-
description: Specifies the external proxy account type code.
|
|
2413
|
+
Cd: CCPT
|
|
2414
|
+
PhoneNumber:
|
|
2415
|
+
title: PhoneNumber
|
|
1851
2416
|
type: string
|
|
1852
|
-
minLength: 1
|
|
1853
|
-
maxLength: 4
|
|
1854
|
-
example: 1234
|
|
1855
|
-
ProxyAccountType1Choice:
|
|
1856
|
-
title: ProxyAccountType1Choice
|
|
1857
2417
|
description: |
|
|
1858
|
-
|
|
2418
|
+
Double check this regex.
|
|
2419
|
+
pattern: ^\+[0-9]{1,3}-[0-9()+\-]{1,30}$
|
|
2420
|
+
PostalAddress24:
|
|
2421
|
+
title: PostalAddress24
|
|
1859
2422
|
type: object
|
|
1860
|
-
|
|
1861
|
-
|
|
1862
|
-
|
|
1863
|
-
|
|
1864
|
-
|
|
1865
|
-
|
|
1866
|
-
|
|
1867
|
-
|
|
1868
|
-
|
|
1869
|
-
|
|
1870
|
-
|
|
1871
|
-
|
|
1872
|
-
|
|
1873
|
-
|
|
1874
|
-
|
|
1875
|
-
|
|
1876
|
-
|
|
1877
|
-
|
|
1878
|
-
|
|
2423
|
+
description: >
|
|
2424
|
+
Information that locates and identifies a specific address, as defined
|
|
2425
|
+
by postal services.
|
|
2426
|
+
properties:
|
|
2427
|
+
AdrTp:
|
|
2428
|
+
$ref: "#/components/schemas/AddressType3Choice"
|
|
2429
|
+
Dept:
|
|
2430
|
+
$ref: "#/components/schemas/Max70Text"
|
|
2431
|
+
SubDept:
|
|
2432
|
+
$ref: "#/components/schemas/Max70Text"
|
|
2433
|
+
StrtNm:
|
|
2434
|
+
$ref: "#/components/schemas/Max70Text"
|
|
2435
|
+
BldgNb:
|
|
2436
|
+
$ref: "#/components/schemas/Max16Text"
|
|
2437
|
+
BldgNm:
|
|
2438
|
+
$ref: "#/components/schemas/Max35Text"
|
|
2439
|
+
Flr:
|
|
2440
|
+
$ref: "#/components/schemas/Max70Text"
|
|
2441
|
+
PstBx:
|
|
2442
|
+
$ref: "#/components/schemas/Max16Text"
|
|
2443
|
+
Room:
|
|
2444
|
+
$ref: "#/components/schemas/Max70Text"
|
|
2445
|
+
PstCd:
|
|
2446
|
+
$ref: "#/components/schemas/Max16Text"
|
|
2447
|
+
TwnNm:
|
|
2448
|
+
$ref: "#/components/schemas/Max35Text"
|
|
2449
|
+
TwnLctnNm:
|
|
2450
|
+
$ref: "#/components/schemas/Max35Text"
|
|
2451
|
+
DstrctNm:
|
|
2452
|
+
$ref: "#/components/schemas/Max35Text"
|
|
2453
|
+
CtrySubDvsn:
|
|
2454
|
+
$ref: "#/components/schemas/Max35Text"
|
|
2455
|
+
Ctry:
|
|
2456
|
+
$ref: "#/components/schemas/CountryCode"
|
|
2457
|
+
AdrLine:
|
|
2458
|
+
$ref: "#/components/schemas/Max70Text"
|
|
1879
2459
|
example:
|
|
1880
|
-
|
|
2460
|
+
AdrTp: ADDR
|
|
2461
|
+
Dept: Dept
|
|
2462
|
+
SubDept: SubDept
|
|
2463
|
+
StrtNm: StrtNm
|
|
2464
|
+
BldgNb: BldgNb
|
|
2465
|
+
BldgNm: BldgNm
|
|
2466
|
+
Flr: Flr
|
|
2467
|
+
PstBx: PstBx
|
|
2468
|
+
Room: Room
|
|
2469
|
+
PstCd: PstCd
|
|
2470
|
+
TwnNm: TwnNm
|
|
2471
|
+
TwnLctnNm: TwnLctnNm
|
|
2472
|
+
DstrctNm: DstrctNm
|
|
2473
|
+
CtrySubDvsn: CtrySubDvsn
|
|
2474
|
+
Ctry: Ctry
|
|
2475
|
+
AdrLine: AdrLine
|
|
2476
|
+
PreferredContactMethod1Code:
|
|
2477
|
+
title: PreferredContactMethod1Code
|
|
2478
|
+
description: >
|
|
2479
|
+
Preferred method used to reach the individual contact within an
|
|
2480
|
+
organisation.
|
|
2481
|
+
|
|
2482
|
+
|
|
2483
|
+
LETT: Letter
|
|
2484
|
+
|
|
2485
|
+
MAIL: Email
|
|
2486
|
+
|
|
2487
|
+
PHON: Phone
|
|
2488
|
+
|
|
2489
|
+
FAXX: Fax
|
|
2490
|
+
|
|
2491
|
+
CELL: Mobile phone
|
|
2492
|
+
type: string
|
|
2493
|
+
enum:
|
|
2494
|
+
- LETT
|
|
2495
|
+
- MAIL
|
|
2496
|
+
- PHON
|
|
2497
|
+
- FAXX
|
|
2498
|
+
- CELL
|
|
2499
|
+
example: CELL
|
|
1881
2500
|
ProxyAccountIdentification1:
|
|
1882
2501
|
title: ProxyAccountIdentification1
|
|
1883
2502
|
description: |
|
|
@@ -1886,142 +2505,170 @@ components:
|
|
|
1886
2505
|
properties:
|
|
1887
2506
|
Tp:
|
|
1888
2507
|
allOf:
|
|
1889
|
-
- $ref:
|
|
2508
|
+
- $ref: "#/components/schemas/ProxyAccountType1Choice"
|
|
1890
2509
|
- description: |
|
|
1891
2510
|
Type
|
|
1892
2511
|
Type of the proxy identification.
|
|
1893
2512
|
Id:
|
|
1894
2513
|
allOf:
|
|
1895
|
-
- $ref:
|
|
1896
|
-
- description:
|
|
2514
|
+
- $ref: "#/components/schemas/Max2048Text"
|
|
2515
|
+
- description: >
|
|
1897
2516
|
Identification
|
|
1898
|
-
|
|
2517
|
+
|
|
2518
|
+
Identification used to indicate the account identification under
|
|
2519
|
+
another specified name.
|
|
1899
2520
|
required:
|
|
1900
2521
|
- Id
|
|
1901
2522
|
example:
|
|
1902
2523
|
Tp:
|
|
1903
2524
|
Cd: IBAN
|
|
1904
2525
|
Id: 123
|
|
1905
|
-
|
|
1906
|
-
title:
|
|
1907
|
-
type: object
|
|
2526
|
+
ProxyAccountType1Choice:
|
|
2527
|
+
title: ProxyAccountType1Choice
|
|
1908
2528
|
description: |
|
|
1909
|
-
|
|
1910
|
-
|
|
1911
|
-
|
|
1912
|
-
|
|
1913
|
-
|
|
1914
|
-
|
|
1915
|
-
|
|
1916
|
-
|
|
1917
|
-
|
|
1918
|
-
|
|
1919
|
-
|
|
1920
|
-
|
|
1921
|
-
|
|
1922
|
-
|
|
1923
|
-
|
|
1924
|
-
|
|
1925
|
-
|
|
1926
|
-
|
|
1927
|
-
|
|
1928
|
-
|
|
1929
|
-
|
|
1930
|
-
|
|
1931
|
-
|
|
1932
|
-
- $ref: '#/components/schemas/Max70Text'
|
|
1933
|
-
- description: |
|
|
1934
|
-
Name
|
|
1935
|
-
Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.
|
|
1936
|
-
Usage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.
|
|
1937
|
-
Prxy:
|
|
1938
|
-
allOf:
|
|
1939
|
-
- $ref: '#/components/schemas/ProxyAccountIdentification1'
|
|
1940
|
-
- description: |
|
|
1941
|
-
Proxy
|
|
1942
|
-
Specifies an alternate assumed name for the identification of the account.
|
|
2529
|
+
Specifies the type of the proxy account.
|
|
2530
|
+
type: object
|
|
2531
|
+
anyOf:
|
|
2532
|
+
- properties:
|
|
2533
|
+
Cd:
|
|
2534
|
+
allOf:
|
|
2535
|
+
- $ref: "#/components/schemas/ExternalProxyAccountType1Code"
|
|
2536
|
+
- description: >
|
|
2537
|
+
Code
|
|
2538
|
+
|
|
2539
|
+
Proxy account type, in a coded form as published in an
|
|
2540
|
+
external list.
|
|
2541
|
+
required:
|
|
2542
|
+
- Cd
|
|
2543
|
+
- properties:
|
|
2544
|
+
Prtry:
|
|
2545
|
+
allOf:
|
|
2546
|
+
- $ref: "#/components/schemas/Max35Text"
|
|
2547
|
+
- description: |
|
|
2548
|
+
Proprietary
|
|
2549
|
+
Proxy account type, in a proprietary form.
|
|
2550
|
+
required:
|
|
2551
|
+
- Prtry
|
|
1943
2552
|
example:
|
|
1944
|
-
|
|
1945
|
-
|
|
1946
|
-
|
|
1947
|
-
|
|
1948
|
-
|
|
1949
|
-
|
|
1950
|
-
Prxy:
|
|
1951
|
-
Id: 12345
|
|
1952
|
-
IdentificationInformation4:
|
|
1953
|
-
title: IdentificationInformation4
|
|
2553
|
+
Cd: EMAIL
|
|
2554
|
+
SupplementaryData1:
|
|
2555
|
+
title: SupplementaryData1
|
|
2556
|
+
description: >
|
|
2557
|
+
Additional information that cannot be captured in the structured fields
|
|
2558
|
+
and/or any other specific block.
|
|
1954
2559
|
type: object
|
|
1955
|
-
description: |
|
|
1956
|
-
Information that locates and identifies a specific party or account.
|
|
1957
2560
|
properties:
|
|
1958
|
-
|
|
1959
|
-
allOf:
|
|
1960
|
-
- $ref: '#/components/schemas/PartyIdentification135'
|
|
1961
|
-
- description: |
|
|
1962
|
-
Party
|
|
1963
|
-
Account owner that owes an amount of money or to whom an amount of money is due.
|
|
1964
|
-
Acct:
|
|
2561
|
+
PlcAndNm:
|
|
1965
2562
|
allOf:
|
|
1966
|
-
- $ref:
|
|
1967
|
-
- description:
|
|
1968
|
-
|
|
1969
|
-
|
|
1970
|
-
|
|
2563
|
+
- $ref: "#/components/schemas/Max350Text"
|
|
2564
|
+
- description: >
|
|
2565
|
+
PlaceAndName
|
|
2566
|
+
|
|
2567
|
+
Unambiguous reference to the location where the supplementary
|
|
2568
|
+
data must be inserted in the message instance.
|
|
2569
|
+
Envlp:
|
|
1971
2570
|
allOf:
|
|
1972
|
-
- $ref:
|
|
1973
|
-
- description:
|
|
1974
|
-
|
|
1975
|
-
|
|
2571
|
+
- $ref: "#/components/schemas/SupplementaryDataEnvelope1"
|
|
2572
|
+
- description: >
|
|
2573
|
+
Envelope
|
|
2574
|
+
|
|
2575
|
+
Technical element wrapping the supplementary data.
|
|
2576
|
+
|
|
2577
|
+
Technical component that contains the validated supplementary
|
|
2578
|
+
data information. This technical envelope allows to segregate
|
|
2579
|
+
the supplementary data information from any other information.
|
|
1976
2580
|
required:
|
|
1977
|
-
-
|
|
2581
|
+
- Envlp
|
|
1978
2582
|
example:
|
|
1979
|
-
|
|
1980
|
-
|
|
1981
|
-
|
|
1982
|
-
|
|
1983
|
-
|
|
1984
|
-
|
|
1985
|
-
|
|
1986
|
-
|
|
1987
|
-
|
|
1988
|
-
|
|
1989
|
-
|
|
1990
|
-
|
|
2583
|
+
PlcAndNm: Additional information
|
|
2584
|
+
Envlp:
|
|
2585
|
+
Cd: CH03
|
|
2586
|
+
Prtry: Additional information
|
|
2587
|
+
SupplementaryDataEnvelope1:
|
|
2588
|
+
title: SupplementaryDataEnvelope1
|
|
2589
|
+
description: >
|
|
2590
|
+
SupplementaryDataEnvelope1
|
|
2591
|
+
|
|
2592
|
+
Technical component that contains the validated supplementary data
|
|
2593
|
+
information. This technical envelope allows to segregate the
|
|
2594
|
+
supplementary data information from any other information.
|
|
2595
|
+
type: object
|
|
2596
|
+
VerificationReason1Choice:
|
|
2597
|
+
title: VerificationReason1Choice
|
|
2598
|
+
type: object
|
|
2599
|
+
description: |
|
|
2600
|
+
Choice of format for the verification reason.
|
|
2601
|
+
Only one, between the coded and the proprietary, can be chosen.
|
|
2602
|
+
anyOf:
|
|
2603
|
+
- properties:
|
|
2604
|
+
Cd:
|
|
2605
|
+
allOf:
|
|
2606
|
+
- $ref: "#/components/schemas/ExternalVerificationReason1Code"
|
|
2607
|
+
- description: >
|
|
2608
|
+
Code
|
|
2609
|
+
|
|
2610
|
+
Reason why the verified identification information is
|
|
2611
|
+
incorrect, as published in an external reason code list.
|
|
2612
|
+
required:
|
|
2613
|
+
- Cd
|
|
2614
|
+
- properties:
|
|
2615
|
+
Prtry:
|
|
2616
|
+
allOf:
|
|
2617
|
+
- $ref: "#/components/schemas/Max35Text"
|
|
2618
|
+
- description: >
|
|
2619
|
+
Proprietary
|
|
2620
|
+
|
|
2621
|
+
Reason why the verified identification information is
|
|
2622
|
+
incorrect, in a free text form.
|
|
2623
|
+
required:
|
|
2624
|
+
- Prtry
|
|
2625
|
+
example:
|
|
2626
|
+
Cd: AGNT
|
|
1991
2627
|
VerificationReport4:
|
|
1992
2628
|
title: VerificationReport4
|
|
1993
2629
|
type: object
|
|
1994
|
-
description:
|
|
2630
|
+
description: >-
|
|
1995
2631
|
VerificationReport
|
|
1996
|
-
|
|
2632
|
+
|
|
2633
|
+
Provides information about the verification of party and/or account
|
|
2634
|
+
identification information.
|
|
1997
2635
|
properties:
|
|
1998
2636
|
OrgnlId:
|
|
1999
2637
|
allOf:
|
|
2000
|
-
- $ref:
|
|
2001
|
-
- description:
|
|
2638
|
+
- $ref: "#/components/schemas/Max35Text"
|
|
2639
|
+
- description: >
|
|
2002
2640
|
OriginalIdentification
|
|
2003
|
-
|
|
2641
|
+
|
|
2642
|
+
Unique identification, as assigned by a sending party, to
|
|
2643
|
+
unambiguously identify the party and account identification
|
|
2644
|
+
information group within the original message.
|
|
2004
2645
|
Vrfctn:
|
|
2005
2646
|
allOf:
|
|
2006
|
-
- $ref:
|
|
2007
|
-
- description:
|
|
2647
|
+
- $ref: "#/components/schemas/IdentificationVerificationIndicator"
|
|
2648
|
+
- description: >
|
|
2008
2649
|
Verification
|
|
2009
|
-
|
|
2650
|
+
|
|
2651
|
+
Identifies whether the party and/or account information received
|
|
2652
|
+
is correct. Boolean value.
|
|
2010
2653
|
Rsn:
|
|
2011
2654
|
allOf:
|
|
2012
|
-
- $ref:
|
|
2013
|
-
- description:
|
|
2655
|
+
- $ref: "#/components/schemas/VerificationReason1Choice"
|
|
2656
|
+
- description: >
|
|
2014
2657
|
Reason
|
|
2015
|
-
|
|
2658
|
+
|
|
2659
|
+
Specifies the reason why the verified identification information
|
|
2660
|
+
is incorrect.
|
|
2016
2661
|
OrgnlPtyAndAcctId:
|
|
2017
2662
|
allOf:
|
|
2018
|
-
- $ref:
|
|
2019
|
-
- description:
|
|
2663
|
+
- $ref: "#/components/schemas/IdentificationInformation4"
|
|
2664
|
+
- description: >
|
|
2020
2665
|
OriginalPartyAndAccountIdentification
|
|
2021
|
-
|
|
2666
|
+
|
|
2667
|
+
Provides party and/or account identification information as
|
|
2668
|
+
given in the original message.
|
|
2022
2669
|
UpdtdPtyAndAcctId:
|
|
2023
2670
|
allOf:
|
|
2024
|
-
- $ref:
|
|
2671
|
+
- $ref: "#/components/schemas/IdentificationInformation4"
|
|
2025
2672
|
- description: |
|
|
2026
2673
|
UpdatedPartyAndAccountIdentification
|
|
2027
2674
|
Provides party and/or account identification information.
|
|
@@ -2067,190 +2714,3 @@ components:
|
|
|
2067
2714
|
Othr:
|
|
2068
2715
|
Id: 123456789
|
|
2069
2716
|
Issr: ABA
|
|
2070
|
-
Max350Text:
|
|
2071
|
-
title: Max350Text
|
|
2072
|
-
description: |
|
|
2073
|
-
Specifies a character string with a maximum length of 350 characters.
|
|
2074
|
-
type: string
|
|
2075
|
-
minLength: 1
|
|
2076
|
-
maxLength: 350
|
|
2077
|
-
example: 350
|
|
2078
|
-
SupplementaryDataEnvelope1:
|
|
2079
|
-
title: SupplementaryDataEnvelope1
|
|
2080
|
-
description: |
|
|
2081
|
-
SupplementaryDataEnvelope1
|
|
2082
|
-
Technical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.
|
|
2083
|
-
type: object
|
|
2084
|
-
SupplementaryData1:
|
|
2085
|
-
title: SupplementaryData1
|
|
2086
|
-
description: |
|
|
2087
|
-
Additional information that cannot be captured in the structured fields and/or any other specific block.
|
|
2088
|
-
type: object
|
|
2089
|
-
properties:
|
|
2090
|
-
PlcAndNm:
|
|
2091
|
-
allOf:
|
|
2092
|
-
- $ref: '#/components/schemas/Max350Text'
|
|
2093
|
-
- description: |
|
|
2094
|
-
PlaceAndName
|
|
2095
|
-
Unambiguous reference to the location where the supplementary data must be inserted in the message instance.
|
|
2096
|
-
Envlp:
|
|
2097
|
-
allOf:
|
|
2098
|
-
- $ref: '#/components/schemas/SupplementaryDataEnvelope1'
|
|
2099
|
-
- description: |
|
|
2100
|
-
Envelope
|
|
2101
|
-
Technical element wrapping the supplementary data.
|
|
2102
|
-
Technical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.
|
|
2103
|
-
required:
|
|
2104
|
-
- Envlp
|
|
2105
|
-
example:
|
|
2106
|
-
PlcAndNm: Additional information
|
|
2107
|
-
Envlp:
|
|
2108
|
-
Cd: CH03
|
|
2109
|
-
Prtry: Additional information
|
|
2110
|
-
GetParties_IdentificationVerificationReportV03:
|
|
2111
|
-
title: GetParties_IdentificationVerificationReportV03
|
|
2112
|
-
type: object
|
|
2113
|
-
properties:
|
|
2114
|
-
Assgnmt:
|
|
2115
|
-
allOf:
|
|
2116
|
-
- $ref: '#/components/schemas/IdentificationAssignment3'
|
|
2117
|
-
- description: |
|
|
2118
|
-
Assignment
|
|
2119
|
-
Identifies the identification assignment.
|
|
2120
|
-
Rpt:
|
|
2121
|
-
allOf:
|
|
2122
|
-
- $ref: '#/components/schemas/VerificationReport4'
|
|
2123
|
-
- description: |
|
|
2124
|
-
Report
|
|
2125
|
-
Information concerning the verification of the identification data for which verification was requested.
|
|
2126
|
-
SplmtryData:
|
|
2127
|
-
allOf:
|
|
2128
|
-
- $ref: '#/components/schemas/SupplementaryData1'
|
|
2129
|
-
- description: |
|
|
2130
|
-
SupplementaryData
|
|
2131
|
-
Additional information that cannot be captured in the structured elements and/or any other specific block.
|
|
2132
|
-
required:
|
|
2133
|
-
- Assgnmt
|
|
2134
|
-
- Rpt
|
|
2135
|
-
example:
|
|
2136
|
-
Assgnmt:
|
|
2137
|
-
MsgId: 123
|
|
2138
|
-
CreDtTm: '2020-01-01T00:00:00Z'
|
|
2139
|
-
Assgnr:
|
|
2140
|
-
OrgId:
|
|
2141
|
-
Othr:
|
|
2142
|
-
Id: 123
|
|
2143
|
-
SchmeNm:
|
|
2144
|
-
Cd: BIC
|
|
2145
|
-
Issr: BIC
|
|
2146
|
-
Assgne:
|
|
2147
|
-
OrgId:
|
|
2148
|
-
Othr:
|
|
2149
|
-
Id: DFSPID
|
|
2150
|
-
Rpt:
|
|
2151
|
-
OrgnlId: 12345678
|
|
2152
|
-
Vrfctn: true
|
|
2153
|
-
UpdtdPtyAndAcctId:
|
|
2154
|
-
Pty:
|
|
2155
|
-
Nm: John Doe
|
|
2156
|
-
PstlAdr:
|
|
2157
|
-
AdrTp: ADDR
|
|
2158
|
-
Dept: Dept
|
|
2159
|
-
SubDept: SubDept
|
|
2160
|
-
StrtNm: StrtNm
|
|
2161
|
-
BldgNb: BldgNb
|
|
2162
|
-
BldgNm: BldgNm
|
|
2163
|
-
Flr: Flr
|
|
2164
|
-
PstBx: PstBx
|
|
2165
|
-
Room: Room
|
|
2166
|
-
PstCd: PstCd
|
|
2167
|
-
TwnNm: TwnNm
|
|
2168
|
-
TwnLctnNm: TwnLctnNm
|
|
2169
|
-
DstrctNm: DstrctNm
|
|
2170
|
-
CtrySubDvsn: CtrySubDvsn
|
|
2171
|
-
Ctry: Ctry
|
|
2172
|
-
AdrLine: AdrLine
|
|
2173
|
-
Id:
|
|
2174
|
-
OrgId:
|
|
2175
|
-
Othr:
|
|
2176
|
-
Id: 18761231234
|
|
2177
|
-
SchmeNm:
|
|
2178
|
-
Prtry: MSISDN
|
|
2179
|
-
CtryOfRes: BE
|
|
2180
|
-
CtctDtls:
|
|
2181
|
-
NmPrfx: Mr
|
|
2182
|
-
Nm: John Doe
|
|
2183
|
-
PhneNb: +123-123-321
|
|
2184
|
-
MobNb: +123-123-321
|
|
2185
|
-
FaxNb: +123-123-321
|
|
2186
|
-
EmailAdr: example@example.com
|
|
2187
|
-
GetPartiesError_IdentificationVerificationReportV03:
|
|
2188
|
-
title: GetPartiesError_IdentificationVerificationReportV03
|
|
2189
|
-
type: object
|
|
2190
|
-
properties:
|
|
2191
|
-
Assgnmt:
|
|
2192
|
-
allOf:
|
|
2193
|
-
- $ref: '#/components/schemas/IdentificationAssignment3'
|
|
2194
|
-
- description: |
|
|
2195
|
-
Assignment
|
|
2196
|
-
Information related to the identification assignment.
|
|
2197
|
-
Rpt:
|
|
2198
|
-
allOf:
|
|
2199
|
-
- $ref: '#/components/schemas/VerificationReport4'
|
|
2200
|
-
- description: |
|
|
2201
|
-
Report
|
|
2202
|
-
Information concerning the verification of the identification data for which verification was requested.
|
|
2203
|
-
SplmtryData:
|
|
2204
|
-
allOf:
|
|
2205
|
-
- $ref: '#/components/schemas/SupplementaryData1'
|
|
2206
|
-
- description: |
|
|
2207
|
-
SupplementaryData
|
|
2208
|
-
Additional information that cannot be captured in the structured elements and/or any other specific block.
|
|
2209
|
-
required:
|
|
2210
|
-
- Assgnmt
|
|
2211
|
-
- Rpt
|
|
2212
|
-
example:
|
|
2213
|
-
Assgnmt:
|
|
2214
|
-
Id: 123
|
|
2215
|
-
CreDtTm: '2013-03-07T16:30:00'
|
|
2216
|
-
Assgnr:
|
|
2217
|
-
Id:
|
|
2218
|
-
Id: 123
|
|
2219
|
-
SchmeNm:
|
|
2220
|
-
Cd: IBAN
|
|
2221
|
-
Issr: BIC
|
|
2222
|
-
Assgne:
|
|
2223
|
-
Id:
|
|
2224
|
-
Id: 123
|
|
2225
|
-
SchmeNm:
|
|
2226
|
-
Cd: IBAN
|
|
2227
|
-
Issr: BIC
|
|
2228
|
-
Rpt:
|
|
2229
|
-
Id: 123
|
|
2230
|
-
CreDtTm: '2013-03-07T16:30:00'
|
|
2231
|
-
RptgPty:
|
|
2232
|
-
Id:
|
|
2233
|
-
Id: 123
|
|
2234
|
-
SchmeNm:
|
|
2235
|
-
Cd: IBAN
|
|
2236
|
-
Issr: BIC
|
|
2237
|
-
RptdPty:
|
|
2238
|
-
Id:
|
|
2239
|
-
Id: 123
|
|
2240
|
-
SchmeNm:
|
|
2241
|
-
Cd: IBAN
|
|
2242
|
-
Issr: BIC
|
|
2243
|
-
RptdDoc:
|
|
2244
|
-
Nb: 123
|
|
2245
|
-
RltdDt: '2013-03-07'
|
|
2246
|
-
RltdDtTp:
|
|
2247
|
-
Cd: 123
|
|
2248
|
-
Rsn:
|
|
2249
|
-
Cd: 123
|
|
2250
|
-
Prtry: 123
|
|
2251
|
-
SplmtryData:
|
|
2252
|
-
PlcAndNm: 123
|
|
2253
|
-
Envlp: 123
|
|
2254
|
-
RltdDt: '2013-03-07'
|
|
2255
|
-
RltdDtTp:
|
|
2256
|
-
Cd: 123
|