CNH's Data Acknowledgement
This interface allows CNH to track the status of a dealer's consent regarding the Data Acknowledgement on CNH's data exchange platform (DEP). It is intended to be used within a Dealer's DMS, allowing dealers to express their agreement or disagreement with the acknowledgement document via DocuSign.
For any feature (such as workorders, SRT, telemetry, etc.) developed through DEP, this functionality will be included.
A prerequisite for this functionality is the dealer's consent to configure the Create Acknowledgement API on their system.
Interface currently available for DMS development in:- NAFTA
Version & Updates
| Version | Revision Date | Revision History |
|---|---|---|
| 1.0 | 4th Feb 2025 | New Release |
| 1.1 | 25th Jun 2025 | Corrected endpoint URL |
| 1.2 | 18th Jul 2025 | Provided DocuSign javascript SDK URL for both UAT and Prod |
Pre-requisites
- Dealer must use their Dealer Portal credentials to authorize API call
- Each DMS provider will have a Subscription key assigned by CNHi team, please reach out to dlnadmssupport@cnh.com for assistance
- Each Subscription key is unique to DMS and the environment it belongs to
- User within Ownership Group has accepted CNH's Data Acknowledgement (if located in NAFTA)
Authentication
- DMS will pass Basic auth in HTTP header with username/password
- Each DMS provider will have a subscription_key assigned by CNHi team, please reach out to dlnadmssupport@cnh.com for assistance
- The UserID and Password will be set up in the Dealer Portal by the Dealer uniquely for DMS access to interfaces
- DEP API will require subscription_key in HTTP header to identify client
How to Gain Access to the Data Acknowledgement
Whenever a DMS user (dealer) calls a DEP API, after completing the authentication process, the following steps are triggered based on the Ownership Group of the UserID:
DEP will check if the user has already agreed to the acknowledgment. Two scenarios are possible:
-
If any user within a specific Ownership Group has already agreed (state = AGREED), DEP will provide the requested data to the user.
-
If no one within the Ownership Group has agreed (either it’s the first time the feature is being called, or the agreement was previously declined by a user from the same group), DEP will return a message such as "user has not agreed to the acknowledgment." In this case, DMS should call another endpoint to retrieve the agreement URL. Then, DMS should display a popup with the acknowledgment, including options to agree or disagree.
a. Note: A user within the Ownership Group only needs to agree to it once
Data Acknowledgement API
API Format
- REST
The DEP takes care of the format transformations (as needed) to process the request and provide a response to the DMS system. New development for this interface are always recommended to the build to REST API for greater simplicity.
Connection Details
CNHi provides two environments:
- CERT / UAT
- Production
This DocuSign Create Acknowledgement can be triggered proactively to accept or agree to the acknowledgement, or it can be used when the below error response is encountered from any of the DEP APIs.
Data Acknowledgement 401 Error
Data Ack. Error
"statusCode": "401", "message": "Ownership Group has not accepted the Data Acknowledgement. Please review and accept the acknowledgement to gain access to the API result."s
Create Acknowledgement API
| Environment | URL | API | Request Type |
|---|---|---|---|
| CERT/UAT | https://{base_url}/external/services/createacknowledgement | REST | POST |
| Production | https://{base_url}/external/services/createacknowledgement | REST | POST |
No request parameters in Create Acknowledgement API.
If any user within a specific Ownership Group has agreed to Data Acknowledgement below would be the Response Description:| Name | Type | Description |
|---|---|---|
| statusCode | Int | API Response Status Code |
| Message | String | API Response Message |
| Name | Type | Description |
|---|---|---|
| clientUserId | String | Client User ID |
| agreementUrl | String | Agreement URL |
| createdOn | String | Agreement created date |
| Status | String | Status (Agreed / Created) |
| documentData | Object | Document Data |
| documentData.fullName | String | Full Name |
| documentData.email | String | |
| documentData.company | String | Company |
| documentData.date | String | Date |
Response Sample
Download Create Ack. JSON Sample ReponseNote:
- If the DMS uses a thick client or Windows-based application, copy the "agreementUrl" from the API response, then open it in a web browser to accept the Dealer Acknowledgment, which will appear as shown below.
- If the DMS uses a web-based application, refer the below DocuSign Click API JavaScript SDK URL and sample code to show acknowledgement popup or model dialog within application.
| Environment | DocuSign Click API JavaScript SDK |
|---|---|
| UAT/Cert | https://demo.docusign.net/clickapi/sdk/latest/docusign-click.js |
| Prod | https://na4.docusign.net/clickapi/sdk/latest/docusign-click.js |
Data Acknowledgement Content
The Data Exchange Platform (DEP) connects CNH’s systems to the Dealer Management Systems (DMS) that authorized dealers use to manage their dealerships (the “Program”). This includes managing Dealer Data, which is transmitted to CNH from a Dealer’s DMS. The goal of the Program is to enable unified services dedicated to improving dealer processes such as end-customer service and maintenance planning, advanced data driven marketing programs, proactive vehicle service alerts enablement, and better parts inventory management through the DEP. Under the Program, the Dealer would transmit Dealer Data to CNH through the DEP and CNH would process such Dealer Data in accordance with the terms and conditions of the Data Sharing Agreement signed between the Dealer and CNH.
Response Codes
| Status Code | Message |
|---|---|
| 200 | createacknowledgement API Response |
| 200 | Ownership Group has agreed to Data Acknowledgement |
| 400 | Bad Request |
| 404 | Unable to retrieve Ownership Group information |
| 500 | Internal Server Error |
| 401 | - Access denied due to invalid credentials! |
| 401 | - Access denied due to missing subscription key. Make sure to include a subscription key when making requests to an API. |