Sign in
Clients EB

Update client

Updates information about a specified client.

post/clients/{id}

Request

  • Base URL: https://apigateway.jpmorgan.com/tsapi/ef/v1
  • URL: https://apigateway.jpmorgan.com/tsapi/ef/v1/clients/{id}
  • Auth: none declared

Path parameters

idstring required

Unique identifier for a client.

Headers

tokenstring

JWT Client token

Request body

businessTypestring

The different business entity types that can be selected e.g. Privately Owned Business | Sole Proprietorship

legalStructurestring

Legal Structure of the business entity. Legal structure is required for Privately Owned Business and Sole Proprietorship.

industryCategorystring

Distinct industry category. e.g. - Accommodation and Food Services - Administrative and Support and Waste Management and Remediation Services - Agriculture, Forestry, Fishing and Hunting (not covered in economic census) - Arts, Entertainment, and Recreation - Construction - Educational Services - Finance and Insurance - Health Care and Social Assistance - Individuals - Information - Management of Companies and Enterprises - Manufacturing - Mining, Quarrying, and Oil and Gas Extraction - Other Services (except Public Administration) - Professional, Scientific, and Technical Services - Public Administration (not covered in economic census) - Real Estate and Rental and Leasing - Retail Trade - Transportation and Warehousing - Utilities - Wholesale Trade

industryTypestring

Industry type.

significantOwnershipboolean

Are there any individuals who own 25% or more of your business? e.g. true|false. significantOwnership is required for Privately Owned Business. If Significant Ownership is selected as True, At least one related party should have a role of owner.

entitiesInOwnershipboolean

If entitiesInOwnership is true, are there any businesses included in your ownership hierarchy? e.g. true|false. entitiesInOwnership is required for Privately Owned Business.

businessNamestring

The business?s legal name. It is the official name of the person or entity that owns a company. And, it?s the name used on your government forms and business paperwork

businessAliasNamestring

The business?s alias name. It is the other alias name of the entity that owns a company.This field can be set to empty by passing field value as ("") in request.

businessDescriptionstring

The business?s description.

websiteAvailableboolean

Does your business have a website? e.g. true|false

websitestring

Website of the client. website is required if websiteAvailable is true.This field can be set to empty by passing field value as ("") in request.

emailstring

Email of the client.

countryOfFormationstring

Country code in alpha-2 format

yearOfFormationstring

Year of formation. Max and Min length is 4.

idstring

Client id, that uniquely identifies the client.

Example request

{
  "address": {
    "addressType": "Principle Place Of Business",
    "addressLine1": "689 Main St",
    "addressLine2": "Opposite St. Andrews Church",
    "addressLine3": "Mini York",
    "city": "Anchorage",
    "state": "AZ",
    "postalCode": "99501",
    "countryCode": "US"
  },
  "phone": {
    "countryCode": "+1",
    "phoneNumber": "7785462944"
  },
  "identities": [
    {
      "idType": "EIN",
      "idDescription": "Employee Identification Number",
      "idIssuer": "US",
      "idValue": "999999999",
      "action": "ADD"
    }
  ],
  "businessType": "Privately Owned Business",
  "legalStructure": "LLC",
  "industryCategory": "Accommodation and Food Services",
  "industryType": "Bed And Breakfast Inns",
  "significantOwnership": true,
  "entitiesInOwnership": true,
  "businessName": "Feltz Printing Service",
  "businessAliasName": "Feltz Printing Service of New York",
  "businessDescription": "Printing Service of New York",
  "websiteAvailable": true,
  "website": "https://www.company.com",
  "email": "client@company.com",
  "countryOfFormation": "US",
  "yearOfFormation": "2020",
  "id": "1234567891",
  "relatedParties": [
    {
      "address": {
        "addressType": "Principle Place Of Business",
        "addressLine1": "689 Main St",
        "addressLine2": "Opposite St. Andrews Church",
        "addressLine3": "Mini York",
        "city": "Anchorage",
        "state": "AZ",
        "postalCode": "99501",
        "countryCode": "US"
      },
      "phone": {
        "countryCode": "+1",
        "phoneNumber": "7785462944"
      },
      "identities": [
        {
          "idType": "EIN",
          "idDescription": "Employee Identification Number",
          "idIssuer": "US",
          "idValue": "999999999",
          "action": "ADD"
        }
      ],
      "id": "f773b9c1-13e5-4e5a-b055-def345eb85d0",
      "businessName": "Feltz Printing Service",
      "firstName": "Lenna",
      "middleName": "More",
      "lastName": "Paprocki",
      "jobTitle": "CEO",
      "jobTitleDescription": "Acting CEO",
      "birthDate": "1983-02-08",
      "email": "client@company.com",
      "natureOfOwnership": "Direct",
      "partyType": "Individual",
      "partyRole": [
        "CONTROLLER",
        "OWNER"
      ],
      "action": "ADD"
    }
  ]
}

