Create a new user

POST /apps/{appId}/users
Bearer auth

Onboard a new user to the banking platform using your unique App ID

Path parameters

  • appId integer Required

    App ID

application/json

Body Required

  • email string(email) Required

    User email address

  • sumsubToken string

    Optional Sumsub token for reusable KYC

  • userType string Required

    User type

    Values are personal or business.

Responses

  • 201 application/json

    User created successfully

    Hide response attributes Show response attributes object
    • email string Required

      User email address

    • id integer Required

      User ID - use this for subsequent API calls
  • 400 application/json

    Invalid request

    Hide response attributes Show response attributes object
    • errorCode string Required

      Error code

    • message string Required

      Error message
  • 401 application/json

    Unauthorized

    Hide response attributes Show response attributes object
    • errorCode string Required

      Error code

    • message string Required

      Error message
POST /apps/{appId}/users 
curl \
 --request POST 'https://auth.bank.place/apps/{appId}/users' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"email":"user@example.com","userType":"personal","sumsubToken":"12345"}'
Request example 
{
  "email": "user@example.com",
  "userType": "personal",
  "sumsubToken": "12345"
}
Response examples (201) 
{
  "id": 123,
  "email": "user@example.com"
}
Response examples (400) 
{
  "message": "Invalid request parameters",
  "errorCode": "invalid_request"
}
Response examples (401) 
{
  "message": "Invalid request parameters",
  "errorCode": "invalid_request"
}