Skip to main content
POST
/
api
/
partner
/
v2
/
users
cURL
curl --request POST \
  --url https://staging-api.capa.fi/api/partner/v2/users \
  --header 'Content-Type: application/json' \
  --header 'partner-api-key: <partner-api-key>' \
  --data '
{
  "type": "INDIVIDUAL or BUSINESS",
  "email": "[email protected]",
  "externalUserId": "1441d100-8cc3-40ca-9e55-6183d6f11f18",
  "alias": "John Doe"
}
'
{
  "success": true,
  "data": {
    "userId": "9486244c-ff7d-4c22-9984-797179d7deaa"
  }
}

Headers

​
partner-api-key
string
required

Api key for the affiliated partner that is performing the request

Body

application/json
​
type
enum<string>
required

The type of user.

Available options:
INDIVIDUAL,
BUSINESS
Example:

"INDIVIDUAL or BUSINESS"

​
email
string
required

The email of the user.

Example:

"[email protected]"

​
externalUserId
string

The external user id of the user.

Example:

"1441d100-8cc3-40ca-9e55-6183d6f11f18"

​
alias
string

An optional alias or display name for the user.

Example:

"John Doe"

Response

201 - application/json
​
success
boolean
Example:

true

​
data
object