JPMorgan Chase Consents 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 Consents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
4 operations
across 3 paths,
and defines 53 schemas.
It is described by OpenAPI 3.2.0, at version 2.0.22.
Requests are made against 3 base URLs: https://api.payments.jpmorgan.com/paybybank/v2, https://api-cat.payments.jpmorgan.com/paybybank/v2, https://api-mock.payments.jpmorgan.com/paybybank/v2.
The identity and technical contract details declared by the specification.
AdditionalContext
object
3 properties
3 required
PartyRole
string
The role of the party to the account.
Error
object
Error details for consent processing issues
3 properties
2 required
Phone
object
Representation of a Phone Number
2 properties
FinancialInstitutionIdType
string
Financial Institution Identifier Type
AccountDetail
object
Consented accounts details
4 properties
1 required
WebHook
object
Webhook Data
7 properties
6 required
ConsentRenew
object
Consent renew or re-consent request for continuous access to existing consented information
2 properties
UpdateConsentLinkResponse
object
Representation of the details necessary to start and track the consent journey.
ConsentLinkWithView
object
Representation of a generated consent link.
PartyIdentity
object
Representation of a party with its role, identity, and verification status.
4 properties
IdempotencyKey
string
A string that enables the API support idempotency by safely retrying requests without accidentally performing the same operation twice.
AccountBasic
object
Basic representation of a financial account.
7 properties
ApiErrorContext
object
The API error context object returned by the API.
5 properties
1 required
Value
object
Value
2 properties
2 required
ConsentLinkType
string
Type of consent link that defines how account connects. | Consent Link Type | Description | |:------------------|:---------------------------------------------…
ConsentLinkRequest
object
Representation of a User's consent detail for accessing financial data
8 properties
3 required
AccountStatus
string
Account Status
ConsentLink
object
Representation of a generated consent link.
3 properties
2 required
ConsentLinkInitiated
object
Consent Link event published as part of account linking flow for consent link URL is generated
2 properties
2 required
ConsentStatus
string
Type of consent status | Consent Status | Description | |:---------------------|:--------------------------------------------------------------------------| |…
ConsentLinkId
string
Unique identifier to access Pay by Bank UI for Link (UUID)
ConsumerProfileId
string
Internal consumer profile identifier provided by JPMC
ApiAdditionalContext
object
3 properties
3 required
FinancialInstitution
object
Represents a financial institution with its name and logo.
2 properties
1 required
ISOCountryCode
string
ISO 3166-1 Alpha-2 Country Code
RequestId
string
Client provided unique identifier for the current request invocation
ErrorContext
object
4 properties
1 required
ConsentId
string
Unique identifier to access consent resources (UUID)
Amount
string
The value representation of a monetary amount. The amount value should be more than 0.01 with maximum of two decimal places allowed.
ReferenceId
string
A unique identifier provided by the client for the request, which will be returned upon the completion of the consent process.
ConsentBasic
object
Representation of a User's consent details without account information.
13 properties
6 required
ExternalUserProfile
object
Details of the external user.
4 properties
Address
object
Representation of an address object.
7 properties
AccountId
string
Internal account identifier provided by JPMC
ConsentLinkFailed
object
Consent Link event published as part of account linking flow for failure
ConsentDetail
object
Representation of a User's consent detail with account information.
ApiError
object
The error object returned by the API.
5 properties
3 required
TraceId
string
A unique identifier generated by server for tracing the request through the system.
FinancialInstitutionId
object
Financial Institution Identifier
2 properties
2 required
ISOCurrencyCode
string
Currency of the money movement: a 3 alpha character ISO 4217 currency code.
SORTCODE
object
Account identifier specific to the SORTCODE account numbering scheme.
3 properties
1 required
IBAN
object
International bank account number (IBAN) standard numbering system.
4 properties
1 required
Email
object
Representation of detailed email information.
3 properties
ExternalUserId
string
User Id for tracking the external user
ConsentType
string
Type of consent requested, specifying the scope of access to account information | Consent Type | Description | Supported Region | |:-------------------------|…
User
object
Pay by Bank User
1 property
Balance
object
Balance Information
3 properties
2 required
Party
object
Representation of a party with its role, identity, and verification status.
4 properties
1 required
ClientId
string
Unique Identifier of the client that is generated by PBB.
USABA
object
Account Identifier in US Banking account number format
5 properties
1 required
ConsentLinkResponse
object
Representation of the details necessary to start and track the consent journey.
AccountType
string
Specifies the type of account. | Account Type | Description | |----------------|------------------------| | CHECKING | A Checking account. | | SAVINGS | A Savi…
The full machine-readable OpenAPI contract behind this narrative.
Other APIs JPMorgan Chase publishes across the network.
