JPMorgan Chase Clients API is one of 65 APIs that JPMorgan Chase publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Clients. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
6 operations
across 3 paths,
and defines 99 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.18.
Requests are made against 3 base URLs: https://api.payments.jpmorgan.com/onboarding/v1, https://api-sandbox.payments.jpmorgan.com/onboarding/v1, https://api-mock.payments.jpmorgan.com/onboarding/v1.
The identity and technical contract details declared by the specification.
ClientProductList
array
A list of product selections.
SocialMediaList
array
The entity's social media profiles.
BirthDate
string
The date of birth (yyyy-MM-dd) of the individual in case of party type being an individual.
OrganizationDetailsRequired
2 required
ClientVerificationResponse
object
2 properties
IndividualDetailsRequired
2 required
NameSuffix
string
The name suffix used by the party
QuestionIdList
array
A list of question IDs.
AmexOptBlueServiceEstablishmentNumber
string
Unique identifier assigned to a merchant/business that participates in the American Express OptBlue program
JcbAccepted
boolean
Indicates if the merchant will accept JCB cards. Required American Express OptBlue is selected in Australia, New Zealand, or Canada.
UpdatePartyRequestInline
object
Update a party inline within the clients API by supplying its ID.
7 properties
ExternalId
string
ID in external system.
ClientQuestionResponse
object
The client's response to a question.
2 properties
MiddleName
string
Middle name of the individual in case of party type being an individual. The format is enforced with the pattern ^[a-zA-Z0-9\(\)\/\&\+\%\@\\;\,\.\:\ \-\']$.
OrganizationName
string
The organization's legal name. It is the official name of the person or entity that owns a company. Must be the name used on the legal party's government forms…
NetworkRegistrationCurrencyCode
string
The merchant's preferred currency for transactions. Required when AMEXOPTBLUE is selected.
PartyType
string
The party type
VisaDebitAcceptance
string
The type of Visa debit card acceptance. Required when VISA is selected.
IndividualJobTitleDescription
string
If jobTitle is Other, then job title description is required.
ResponseValueList
array
The values of a question response. Each item is a string that will be validated according to the question's responseSchema.
OrganizationIdentityDto
object
The tax ID of the organization.
5 properties
3 required
ValidationType
string
The type of validation process. | Type | Description | | -- | -- | | ENTITYVALIDATION | Validation of the party identity. | | LIVENESSCHECK | Validation of the…
ApiErrorContext
object
Context of the API error.
4 properties
1 required
ClientUpdatedResponse
object
1 property
Attestation
object
The attesting of presented legal statements. Either "attester" or "attesterFullName" is required.
5 properties
3 required
AttestationRemoval
object
Describes which attestation to remove. An existing attestation with a matching documentId will be removed.
1 property
1 required
ClientResponse
object
11 properties
5 required
IndividualJobTitle
string
Job title in the case of party type being an INDIVIDUAL. Job title is a required field for controllers, beneficial owners, and decision makers. Allowed values…
PartyRoleList
array
A list of party roles. - CLIENT: A party that is the business entity. Only one party under a client may have this role. No other role can be specified alongsid…
PubliclyTraded
object
Provide details for stock exchange and ticker symbol if your organization is a publicly traded company. If your organization is a subsidiary use these fields t…
3 properties
2 required
MerchantCategoryCode
string
The merchant category code describing the merchant's industry.
OrganizationDetails
object
Details of an organization.
22 properties
PageMetaData
object
Page metadata.
3 properties
IndividualDetails
object
Details of an individual.
15 properties
ValidationResponse
array
List of validation info.
ServiceEstablishmentStatus
string
The American Express status code for the merchant if they are terminated or reinstated. The payment provider must provide this if the merchant was previously t…
Role
string
The party's role. - CLIENT: A party that is the business entity. Only one party under a client may have this role. No other role can be specified alongside CLI…
ClientStatus
string
The client's status.
PartyResponse
object
17 properties
AmexSellerId
string
The ID that identifies the merchant account when processing with American Express OptBlue.
YearOfFormation
string
Year of company formation.
OrganizationType
string
This field specifies the legal structure or classification of the organization and identifies whether the entity is a Corporation, Sole Proprietorship, Non-Pro…
ClientResults
object
The results of the client verification process.
1 property
1 required
AmexOptBlueMarketing
boolean
Indicates whether the merchant has opted-in to American Express OptBlue marketing. - true – All Marketing (Merchant has not opted out of receiving marketing) -…
QuestionId
string
The ID uniquely identifying a question.
AttesterDesignation
string
The attester's held position in the client business.
ParentPartyId
string
The parent party ID.
ClientVerificationRequest
object
1 property
OrganizationIndustry
object
2 properties
Active
boolean
Whether the party is active or not. False if inactive.
LastName
string
Last name of the individual in case of party type being an individual like Owners, Controllers and Decision Makers. The format is enforced with the pattern ^[a…
CustomerIdentityStatus
string
The status of the customer identification process.
ClientListResponse
object
Collection of clients.
2 properties
2 required
ClientSummaryResponse
object
5 properties
5 required
UpdateClientRequestSmbdo
object
6 properties
PhoneSmbdo
object
Phone number information of the party.
3 properties
2 required
SocialMedia
object
2 properties
2 required
DocumentId
string
The unique id generated by the system for the uploaded document, which can be used for future retrieval.
FirstName
string
First name of the individual in case of party type being an individual like Owners, Controllers and Decision Makers. The format is enforced with the pattern '^…
ConsumerDevice
object
Consumer device information provided by the merchant. It is only returned when present in the create or update client requests.
2 properties
DefaultLanguagePreferenceEnum
string
The default language preference of the party's user. It defines the initial language of user communications during client onboarding. Any changes to the user's…
DocumentIdList
array
A list of document IDs.
AccessList
array
List of user access descriptors.
DbaName
string
An alternate name that the business is doing business under. Provide this if your business is registered with an alias. The format is enforced with the pattern…
CreatePartyRequestInlineRequired
Create a party within the clients payload.
2 required
WebsiteAvailable
boolean
Whether the party has a website. False if opted out.
ClientProduct
string
Client Product Table: | Product | Description | | -- | -- | | EMBEDDEDPAYMENTS | Create and manage embedded bank accounts | | MERCHANTSERVICES | JPMorgan solut…
PartyIdList
array
A list of party IDs.
DiscoverMerchantId
string
The ID that identifies the merchant account when processing with Discover.
AddressDto
object
An address.
6 properties
4 required
NetworkRegistration
object
Network registration configuration.
13 properties
DiscoverDebtRepayment
boolean
Indicates if the merchant will be accepting Discover cards as a part of Discover's consumer debt repayment program.
Attester
object
The details of the attester.
4 properties
3 required
CreateClientRequestSmbdo
object
5 properties
1 required
SocialMediaUrl
string
Social media profile URL.
Email
string
Email of the party. The email is validated against the [RFC 2822](https://datatracker.ietf.org/doc/html/rfc2822) format, which is 64 characters (local part) +…
TransactionDeviceType
string
The mechanism used to provide details at the merchant's terminal for transactions. Required when DISCOVER is selected.
ValidationStatus
string
Status of a party validation. Missing fields result in NEEDSINFO.
CountryCodeIsoAlpha2
string
Country code in ISO alpha-2 format.
SettlementPaymentMethods
string
The method of payment used in network registration.
Website
string
Name/URL of the website
CreatePartyRequestInline
object
Create a party within the clients payload.
9 properties
schemas-ApiError
object
An API error.
5 properties
2 required
EntitiesInOwnership
boolean
Entities in ownership means that one or more businesses own part of the business connected to the client.
DocumentRequestIdList
array
A list of document request IDs.
OrganizationIndustryCategory
string
The industry category of the business connected to the client. For example, Accommodation and Food Services. You can use the [Industry Descriptor Reference](ht…
OrganizationIndustryType
string
The industry type of the business connected to the client. You can use the [Industry Descriptor Reference](https://developer.payments.jpmorgan.com/docs/embedde…
PartyField
object
A party field. It refers to either a missing field or a field that needs to be updated.
3 properties
ClientId
string
A client's unique ID
AttesterMiddleName
string
The middle name of an individual.
OrganizationDescription
string
The organization's description.
NatureOfOwnership
string
Nature of ownership. Allowed values are: Direct, Indirect.
PartyId
string
Organization/Individual party id, that uniquely identifies the party.
AttesterLastName
string
The last name of an individual.
AttesterFirstName
string
The first name of an individual.
IndividualIdentity
object
An individual's identification. For MerchantServices product in Canada, individual party ID is optional.
5 properties
3 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs JPMorgan Chase publishes across the network.
