# Creates a new onboarding.

**POST /2026-2/onboardings**

Creates a new onboarding process for a specific user.


## Servers
- PACE Payment Service: https://api.pace.cloud/payment (PACE Payment Service)


## Authentication methods
- Oauth2
- Oauth2


## Parameters



### Body: application/json (object)

- **cancelRedirectUrl** (string(uri))
  The URL to which the user will be redirected after a cancelled onboarding.
- **failureRedirectUrl** (string(uri))
  The URL to which the user will be redirected after a failed onboarding.
- **kind** (string)
  The kind of the payment method to be created.
- **metadata** (object)
  An optional metadata object that is passed to the underlying payment integration. The requirements may vary for each provider.
- **proxy** (boolean)
  Determines if the payment method will be created as proxy payment method.
- **successRedirectUrl** (string(uri))
  The URL to which the user will be redirected after a successful onboarding.
- **userId** (string(uuid))
  The unique identifier of the user associated with the onboarding. Required if not requesting with the :authenticated scope.


## Responses
### 201
The onboarding was successfully created.

#### Body: application/json (object)
- **data** (object)
  The onboarding that was created.

### 401
Client authentication failed.

### 403
Missing one or more required scopes.

### 500
An internal server error occurred.


[Powered by Bump.sh](https://bump.sh)