Updated YAML specs

This commit is contained in:
aleksei
2021-04-10 14:56:33 +02:00
parent 8a4e987746
commit 13901fe810
56 changed files with 7066 additions and 794 deletions

View File

@@ -1396,6 +1396,13 @@ components:
items:
$ref: '#/components/schemas/ShareholderContact'
type: array
signatories:
description: 'Signatories associated with the company.
Each array entry should represent one signatory.'
items:
$ref: '#/components/schemas/SignatoryContact'
type: array
taxId:
description: The tax ID of the company.
type: string
@@ -1785,6 +1792,8 @@ components:
- shareholder
- shareholderCode
- shareholderType
- shopperInteraction
- signatory
- socialSecurityNumber
- sourceAccountCode
- splitAccount
@@ -1807,6 +1816,7 @@ components:
- transferCode
- unknown
- value
- verificationType
- virtualAccount
- visaNumber
- webAddress
@@ -2035,7 +2045,6 @@ components:
type: string
required:
- schedule
- nextScheduledPayout
PersonalDocumentData:
properties:
expirationDate:
@@ -2308,6 +2317,69 @@ components:
enum:
- Controller
- Owner
- Signatory
type: string
webAddress:
description: The URL of the person's website.
type: string
SignatoryContact:
properties:
address:
description: The address of the person.
$ref: '#/components/schemas/ViasAddress'
email:
description: The e-mail address of the person.
type: string
fullPhoneNumber:
description: 'The phone number of the person provided as a single string. It
will be handled as a landline phone.
Examples: "0031 6 11 22 33 44", "+316/1122-3344", "(0031) 611223344"'
type: string
jobTitle:
description: 'Job title of the signatory.
Example values: **Chief Executive Officer**, **Chief Financial Officer**,
**Chief Operating Officer**, **President**, **Vice President**, **Executive
President**, **Managing Member**, **Partner**, **Treasurer**, **Director**,
or **Other**.'
type: string
name:
description: The name of the person.
$ref: '#/components/schemas/ViasName'
personalData:
description: Contains information about the person.
$ref: '#/components/schemas/ViasPersonalData'
phoneNumber:
description: The phone number of the person.
$ref: '#/components/schemas/ViasPhoneNumber'
signatoryCode:
description: 'The unique identifier (UUID) of the Signatory.
>**If, during an Account Holder create or update request, this field is
left blank (but other fields provided), a new Signatory will be created
with a procedurally-generated UUID.**
>**If, during an Account Holder create request, a UUID is provided, the
creation of the Signatory will fail while the creation of the Account
Holder will continue.**
>**If, during an Account Holder update request, a UUID that is not correlated
with an existing Signatory is provided, the update of the Signatory will
fail.**
>**If, during an Account Holder update request, a UUID that is correlated
with an existing Signatory is provided, the existing Signatory will be
updated.**
'
type: string
signatoryReference:
description: Your reference for the Signatory.
type: string
webAddress:
description: The URL of the person's website.