Optimization Protection

Digital Onboarding changelog

November 24, 2025

API Release v1.0.18

New

New features for the Digital Onboarding API v1.0.18
Feature name	Description
API specification	Release of API specification version 1.0.18.

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

New fields for the Digital Onboarding API v1.0.18
Field	Description	Endpoint
OrganizationDetails.`isSubsidiary`	Indicate whether your organization is a subsidiary of a publicly traded company.	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
OrganizationDetails.`publiclyTraded`	Provide stock exchange and ticker symbol information for your organization as a publicly traded company. If your organization is a subsidiary of a publicly traded company, provide the details for your parent organization.

Change

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

Field changes for the Digital Onboarding API v1.0.18
Field	Description	Endpoint
AddressDto.`addressLines`	Updated the description to include virtual office and registered agent addresses as not allowed and added the statement, "The address has to be the principal place of business."	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
OrganizationDetails.`organizationType`	Added the following description: "This field specifies the legal structure or classification of the organization and identifies whether the entity is a Corporation, Sole Proprietorship, Non-Profit, or Government Body. Note: The values `PARTNERSHIP` and `PUBLICLY_TRADED_COMPANY` are deprecated and should not be used."
`OrganizationIndustryCategory` and `OrganizationIndustryType`	Updated the link in each description to the Industry Descriptor Reference.
AddressDto.`city`	Updated maximum length to 40 characters.

October 23, 2025

API Release v1.0.17

New

New features for the Digital Onboarding API v1.0.17
Feature name	Description
API specification	Release of API specification version 1.0.17.

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

New fields for the Digital Onboarding API v1.0.17
Field	Description	Endpoint
`consumerDevice`	Added support for the device fingerprint session ID.	Request and response: `POST /clients` Create client `PATCH /clients/{id}` Update client `POST /clients/{id}/verifications` Perform client verifications Response: `GET /clients/{id}` Get client

Change

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

Field changes for the Digital Onboarding API v1.0.17
Field	Description	Endpoint
`attestations`	Removed `deprecated` flag.	Request: `POST /clients` Create client
IndividualDetails.`firstName` IndividualDetails.`lastName`	Updated maximum length to 30.	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
IndividualIdentity.`value`	Updated description clarifies the length of the ID value.
OrganizationIdentityDto.`value`	Updated description clarifies the length of the ID value.

Deprecated

The following fields are deprecated as of the Digital Onboarding specification version 1.0.17:

Deprecated fields as of the Digital Onboarding API v1.0.17
Field	Description	Endpoint
attestations[*].`attesterFullName`	Deprecated.	Request and response: `POST /clients` Create client `PATCH /clients/{id}` Update client Response: `GET /clients/{id}` Get client
documentRequests[*].`documentType`	Deprecated.	Response: `GET /document-requests` List document requests
`documentType`	Deprecated.	Response: `GET /document-requests/{id}` Get document request

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 v1.0.16
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. Offboarding sets the `profileStatus` to `TERMINATED` for the party.
API specification	Released API specification version 1.0.16.

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

New fields for the Digital Onboarding API v1.0.16
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 v1.0.16
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 v1.0.16
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 as of the Digital Onboarding API specification version 1.0.16:

Deprecated fields in the Digital Onboarding API v1.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	Released API specification version 1.0.12 with minor field description changes.

February 13, 2025

API Release v1.0.11

New

Digital onboarding changelog v1.0.11
Feature name	Description
API Specification	Released API specification version 1.0.11.

New fields added to the API specification:

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

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 v1.0.11
Field name	Description	Endpoint
`roles`	Added description for role values.	`POST /clients` Create client `POST /parties` Create party
`email`	Updated description with validation format.
AddressDto.`addressLines`	Updated description with validation details and example.
AddressDto.`postalCode`	Added minimum length.
AddressDto.`country`	Added minimum and maximum length.
IndividualDetails.`firstName`	Updated minimum length.
IndividualDetails.`middleName`
IndividualDetails.`lastName`
IndividualDetails.`jobTitle`	Added minimum and maximum length. Updated description with applicable roles.
IndividualIdentity.`description`	Added minimum and maximum length.
IndividualIdentity.`issuer`	Added minimum and maximum length.
phone.`countryCode`	Updated description with validation format.
phone.`phoneNumber`	Updated minimum and maximum length.
OrganizationDetails.`industryCategory`	Updated description with industry descriptor guide.
OrganizationDetails.`industryType`	Updated description with industry descriptor guide.
OrganizationDetails.`organizationName`	Added maximum length.
OrganizationDetails.`organizationDescription`	Updated minimum and maximum length.
OrganizationIdentityDto.`description`	Added minimum and maximum length.
OrganizationIdentityDto.`value`	Updated maximum length.
OrganizationIdentityDto.`issuer`	Updated minimum and maximum length.

October 11, 2024

API Release v1.0.9

New features for Digital Onboarding API v1.0.9
Feature name	Description
Onboard a client	Support for Merchant Services US and 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	Released API specification version 1.0.9.

August 13, 2024

API Release v1.0.5

New — First publication

New features for Digital Onboarding API v1.0.5
Feature name	Description
Screening services 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	Released API specification version 1.0.5.