Digital Onboarding changelog

July 25, 2025

API Release v1.0.16

New

The following features have been added in the Digital Onboarding API specification version 1.0.16:

New features for the Digital Onboarding API
Feature name	Description
Offboarding	As a secondary screening platform, such as a payfac or marketplace, request to offboard a party for business or card network-defined reasons. This action sets the `profileStatus` to `TERMINATED` for the party.
API specification	API specification version 1.0.16 was released.

The following fields were added in the Digital Onboarding API specification version 1.0.16:

New fields for the Digital Onboarding API
Field	Description	Endpoint
`Idempotency-Key`	New optional header parameter for a client-generated unique idempotency key to recognize consecutive retries of the same request.	Request: `POST /clients` - Create client `PATCH /clients/{id}` - Update client `POST /clients/{id}/verifications` - Perform client verifications `POST /document-requests/{id}/submit` - Submit a document request `POST /documents` - Upload document `POST /parties` - Create party `PATCH /parties/{partyId}` - Update party `POST /parties/{partyId}/validations` - Start party validation `POST /offboarding-requests` - Create an offboarding request
`file`, `documentData`	New fields to support multipart/form-data in the document upload request object.	Request: `POST /documents` - Upload document

Change

The following features were changed in the Digital Onboarding API specification version 1.0.16:

Feature changes for the Digital Onboarding API
Feature	Description
Updated server domain and endpoints	Sub-domain updated to `payments.jpmorgan.com` and API namespace updated to `/onboarding`
Added response codes 409 and 422	New 409 response indicates a concurrent request conflict. New 422 response for semantic errors.

The following fields were updated in the Digital Onboarding API specification version 1.0.16:

Field changes for Digital Onboarding API
Field	Description	Endpoint
Update client (response-only), Create client, and Get client: parties[].individualDetails.individualIds[].`value` Update client (request-only): addParties[].individualDetails.individualIds[].`value` Create party, Get party, and Update party: individualDetails.individualIds[*].`value`	Added pattern and updated description.	Request and response: `POST /clients` - Create client `PATCH /clients/{id}` - Update client `POST /parties` - Create party `PATCH /parties/{partyId}` - Update party Response: `GET /clients/{id}` - Get client `GET /parties/{partyId}` - Get party
Update client (response-only), Create client, and Get client: parties[].organizationDetails.organizationIds[].`value` Update client (request-only): addParties[].organizationDetails.organizationIds[].`value` Create party, Get party, and Update party: organizationDetails.organizationIds[*].`value`	Added pattern.	Request and response: `POST /clients` - Create client `PATCH /clients/{id}` - Update client `POST /parties` - Create party `PATCH /parties/{partyId}` - Update party Response: `GET /clients/{id}` - Get client `GET /parties/{partyId}` - Get party
List document requests: documentRequests[].requirements[].`minRequired` Get document request: requirements[*].`minRequired`	Updated the minimum and default attributes to 0 to support optional items.	Response: `GET /document-requests` - List document requests `GET /document-requests/{id}` - Get document request
Update client (response-only), Create client, and Get client: parties[].individualDetails.addresses[].`state` parties[].organizationDetails.addresses[].`state` Update client (request-only): addParties[].individualDetails.addresses[].`state` addParties[].organizationDetails.addresses[].`state` Create party, Get party, and Update party: individualDetails.addresses[].`state` organizationDetails.addresses[].`state`	Field description updated to "The 2-3 character length state code should be provided in alpha-2 format, adhering to ISO-3166-2. State is mandatory in the US. In Great Britain, for example, the CIty of London would be LND. State would serve as Province in countries where applicable."	Request and response: `POST /clients` - Create client `PATCH /clients/{id}` - Update client `POST /parties` - Create party `PATCH /parties/{partyId}` - Update party Response: `GET /clients/{id}` - Get client `GET /parties/{partyId}` - Get party
Update client (response-only), Create client, and Get client: parties[].individualDetails.addresses[].`city` parties[].organizationDetails.addresses[].`city` Update client (request-only): addParties[].individualDetails.addresses[].`city` addParties[].organizationDetails.addresses[].`city` Create party, Get party, and Update party: individualDetails.addresses[].`city` organizationDetails.addresses[].`city`	Field description updated to "City has a maximum of 34 characters. City would serve as County in countries where applicable."	Request and response: `POST /clients` - Create client `PATCH /clients/{id}` - Update client `POST /parties` - Create party `PATCH /parties/{partyId}` - Update party Response: `GET /clients/{id}` - Get client `GET /parties/{partyId}` - Get party

Deprecated

The following fields are deprecated in the Digital Onboarding API specification version 1.0.16:

