---
title: "Create an account for a partner"
method: POST
path: "/api/v1/partners/accounts/onboard"
tags: ["Partner"]
---

# Create an account for a partner

`POST /api/v1/partners/accounts/onboard`

partner_api

## Request body

- AccountOnboardDto
  - `email` string, required — User email. Should be unique
  - `name` string, required — Business name
  - `website` string — Business website
  - `phone` string — Business phone number
  - `brandColor` string — Brand color in hex format
  - `addressDetails` AddressDetailDto
    - `line1` string
    - `line2` string
    - `city` string
    - `state` string
    - `postalCode` string
    - `country` string
  - `paymentSetting` UpdatePaymentSettingDto
    - `preferredChainId` number — The preferred chain's id
    - `preferredCurrency` 'usdc' | 'usdt' | 'pyusd' | 'eurc' | 'brett' | 'dai' | 'btc' | 'eth' | 'matic' | 'bnb' | 'sol' | 'busd' | 'trx' | 'food' | 'bonk' | 'wif' | 'goat' | 'spx' | 'truf' | 'pengu'
    - `allowSwap` boolean — Whether the user can swap the payment currency
    - `applyFee` boolean — Whether add a application fee to the user payment
    - `applyGasFee` boolean — Whether add a transaction fee to the user payment
    - `allowSplitPayments` boolean — Whether the user can split the payment
    - `slippagePercentage` number — The slippage percentage allowed for swaps and withdrawals
  - `withdrawalAddresses` CreateWithdrawalAddressDto[] — Organization withdrawal addresses
    - `name` string, required — Withdrawal address name
    - `address` string, required — Withdrawal address
    - `chainId` number, required — Withdrawal address chain id
  - `webhookEndpoints` CreateWebhookEndpointDto[] — Organization webhook endpoints
    - `description` string, required
    - `url` string, required
    - `enabledEvents` WebhookEventsDto, required
      - `events` WebhookEvents[], required

## Response `200`

- AccountOnboardResponseDto
  - `organization` OrganizationDto, required
    - `id` string, required
    - `createdAt` string, date-time
    - `updatedAt` string, date-time
    - `name` string, required — Organization's name
    - `type` string, required — Organization's type
    - `status` 'pending' | 'active' | 'suspended', required
    - `kind` 'individual' | 'business', required
    - `ownerId` string, required — User's id who owns organization
    - `noOfEmployees` string, required — No of employees
    - `monthlyPaymentVolume` string, required — Monthly payment volume
    - `addresses` WithdrawalAddressMinimalDto[], required — Withdrawal addresses
      - `id` string, required — Withdrawal address id
      - `name` string, required — Withdrawal address name
      - `address` string, required — Withdrawal address
      - `chainId` number, required — Withdrawal address chain id
      - `isDefault` boolean, required — Is default withdrawal address
    - `email` string — Organization's email
    - `supportEmail` string — Organization's support email
    - `phone` string — Organization's support phone number
    - `addressDetails` AddressDetailDto
      - `line1` string
      - `line2` string
      - `city` string
      - `state` string
      - `postalCode` string
      - `country` string
    - `brandLogo` string, required — Brand logo url
    - `brandColor` string, required — Brand color in hex format
    - `supportUrl` string — Organization's support url
    - `termsUrl` string — Organization's terms and conditions url
    - `privacyUrl` string — Organization's privacy policy url
    - `websiteUrl` string — Organization's website url
    - `featureAccessRequests` string[], required — Feature access requests from organization
    - `companyIdentificationNumber` string
    - `taxIdentificationNumber` string
    - `referralCode` string — Referral code
    - `referrerId` string
  - `user` UserDto, required
    - `id` string, required
    - `firstName` string, required
    - `lastName` string, required
    - `email` string
    - `role` string, required
    - `profilePicture` string
    - `phone` string
    - `position` string
    - `status` 'pending' | 'active' | 'suspended', required
    - `createdAt` string, date-time
    - `updatedAt` string, date-time
    - `flags` UserFlagsDto
      - `introModal` boolean
  - `paymentSetting` PaymentSettingDto, required
    - `id` string, required
    - `createdAt` string, date-time
    - `updatedAt` string, date-time
    - `paymentMethodTypes` PaymentMethodType[] — A list of the types of payment methods
    - `allowedChains` PaymentSettingChainDto[] — The list of chains allowed for the payment. If not provided, all chains supported by the organization are enabled.
      - `chainId` number, required
      - `blacklistCurrencies` CryptoCurrency[] — The list of currencies to disable for the payment. Note: This field is only used for checkout session API atm.
      - `withdrawalAddress` string — This is optional, default withdrawal address configured in dashboard under settings > payment methods is used. The custom withdrawal address to use for this chain instead of stored default withdrawal address.
      - `withdrawalAddresses` CheckoutSessionSplitWithdrawalAddressDto[] — The list of withdrawal addresses to split the payment. If provided, the sum of all split percentages should be 100.
        - `splitPercentage` number, required
        - `address` string, required — The withdrawal address for the split percentage
    - `allowedCurrencies` CryptoCurrency[] — The list of currencies allowed for the payment.
    - `preferredChainId` number — The preferred chain's id
    - `preferredCurrency` 'usdc' | 'usdt' | 'pyusd' | 'eurc' | 'brett' | 'dai' | 'btc' | 'eth' | 'matic' | 'bnb' | 'sol' | 'busd' | 'trx' | 'food' | 'bonk' | 'wif' | 'goat' | 'spx' | 'truf' | 'pengu'
    - `allowSwap` boolean — Whether the user can swap the payment currency
    - `applyFee` boolean — Whether add a application fee to the user payment
    - `feePercentage` number, required — Percent that will be added to subtotal as a fee
    - `applyGasFee` boolean — Whether add a transaction fee to the user payment
    - `allowSplitPayments` boolean — Whether the user can split the payment
    - `slippagePercentage` number — The slippage percentage allowed for swaps and withdrawals
  - `webhookEndpoints` AddressDetailDto[], required — Organization webhook endpoints
    - `line1` string
    - `line2` string
    - `city` string
    - `state` string
    - `postalCode` string
    - `country` string
  - `withdrawalAddresses` WithdrawalAddressDto[], required — Organization withdrawal addresses
    - `id` string, required — Withdrawal address id
    - `name` string, required — Withdrawal address name
    - `address` string, required — Withdrawal address
    - `chainId` number, required — Withdrawal address chain id
    - `isDefault` boolean, required — Is default withdrawal address
    - `createdAt` string, date-time, required — Withdrawal address creation date
    - `updatedAt` string, date-time, required — Withdrawal address update date
  - `personalAccessToken` PersonalAccessTokenWithPlainTokenDto, required
    - `id` string, required
    - `name` string, required
    - `tokenIdentifier` string, required
    - `organizationId` string, required
    - `userId` string, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `token` string, required

## Other responses

- `500`

---

[API](https://skmtc.net/copperx/apis/copperx-api-2.md) · [All operations](https://skmtc.net/copperx/apis/copperx-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/copperx/copperx-api-2/revisions/c0bfbc37fb98/schema)