Swissquote
API docs by Redocly

AM signup interface (V1 (1.1.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

Contracts

Resource to manage contracts for a signup request

Download a contract document

Downloads a personalized contract document pre-filled with client data. Use the contract name returned by the getContracts endpoint.

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

UUID of the signup request

Link to specification
contractName
required
string

Contract name as returned by the getContracts endpoint

Responses

Upload a digitally signed contract document

Uploads a contract document. The uploaded file must be a digitally signed PDF.

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

UUID of the signup request

Link to specification
contractName
required
string

Contract name as returned by the getContracts endpoint

Request Body schema: multipart/form-data
file
required
object <binary>

File payload

fileName
required
string

Original file name

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": "IDENTIFICATION_SOURCE_NOT_SUPPORTED",
  • "fieldDetails": [
    ]
}

Exposes available client contracts and agreements for signing

Returns contracts for the signup request with their status: UNDER_PREPARATION or READY. Poll until all contracts are READY before downloading.

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

UUID of the signup request

Link to specification

Responses

Response samples

Content type
application/json
{
  • "uuid": "ec254f58-571a-4a47-af6c-954902834575",
  • "contracts": [
    ]
}

Documents

Resource to upload supporting documents for a signup request

Upload a document

Uploads a supporting document for an existing signup request

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

UUID of the signup request

Link to specification
Request Body schema: multipart/form-data
file
required
object <binary>

File payload

fileName
required
string

Original file name

category
required
string (Document category)
Enum: "SELFIE_PORTRAIT" "ID_CARD_FRONT" "ID_CARD_BACK" "PASSPORT" "PASSPORT_SIGNATURE" "RESIDENCE_PERMIT_FRONT" "RESIDENCE_PERMIT_BACK" "PROOF_OF_IDENTIFICATION" "ADDITIONAL"

Category of the uploaded document. Must be provided in uppercase. Each category has specific allowed file extensions and a maximum file size of 8 MB.

Category Description Allowed extensions
SELFIE_PORTRAIT Client portrait / selfie image jpg, jpeg, png
ID_CARD_FRONT Front side of ID card jpg, jpeg, png
ID_CARD_BACK Back side of ID card jpg, jpeg, png
PASSPORT Passport image jpg, jpeg, png
PASSPORT_SIGNATURE Passport signature page jpg, jpeg, png
RESIDENCE_PERMIT_FRONT Front side of residence permit jpg, jpeg, png
RESIDENCE_PERMIT_BACK Back side of residence permit jpg, jpeg, png
PROOF_OF_IDENTIFICATION Proof of identity verification pdf
ADDITIONAL Additional supporting documents jpg, jpeg, png, pdf

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": "IDENTIFICATION_SOURCE_NOT_SUPPORTED",
  • "fieldDetails": [
    ]
}

SubmitOnboardingApplication

Resource to submit client onboarding application and provide its status

Provide information about onboarding application

Find onboarding application information by id

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

The generated UUID

Link to specification
submitOnboardingApplicationOperationUuid
required
string <uuid> (Submit onboarding application operation identifier)
Example: ec254f58-571a-4a47-af6c-954902834575

The generated UUID

Link to specification

Responses

Response samples

Content type
application/json
{
  • "uuid": "ec254f58-571a-4a47-af6c-954902834575",
  • "status": "ACKNOWLEDGED",
  • "errors": [
    ]
}

Submit client onboarding application

Submits client onboarding application for provided signup request uuid

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

The generated UUID

Link to specification
submitOnboardingApplicationOperationUuid
required
string <uuid> (Submit onboarding application operation identifier)
Example: ec254f58-571a-4a47-af6c-954902834575

The generated UUID

Link to specification

Responses

Response samples

Content type
application/json
{
  • "uuid": "ec254f58-571a-4a47-af6c-954902834575",
  • "status": "ACKNOWLEDGED",
  • "errors": [
    ]
}

SignupOptions

Resource to find possible field values

Provide list of available business sector codes

Authorizations:
Token authorisation

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": "IDENTIFICATION_SOURCE_NOT_SUPPORTED",
  • "fieldDetails": [
    ]
}

Provide list of available commission fees models

Authorizations:
Token authorisation

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": "IDENTIFICATION_SOURCE_NOT_SUPPORTED",
  • "fieldDetails": [
    ]
}

Provide list of available correspondence countries

Authorizations:
Token authorisation

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": "IDENTIFICATION_SOURCE_NOT_SUPPORTED",
  • "fieldDetails": [
    ]
}

Provide list of available currencies

Authorizations:
Token authorisation

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": "IDENTIFICATION_SOURCE_NOT_SUPPORTED",
  • "fieldDetails": [
    ]
}

Provide list of available languages

Authorizations:
Token authorisation

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": "IDENTIFICATION_SOURCE_NOT_SUPPORTED",
  • "fieldDetails": [
    ]
}

Provide list of available legal countries

Authorizations:
Token authorisation

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": "IDENTIFICATION_SOURCE_NOT_SUPPORTED",
  • "fieldDetails": [
    ]
}

Provide list of available nationalities

Authorizations:
Token authorisation

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": "IDENTIFICATION_SOURCE_NOT_SUPPORTED",
  • "fieldDetails": [
    ]
}

Provide list of available templates' names

Authorizations:
Token authorisation

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": "IDENTIFICATION_SOURCE_NOT_SUPPORTED",
  • "fieldDetails": [
    ]
}

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

required
object (Account's settings)

Account settings

required
object (Company's information)

Company information

required
object (Company's profile)

Company profile

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

Request samples

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

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": "IDENTIFICATION_SOURCE_NOT_SUPPORTED",
  • "fieldDetails": [
    ]
}

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

required
object (Account's settings)

Account settings

required
object (Client's personal information)

Client personal information

required
object (Client's profile)

Client profile

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

object (KPMG Tax Statement request)

Specify to order KPMG Tax Statement. Applicable only for German tax residents

object (Client's identification settings)

Configuration of client identification flow

Responses

Request samples

Content type
application/json
{
  • "settings": {
    },
  • "clientInformation": {
    },
  • "clientProfile": {
    },
  • "financialInfo": {
    },
  • "passwordChannel": "POST",
  • "secondFactorChannel": "POST",
  • "kpmgTaxStatementRequest": {
    },
  • "identificationSettings": {
    }
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": "IDENTIFICATION_SOURCE_NOT_SUPPORTED",
  • "fieldDetails": [
    ]
}

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

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": "IDENTIFICATION_SOURCE_NOT_SUPPORTED",
  • "fieldDetails": [
    ]
}

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

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": "IDENTIFICATION_SOURCE_NOT_SUPPORTED",
  • "fieldDetails": [
    ]
}