Sign in
Clients EB

Create client

Creates a new client.

post/clients

Request

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

Request body

businessTypestring

The type of business connected to the client. You can use the Reference Data resource to get a list of acceptable values. Examples include: Privately Owned Business. Sole Proprietorship.

legalStructurestring

Legal Structure of the business entity. Legal structure is required for Privately Owned Business and Sole Proprietorship. Distinct legal structure. e.g. - Limited Liability Company - Corporation - Limited Partnership - Sole Proprietorship

industryCategorystring

The industry category of the business connected to the client. For example, Accommodation and Food Services. You can use the Reference Data resource to get a list of acceptable values.

industryTypestring

The industry type of the business connected to the client. You can use the Reference Data resource to get a list of acceptable values.

significantOwnershipboolean

Significant ownership means there individuals who own 25% or more of the client's business. Always required for a Privately Owned Business. If Significant Ownership is selected as True, At least one related party should have the role of owner.

entitiesInOwnershipboolean

Entities in ownership means that one or more businesses own part of the business conected to the client. Always required for a Privately Owned Business.

businessNamestring required

The business?s legal name. It is the official name of the person or entity that owns a company. Must be the name used on the client's government forms and business paperwork

businessAliasNamestring

Any alias names for the business connected to the client.

businessDescriptionstring

The business?s description.

websiteAvailableboolean

Whether or not the business connected to the client has a website.

websitestring

Website of the business connected to the client. Always required if websiteAvailable is true.

emailstring

Email of the client.

countryOfFormationstring

Country code in alpha-2 format

yearOfFormationstring

Year of company formation. Max and Min length is 4.

parentClientIdstring

The parent (platform) relationship owner's ID.

productsstring[] required

The products available for clients in a jurisdiction.

jurisdictionstring

The jurisdiction where the client would be onboarding.

Example request

{
  "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"
  },
  "phone": {
    "countryCode": "+1",
    "phoneNumber": "7785462944"
  },
  "identities": [
    {
      "idType": "EIN",
      "idDescription": "Employee Identification Number",
      "idIssuer": "US",
      "idValue": "999999999"
    }
  ],
  "businessType": "Privately Owned Business",
  "legalStructure": "Limited Liability Company",
  "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",
  "relatedParties": [
    {
      "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"
      },
      "phone": {
        "countryCode": "+1",
        "phoneNumber": "7785462944"
      },
      "identities": [
        {
          "idType": "EIN",
          "idDescription": "Employee Identification Number",
          "idIssuer": "US",
          "idValue": "999999999"
        }
      ],
      "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",
        "DECISION_MAKER"
      ]
    }
  ],
  "products": [
    "EB"
  ],
  "jurisdiction": "US"
}

Response

OK

businessTypestring

The type of business connected to the client. You can use the Reference Data resource to get a list of acceptable values. Examples include: Privately Owned Business. Sole Proprietorship.

legalStructurestring

Legal Structure of the business entity. Legal structure is required for Privately Owned Business and Sole Proprietorship. Distinct legal structure. e.g. - Limited Liability Company - Corporation - Limited Partnership - Sole Proprietorship

industryCategorystring

The industry category of the business connected to the client. For example, Accommodation and Food Services. You can use the Reference Data resource to get a list of acceptable values.

industryTypestring

The industry type of the business connected to the client. You can use the Reference Data resource to get a list of acceptable values.

significantOwnershipboolean

Significant ownership means there individuals who own 25% or more of the client's business. Always required for a Privately Owned Business. If Significant Ownership is selected as True, At least one related party should have the role of owner.

entitiesInOwnershipboolean

Entities in ownership means that one or more businesses own part of the business conected to the client. Always required for a Privately Owned Business.

businessNamestring

The business?s legal name. It is the official name of the person or entity that owns a company. Must be the name used on the client's government forms and business paperwork

businessAliasNamestring

Any alias names for the business connected to the client.

businessDescriptionstring

The business?s description.

websiteAvailableboolean

Whether or not the business connected to the client has a website.

websitestring

Website of the business connected to the client. Always required if websiteAvailable is true.

emailstring

Email of the client.

countryOfFormationstring

Country code in alpha-2 format

yearOfFormationstring

Year of company formation. Max and Min length is 4.

parentClientIdstring

Client ID of the platform entity the client is onboarded to.

idstring required

Client ID. The unique identifier for a client.

statusstring

active | deleted

productsstring[]

The products available for clients in a jurisdiction.

jurisdictionstring

The jurisdiction where the client would be onboarding.

enablePayoutsboolean

Once KYC has completed and approved, clients will be able to make payments out of their Embedded Bank Account. This flag will be set to FALSE until this process completes. Only present for clients.

createdAtstring

Date the profile was created.

onboardingStatusstring

The client onboarding status

Example response

{
  "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"
  },
  "phone": {
    "countryCode": "+1",
    "phoneNumber": "7785462944"
  },
  "identities": [
    {
      "idType": "EIN",
      "idDescription": "Employee Identification Number",
      "idIssuer": "US",
      "idValue": "999999999"
    }
  ],
  "businessType": "Privately Owned Business",
  "legalStructure": "Limited Liability Company",
  "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": "1bd824ef-355d-496d-9272-900cfe4b95f9",
  "status": "active",
  "products": [
    "EB"
  ],
  "jurisdiction": "US",
  "enablePayouts": true,
  "createdAt": "2021-11-17T10:04:37Z",
  "onboardingStatus": "Pending Submission, Review in Progress, Complete",
  "relatedParties": [
    {
      "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"
      },
      "phone": {
        "countryCode": "+1",
        "phoneNumber": "7785462944"
      },
      "identities": [
        {
          "idType": "EIN",
          "idDescription": "Employee Identification Number",
          "idIssuer": "US",
          "idValue": "999999999"
        }
      ],
      "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",
        "DECISION_MAKER"
      ],
      "id": "b98355d9-d193-4f50-9957-c699266b1530",
      "status": "active"
    }
  ]
}

Changes

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