Users

Create user

Creates a new user. This API is developed to enable clients to create a user for accessing and managing resources for that client. The payload has a property partyId. This partyId is used to add an existing party as a user. Phone field is optional when partyId is provided. When partyId is not provided, then phone field should be populated. When providing a role, if the role is a DEBIT_CARD_HOLDER then the resourceType and resourceId and action should be provided.

post/users

Request

  • Base URL: https://apigateway.jpmorgan.com/tsapi/ef/v1
  • URL: https://apigateway.jpmorgan.com/tsapi/ef/v1/users
  • Auth: none declared

Headers

tokenstring

JWT Client token

Request body

usernamestring

Username of the user. If not provided during user creation, system will use emailAddress as username. If provided, then it

  • Can be 5 to 30 characters long.
  • Can allow special characters underscore or dot or @
  • Can neither start nor end with any special characters
  • Cannot contain consecutive special characters
emailAddressstring

Email of the user

firstNamestring

First name of the individual in case of party type being an individual like Owners, Controllers and Decision Makers.

middleNamestring

Middle name of the individual in case of party type being an individual.

lastNamestring

Last name of the individual in case of party type being an individual like Owners, Controllers and Decision Makers.

Example request

{
  "username": "me@chase21",
  "emailAddress": "me@jpmchase.com",
  "phone": {
    "countryCode": "+1",
    "phoneNumber": "7785462944"
  },
  "firstName": "Lenna",
  "middleName": "More",
  "lastName": "Paprocki",
  "address": {
    "addressType": "Principal place of business",
    "addressLine1": "689 Main St",
    "addressLine2": "Opposite St. Andrews Church",
    "addressLine3": "Mini York",
    "city": "Anchorage",
    "state": "AZ",
    "postalCode": "99501",
    "countryCode": "US"
  }
}

Response

Created.

usernamestring

Username of the user. If not provided during user creation, system will use emailAddress as username. If provided, then it

  • Can be 5 to 30 characters long.
  • Can allow special characters underscore or dot or @
  • Can neither start nor end with any special characters
  • Cannot contain consecutive special characters
emailAddressstring

Email of the user

firstNamestring

First name of the individual in case of party type being an individual like Owners, Controllers and Decision Makers.

middleNamestring

Middle name of the individual in case of party type being an individual.

lastNamestring

Last name of the individual in case of party type being an individual like Owners, Controllers and Decision Makers.

Example response

{
  "username": "me@chase21",
  "emailAddress": "me@jpmchase.com",
  "phone": {
    "countryCode": "+1",
    "phoneNumber": "7785462944"
  },
  "firstName": "Lenna",
  "middleName": "More",
  "lastName": "Paprocki",
  "address": {
    "addressType": "Principal place of business",
    "addressLine1": "689 Main St",
    "addressLine2": "Opposite St. Andrews Church",
    "addressLine3": "Mini York",
    "city": "Anchorage",
    "state": "AZ",
    "postalCode": "99501",
    "countryCode": "US"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.