Consumer Profile Management API
The consumer profile management API provides merchant functionality to create, store, update, and maintain customer or consumer profiles.
Consumer Profile Management API is one of 26 APIs that JPMorgan Chase publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Addresses, Bulk Import, Communications, Consumer Profiles, and Health Check. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 18 operations across 13 paths, organized into 6 resource areas, and defines 127 schemas. It is described by OpenAPI 3.0.1, at version 2.4.2.
Requests are made against 3 base URLs: https://profiles-api.merchant.jpmorgan.com/api/v2/mmp, https://cat-profiles-api.merchant.jpmorgan.com/api/v2/mmp, https://api-mock.payments.jpmorgan.com/api/v2/mmp.
18 operations
13 paths
127 schemas
4 DELETE4 GET6 PATCH4 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Consumer Profile Management API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (BearerAuth).
By default, every request must be authenticated.
Paths & Operations 18
Across 13 paths, the API surfaces 18 operations — 4 DELETE, 4 GET, 6 PATCH, 4 POST. They span 6 resource areas: Health Check, Consumer Profiles, Payment Methods, Addresses, Communication, Bulk Import. Each is listed below with its method, path, parameters, and response codes.
Health Check 1
Validate the health of the service.
GET
/healthcheck
Health check for CPM API
Consumer Profiles 4
Consumer Profiles API
POST
/consumer-profiles
Create a consumer profile
PATCH
/consumer-profiles/{consumer-profile-id}
Update a consumer profile
GET
/consumer-profiles/{consumer-profile-id}
Retrieve a consumer profile
DELETE
/consumer-profiles/{consumer-profile-id}
Delete a consumer profile
Payment Methods 5
Payment Methods API
POST
/consumer-profiles/{consumer-profile-id}/payment-methods
Add a new payment method to an existing consumer profile
PATCH
/consumer-profiles/{consumer-profile-id}/payment-methods/{payment-method-id}/default
Update a payment method to default on an existing consumer profile
PATCH
/consumer-profiles/{consumer-profile-id}/payment-methods/{payment-method-id}
Update a payment method on an existing consumer profile
DELETE
/consumer-profiles/{consumer-profile-id}/payment-methods/{payment-method-id}
Delete a payment method
GET
/consumer-profiles/{consumer-profile-id}/payment-methods/{payment-method-id}/status
Retrieve 3DS status
Addresses 3
Addresses API
POST
/consumer-profiles/{consumer-profile-id}/addresses
Add a new address to an existing consumer profile
PATCH
/consumer-profiles/{consumer-profile-id}/addresses/{address-id}
Update an address on an existing consumer profile
DELETE
/consumer-profiles/{consumer-profile-id}/addresses/{address-id}
Delete an address
Communication 4
Communication Update
POST
/consumer-profiles/{consumer-profile-id}/communication
Add a new communication to an existing consumer profile
PATCH
/consumer-profiles/{consumer-profile-id}/communication/{communication-id}/default
Update a communication method to default on an existing consumer profile
PATCH
/consumer-profiles/{consumer-profile-id}/communication/{communication-id}
Update a communication attributes based on communication id provided; either email or phone
DELETE
/consumer-profiles/{consumer-profile-id}/communication/{communication-id}
Delete a communication method
Bulk Import 1
GET
/bulk-import/status
Retrieve the status of a bulk import file
Schemas 127
The contract defines 127 schemas that model the data the API accepts and returns. The most detailed are profileCard (23 properties), createCard (23 properties), card (23 properties), updatedCard (20 properties). Each schema is shown below with its type and property counts.
healthCheckResource
object
Contains health check information about a resource.
1 property
1 required
adfsError
object
Object containing information about the active directory file system error.
3 properties
3 required
messages
object
A list of errors and warnings.
4 properties
2 required
validationMessage
object
Object containing information about transaction validation.
3 properties
2 required
responseStatus
string
Request result status.
responseCode
string
Short explanation of the response code.
responseMessage
string
Long explanation of the response message.
code
string
Codifies a raised exception encountered by an internal or external system, sub-system, interface, job, module, or system component with which the web service a…
message
string
Provides textual description of a problem that has occurred and which is preventing the system from completing a task. Messages can be a confirmation, warning…
consumerProfile
object
Consumer Profile Object
13 properties
address
object
Address Object
14 properties
2 required
paymentMethodType
object
Payment Method Object
5 properties
createPaymentMethod
object
Payment Method Information. Atleast one payment method information should be mandatory
12 properties
createCard
object
Card payment Information
23 properties
1 required
createSepa
object
Sepa Payment Information
11 properties
createAch
object
ACH payment Information
13 properties
2 required
createBacs
object
Object for BACS (Bankers' Automated Clearing System) is an electronic system payment method make payments directly from one bank account to another. This payme…
11 properties
2 required
createDefaultMOP
object
Default payment method
4 properties
updatePaymentMethod
object
Payment Method Object
5 properties
createAddress
object
Create Address Object
12 properties
updateAddress
object
Update Address Object
11 properties
communication
object
Communication Object
4 properties
consumerProfileIdResponse
object
Consumer Profile Response Object
4 properties
updateConsumerProfile
object
Update Consumer Profile Object
7 properties
addressType
string
Codifies the classification given to the various addresses captured for a party, such as Doing Business As Address, Legal Entity Address, and Tax Address. Vali…
line1
string
A portion of a party's address which is the line of the unstructured (unparsed) geographic street address containing any of the following: house number, street…
line2
string
A portion of a party's address which is the line of the unstructured (unparsed) geographic street address containing any of the following: house number, street…
city
string
A portion of a party's address which is the geographic area that is a municipality with legal power granted by a state/province charter.
state
string
Classifies a geographic area that represents a first level, legal and political subdivision of a country; it should be in the ISO 3166-2 format. For Example: t…
postalCode
string
The portion of a party’s address that is the encoded representation of a geographic area to facilitate mail delivery services.
countryCode
string
A code that identifies the Country, a Geographic Area, that is recognized as an independent political unit in world affairs. Note: This data element is a child…
consumerAssignedAddressName
string
A short label defined by the consumer that will allow them to refer to the address by name. E.g Home , Office , JohnDoeHome
primaryAddressIndicator
boolean
Indicates the 'TRUE'/'FALSE' value that represents whether or not an address is the primary address for a given owner
createTimestamp
string
Designates the hour, minute and second in a specific day when the record was created.
createUserIdentifier
string
The identifier (id) of the user who created the object or inserted the row. This could be the Firm’s Standard Identifier, or the identifier of a batch/function…
updateTimestamp
string
Designates the hour, minute, and second in a specifc day when the record was last modified.
updateUserIdentifier
string
The identifier (id) of the user who last updated the object or the row. This could be the Firm’s Standard Identifier, or the identifier of a batch/functional p…
cardType
string
Codifies the method used to pay for the exchange of money, goods or services between a merchant and their customer such as VI,MC, AX.
cardExpirationMonthYearNumber
string
A number in the form of Month/Year that is displayed on a card (Debit/Credit). This number is used for the date which is no longer in effect for transactions b…
accountNumber
string
The card or token number.
consumerProfileAddress
object
Address Information used for consumer profile
12 properties
consumerProfileResponse
object
Consumer Profile Response Object
18 properties
addressStatus
string
Codifies the current status of the profile address.
accountStatus
string
Codifies the current status of the card.
firstName
string
That part of an individual's full name considered a personal name or given name and generally positioned before the last name or family name.
lastName
string
That part of an individual’s name generally placed at the end of the given name. The last name is also known as the surname or family name. (Note: name convent…
profileStatus
string
Codifies the current standing of a Party's profile.
middleName
string
That part of an individual's name generally positioned between the first and family names, as a second given name or a maternal surname. (NOTE: in some instanc…
card
object
Card payment Information
23 properties
1 required
sepa
object
Sepa Payment Information
11 properties
ach
object
ACH payment Information
13 properties
2 required
defaultMOP
object
Default payment method
4 properties
phone
object
Phone Information
4 properties
2 required
email
object
Email information
3 properties
1 required
mandate
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
4 properties
3 required
addressIdentifier
string
Identifies a classification of a geographic area that is captured for a consumer purchasing goods or services.
last4AccountNumber
string
Identifies the final 4 digits of the Payment Method Account Number. The truncated value is used in place of the full number to protect against exposure of conf…
paymentMethodId
string
Identifies a unique occurrence of the type of payment accepted by a level of the hierarchy of the merchant acquiring account.
updateCard
object
Card payment Information
14 properties
updateSepa
object
Sepa Payment Information
7 properties
updateAch
object
ACH payment Information
8 properties
last4CardNumber
string
Identifies the final 4 digits of the 16 digit card number. The truncated value is used in place of the full number to protect against exposure of confidential…
first6CardNumber
string
Identifies the first six digits of the primary account number of a credit, debit or pre-paid card. As of 2017, this does not necessarily align to the Issuer Id…
profileCard
object
Card payment Information
23 properties
1 required
profileSepa
object
Sepa Payment Information
10 properties
2 required
profileAch
object
ACH payment Information
12 properties
2 required
profilePaymentMethod
object
Payment Method Information.Atleast one payment method information should be mandatory
8 properties
profileDefaultMOP
object
Default payment method
4 properties
financialInstitutionRoutingNumber
string
Identifies the routing and transit number assigned by an administrative body to formally identify a chartered financial institution (bank) within a given count…
paymentType
string
Identifies how accountholders initiated debits to their accounts .
accountType
string
Codifies a bank account where funds are deposited or stored (e.g., checking and savings account). When shared with a financial institution as the client's prim…
isTransactionMicroEntry
boolean
Indicates the current transaction is an Automated Clearing House (ACH) credit or debit Entry used by an Originator for the purpose of verifying a Receiver’s ac…
communicationUpdate
object
Communication Update information
2 properties
consumerProfileUniqueId
string
Identifies a unique occurrence of a consumer's information maintained by the Firm acorss merchant.
consumerProfileId
string
Identifies a unique occurrence of a consumer's information maintained by the Firm on behalf of the merchant. The consumer profile contains information relevant…
cardAuthenticationDetails
object
Card Authentication Details
7 properties
merchant
object
Information about the merchant
1 property
merchantSoftware
object
Contains information related to the merchant software
3 properties
authenticationRequest
object
Authentication Request
3 properties
threeDSPurchaseInfo
object
Three DS Purchase Info
2 properties
threeDSAuthenticatedData
object
Three DS Authenticated Data
4 properties
browserInfo
object
Browser Information of the consumer
11 properties
threeDSRequestorAuthenticationInfo
object
Three DS Requestor Authentication Info
2 properties
currency
string
Codifies the monetary unit that was associated with the financial transaction (such as sale, returns, chargebacks etc.).
authenticationId
string
A unique identifier for the card owner authentication provided by a global authentication solution such as Three Domain Secure (3DS) designed to make eCommerce…
authenticationResult
object
Cardholder Authentication Result from the Payment request.
3 properties
consumerUpdatedProfileResponse
object
This is the response payload returned after an update operation.
18 properties
updatedCard
object
Updated card information
20 properties
updatedPaymentMethodType
object
Updated Payment Method Type
5 properties
updatedDefaultMOP
object
Updated Default MOP information
4 properties
externalConsumerProfileIdentifier
string
Identifies a unique occurrence of a consumer maintained by the merchant or a vendor. Consumer profile contains information relevant to processing transactions…
bacs
object
Object for BACS (Bankers' Automated Clearing System) is an electronic system payment method make payments directly from one bank account to another. This payme…
11 properties
2 required
profileBacs
object
Object for BACS (Bankers' Automated Clearing System) is an electronic system payment method make payments directly from one bank account to another. This payme…
10 properties
2 required
updateBacs
object
Update BACS information
7 properties
requestId
string
Unique request identifier to track the request through application programming interface(API) .
softMerchant
object
Soft merchant information is passed to the card association along with the transaction. This soft merchant information may also be used for cases where smaller…
6 properties
billerDebitCardReferenceNumber
string
The Firm identifier assigned to a debit card number at the instantiation of the debit card number that persists over time as the debit card number changes thro…
fullName
string
Name of accoundholder business name.
orderOverrideCode
string
Codifies the option merchant has chosen to perform a non-systemic override on a payment order.
isBillPayment
boolean
Indicates whether or not the transaction is identified by Visa as a bill payment, prearranged between the cardholder and the merchant.
verificationResult
object
card verification Result
3 properties
accountNumberType
string
Specifies the type of payment method used by the account number in payment transaction.
bulkImportFileStatusResponse
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
19 properties
merchantFileName
string
This is used for specifying FileName of the Bulk Import File.
bulkTokenizationStatus
object
Contains information related to the Tokenization status for the Bulk Import file.
5 properties
submitterIdentifier
string
This is used for specifying Submitter Id of the Bulk Import File.
profileCardSourceName
string
profileCardSourceName (string, optional): This attribute is to inform if the card is converted card from safetech token or Apple Pay token or network token. ["…
merchantId
string
Identifies a unique entity for transaction processing at the lowest level of the account hierarchy of the backend proprietary merchant acquiring processing pla…
paze
object
Use is for encrypted bundles for web or Internet acceptance of digital device wallets PAZE
1 property
applepay
object
Use is for encrypted bundles for web or Internet acceptance of digital device wallets such as Apple Pay
2 properties
googlepay
object
Use is for encrypted bundles for web or Internet acceptance of digital device wallets such as Google Pay
2 properties
latLong
string
Identifies the latitude and longitude coordinates of the digital device when it is being provisioned. Information is expressed in the order of latitude followe…
encryptedPaymentBundle
object
Encrypted Data for digital payment methods such as ApplePay, GooglePay and Paze.
4 properties
encryptedPaymentHeader
object
Header information used on digital payment methods such as ApplePay, GooglePay and Paze in the Encrypted format.
4 properties
profileGooglepay
object
Use is for encrypted bundles for web or Internet acceptance of digital device wallets such as Google Pay
2 properties
encryptedPayload
string
Encrypted message details have been rendered unreadable by general means through the application of a given set of instructions and a key.
profileApplepay
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
2 properties
profilePaze
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
1 property
bulkImportFileStatusListResponse
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
2 properties
pageNumber
string
THE DOMAIN ASSIGNED TO THIS ATTRIBUTE IS A MID-LEVEL INHERITANCE DOMAIN NOT INTENDED TO BE ASSIGNED TO AN ATTRIBUTE. IF THIS ELEMENT IS A CRITICAL DATA ELEMENT…
bulkImportFileStatusInfo
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
17 properties
pageSize
integer
The number of records to be returned per page.This is used in API requests to specify how many records should be included in each page of results.Sample values…
signedUrl
string
A reference to a web resource on the internet specifying its location on a computer network and a mechanism for retrieving.
overallFileStatus
string
Codifies the state of processing a file.
consumerPreferredPaymentNetwork
string
The consumer’s chosen card network to route eligible transactions when multiple networks are available. Valid Values are VI,MC, CB
templateType
string
Description type of template that is being processed
cardBadgeType
string
Codifies the type of card that operate on single payment network or co-badge (more than one network) .Valid values : COBADGED or MONOBADGED
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from JPMorgan Chase 12
Other APIs JPMorgan Chase publishes across the network.
Digital Onboarding API
Tokenization API
Reporting API
Notifications API
Request to Pay via QR Code API
Checkout API
Dispute Management API
Accounts API
Alerts and Decisioning API
Product Configuration API
Recipients API
Webhooks API
#Addresses#Bulk Import#Communications#Consumer Profiles#Health Check#Payment Methods
Where this information came from
This is an independent, third-party profile of Consumer Profile Management API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.