AM signup interface (V1 (1.0.0))

Download OpenAPI specification:Download

Support team: it.operations.support@swissquote.ch URL: https://www.swissquote.com

The AM Signup Interface permits Asset Managers that have requested a Swissquote Technical Account to register new client.
The following document explains in detail how to use this service.

Run mock server

To run mock server you can find instructions here

Authentication

Token authorisation

The service uses OAuth 2.0 mechanism to validate the AM using his authentication token. All requests done to the service must pass this first check

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer

SignupOptions

Resource to find possible field values

Provide list of available business sector codes

Authorizations:

Token authorisation

Responses

500

Internal error

default

List of available business sector codes

get /signup-options/businessSectorCodes

Main server

https://bankingapi.swissquote.ch/sq-am-clients-signup/api/v1/signup-options/businessSectorCodes

Response samples

500
default

Content type

application/json

Copy

Expand all Collapse all


{"description": "string",
"fieldDetails": 
[
{"field": "string",
"reason": "string"
}
]
}

Provide list of available commission fees models

Authorizations:

Token authorisation

Responses

500

Internal error

default

List of available commission fees models

get /signup-options/commissionFeesModels

Main server

https://bankingapi.swissquote.ch/sq-am-clients-signup/api/v1/signup-options/commissionFeesModels

Response samples

500
default

Content type

application/json

Copy

Expand all Collapse all


{"description": "string",
"fieldDetails": 
[
{"field": "string",
"reason": "string"
}
]
}

Provide list of available correspondence countries

Authorizations:

Token authorisation

Responses

500

Internal error

default

List of available correspondence countries

get /signup-options/correspondenceCountries

Main server

https://bankingapi.swissquote.ch/sq-am-clients-signup/api/v1/signup-options/correspondenceCountries

Response samples

500
default

Content type

application/json

Copy

Expand all Collapse all


{"description": "string",
"fieldDetails": 
[
{"field": "string",
"reason": "string"
}
]
}

Provide list of available currencies

Authorizations:

Token authorisation

Responses

500

Internal error

default

List of available currencies

get /signup-options/currencies

Main server

https://bankingapi.swissquote.ch/sq-am-clients-signup/api/v1/signup-options/currencies

Response samples

500
default

Content type

application/json

Copy

Expand all Collapse all


{"description": "string",
"fieldDetails": 
[
{"field": "string",
"reason": "string"
}
]
}

Provide list of available languages

Authorizations:

Token authorisation

Responses

500

Internal error

default

List of available languages

get /signup-options/languages

Main server

https://bankingapi.swissquote.ch/sq-am-clients-signup/api/v1/signup-options/languages

Response samples

500
default

Content type

application/json

Copy

Expand all Collapse all


{"description": "string",
"fieldDetails": 
[
{"field": "string",
"reason": "string"
}
]
}

Provide list of available legal countries

Authorizations:

Token authorisation

Responses

500

Internal error

default

List of available legal countries

get /signup-options/legalCountries

Main server

https://bankingapi.swissquote.ch/sq-am-clients-signup/api/v1/signup-options/legalCountries

Response samples

500
default

Content type

application/json

Copy

Expand all Collapse all


{"description": "string",
"fieldDetails": 
[
{"field": "string",
"reason": "string"
}
]
}

Provide list of available nationalities

Authorizations:

Token authorisation

Responses

500

Internal error

default

List of available nationalities

get /signup-options/nationalities

Main server

https://bankingapi.swissquote.ch/sq-am-clients-signup/api/v1/signup-options/nationalities

Response samples

500
default

Content type

application/json

Copy

Expand all Collapse all


{"description": "string",
"fieldDetails": 
[
{"field": "string",
"reason": "string"
}
]
}

Provide list of available templates' names

Authorizations:

Token authorisation

Responses

500

Internal error

default

List of available templates' names

get /signup-options/templates

Main server

https://bankingapi.swissquote.ch/sq-am-clients-signup/api/v1/signup-options/templates

Response samples

500
default

Content type

application/json

Copy

Expand all Collapse all


