We're delighted to present you with the comprehensive API documentation for PEAX. This all-in-one workspace for API design offers you a clear, concise, and interactive exploration of our API functionalities.

Create a business account.

Developing

POST

https://proxy-stage.peax.ch/business-accounts/sources/{sourceId}/client-references/{clientReferenceId}

Creates a business account and its members.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

sourceId

string

required

clientReferenceId

string

required

Header Params

Authorization

string

optional

Default:

Bearer {{JWT}}

Body Params application/json

businessAccount

object (BusinessAccount)

required

string <email>

required

Example:

info@company.com

name

string

required

Example:

ACME Corporation

type

enum<string>

optional

Allowed values:

COMPANY_IN_COMMERCIAL_REGISTERCOMPANY_NOT_IN_COMMERCIAL_REGISTERNOT_APPLICABLE

Example:

COMPANY_IN_COMMERCIAL_REGISTER

uid

string

optional

Example:

CHE-123.456.789

domicileAddress

object (Address)

optional

forwardingAddress

object (Address)

optional

subscription

string

optional

Example:

plus

members

array[object (Member) {6}]

required

string <email>

required

Example:

john.doe@example.com

firstName

string

required

Example:

John

lastName

string

required

Example:

Doe

verified

boolean

optional

Example:

true

signatoryAuthorization

boolean

optional

Example:

true

domicileAddress

object (Address)

optional

Example

{
    "businessAccount": {
        "email": "info@company.com",
        "name": "ACME Corporation",
        "type": "COMPANY_IN_COMMERCIAL_REGISTER",
        "uid": "CHE-123.456.789",
        "domicileAddress": {
            "name": "string",
            "addressSupplement": "example suplement",
            "street": "Main Street",
            "streetNumber": "123",
            "poBox": "12345",
            "postalCode": "1234",
            "city": "Zurich",
            "country": "Switzerland"
        },
        "forwardingAddress": {
            "name": "string",
            "addressSupplement": "example suplement",
            "street": "Main Street",
            "streetNumber": "123",
            "poBox": "12345",
            "postalCode": "1234",
            "city": "Zurich",
            "country": "Switzerland"
        },
        "subscription": "plus"
    },
    "members": [
        {
            "email": "john.doe@example.com",
            "firstName": "John",
            "lastName": "Doe",
            "verified": true,
            "signatoryAuthorization": true,
            "domicileAddress": {
                "name": "string",
                "addressSupplement": "example suplement",
                "street": "Main Street",
                "streetNumber": "123",
                "poBox": "12345",
                "postalCode": "1234",
                "city": "Zurich",
                "country": "Switzerland"
            }
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://proxy-stage.peax.ch/business-accounts/sources//client-references/' \
--header 'Authorization: Bearer {{JWT}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "businessAccount": {
        "email": "info@company.com",
        "name": "ACME Corporation",
        "type": "COMPANY_IN_COMMERCIAL_REGISTER",
        "uid": "CHE-123.456.789",
        "domicileAddress": {
            "name": "string",
            "addressSupplement": "example suplement",
            "street": "Main Street",
            "streetNumber": "123",
            "poBox": "12345",
            "postalCode": "1234",
            "city": "Zurich",
            "country": "Switzerland"
        },
        "forwardingAddress": {
            "name": "string",
            "addressSupplement": "example suplement",
            "street": "Main Street",
            "streetNumber": "123",
            "poBox": "12345",
            "postalCode": "1234",
            "city": "Zurich",
            "country": "Switzerland"
        },
        "subscription": "plus"
    },
    "members": [
        {
            "email": "john.doe@example.com",
            "firstName": "John",
            "lastName": "Doe",
            "verified": true,
            "signatoryAuthorization": true,
            "domicileAddress": {
                "name": "string",
                "addressSupplement": "example suplement",
                "street": "Main Street",
                "streetNumber": "123",
                "poBox": "12345",
                "postalCode": "1234",
                "city": "Zurich",
                "country": "Switzerland"
            }
        }
    ]
}'

Responses

🟢200Business account creation was successful.

application/json

Body

status

enum<string>

required

Allowed values:

SUCCESSPENDINGFAILED

peaxId

string

required

members

array [object {2}]

required

peaxId

string

required

link

string

required

Example

{
    "status": "SUCCESS",
    "peaxId": "string",
    "members": [
        {
            "peaxId": "string",
            "link": "string"
        }
    ]
}

🟠400Bad request due to missing mandatory fields or validation errors.

🟠401Unauthorized

🟠403Permission denied

🔴500An internal server error occurred.

Modified at 2024-06-13 13:32:22

Changelog