Partner

Create an account for a partner

partner_api

post/api/v1/partners/accounts/onboard

Request

Base URL
https://api.copperx.dev
Auth
HTTP bearer
TypeScript
https://skmtc.dev/copperx/apis/copperx-api-2/docs/api/v1/partners/accounts/onboard/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

emailstring required

User email. Should be unique

namestring required

Business name

websitestring

Business website

phonestring

Business phone number

brandColorstring

Brand color in hex format

Example request

{
  "paymentSetting": {
    "preferredChainId": 1,
    "slippagePercentage": 1
  },
  "withdrawalAddresses": [
    {
      "chainId": 1
    }
  ]
}

Response

Example response

{
  "organization": {
    "addresses": [
      {
        "chainId": 1
      }
    ]
  },
  "paymentSetting": {
    "allowedChains": [
      {
        "chainId": 137
      }
    ],
    "allowedCurrencies": [
      "usdc",
      "usdt"
    ],
    "preferredChainId": 1,
    "feePercentage": 1,
    "slippagePercentage": 1
  },
  "withdrawalAddresses": [
    {
      "chainId": 1
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.