Deprecated fields in the Digital Onboarding API version 1.0.16
Field	Description	Endpoint
`attestations[*]`	Deprecated	Request and response: `POST /clients` - Create client Response: `GET /clients/{id}` - Get client `PATCH /clients/{id}` - Update client
Update client (response-only), Create client, and Get client: parties[].individualDetails.individualIds[].`description` parties[].individualDetails.individualIds[].`expiryDate` parties[].individualDetails.socialMedia[].`profilePlatform` parties[].individualDetails.socialMedia[].`username` parties[].organizationDetails.organizationIds[].`description` parties[].organizationDetails.organizationIds[].`expiryDate` parties[].organizationDetails.socialMedia[].`profilePlatform` parties[].organizationDetails.socialMedia[].`username` parties[].organizationDetails.`websiteAvailable` Update client (request-only): addParties[].individualDetails.individualIds[].`description` addParties[].individualDetails.individualIds[].`expiryDate` addParties[].individualDetails.socialMedia[].`profilePlatform` addParties[].individualDetails.socialMedia[].`username` addParties[].organizationDetails.organizationIds[].`description` addParties[].organizationDetails.organizationIds[].`expiryDate` addParties[].organizationDetails.socialMedia[].`profilePlatform` addParties[].organizationDetails.socialMedia[].`username` addParties[].organizationDetails.`websiteAvailable` Create party, Get party, and Update party: individualDetails.individualIds[].`description` individualDetails.individualIds[].`expiryDate` individualDetails.socialMedia[].`profilePlatform` individualDetails.socialMedia[].`username` organizationDetails.organizationIds[].`description` organizationDetails.organizationIds[].`expiryDate` organizationDetails.socialMedia[].`profilePlatform` organizationDetails.socialMedia[].`username` organizationDetails.`websiteAvailable`	Deprecated	Request and response: `POST /clients` - Create client `PATCH /clients/{id}` - Update client `POST /parties` - Create party `PATCH /parties/{partyId}` - Update party Response: `GET /clients/{id}` - Get client `GET /parties/{partyId}` - Get party
Create client, Get client, and Update client: parties[].validationResponse[].`comments` parties[].validationResponse[].`identities` Create party, Get party, and Update party: validationResponse[].`comments` validationResponse[].`identities`	Deprecated	Response: `POST /clients` - Create client `GET /clients/{id}` - Get client `PATCH /clients/{id}` - Update client `POST /parties` - Create party `GET /parties/{partyId}` - Get party `PATCH /parties/{partyId}` - Update party
Create client, Get client, and Update client: parties[*].`status` Create party, Get party, and Update party: `status`	Deprecated	Request and response: `PATCH /parties/{partyId}` - Update party Response: `POST /clients` - Create client `GET /clients/{id}` - Get client `PATCH /clients/{id}` - Update client `POST /parties` - Create party `GET /parties/{partyId}` - Get party

March 31, 2025

API Release v1.0.12

New

New Digital Onboarding API Specification

Digital onboarding release 1.0.12 changelog
Feature name	Description
API Specification	API specification version 1.0.12 was released with minor field description changes.

February 13, 2025

API Release v1.0.11

New

Digital onboarding changelog
Feature name	Description
API Specification	API specification version 1.0.11 was released.

New fields added to the API specification:

New fields for Digital Onboarding API
Field name	Description	Endpoint
preferences.defaultLanguage	Added default language preference.	POST /clients POST /parties
NetworkRegistration amexOptBlueServiceEstablishmentNumber	Added AMEX Opt Blue service establishment number.	POST /parties

Change

The following fields were updated in the API specification v1.0.11.

Field changes in the API specification. All changes affect endpoints POST /clients and POST /parties.

New fields for Digital Onboarding API
Field name	Description	Endpoint
roles	Added description for role values.	POST /clients POST /parties
email	Updated description with validation format.	POST /clients POST /parties
AddressDto addressLines	Updated description with validation details.	POST /clients POST /parties
AddressDto addressLines	Updated description with example.	POST /clients POST /parties
AddressDto postalCode	Added minimum length	POST /clients POST /parties
AddressDto country	Added minimum and maximum length.	POST /clients POST /parties
AddressDto country	Added minimum and maximum length.	POST /clients POST /parties
IndividualDetails firstName	Updated minimum length.	POST /clients POST /parties
IndividualDetails middleName	Updated minimum length.	POST /clients POST /parties
IndividualDetails lastName	Updated minimum length.	POST /clients POST /parties
IndividualDetails jobTitle	Added minimum and maximum length. Updated description with applicable roles.	POST /clients POST /parties
IndividualIdentity description	Added minimum and maximum length.	POST /clients POST /parties
IndividualIdentity issuer	Added minimum and maximum length.	POST /clients POST /parties
Phone countryCode	Updated description with validation format.	POST /clients POST /parties
Phone phoneNumber	Updated minimum and maximum length.	POST /clients POST /parties
OrganizationDetails industryCategory	Updated description with industry descriptor guide.	POST /clients POST /parties
OrganizationDetails industryType	Updated description with industry descriptor guide.	POST /clients POST /parties
OrganizationDetails organizationName	Added maximum length.	POST /clients POST /parties
OrganizationDetails organizationDescription	Updated minimum and maximum length.	POST /clients POST /parties
OrganizationIdentityDto description	Added minimum and maximum length.	POST /clients POST /parties
OrganizationIdentityDto value	Updated maximum length.	POST /clients POST /parties
OrganizationIdentityDto issuer	Updated minimum and maximum length.	POST /clients POST /parties

October 11, 2024

API Release v1.0.9

New features for Digital Onboarding API
Feature name	Description
Onboard a client	Support for Merchant Services US & Canada Added the ability to collect social media information from clients to pass it on to the risk engine for fraud assessment. Ability to consume customer device fingerprint token information (IP Address, Session Id) if it's captured by platform UI. Relaxed the requirement to collect related party ID values for Canada Merchant Services product. Updated Merchant Services product in Canada due diligence question to reflect Fintrac regulation change where Money Service Businesses include armored car services. Platform Level Enhancements Added option for clients to provide Utility Bill or Bank Statement as additional documents together with required identification documents to complete CIP manually. Added feature to close outstanding document requests with all parties and clients marked as approved upon KYC completion event being received. Technical enhancement that ensures SMBDO event processing is streamlined and only necessary events are sent out.
API specification	API specification version 1.0.9 was released.

August 13, 2024

API Release v1.0.5

New — First publication

New features for Digital Onboarding API
Feature name	Description
Merchant screening and Onboard a client	Use the Digital Onboarding API to add your clients to J.P. Morgan products. You can use the API to: Create a client record. Add parties related to your client’s account , such as beneficial owners and controllers. Perform due diligence procedures. Fulfill document requests for clients.
API specification	API specification version 1.0.5 was released.