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 Linking

POST

https://proxy-stage.peax.ch/onboarding/agent-api/v1/integrator-applications/{sourceId}/client-account-links

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

sourceId

string

required

Header Params

Authorization

string

optional

Default:

Bearer {{JWT}}

Body Params application/json

applicationClientReferenceId

string

required

accountId

string

required

startDate

string

required

Example

{
  "applicationClientReferenceId": "an-xyz-client-id",
  "accountId": "678.6323.9110.59",
  "startDate": "2023-11-12"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://proxy-stage.peax.ch/onboarding/agent-api/v1/integrator-applications//client-account-links' \
--header 'Authorization: Bearer {{JWT}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "applicationClientReferenceId": "an-xyz-client-id",
  "accountId": "678.6323.9110.59",
  "startDate": "2023-11-12"
}'

Responses

🟢200Success

application/json

Body

object {0}

Example

{}

Modified at 2025-06-03 11:24:52

Changelog

Retrieve document metadata information