---
title: "Register User"
method: POST
path: "/user/register"
tags: ["User"]
---

# Register User

`POST /user/register`

The register user service is used to register a user in Yodlee.<br>The loginName cannot include spaces and must be between 3 and 150 characters.<br>locale passed must be one of the supported locales for the customer. <br>Currency provided in the input will be respected in the derived services and the amount fields in the response will be provided in the preferred currency.<br>userParam is accepted as a body parameter. <br><br><b>Note:</b> <li>The content type has to be passed as application/json for the body parameter.</li>

## Request body

- UserRequest
  - `user` UserRegistration, required
    - `preferences` UserRequestPreferences
      - `dateFormat` string — The dateformat of the user.This attribute is just a place holder and has no impact on any other API services.
      - `timeZone` string — The timezone of the user. This attribute is just a place holder and has no impact on any other API services.
      - `currency` 'AUD' | 'BRL' | 'CAD' | 'EUR' | 'GBP' | 'HKD' | 'IDR' | 'INR' | 'JPY' | 'NZD' | 'SGD' | 'USD' | 'ZAR' | 'CNY' | 'VND' | 'MYR' | 'CHF' — The currency of the user. This currency will be respected while providing the response for derived API services.<br><b>Applicable Values</b><br>
      - `locale` 'en_US' | 'en_ES' | 'fr_CA' | 'zh_CN' — The locale of the user. This locale will be considered for localization features like providing the provider information in the supported locale or providing category names in the transaction related services.<br><b>Applicable Values</b><br>
    - `address` UserAddress
      - `zip` string
      - `country` string
      - `address3` string
      - `address2` string
      - `city` string
      - `address1` string
      - `state` string
    - `loginName` string, required
    - `name` Name
      - `middle` string
      - `last` string
      - `fullName` string
      - `first` string
    - `email` string
    - `segmentName` string

## Response `200`

Login Successful

## Other responses

- `400` — Y800 : Invalid value for loginName<br>Y800 : Invalid value for email<br>Y801 : Invalid length for loginName<br>
- `401` — Unauthorized
- `404` — Not Found

---

[API](https://skmtc.net/yodlee/apis/yodlee-core-apis.md) · [All operations](https://skmtc.net/yodlee/apis/yodlee-core-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/yodlee/yodlee-core-apis/versions/3bc0042deba8/schema)