{"description": "string",
"fieldDetails": 
[
{"field": "string",
"reason": "string"
}
]
}

Signups

Resource to register new client and provide registration status

Register new corporate client

Creates new corporate client signup request

Authorizations:

Token authorisation

path Parameters

uuid

required

string <uuid> (Signup identifier)

Example: ec254f58-571a-4a47-af6c-954902834575

The generated UUID

Link to specification

Request Body schema: application/json

Corporate signup request payload

settings required	object (Account's settings) Account settings
companyInfo required	object (Company's information) Company information
companyProfile required	object (Company's profile) Company profile
financialInfo required	object (Company's financial information) Financial information
passwordChannel	string (Password channel) Enum: "POST" "EMAIL" "SMS" The way how client should receive password
secondFactorChannel	string (Second factor channel) Enum: "POST" "ACTIVATE_ON_CONNECTION" The way how client should receive second factor

Responses

400

Signup request contains invalid entries

409

Signup request with such uuid exists

500

Internal error

default

Signup information

post /signups/corporate/{uuid}

Main server

https://bankingapi.swissquote.ch/sq-am-clients-signup/api/v1/signups/corporate/{uuid}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"settings": 
{"clientType": "UNDER_MANAGEMENT",
"fxAutoCompensation": true,
"autoSaleExpiringWarrants": true,
"template": "string",
"commissionFeesModel": "string",
"referenceCurrency": "CHF",
"language": "FR",
"notifications": 
["EMAIL"
],
"userRights": 
[
{"operatorId": "1234",
"operatorLogin": "asdf1234",
"rightType": "READ"
}
],
"company": "16125"
},
"companyInfo": 
{"companyDetails": 
{"companyName": "Company Ltd",
"companySite": "company_name.com",
"dateOfInc": "1985-05-30",
"incorporationCity": "Berlin",
"incorporationCountryCode": "DE",
"legalForm": "ASSOCIATION",
"businessNature": "Some business nature",
"employeesNumber": 23,
"nogaCode": "FOOD",
"businessSector": "ENERGY_EQUIPMENT_AND_SERVICES",
"geographicAreaCodes": 
["SWITZERLAND"
]
},
"businessAddress": 
{"country": "CH",
"city": "string",
"streetAddresses": 
["string"
],
"postCode": "string"
},
"correspondenceAddresses": 
[
{"country": "CH",
"city": "string",
"streetAddresses": 
["string"
],
"postCode": "string"
}
],
"contactPersonDetails": 
{"firstName": "John",
"familyName": "Smith",
"mobilePhoneNumber": 
{"prefix": "+41",
"number": "335557799"
},
"phoneNumbers": 
[
{"prefix": "+41",
"number": "335557799"
}
],
"emails": "john.smith@company.com"
},
"heardAboutSQ": "FRIEND",
"promoCode": "string",
"introducedBySmb": "string",
"sponsorshipNumber": "string"
},
"companyProfile": 
{"shareholders": 
[
{"firstName": "John",
"familyName": "Smith",
"dateOfBirth": "1985-05-30",
"nationalityCode": "DE",
"email": "john.smith@company.com",
"shareholdingPercentage": "15",
"occupation": "Manager"
}
],
"signatories": 
[
{"firstName": "John",
"familyName": "Smith",
"dateOfBirth": "1985-05-30",
"nationalityCode": "DE",
"position": "Director"
}
],
"classificationPursuantCode": "REPORTING_FINANCIAL_INSTITUTION",
"taxResidences": 
[
{"country": "CH",
"taxId": "111-555-999",
"taxIdNature": "TAXPAYER_IDENTIFICATION_NUMBER",
"otherTaxIdNature": "AHV"
}
],
"publicFunction": "Policeman",
"usPerson": true
},
"financialInfo": 
{"plannedInvestment": 15000,
"wealthDetails": 
{"originOfMoneys": 
{"originOfMoney": 
["INCOME"
],
"otherMoneyOrigin": "string"
},
"annualRevenues": 1,
"annualProfits": 1
},
"relationBank": "string",
"beneficialOwner": 
{"personDetails": 
{"title": "MR",
"firstName": "John",
"familyName": "Smith",
"maritalStatus": "SINGLE",
"birthday": "1985-05-30",
"nationalities": "[DE, FR]"
},
"address": 
{"country": "CH",
"city": "string",
"streetAddresses": 
["string"
],
"postCode": "string"
}
},
"managementPosition": 
{"businessSector": "Art",
"companyName": "Some company",
"position": "Director"
},
"accountUsages": 
{"usages": 
["RECEIPT_OF_COMMISSION"
],
"otherUsage": "string"
},
"referenceAccounts": 
[
{"financialInstitutionType": "SWIFT_BIC",
"financialInstitutionCode": "string",
"accountNumber": "string",
"bankName": "string",
"bankAddress": "string"
}
]
},
"passwordChannel": "POST",
"secondFactorChannel": "POST"
}

Response samples

400
409
500
default

Content type

application/json

Copy

Expand all Collapse all


{"description": "string",
"fieldDetails": 
[
{"field": "string",
"reason": "string"
}
]
}

Register new individual client

Creates new individual client signup request

Authorizations:

Token authorisation

path Parameters

uuid

required

string <uuid> (Signup identifier)

Example: ec254f58-571a-4a47-af6c-954902834575

The generated UUID

Link to specification

Request Body schema: application/json

Individual signup request payload

settings required	object (Account's settings) Account settings
clientInformation required	object (Client's personal information) Client personal information
clientProfile required	object (Client's profile) Client profile
financialInfo required	object (Client's financial information) Financial information
passwordChannel	string (Password channel) Enum: "POST" "EMAIL" "SMS" The way how client should receive password
secondFactorChannel	string (Second factor channel) Enum: "POST" "ACTIVATE_ON_CONNECTION" The way how client should receive second factor

Responses

400

Signup request contains invalid entries

409

Signup request with such uuid exists

500

Internal error

default

Signup information

post /signups/individual/{uuid}

Main server

https://bankingapi.swissquote.ch/sq-am-clients-signup/api/v1/signups/individual/{uuid}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"settings": 
{"clientType": "UNDER_MANAGEMENT",
"fxAutoCompensation": true,
"autoSaleExpiringWarrants": true,
"template": "string",
"commissionFeesModel": "string",
"referenceCurrency": "CHF",
"language": "FR",
"notifications": 
["EMAIL"
],
"userRights": 
[
{"operatorId": "1234",
"operatorLogin": "asdf1234",
"rightType": "READ"
}
]
},
"clientInformation": 
{"personDetails": 
{"title": "MR",
"firstName": "John",
"familyName": "Smith",
"maritalStatus": "SINGLE",
"birthday": "1985-05-30",
"nationalities": "[DE, FR]"
},
"legalAddress": 
{"country": "CH",
"city": "string",
"streetAddresses": 
["string"
],
"postCode": "string"
},
"correspondenceAddresses": 
[
{"country": "CH",
"city": "string",
"streetAddresses": 
["string"
],
"postCode": "string"
}
],
"mobilePhoneNumber": 
{"prefix": "+41",
"number": "335557799"
},
"phoneNumbers": 
[
{"prefix": "+41",
"number": "335557799"
}
],
"emails": "john.smith@company.com"
},
"clientProfile": 
{"mainEmployment": 
{"employed": 
{"companyName": "Company Ltd",
"companyWebSite": "company_name.com",
"businessSector": "string",
"jobTitle": "IT specialist"
},
"student": 
{"educationalInstitution": "string",
"faculty": "string"
},
"selfEmployed": 
{"companyName": "Company Ltd",
"companyWebSite": "company_name.com",
"businessSector": "string",
"jobTitle": "IT specialist",
"participatingInterest": "string"
},
"unemployed": 
{"lastEmployer": "string",
"lastOccupation": "string"
},
"retiredEmployed": 
{"companyName": "Company Ltd",
"companyWebSite": "company_name.com",
"businessSector": "string",
"jobTitle": "IT specialist"
},
"retiredSelfEmployed": 
{"companyName": "Company Ltd",
"companyWebSite": "company_name.com",
"businessSector": "string",
"jobTitle": "IT specialist",
"participatingInterest": "string",
"companyStillActive": true
},
"retiredOtherEmployed": "string",
"otherEmployed": "string"
},
"secondaryEmployment": 
{"employed": 
{"companyName": "Company Ltd",
"companyWebSite": "company_name.com",
"businessSector": "string",
"jobTitle": "IT specialist"
},
"selfEmployed": 
{"companyName": "Company Ltd",
"companyWebSite": "company_name.com",
"businessSector": "string",
"jobTitle": "IT specialist",
"participatingInterest": "string"
},
"otherEmployed": "string"
},
"taxResidences": 
[
{"country": "CH",
"taxId": "111-555-999",
"taxIdNature": "TAXPAYER_IDENTIFICATION_NUMBER",
"otherTaxIdNature": "AHV"
}
],
"executivePosition": "string",
"publicFunction": "string",
"usPerson": true
},
"financialInfo": 
{"plannedInvestment": 1,
"globalAssets": 1,
"wealthDetails": 
{"assetsCashPercent": 10,
"assetsRealEstatePercent": 15,
"assetsIndustrialPercent": 20,
"assetsSecuritiesPercent": 25,
"assetsOtherPercent": 30,
"securitiesSharesPercent": 25,
"securitiesBondsPercent": 25,
"securitiesFundsPercent": 25,
"securitiesOtherPercent": 25
},
"moneySources": 
{"sources": 
["INCOME"
],
"otherSourceDetails": "string",
"mainMoneySource": "string",
"moneySourceDescription": "string"
},
"accountUsages": 
{"usages": 
["RECEIPT_OF_COMMISSION"
],
"otherUsage": "string"
},
"beneficialOwner": 
{"personDetails": 
{"title": "MR",
"firstName": "John",
"familyName": "Smith",
"maritalStatus": "SINGLE",
"birthday": "1985-05-30",
"nationalities": "[DE, FR]"
},
"address": 
{"country": "CH",
"city": "string",
"streetAddresses": 
["string"
],
"postCode": "string"
}
},
"referenceAccounts": 
[
{"financialInstitutionType": "SWIFT_BIC",
"financialInstitutionCode": "string",
"accountNumber": "string",
"bankName": "string",
"bankAddress": "string"
}
]
},
"passwordChannel": "POST",
"secondFactorChannel": "POST"
}

Response samples

400
409
500
default

Content type

application/json

Copy

Expand all Collapse all


{"description": "string",
"fieldDetails": 
[
{"field": "string",
"reason": "string"
}
]
}

Provide information about signup request

Find signup request information by id

Authorizations:

Token authorisation

path Parameters

uuid

required

string <uuid> (Signup identifier)

Example: ec254f58-571a-4a47-af6c-954902834575

The generated UUID

Link to specification

Responses

404

Signup not exists

500

Internal error

default

Signup information

get /signups/{uuid}

Main server

https://bankingapi.swissquote.ch/sq-am-clients-signup/api/v1/signups/{uuid}

Response samples

404
500
default

Content type

application/json

Copy

Expand all Collapse all


{"description": "string",
"fieldDetails": 
[
{"field": "string",
"reason": "string"
}
]
}

Find all signup request information

Find signups requests information by specified criteria

Authorizations:

Token authorisation

query Parameters

status	Array of strings Items Enum: "ACKNOWLEDGED" "REQUEST_FAILED" "AWAITING_DOCUMENTS" "OPENING_IN_PROGRESS" "ACCOUNT_OPEN" Statuses to search signups information
page	integer <int32> >= 1 Default: 1 Page number
maxCount	integer <int32> <= 10000 Default: 1000 Max count of signups to return

Responses

500

Internal error

default

Found signups

get /signups

Main server

https://bankingapi.swissquote.ch/sq-am-clients-signup/api/v1/signups

Response samples

500
default

Content type

application/json

Copy

Expand all Collapse all


{"description": "string",
"fieldDetails": 
[
{"field": "string",
"reason": "string"
}
]
}