Response

OK

businessTypestring

The different business entity types that can be selected e.g. Privately Owned Business | Sole Proprietorship

legalStructurestring

Legal Structure of the business entity. Legal structure is required for Privately Owned Business and Sole Proprietorship.

industryCategorystring

Distinct industry category. e.g. - Accommodation and Food Services - Administrative and Support and Waste Management and Remediation Services - Agriculture, Forestry, Fishing and Hunting (not covered in economic census) - Arts, Entertainment, and Recreation - Construction - Educational Services - Finance and Insurance - Health Care and Social Assistance - Individuals - Information - Management of Companies and Enterprises - Manufacturing - Mining, Quarrying, and Oil and Gas Extraction - Other Services (except Public Administration) - Professional, Scientific, and Technical Services - Public Administration (not covered in economic census) - Real Estate and Rental and Leasing - Retail Trade - Transportation and Warehousing - Utilities - Wholesale Trade

industryTypestring

Industry type.

significantOwnershipboolean

Are there any individuals who own 25% or more of your business? e.g. true|false. significantOwnership is required for Privately Owned Business. If Significant Ownership is selected as True, At least one related party should have a role of owner.

entitiesInOwnershipboolean

If entitiesInOwnership is true, are there any businesses included in your ownership hierarchy? e.g. true|false. entitiesInOwnership is required for Privately Owned Business.

businessNamestring

The business?s legal name. It is the official name of the person or entity that owns a company. And, it?s the name used on your government forms and business paperwork

businessAliasNamestring

The business?s alias name. It is the other alias name of the entity that owns a company.This field can be set to empty by passing field value as ("") in request.

businessDescriptionstring

The business?s description.

websiteAvailableboolean

Does your business have a website? e.g. true|false

websitestring

Website of the client. website is required if websiteAvailable is true.This field can be set to empty by passing field value as ("") in request.

emailstring

Email of the client.

countryOfFormationstring

Country code in alpha-2 format

yearOfFormationstring

Year of formation. Max and Min length is 4.

idstring

Client id, that uniquely identifies the client.

productsstring[]

The products available for clients.

Example response

{
  "address": {
    "addressType": "Principle Place Of Business",
    "addressLine1": "689 Main St",
    "addressLine2": "Opposite St. Andrews Church",
    "addressLine3": "Mini York",
    "city": "Anchorage",
    "state": "AZ",
    "postalCode": "99501",
    "countryCode": "US"
  },
  "phone": {
    "countryCode": "+1",
    "phoneNumber": "7785462944"
  },
  "identities": [
    {
      "idType": "EIN",
      "idDescription": "Employee Identification Number",
      "idIssuer": "US",
      "idValue": "999999999",
      "action": "ADD"
    }
  ],
  "businessType": "Privately Owned Business",
  "legalStructure": "LLC",
  "industryCategory": "Accommodation and Food Services",
  "industryType": "Bed And Breakfast Inns",
  "significantOwnership": true,
  "entitiesInOwnership": true,
  "businessName": "Feltz Printing Service",
  "businessAliasName": "Feltz Printing Service of New York",
  "businessDescription": "Printing Service of New York",
  "websiteAvailable": true,
  "website": "https://www.company.com",
  "email": "client@company.com",
  "countryOfFormation": "US",
  "yearOfFormation": "2020",
  "id": "1234567891",
  "relatedParties": [
    {
      "address": {
        "addressType": "Principle Place Of Business",
        "addressLine1": "689 Main St",
        "addressLine2": "Opposite St. Andrews Church",
        "addressLine3": "Mini York",
        "city": "Anchorage",
        "state": "AZ",
        "postalCode": "99501",
        "countryCode": "US"
      },
      "phone": {
        "countryCode": "+1",
        "phoneNumber": "7785462944"
      },
      "identities": [
        {
          "idType": "EIN",
          "idDescription": "Employee Identification Number",
          "idIssuer": "US",
          "idValue": "999999999",
          "action": "ADD"
        }
      ],
      "id": "1234567891",
      "businessName": "Feltz Printing Service",
      "firstName": "Lenna",
      "middleName": "More",
      "lastName": "Paprocki",
      "jobTitle": "CEO",
      "jobTitleDescription": "Acting CEO",
      "birthDate": "1983-02-08",
      "email": "client@company.com",
      "natureOfOwnership": "Direct",
      "partyType": "Individual",
      "partyRole": [
        "CONTROLLER",
        "OWNER"
      ]
    }
  ],
  "products": [
    "EP"
  ]
}

Changes

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