AM signup interface (V1 (1.0.0))

Download OpenAPI specification:Download

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:

Responses

500

Internal error

default

List of available business sector codes

get /signup-options/businessSectorCodes

Main server

https://bankapi.swissuoqte.ch/am-signup-interface/api/v1/signup-options/businessSectorCodes

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "description": "string",
  • "fieldDetails":
    [
    ]
}

Provide list of available commission fees models

Authorizations:

Responses

500

Internal error

default

List of available commission fees models

get /signup-options/commissionFeesModels

Main server

https://bankapi.swissuoqte.ch/am-signup-interface/api/v1/signup-options/commissionFeesModels

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "description": "string",
  • "fieldDetails":
    [
    ]
}

Provide list of available correspondence countries

Authorizations:

Responses

500

Internal error

default

List of available correspondence countries

get /signup-options/correspondenceCountries

Main server

https://bankapi.swissuoqte.ch/am-signup-interface/api/v1/signup-options/correspondenceCountries

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "description": "string",
  • "fieldDetails":
    [
    ]
}

Provide list of available currencies

Authorizations:

Responses

500

Internal error

default

List of available currencies

get /signup-options/currencies

Main server

https://bankapi.swissuoqte.ch/am-signup-interface/api/v1/signup-options/currencies

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "description": "string",
  • "fieldDetails":
    [
    ]
}

Provide list of available languages

Authorizations:

Responses

500

Internal error

default

List of available languages

get /signup-options/languages

Main server

https://bankapi.swissuoqte.ch/am-signup-interface/api/v1/signup-options/languages

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "description": "string",
  • "fieldDetails":
    [
    ]
}

Provide list of available legal countries

Authorizations:

Responses

500

Internal error

default

List of available legal countries

get /signup-options/legalCountries

Main server

https://bankapi.swissuoqte.ch/am-signup-interface/api/v1/signup-options/legalCountries

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "description": "string",
  • "fieldDetails":
    [
    ]
}

Provide list of available nationalities

Authorizations:

Responses

500

Internal error

default

List of available nationalities

get /signup-options/nationalities

Main server

https://bankapi.swissuoqte.ch/am-signup-interface/api/v1/signup-options/nationalities

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "description": "string",
  • "fieldDetails":
    [
    ]
}

Provide list of available templates' names

Authorizations:

Responses

500

Internal error

default

List of available templates' names

get /signup-options/templates

Main server

https://bankapi.swissuoqte.ch/am-signup-interface/api/v1/signup-options/templates

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "description": "string",
  • "fieldDetails":
    [
    ]
}

Signups

Resource to register new client and provide registration status

Register new corporate client

Creates new corporate client signup request

Authorizations:
path Parameters
uuid
required
string <uuid> (Signup identifier)
Example: ec254f58-571a-4a47-af6c-954902834575

The generated UUID

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://bankapi.swissuoqte.ch/am-signup-interface/api/v1/signups/corporate/{uuid}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "settings":
    {
    },
  • "companyInfo":
    {
    },
  • "companyProfile":
    {
    },
  • "financialInfo":
    {
    },
  • "passwordChannel": "POST",
  • "secondFactorChannel": "POST"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "description": "string",
  • "fieldDetails":
    [
    ]
}

Register new individual client

Creates new individual client signup request

Authorizations:
path Parameters
uuid
required
string <uuid> (Signup identifier)
Example: ec254f58-571a-4a47-af6c-954902834575

The generated UUID

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://bankapi.swissuoqte.ch/am-signup-interface/api/v1/signups/individual/{uuid}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "settings":
    {
    },
  • "clientInformation":
    {
    },
  • "clientProfile":
    {