Clients EB

List clients

Returns a list of Embedded Finance clients associated with your platform.

get/clients

Request

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

Query parameters

limitinteger

Number of records per page.

pageinteger

Page Number

Headers

tokenstring

JWT Client token

Response

Ok.

Example response

{
  "metadata": {
    "page": 1,
    "limit": 30,
    "total_items": 1
  },
  "items": [
    {
      "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.