{"info":{"_postman_id":"8321c2b5-b77a-400a-94f4-5c296a853df1","name":"_ Certifer APIs by ZDHC Gateway _","description":"

Revolutionize your certification process today! 🌟

Say goodbye to manual product verification.

\n
With our innovative API, Certification Body can swiftly integrate certificates and product lists directly into the Formulator’s workflow.
\n

Streamline your operations and effortlessly create a approved certification list, eliminating the need for tedious verifications. 🚀✨

Simplify your journey to certification now! 🌟📈

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"26733334","collectionId":"8321c2b5-b77a-400a-94f4-5c296a853df1","publishedId":"2sA3kXEg9Y","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2D5CB9"},"publishDate":"2024-07-24T18:07:57.000Z"},"item":[{"name":"📜 API Documentation","item":[{"name":"🧪 What can I do?","item":[],"id":"31ae428d-ae64-47fe-832c-b56b11a3e672","description":"

If you wish to upload your ZDHC MRSL Certification information to ZDHC Gateway as part of auto-verified list, you can explore these APIs and build your own new workflows. Common workflows can be found here:

How to view the list of ZDHC MRSL Certification Standards under my organisation?
\n
How to add new ZDHC MRSL Certification information to a formulator's product/s?
\n
How to renew a ZDHC MRSL Certification information if it is already expired or about to expire?
\n
How to add more products to an existing ZDHC MRSL Certification information?
\n
How to remove a product under an existing ZDHC MRSL Certification information?
\n

\n","_postman_id":"31ae428d-ae64-47fe-832c-b56b11a3e672"},{"name":"➕ Benefits","item":[],"id":"fd87a9b1-ecd1-4ec9-af2d-ab3731fb06a1","description":"

As a ZDHC Approved MRSL Certifier you can now skip the manual verification process inside the ZDHC Gateway platform since the ZDHC MRSL Certification information you will POST is considered as auto-verified already
\n
Get email notification once POST processing is complete
\n
Get monthly summary report for each certification standard per formulator
\n
Increase data integrity for existing certificates
\n

\n","_postman_id":"fd87a9b1-ecd1-4ec9-af2d-ab3731fb06a1"},{"name":"🪐 Get Started","item":[],"id":"67ebcdb4-85db-4d9c-93bb-cb09a71e2353","description":"

Certifier APIs by ZDHC Gateway is a JSON-based OAuth2 API. All requests are made to endpoints beginning: https://www.my-aip.com/Gateway/rest/CertifierAPIv1/

All requests must be secure, i.e. https, not http.

Developer agreement

By using Certifier APIs by ZDHC Gateway, you agree to the terms and conditions found in your Third Party Service Contract with ZDHC Foundation.

\n $\"Authentication%20approach\"$ \n\n

accessToken will be the main key to autheticate the API transaction. It is consist of two parts:

AuthenticationKey - a key supplied to the Certifier to give permission to the set of APIs included in this document
\n
UserAccessKey - a key of a particular user of a Certification Body. This can be obtained by logging into ZDHC Gateway and navigating to user profile. The user must be an account admin and not just a viewer type.
\n

OAuth authentication

We offer 2 ways to acquire an access token:
/Gateway/rest/oauth/GetToken
Retrieve a token using authentication key and user login credentials for accessing the data.

/Gateway/rest/oauth/TokenByKey
Retrieve a token using authentication key and user access keys for accessing the data.

If assistance is needed, please reach out to gateway@zdhc.org.

\n","_postman_id":"67ebcdb4-85db-4d9c-93bb-cb09a71e2353"},{"name":"💻 Environments","item":[],"id":"81053f4c-eef4-49d8-b9ca-7901ff71cae3","description":"

Production - https://www.my-aip.com/Gateway/rest/CertifierAPIv1/
\n
BETA - https://beta.my-aip.com/Gateway/rest/CertifierAPIv1/
- UAT with Sample Data similar to PROD
\n

Testing

ZDHC Approved MRSL Certifiers may connect to BETA environment by using one of the ways to generate the token under the OAuth authentication.

\n","_postman_id":"81053f4c-eef4-49d8-b9ca-7901ff71cae3"},{"name":"📚Other Ways to Implement","item":[],"id":"a3be420f-1112-41ae-b259-6e88426ff32f","description":"

We understand that not all certifier have the ability to integrate these Certifier APIs into their own platform immediately or in the near future. So we have a couple of suggestions on how you will still be able to harness the power of this new set of APIs:

Using the PostMan Tool - TBC
\n
Using the Bulk Upload Page inside Gateway - TBC
\n

\n","_postman_id":"a3be420f-1112-41ae-b259-6e88426ff32f"},{"name":"📢 Recent Updates","item":[],"id":"802acb8a-bfc4-464b-97d8-b18220b4f83e","description":"

See Release History for further details.

Production: Current Version is TBC *pending launch April 1, 2025*
\n
BETA: Future Version is version 1.0 *to be available by Dec 2024-Jan 2025*
\n

See Documentation History for further details.

Updated Supporting APIs in BETA Section on Mar 16, 2025
\n
Added 'API Beta Only' in the Certifier API Project Process Flow on Jan 23, 2025
\n
Initial published to public on Jan 15, 2025
\n

\n","_postman_id":"802acb8a-bfc4-464b-97d8-b18220b4f83e"},{"name":"🦉References","item":[],"id":"4c0ba419-2361-4877-bf28-bdae120957d2","description":"

Key Concept

For discussion purposes, we will consider a certificate information to have two sections:

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Sections	Fields	Source
Certificate Header - Certificate information being issued to product(s)	Certifier ZDHC AID Certification Standard ID, ZDHC MRSL Version ID, Certificate Identifier (optional), Formulator ZDHC AID	Based on generated token GET/CertStandards GET/CertStandards Provided by the Certifier Provided by the Formulator or via GET/Formulators
Product Details - The Formulator's Product(s)	ZDHC PID, Certificate Issued Date and Certificate Expiration Date (validity period), Product Name, Local Language (formerly Other Names)	GET/FindProductMatch Provided by the Certifier Provided by the Formulator

Terminologies

Certification Body pertains to a third-party approved in accordance with the applicable version of ZDHC MRSL and ZDHC MRSL Conformance Guidance and which issues and/or confirms the validity of the certificates indicating the ZDHC MRSL Conformance Levels entered on the ZDHC Gateway. Also, known as Certifier in this documentation.
\n
Formulator refers to a person or business entity in the chemical industry involved in formulating, manufacturing, diluting, relabelling or mixing chemical products.
\n
A web-based platform hosting the ZDHC Gateway - Chemical Module and Wastewater Module. Also, referred to as Gateway or GW in this documentation.
\n
Auto-Verified Certificates is the list that is being maintained by a Certification Body via the Certifier APIs.
\n

\n","_postman_id":"4c0ba419-2361-4877-bf28-bdae120957d2"},{"name":"♻ Work Flow","item":[],"id":"af14e1a2-efdc-497c-abbc-965e5e8dc418","description":"

Right click then open image to enlarge

\n $\"High%20Level%20Process%20Flow\"$ \n\n

Using Gateway Platform, Bureau Account Admin configures Certification Body's records and provides permission to access the Certifier APIs.
\n
Still in Gateway Platform, Formulator Account Admin adds new product as \"Draft\" status. SDS and TDS file are optional at this point. Forward the new or existing product's detail to Certification Body outside GW during their application for a certificate.
\n
Certifier performs the actual certification on their end. Then using a Certifier Account Admin keys pushes the data via APIs. Gateway APIs will analyze and process the records. The Certifier will receive email notification once the process is completed. Inside Gateway, both Formulator and Certifier will receive a bell notification.
\n
Formulator Account Admin needs to accept new certificates before it is associated to their product. For updates on existing ones, the changes will be applied immediately after certifier posts it.
\n
If the SDS file is not yet available, Formulator Account Admin must upload or link the file first before publishing the product inside Gateway platform. TDS and Certificate file upload is optional.
\n

\n","_postman_id":"af14e1a2-efdc-497c-abbc-965e5e8dc418"},{"name":"💀 Error Codes","item":[],"id":"6ac2e167-683a-48a2-81d6-d0a8f3ce5fe9","description":"

For general technical errors in using API, refer to this article. - TBC
\n
For functionality errors, refer to each Certifier API error handling guide.
\n

\n","_postman_id":"6ac2e167-683a-48a2-81d6-d0a8f3ce5fe9"},{"name":"🤔 Need Help?","item":[],"id":"976f6699-0288-4dd7-9921-f98571f02988","description":"

The ZDHC Gateway team wants to ensure that your organisation has everything they need to successfully integrate our services into your applications and services. Don't hesitate to reach out to us via email gateway@zdhc.org.

\n
Is your team utilizing this API in a use case not represented here? We want to know about it! Add a comment with your suggestions and feedback!
\n

\n","_postman_id":"976f6699-0288-4dd7-9921-f98571f02988"}],"id":"b50bfa90-3f43-4f86-bba8-6e268df6fced","description":"

This document assumes that the reader is a ZDHC Approved MRSL Certifier or a member of an organisation categorized as a Certification Body.

\n
Certifier API Documentation helps consumers onboard to the Certifier APIs quickly. This contains a list of executable endpoints that API consumers can leverage and easily select the ones that best suit their needs.
\n

\n","_postman_id":"b50bfa90-3f43-4f86-bba8-6e268df6fced"},{"name":"⭐Current Version","item":[{"name":"Version 1.0","item":[{"name":"How to Maintain Records","item":[{"name":"CertStandards","id":"4241dcf1-8576-4684-9caf-900dda4349fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"accessToken","value":"{{token}}","description":"

Key to authenticate the API call using UserAccessKey and AuthenticationKey

\n","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{env}}.my-aip.com/Gateway/rest/CertifierAPIv1/CertStandards?IncludeInactive={True or False}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n

BETA Environment	PROD Environment
Available by Dec 2024 or Jan 2025	Target Release on April 1, 2025

When to use this API?

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

This can help a Certifier in the following scenarios:
I need to get the value for the CertStandardID before I call POST/CertToProducts
I need to get the value for the MRSLVersionID before I call POST/CertToProducts
I wish to view the active Certification Standards records under my organisation inside ZDHC Gateway
I wish to view all Certification Standards records under my organisation inside ZDHC Gateway including inactive ones
I wish to view details of each Certification Standards records under my organisation inside ZDHC Gateway
I wish to check which ZDHC MRSL Version is registered inside ZDHC Gateway under my Certification Standards

Limitations:

For non-Bureau, API will only return certification standards based on Certifier's valid token

GW Database:

SELECT Certification Standards

Responses

{\n    \"TotalCertStandards\": 2,\n    \"CertStandardsbyCertifier\": [\n        {\n            \"UpdateDate\": \"12-02-2024 21:26:23\",\n            \"CertStandardId\": \"3\",\n            \"CertStandardName\": \"Sample Certificate Standard - Level 3\",\n            \"IsActive\": true,\n            \"IsPrivate\": false,\n            \"CertificationBodyPhaseId\": 4,\n            \"CertificationGUID\": \"72X0801XX3620XX6X0530100007X4XX3\",\n            \"FileId\": 0,\n            \"FileName\": \"\",\n            \"IsAttachmentRequired\": true,\n            \"MRSLVersion\": [\n                {\n                    \"MRSLVersionID\": \"186\",\n                    \"MRSLVersionName\": \"ZDHC MRSL v3.1\",\n                    \"MRSLLevel\": \"Level 3\",\n                    \"CtZLevel\": \"Prov. Progressive\",\n                    \"IsSelfDeclarationRequired\": true,\n                    \"IsActive\": true\n                }\n            ]\n        },\n        {\n            \"UpdateDate\": \"08-16-2023 14:07:31\",\n            \"CertStandardId\": \"2\",\n            \"CertStandardName\": \"Sample Certificate Standard - Level 2\",\n            \"IsActive\": true,\n            \"IsPrivate\": false,\n            \"CertificationBodyPhaseId\": 4,\n            \"CertificationGUID\": \"Z07Z77Z4794Z640ZE0530100007Z60Z5\",\n            \"FileId\": 0,\n            \"FileName\": \"\",\n            \"IsAttachmentRequired\": true,\n            \"MRSLVersion\": [\n                {\n                    \"MRSLVersionID\": \"186\",\n                    \"MRSLVersionName\": \"ZDHC MRSL v3.1\",\n                    \"MRSLLevel\": \"Level 2\",\n                    \"CtZLevel\": \"Prov. Progressive\",\n                    \"IsSelfDeclarationRequired\": true,\n                    \"IsActive\": true\n                }\n            ]\n        }\n    ],\n    \"Meta\": {\n        \"Version\": \"1.0.0\",\n        \"ReleaseDate\": \"2024-11-07\"\n    },\n    \"Result\": {\n        \"Success\": true,\n        \"Message\": \"\"\n    }\n}\n\n

Error Handling

{\n    \"TotalCertStandards\": 0,\n    \"CertStandardsbyCertifier\": [],\n    \"Meta\": {\n        \"Version\": \"1.0.0\",\n        \"ReleaseDate\": \"2024-11-07\"\n    },\n    \"Result\": {\n        \"Success\": false,\n        \"Message\": \"(Refer to list below)\"\n    }\n}\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Message	How to Resolve
1. Invalid access key. You do not have the permission to call this API.	Make sure the AuthenticationKey you used has the permission to access the Certifier APIs from GW configuration.
2. Invalid organisation type. This API is only for certification body or certifier.	Make sure the UserKey is owned by an account admin user in GW that belongs to a Certification Body organisation type.
3. API Error.

","urlObject":{"protocol":"https","path":["Gateway","rest","CertifierAPIv1","CertStandards"],"host":["{{env}}","my-aip","com"],"query":[{"description":{"content":"

Optional | Boolean | Default is False; pass as True to include even the inactive records

\n","type":"text/plain"},"key":"IncludeInactive","value":"{True or False}"}],"variable":[]}},"response":[{"id":"c8bae24d-9a9c-478a-98df-b32dacada2d9","name":"Certifier retrieves Active Only","originalRequest":{"method":"GET","header":[{"key":"accessToken","value":"{ZDHC_api_token}","type":"text"}],"url":{"raw":"https://{{env}}.my-aip.com/Gateway/rest/CertifierAPIV1/CertStandards","protocol":"https","host":["{{env}}","my-aip","com"],"path":["Gateway","rest","CertifierAPIV1","CertStandards"],"query":[{"key":"CertifierID","value":"{CertifierID}","description":"Optional | Text | Mainly for Bureau Account Admin only","disabled":true},{"key":"IncludeInactive","value":"{IncludeInactive}","description":"Optional | Boolean | When you opt to view GW Certification Standards with Inactive records","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 10 Dec 2024 19:31:37 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"370"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000;includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"TotalCertStandards\": 1,\n \"CertStandardsbyCertifier\": [\n {\n \"UpdateDate\": \"12-10-2024 19:14:46\",\n \"CertStandardId\": \"302\",\n \"CertStandardName\": \"MRY Sample Certifier YYY - Level 3\",\n \"IsActive\": true,\n \"IsPrivate\": false,\n \"CertificationBodyPhaseId\": 1,\n \"CertificationGUID\": \"28F0477E8A7D5F9FE0630100007F2EFA\",\n \"FileId\": 0,\n \"FileName\": \"\",\n \"IsAttachmentRequired\": false,\n \"MRSLVersion\": [\n {\n \"MRSLVersionID\": \"186\",\n \"MRSLVersionName\": \"ZDHC MRSL v3.1\",\n \"MRSLLevel\": \"Level 3\",\n \"CtZLevel\": \"Prov. Progressive\",\n \"IsSelfDeclarationRequired\": true,\n \"IsActive\": true\n }\n ]\n }\n ],\n \"Meta\": {\n \"Version\": \"1.0.0\",\n \"ReleaseDate\": \"2024-11-07\"\n },\n \"Result\": {\n \"Success\": true,\n \"Message\": \"\"\n }\n}"},{"id":"e28fc620-c6cf-41a3-8071-c436b0db98a8","name":"Certifier retrieves including Inactive","originalRequest":{"method":"GET","header":[{"key":"accessToken","value":"{{token}}","type":"text"}],"url":{"raw":"https://{{env}}.my-aip.com/Gateway/rest/CertifierAPIV1/CertStandards?IncludeInactive=True","protocol":"https","host":["{{env}}","my-aip","com"],"path":["Gateway","rest","CertifierAPIV1","CertStandards"],"query":[{"key":"CertifierID","value":"{CertifierID}","description":"Optional | Text | Mainly for Bureau Account Admin only","disabled":true},{"key":"IncludeInactive","value":"True","description":"Optional | Boolean | When you opt to view GW Certification Standards with Inactive records"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 10 Dec 2024 19:33:35 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"449"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000;includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"TotalCertStandards\": 3,\n \"CertStandardsbyCertifier\": [\n {\n \"UpdateDate\": \"12-10-2024 19:30:23\",\n \"CertStandardId\": \"301\",\n \"CertStandardName\": \"MRY Sample Certifier YYY - Level 2\",\n \"IsActive\": false,\n \"IsPrivate\": false,\n \"CertificationBodyPhaseId\": 1,\n \"CertificationGUID\": \"28F04981E87B1E01E0630100007FB27B\",\n \"FileId\": 0,\n \"FileName\": \"\",\n \"IsAttachmentRequired\": false,\n \"MRSLVersion\": [\n {\n \"MRSLVersionID\": \"186\",\n \"MRSLVersionName\": \"ZDHC MRSL v3.1\",\n \"MRSLLevel\": \"Level 2\",\n \"CtZLevel\": \"Foundational\",\n \"IsSelfDeclarationRequired\": false,\n \"IsActive\": true\n }\n ]\n },\n {\n \"UpdateDate\": \"12-10-2024 19:30:06\",\n \"CertStandardId\": \"300\",\n \"CertStandardName\": \"MRY Sample Certifier YYY - Level 1\",\n \"IsActive\": false,\n \"IsPrivate\": false,\n \"CertificationBodyPhaseId\": 1,\n \"CertificationGUID\": \"28F0477E8A7C5F9FE0630100007F2EFA\",\n \"FileId\": 0,\n \"FileName\": \"\",\n \"IsAttachmentRequired\": false,\n \"MRSLVersion\": [\n {\n \"MRSLVersionID\": \"186\",\n \"MRSLVersionName\": \"ZDHC MRSL v3.1\",\n \"MRSLLevel\": \"Level 1\",\n \"CtZLevel\": \"Foundational\",\n \"IsSelfDeclarationRequired\": false,\n \"IsActive\": true\n }\n ]\n },\n {\n \"UpdateDate\": \"12-10-2024 19:14:46\",\n \"CertStandardId\": \"302\",\n \"CertStandardName\": \"MRY Sample Certifier YYY - Level 3\",\n \"IsActive\": true,\n \"IsPrivate\": false,\n \"CertificationBodyPhaseId\": 1,\n \"CertificationGUID\": \"28F0477E8A7D5F9FE0630100007F2EFA\",\n \"FileId\": 0,\n \"FileName\": \"\",\n \"IsAttachmentRequired\": false,\n \"MRSLVersion\": [\n {\n \"MRSLVersionID\": \"186\",\n \"MRSLVersionName\": \"ZDHC MRSL v3.1\",\n \"MRSLLevel\": \"Level 3\",\n \"CtZLevel\": \"Prov. Progressive\",\n \"IsSelfDeclarationRequired\": true,\n \"IsActive\": true\n }\n ]\n }\n ],\n \"Meta\": {\n \"Version\": \"1.0.0\",\n \"ReleaseDate\": \"2024-11-07\"\n },\n \"Result\": {\n \"Success\": true,\n \"Message\": \"\"\n }\n}"}],"_postman_id":"4241dcf1-8576-4684-9caf-900dda4349fd"},{"name":"FindProductMatch","id":"001e53a4-8844-4b36-9599-c914b4431858","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"accessToken","value":"{{token}}","description":"

Key to authenticate the API call using UserAccessKey and AuthenticationKey

\n","type":"text"}],"url":"https://{{env}}.my-aip.com/Gateway/rest/CertifierAPIv1/FindProductMatch?ZDHC_AID={ZDHC_AID}&ZDHC_PID={ZDHC_PID}&ProductName={productName}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n

BETA Environment	PROD Environment
Available by Dec 2024 or Jan 2025	Target Release on April 1, 2025

When to use this API?

\n\n\n\n\n\n\n\n\n\n\n\n\n\n

This can help a Certifier in the following scenarios:
I need to get the value for the ZDHC_PID before I call POST/CertToProducts
I need to validate that the ZDHC_PID provided by the Formulator is valid before I call POST/CertToProducts

Limitations:

API will return the product's exact match only within the Formulator's portfolio

GW Database:

SELECT Product Details

Responses

{\n    \"TotalProduct\": 1,\n    \"ZDHC_AID\": \"A395SR14\",\n    \"ZDHC_PID\": \"P115MY17\",\n    \"ProductName\": \"MRY-AAA Product One\",\n    \"LocalLanguage\": \"\",\n    \"ProductStatus\": \"Active\",\n    \"ProductVisibility\": \"Unpublished\",\n    \"Meta\": {\n        \"Version\": \"1.0.0\",\n        \"ReleaseDate\": \"2024-11-28\"\n    },\n    \"Result\": {\n        \"Success\": true,\n        \"Message\": \"\"\n    }\n}\n\n

\n\n

Error Handling

{\n    \"TotalProduct\": 0,\n    \"ZDHC_AID\": \"\",\n    \"ZDHC_PID\": \"\",\n    \"ProductName\": \"\",\n    \"LocalLanguage\": \"\",\n    \"ProductStatus\": \"\",\n    \"ProductVisibility\": \"\",\n    \"Meta\": {\n        \"Version\": \"1.0.0\",\n        \"ReleaseDate\": \"2024-11-28\"\n    },\n    \"Result\": {\n        \"Success\": false,\n        \"Message\": \"(Refer to the list below)\"\n    }\n}\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Message	How to Resolve
1. Invalid access key. You do not have the permission to call this API.	Make sure the AuthenticationKey you used has the permission to access the Certifier APIs from GW configuration.
2. Invalid organisation type. This API is only for certification body or certifier.	Make sure the UserKey is owned by an account admin user in GW that belongs to a Certification Body organisation type.
3. ZDHC_AID does not exist in ZDHC Gateway.	Double check with the Formulator if they provided the correct ZDHC Account ID or no input error. You may opt to use GET/Formulators to search for the ZDHC AID.
4. ZDHC_AID is already deactivated in ZDHC Gateway.	ZDHC AID is in ZDHC Gateway however it has been deactivated. Double check with the Formulator if they are an active organisation in GW or contact support for re-activation.
5. < ZDHC_PID or ProductName > does not exist in ZDHC Gateway.	Double check that the PID or Product Name is valid from your end. Otherwise, check with Formulator if they provided the correct info.
6. < ZDHC_PID or ProductName > does not exist in ZDHC_AID Portfolio in ZDHC Gateway.	Double check that the PID or Product Name is valid from your end. Otherwise, check with Formulator if they provided the correct info.
~~7. < ZDHC_PID or ProductName > is inactive in ZDHC_AID Portfolio in ZDHC Gateway.~~ - We are now including inactive products in search	~~Request Formulator to provide ZDHC_PID or ProductName that is in Active/Pending product status. Formulator can also generate a new ZDHC_PID with \"Draft\" product status.~~
8. < ZDHC_PID or ProductName > has invalid visibility in ZDHC_AID Portfolio in ZDHC Gateway.	The product exist in Formulator's portfolio but it has been discontinued or already archived. Request Formulator to provide ZDHC_PID or ProductName that is in published or unpublished visibility. Formulator can also generate a new ZDHC_PID with \"Draft\" product status and unpublished visibility.
API Error.

","urlObject":{"protocol":"https","path":["Gateway","rest","CertifierAPIv1","FindProductMatch"],"host":["{{env}}","my-aip","com"],"query":[{"description":{"content":"

Required | Text | Formulator’s GW Account ID

\n","type":"text/plain"},"key":"ZDHC_AID","value":"{ZDHC_AID}"},{"description":{"content":"

Optional | Text | To check if the PID provided exist under the Formulator’s AID

\n","type":"text/plain"},"key":"ZDHC_PID","value":"{ZDHC_PID}"},{"description":{"content":"

Optional if ZDHC PID is provided but Required if otherwise | Text | To search if the Product Name exist under the Formulator’s AID

\n","type":"text/plain"},"key":"ProductName","value":"{productName}"}],"variable":[]}},"response":[{"id":"90ae1b4b-57da-4091-b1ea-d4d2ddb7031c","name":"Success by PID Active Unpublished","originalRequest":{"method":"GET","header":[{"key":"accessToken","value":"{ZDHC_api_token}","type":"text"}],"url":{"raw":"https://{{env}}.my-aip.com/Gateway/rest/CertifierAPIV1/FindProductMatch?ZDHC_AID=A690QW60&ZDHC_PID=P351JQ73","protocol":"https","host":["{{env}}","my-aip","com"],"path":["Gateway","rest","CertifierAPIV1","FindProductMatch"],"query":[{"key":"ZDHC_AID","value":"A690QW60"},{"key":"ZDHC_PID","value":"P351JQ73"},{"key":"ProductName","value":"{ProductName}","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 10 Dec 2024 19:38:49 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"208"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000;includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"TotalProduct\": 1,\n \"ZDHC_AID\": \"A690QW60\",\n \"ZDHC_PID\": \"P351JQ73\",\n \"ProductName\": \"0240-TA\",\n \"LocalLanguage\": \"\",\n \"ProductStatus\": \"Active\",\n \"ProductVisibility\": \"Unpublished\",\n \"Meta\": {\n \"Version\": \"1.0.0\",\n \"ReleaseDate\": \"2024-11-28\"\n },\n \"Result\": {\n \"Success\": true,\n \"Message\": \"\"\n }\n}"},{"id":"cc824611-a7ae-4408-a4d3-d99e3be25732","name":"Success by PID Pending Unpublished","originalRequest":{"method":"GET","header":[{"key":"accessToken","value":"{{token}}","type":"text"}],"url":{"raw":"https://{{env}}.my-aip.com/Gateway/rest/CertifierAPIV1/FindProductMatch?ZDHC_AID=A690QW60&ZDHC_PID=P236PN90","protocol":"https","host":["{{env}}","my-aip","com"],"path":["Gateway","rest","CertifierAPIV1","FindProductMatch"],"query":[{"key":"ZDHC_AID","value":"A690QW60"},{"key":"ZDHC_PID","value":"P236PN90"},{"key":"ProductName","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 10 Dec 2024 19:45:49 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"213"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000;includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"TotalProduct\": 1,\n \"ZDHC_AID\": \"A690QW60\",\n \"ZDHC_PID\": \"P236PN90\",\n \"ProductName\": \"Product Nov 06-060\",\n \"LocalLanguage\": \"\",\n \"ProductStatus\": \"Pending\",\n \"ProductVisibility\": \"Unpublished\",\n \"Meta\": {\n \"Version\": \"1.0.0\",\n \"ReleaseDate\": \"2024-11-28\"\n },\n \"Result\": {\n \"Success\": true,\n \"Message\": \"\"\n }\n}"},{"id":"974d15d7-037e-4f99-a953-fec9e02570af","name":"Failed by PName Inactive Expired","originalRequest":{"method":"GET","header":[{"key":"accessToken","value":"{{token}}","type":"text"}],"url":{"raw":"https://{{env}}.my-aip.com/Gateway/rest/CertifierAPIV1/FindProductMatch?ZDHC_AID=A690QW60&ProductName=3422-CA","protocol":"https","host":["{{env}}","my-aip","com"],"path":["Gateway","rest","CertifierAPIV1","FindProductMatch"],"query":[{"key":"ZDHC_AID","value":"A690QW60"},{"key":"ZDHC_PID","value":"","disabled":true},{"key":"ProductName","value":"3422-CA"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 10 Dec 2024 19:43:50 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"218"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000;includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"TotalProduct\": 0,\n \"ZDHC_AID\": \"\",\n \"ZDHC_PID\": \"\",\n \"ProductName\": \"\",\n \"LocalLanguage\": \"\",\n \"ProductStatus\": \"\",\n \"ProductVisibility\": \"\",\n \"Meta\": {\n \"Version\": \"1.0.0\",\n \"ReleaseDate\": \"2024-11-28\"\n },\n \"Result\": {\n \"Success\": false,\n \"Message\": \"ProductName 3422-CA is inactive in ZDHC_AID A690QW60 Portfolio in ZDHC Gateway.\"\n }\n}"}],"_postman_id":"001e53a4-8844-4b36-9599-c914b4431858"},{"name":"CertToProducts","id":"60d77485-9358-496d-b9e5-3fe9b0faeb3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"accessToken","value":"{{token}}","description":"

Key to authenticate the API call using UserAccessKey and AuthenticationKey

\n","type":"text"}],"body":{"mode":"raw","raw":"\r\n [\r\n {\r\n \"CertIdentifier\": \"{{Certdentifier}}\",\r\n \"CertStandardID\": \"{{CertStandardID}}\",\r\n \"CertMRSLVersionID\": \"{{CertMRSLVersionID}}\",\r\n \"ZDHC_AID\": \"{{ZDHC_AID}}\",\r\n \"ZDHC_PID\": \"{{ZDHC_PID}}\",\r\n \"CertIssueDate\": \"{{certIssueDate}}\",\r\n \"CertExpirationDate\": \"{{certificateEndDate}}\",\r\n \"ProductName\": \"{{productName}}\",\r\n \"LocalLanguage\": \"{{LocalLanguage}}\"\r\n }\r\n ]\r\n","options":{"raw":{"language":"json"}}},"url":"https://{{env}}.my-aip.com/Gateway/rest/CertifierAPIv1/CertToProducts","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n

BETA Environment	PROD Environment
Available by Dec 2024 or Jan 2025	Target Release on April 01, 2025

When to use this API?

\n\n\n\n\n\n\n\n\n\n\n\n\n\n

This can help a Certifier in the following scenarios:
I have a newly issued certificate and I want to post in ZDHC Gateway
I have an existing certificate already issued in the past and I want to post the updates in ZDHC Gateway

Pre-requisites:

Use GET/CertStandards to get the correct value for CertStandardID parameter and CertMRSLVersionID
\n
Formulator's ZDHC AID should have been provided
\n
ZDHC PID for each product must have been validated through GET/FindProductMatch
\n
'CertIdentifier' field - Assign a unique Cert ID to a Product
\n
If the 'CertIdentifier' is the same for different products - you must pass the latest complete product list under the same 'CertIdentifier' every time you call POST/CertToProducts, regardless of your target action. ZDHC GW API will analyze and determine whether you are adding or modifying, or renewing a certificate for each product. And to refrain unintended removal of the certificate from the product/s.
\n

Limitations:

Maximum 2000 Products only per request
\n
CertIdentifier: Maximum of 100-character
\n

GW Database:

INSERT Certificate
\n
UPDATE Products
\n
INSERT Transaction Logs
\n

Responses

{\n    \"TotalValidIdentifiers\": 1,\n    \"TotalInvalidIdentifiers\": 0,\n    \"TotalIdentifiers\": 1,\n    \"TotalValidProducts\": 3,\n    \"TotalInvalidProducts\": 0,\n    \"TotalDuplicates\": 0,\n    \"TotalProducts\": 3,\n    \"Meta\": {\n        \"Version\": \"1.0.0\",\n        \"ReleaseDate\": \"2024-11-28\"\n    },\n    \"Result\": {\n        \"Success\": true,\n        \"Message\": \"1 of 1 Certificate(s) are accepted for processing: MRY.Certifier.YYY - 20241211 -C1. You will receive email notification once auto-verification is finished. \"\n    }\n}\n\n

\n\n

Error Handling

{\n}\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Message	How to Resolve
I. Permission Validations
1. Invalid access key. You do not have the permission to call this API.	Make sure the AuthenticationKey you used has the permission to access the Certifier APIs from GW configuration.
2. Invalid organisation type. This API is only for certification body or certifier.	Make sure the UserKey is owned by an account admin user in GW that belongs to a Certification Body organisation type.
3. Invalid identifier. Reach out to system admin to correctly setup your certification records.	Make sure you received confirmation from GW support team that they have completed the configuration of all the permission required for your organisation to start accessing the Certifier APIs.
II. Certificate Header Validations
1.Duplicate Unique ID. (value) already exist cannot be posted as new. Use renew instead.	You may have already used the Unique ID in the past. Use CertifierAPI/ViewPreapprovedCert to revisit the current record under this Unique ID and double check.
2.Invalid Parameter. UniqueID is required.	Supply a value of text with max. length of 1000. This is an essential parameter so make sure to provide a meaningful value that makes sense to your organisation as this will be used all throughout the lifetime of the certificate.
3.Invalid Parameter. CertificationStandardID is required.	Supply a value for this parameter. Use CertifierAPI/CertStandards to get the list of Certification Standards in GW for your organisation.
4.Invalid Parameter. CertificationStandardID (value) is inactive.	Double check value is still active in GW by using the returned set from GET CertifierAPI/CertStandards.
5.Invalid Parameter. CertificationStandardID (value) does not exist under this certifier.	Double check the value exist under your organisation in GW by using the returned set from GET CertifierAPI/CertStandards.
6.Invalid Parameter. Certificate Start Date must be less than End Date.	Make sure the dates are a valid from and to with sensible period in between. Usually this is a year apart.
7.Invalid Parameter. FormulatorID does not exist or already inactive.	Double check value is still active in GW
8.Invalid Parameter. CertIdentifier Exceeds the 50-character limit.	CertIdentifier should be 50 and below characters
III. Product Details Validations
1.Invalid product list. You need at least one product under this certificate.	Add product(s) detail under Products [] array to make this a valid call.
2.Product Name required	Supply a value of text with max. length of 1000.
3.Product Validity Start Date required	Supply a value of with dd-MM-yyyy format
4.Product Validity Start Date must be within Certificate dates	Supply a value within CertificateStartDate and CertificateEndDate
5.Product Validity Start Date must be less than End Date	Supply a value less than ValidityEndDate
6.Product Validity End Date must be within Certificate dates	Supply a value within CertificateStartDate and CertificateEndDate
IV. General Validations
Invalid Parameter. format must be dd-MM-yyyy.	Reformat the date value to follow the correct form.
Invalid Parameter.
API Error.

","urlObject":{"protocol":"https","path":["Gateway","rest","CertifierAPIv1","CertToProducts"],"host":["{{env}}","my-aip","com"],"query":[],"variable":[]}},"response":[{"id":"8b7ac064-2be0-467c-b9de-636b260e3a6a","name":"Success Added to Existing Single Product","originalRequest":{"method":"POST","header":[{"key":"accessToken","value":"{ZDHC_api_token}","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"CertIdentifier\": \"MRY.Certifier.YYY - 20241211 -C1\",\r\n \"CertStandardID\": \"302\",\r\n \"CertMRSLVersionID\": \"186\",\r\n \"ZDHC_AID\": \"A690QW60\",\r\n \"ZDHC_PID\": \"P351JQ73\",\r\n \"CertIssueDate\": \"01-12-2022\",\r\n \"CertExpirationDate\": \"30-11-2023\",\r\n \"ProductName\": \"\",\r\n \"LocalLanguage\": \"\"\r\n }\r\n]\r\n","options":{"raw":{"language":"json"}}},"url":"https://{{env}}.my-aip.com/Gateway/rest/CertifierAPIV1/CertToProducts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 10 Dec 2024 20:00:42 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"258"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000;includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"TotalValidIdentifier\": 1,\n \"TotalInvalidIdentifier\": 0,\n \"TotalIdentifier\": 1,\n \"TotalValidProducts\": 1,\n \"TotalInvalidProducts\": 0,\n \"TotalDuplicates\": 0,\n \"TotalProducts\": 1,\n \"Meta\": {\n \"Version\": \"1.0.0\",\n \"ReleaseDate\": \"2024-11-28\"\n },\n \"Result\": {\n \"Success\": true,\n \"Message\": \"1 of 1 Certificate(s) are accepted for processing: MRY.Certifier.YYY - 20241211 -C1. You will receive email notification once auto-verification is finished. \"\n }\n}"},{"id":"9c4eed4a-d2bf-453d-a2e1-553d7baa8b3a","name":"Success NEW Products with Renew","originalRequest":{"method":"POST","header":[{"key":"accessToken","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"CertIdentifier\": \"MRY.Certifier.YYY - 20241211 -C1\",\r\n \"CertStandardID\": \"302\",\r\n \"CertMRSLVersionID\": \"186\",\r\n \"ZDHC_AID\": \"A690QW60\",\r\n \"ZDHC_PID\": \"P351JQ73\",\r\n \"CertIssueDate\": \"01-12-2023\",\r\n \"CertExpirationDate\": \"30-11-2024\",\r\n \"ProductName\": \"\",\r\n \"LocalLanguage\": \"\"\r\n },\r\n {\r\n \"CertIdentifier\": \"MRY.Certifier.YYY - 20241211 -C1\",\r\n \"CertStandardID\": \"302\",\r\n \"CertMRSLVersionID\": \"186\",\r\n \"ZDHC_AID\": \"A690QW60\",\r\n \"ZDHC_PID\": \"P200DC72\",\r\n \"CertIssueDate\": \"01-12-2023\",\r\n \"CertExpirationDate\": \"30-11-2024\",\r\n \"ProductName\": \"\",\r\n \"LocalLanguage\": \"\"\r\n },\r\n {\r\n \"CertIdentifier\": \"MRY.Certifier.YYY - 20241211 -C1\",\r\n \"CertStandardID\": \"302\",\r\n \"CertMRSLVersionID\": \"186\",\r\n \"ZDHC_AID\": \"A690QW60\",\r\n \"ZDHC_PID\": \"P341XE64\",\r\n \"CertIssueDate\": \"01-12-2023\",\r\n \"CertExpirationDate\": \"30-11-2024\",\r\n \"ProductName\": \"\",\r\n \"LocalLanguage\": \"\"\r\n }\r\n]\r\n","options":{"raw":{"language":"json"}}},"url":"https://{{env}}.my-aip.com/Gateway/rest/CertifierAPIV1/CertToProducts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 10 Dec 2024 20:09:04 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"261"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000;includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"TotalValidIdentifier\": 1,\n \"TotalInvalidIdentifier\": 0,\n \"TotalIdentifier\": 1,\n \"TotalValidProducts\": 3,\n \"TotalInvalidProducts\": 0,\n \"TotalDuplicates\": 0,\n \"TotalProducts\": 3,\n \"Meta\": {\n \"Version\": \"1.0.0\",\n \"ReleaseDate\": \"2024-11-28\"\n },\n \"Result\": {\n \"Success\": true,\n \"Message\": \"1 of 1 Certificate(s) are accepted for processing: MRY.Certifier.YYY - 20241211 -C1. You will receive email notification once auto-verification is finished. \"\n }\n}"},{"id":"8baf09b8-f134-477c-86a1-66654c2e2c10","name":"Success Renew Products","originalRequest":{"method":"POST","header":[{"key":"accessToken","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"CertIdentifier\": \"MRY.Certifier.YYY - 20241211 -C1\",\r\n \"CertStandardID\": \"302\",\r\n \"CertMRSLVersionID\": \"186\",\r\n \"ZDHC_AID\": \"A690QW60\",\r\n \"ZDHC_PID\": \"P351JQ73\",\r\n \"CertIssueDate\": \"01-12-2024\",\r\n \"CertExpirationDate\": \"30-11-2025\",\r\n \"ProductName\": \"\",\r\n \"LocalLanguage\": \"\"\r\n },\r\n {\r\n \"CertIdentifier\": \"MRY.Certifier.YYY - 20241211 -C1\",\r\n \"CertStandardID\": \"302\",\r\n \"CertMRSLVersionID\": \"186\",\r\n \"ZDHC_AID\": \"A690QW60\",\r\n \"ZDHC_PID\": \"P200DC72\",\r\n \"CertIssueDate\": \"01-12-2024\",\r\n \"CertExpirationDate\": \"30-11-2025\",\r\n \"ProductName\": \"\",\r\n \"LocalLanguage\": \"\"\r\n },\r\n {\r\n \"CertIdentifier\": \"MRY.Certifier.YYY - 20241211 -C1\",\r\n \"CertStandardID\": \"302\",\r\n \"CertMRSLVersionID\": \"186\",\r\n \"ZDHC_AID\": \"A690QW60\",\r\n \"ZDHC_PID\": \"P341XE64\",\r\n \"CertIssueDate\": \"01-12-2024\",\r\n \"CertExpirationDate\": \"30-11-2025\",\r\n \"ProductName\": \"\",\r\n \"LocalLanguage\": \"\"\r\n }\r\n]\r\n","options":{"raw":{"language":"json"}}},"url":"https://{{env}}.my-aip.com/Gateway/rest/CertifierAPIV1/CertToProducts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 10 Dec 2024 20:26:09 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"261"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000;includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"TotalValidIdentifier\": 1,\n \"TotalInvalidIdentifier\": 0,\n \"TotalIdentifier\": 1,\n \"TotalValidProducts\": 3,\n \"TotalInvalidProducts\": 0,\n \"TotalDuplicates\": 0,\n \"TotalProducts\": 3,\n \"Meta\": {\n \"Version\": \"1.0.0\",\n \"ReleaseDate\": \"2024-11-28\"\n },\n \"Result\": {\n \"Success\": true,\n \"Message\": \"1 of 1 Certificate(s) are accepted for processing: MRY.Certifier.YYY - 20241211 -C1. You will receive email notification once auto-verification is finished. \"\n }\n}"}],"_postman_id":"60d77485-9358-496d-b9e5-3fe9b0faeb3a"}],"id":"1569b5ec-28a9-4a52-adb2-f400f9da66c3","description":"

Keep your Certificate Header up-to-date by calling these request:

\n\n

Pre-requisite:

For new products, Formulator must register the product in GW and save it under \"Draft\" status
\n
Formulator then forwards their ZDHC AID (Account ID) and Product Name, preferrably with its ZDHC PID (Product ID) for each products they wish to get certified regardless if new or existing Gateway Products to the Certifier
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Certifier Action	API Functionality	Purpose	Frequency
Retrieve latest Certification Standard List	GET/CertStandards	The IDs retrieved from here will be used for POST.	Periodically will suffice but you may opt to call before posting
Validate Product Details forwarded by the Formulator	GET/FindProductMatch	Retrieve the ZDHC PID or check if the PID provided is valid	Regulary before calling POST
Issue a new certificate with at least one product under it	POST/CertToProducts**	Insert the certificate record to product(s) as new++	Regularly
Renews an existing certificate	POST/CertToProducts**	Insert the certificate record to product(s) as renewal	Regularly
Adds new product into existing certificate	POST/CertToProducts**	Insert the certificate record to product(s) as new++	As needed
Removes existing product from an existing certificate	POST/CertToProducts** or POST/Remove CertFromProduct	Delete the certificate record from product(s)	As needed
Modify validity period of an existing certificate	POST/CertToProducts**	Update the certificate record from product(s)	As needed

** If the 'CertIdentifier' is the same for different products - you must pass the latest complete product list under the same 'CertIdentifier' every time you call POST/CertToProducts, regardless of your target action. ZDHC GW API will analyze and determine whether you are adding or modifying, or renewing a certificate for each product. And to refrain unintended removal of the certificate from the product/s.

++ If the certificate is being added to a product for the first time, an additional step is required from the Formulator before it appears under the product. The Formulator must be accept the new certificate first inside Gateway platform.

Process Flow

Right click then open image to enlarge

\n $\"Certifier%20API%20Project%20Process%20Flow\"$ \n\n

Availability of APIs as of 16 Mar 2025:

\n\n\n\n\n\n\n\n\n\n\n\n\n

BETA	PROD
GET/CertStandards GET/FindProductMatch POST/CertToProducts GET/CertProductList POST/RemoveCertFromProduct ------------ For Testing Purposes only as a Formulator POST/NewProducts POST/CertToProductsApproval GET/CertifierProducts	Target on 01 Apr 2025

","_postman_id":"1569b5ec-28a9-4a52-adb2-f400f9da66c3"},{"name":"How to View Records","item":[{"name":"CertProductList","id":"d064cdb2-3b4a-474b-8a7c-b62ef2663e37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"accessToken","value":"{{token}}","description":"

Key to authenticate the API call using UserAccessKey and AuthenticationKey

\n","type":"text"}],"url":"https://{{env}}.my-aip.com/Gateway/rest/CertifierAPIV1/CertProductList?ZDHC_AID={ZDHC_AID}&CertIdentifier={CertIdentifier}&CertStandardID={CertStandardID}&CertMRSLVersionID={CertMRSLVersionID}&IncludeExpiredCert={IncludeExpiredCert}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n

BETA Environment	PROD Environment
Available by Jan 2025	Target Release on April 01, 2025

When to use this API?

\n\n\n\n\n\n\n\n\n\n\n

This can help a Certifier in the following scenarios:
I wish to view product list to each certificate

Limitations:

API will only return auto based on Certifier's token

GW Database:

SELECT Auto-verified Certificates

Responses

{\n}\n\n

\n\n

Error Handling

{\n}\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Message	How to Resolve
1. Invalid access key. You do not have the permission to call this API.	Make sure the AuthenticationKey you used has the permission to access the Certifier APIs from GW configuration.
2. Invalid organisation type. This API is only for certification body or certifier.	Make sure the UserKey is owned by an account admin user in GW that belongs to a Certification Body organisation type.
3. API Error.

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"a1c91025-a5b7-4db1-a397-f4179cf10455","id":"a1c91025-a5b7-4db1-a397-f4179cf10455","name":"How to View Records","type":"folder"}},"urlObject":{"protocol":"https","path":["Gateway","rest","CertifierAPIV1","CertProductList"],"host":["{{env}}","my-aip","com"],"query":[{"description":{"content":"

Required | Text | Formulator's GW Account ID

\n","type":"text/plain"},"key":"ZDHC_AID","value":"{ZDHC_AID}"},{"description":{"content":"

Optional | Text | Unique Identifier of your Certificate such as Number or Product Code

\n","type":"text/plain"},"key":"CertIdentifier","value":"{CertIdentifier}"},{"description":{"content":"

Optional | Text | GW ID for the Certification Standard

\n","type":"text/plain"},"key":"CertStandardID","value":"{CertStandardID}"},{"description":{"content":"

Optional | Text | GW ID for the MRSL Version

\n","type":"text/plain"},"key":"CertMRSLVersionID","value":"{CertMRSLVersionID}"},{"description":{"content":"

Optional | Boolean | Default is False

\n","type":"text/plain"},"key":"IncludeExpiredCert","value":"{IncludeExpiredCert}"}],"variable":[]}},"response":[],"_postman_id":"d064cdb2-3b4a-474b-8a7c-b62ef2663e37"}],"id":"a1c91025-a5b7-4db1-a397-f4179cf10455","description":"

Now that you have build up your auto-verified certificate portfolio by using the POST request, you can revisit them and view them with these set of APIs.

","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"e56410d3-e135-4691-b089-78ff23e666c6","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"30cc2aaf-b5a0-4077-abe6-946814b50184","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"a1c91025-a5b7-4db1-a397-f4179cf10455"},{"name":"Supporting APIs in BETA","item":[{"name":"NewProducts","id":"0254d9c9-16ac-4c92-8878-4fc48149b8c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accessToken","value":"{{token}}","type":"text"}],"url":"https://beta.my-aip.com/TestAPI/rest/CertifierAPIBeta/NewProducts?ZDHC_AID={ZDHC_AID}&ProductCount={ProductCount}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n

BETA Environment	PROD Environment
Available by Mar 2025	Not applicable, for BETA Only

When to use this API?

\n\n\n\n\n\n\n\n\n\n\n\n\n\n

This can help a Certifier in the following scenarios:
I want to mimic a Formulator's action in the UI to create new a product
I want to mimic a Formulator's action in the UI to create new products in batch

Pre-requisites:

You need a Formulator's ZDHC Account ID (AID)

Notes:

This will auto-create new products, the default values would be

(ZDHC AID)-Product-(Counter)
\n
Draft Product Status
\n
Unpublished Visibility
\n
Substrate: Adhesives
\n
Category: Activators
\n
Type: Catalyst
\n

\n","urlObject":{"protocol":"https","path":["TestAPI","rest","CertifierAPIBeta","NewProducts"],"host":["beta","my-aip","com"],"query":[{"description":{"content":"

Required | String | Formulator's ZDHC Account ID (AID)

\n","type":"text/plain"},"key":"ZDHC_AID","value":"{ZDHC_AID}"},{"description":{"content":"

Required | Numeric | Number of Products you wish to auto-create

\n","type":"text/plain"},"key":"ProductCount","value":"{ProductCount}"}],"variable":[]}},"response":[{"id":"e10687d9-c852-4322-b8f5-4ee1ea849911","name":"Success Auto Create 25 Products","originalRequest":{"method":"POST","header":[{"key":"accessToken","value":"{{token}}","type":"text"}],"url":{"raw":"https://beta.my-aip.com/TestAPI/rest/CertifierAPIBeta/NewProducts?ZDHC_AID=A899RK58&ProductCount=25","protocol":"https","host":["beta","my-aip","com"],"path":["TestAPI","rest","CertifierAPIBeta","NewProducts"],"query":[{"key":"ZDHC_AID","value":"A899RK58","description":"Required | String | Formulator's ZDHC Account ID (AID)"},{"key":"ProductCount","value":"25","description":"Required | Numeric | Number of Products you wish to auto-create"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 16 Mar 2025 15:18:56 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"67"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=SkRmcFS4wHtjKBQ0i3oe8nRuApcq5B4K2UDgPv7Gj297pvALvJsAZRu0fWmkwCQTHfWPTGLHRTSY/PPaaoEqdRAwSh4bTP60p5e+OGFsVb/yR5W9MgdcATSvBbp4; Expires=Sun, 23 Mar 2025 15:18:45 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=SkRmcFS4wHtjKBQ0i3oe8nRuApcq5B4K2UDgPv7Gj297pvALvJsAZRu0fWmkwCQTHfWPTGLHRTSY/PPaaoEqdRAwSh4bTP60p5e+OGFsVb/yR5W9MgdcATSvBbp4; Expires=Sun, 23 Mar 2025 15:18:45 GMT; Path=/; SameSite=None; Secure"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000;includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"Result\": {\n \"Success\": true,\n \"Message\": \"\"\n }\n}"}],"_postman_id":"0254d9c9-16ac-4c92-8878-4fc48149b8c3"},{"name":"CertifierProducts","id":"582fc686-09d7-4638-9de9-f55ec5509dff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"accessToken","value":"{{token}}","type":"text"}],"url":"https://beta.my-aip.com/TestAPI/rest/CertifierAPIBeta/CertifierProducts?ZDHC_AID={ZDHC_AID}&ProductStatus={ProductStatus}&ReturnExcel={ReturnExcel}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n

BETA Environment	PROD Environment
Available by Mar 2025	Not applicable, for BETA Only

When to use this API?

\n\n\n\n\n\n\n\n\n\n\n

This can help a Certifier in the following scenarios:
I want to mimic a Formulator's action in the UI to view product portfolio in Draft

Pre-requisites:

You need a Formulator's ZDHC Account ID (AID)

Notes:

You may opt to return as an MS Excel file
\n
Use the ZDHC Product IDs (PID) in assigning your certificate information
\n

\n","urlObject":{"protocol":"https","path":["TestAPI","rest","CertifierAPIBeta","CertifierProducts"],"host":["beta","my-aip","com"],"query":[{"description":{"content":"

Required | String | Formulator's ZDHC AID

\n","type":"text/plain"},"key":"ZDHC_AID","value":"{ZDHC_AID}"},{"description":{"content":"

Optional | String |

\n","type":"text/plain"},"key":"ProductStatus","value":"{ProductStatus}"},{"description":{"content":"

Optional | Boolean | Default is False

\n","type":"text/plain"},"key":"ReturnExcel","value":"{ReturnExcel}"}],"variable":[]}},"response":[{"id":"eba44f70-72d8-4342-b5c8-81847173d3ba","name":"Success Retrieve Newly Created Products","originalRequest":{"method":"GET","header":[{"key":"accessToken","value":"{{token}}","type":"text"}],"url":{"raw":"https://beta.my-aip.com/TestAPI/rest/CertifierAPIBeta/CertifierProducts?ZDHC_AID=A899RK58","protocol":"https","host":["beta","my-aip","com"],"path":["TestAPI","rest","CertifierAPIBeta","CertifierProducts"],"query":[{"key":"ZDHC_AID","value":"A899RK58","description":"Required | String | Formulator's ZDHC AID"},{"key":"ProductStatus","value":"{ProductStatus}","description":"Optional | String |","disabled":true},{"key":"ReturnExcel","value":"{ReturnExcel}","description":"Optional | Boolean | Default is False","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 16 Mar 2025 15:20:35 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"446"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=Zr1MOQJVmVcDsR8ER0xl5pFxYHWIFa9F79VdozOWJbKUXgaH8DepzPn66XAjA6RRFkZvMRESLofNtjJn/UXtI4ghRD+LIQXpwCRxH+YbVDZ3wRMH9ihvSyvmnBln; Expires=Sun, 23 Mar 2025 15:20:35 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=Zr1MOQJVmVcDsR8ER0xl5pFxYHWIFa9F79VdozOWJbKUXgaH8DepzPn66XAjA6RRFkZvMRESLofNtjJn/UXtI4ghRD+LIQXpwCRxH+YbVDZ3wRMH9ihvSyvmnBln; Expires=Sun, 23 Mar 2025 15:20:35 GMT; Path=/; SameSite=None; Secure"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000;includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"CertifierProductsList\": [\n {\n \"ZDHCPID\": \"P798FW32\",\n \"ProductName\": \"A899RK58-Product-1\",\n \"Formulator\": \"MRY Demo Formulator 2025-0311\",\n \"ZDHCAID\": \"A899RK58\",\n \"CertificationStandard\": \"\",\n \"ProductStatus\": \"Draft\"\n },\n {\n \"ZDHCPID\": \"P323BN47\",\n \"ProductName\": \"A899RK58-Product-2\",\n \"Formulator\": \"MRY Demo Formulator 2025-0311\",\n \"ZDHCAID\": \"A899RK58\",\n \"CertificationStandard\": \"\",\n \"ProductStatus\": \"Draft\"\n },\n {\n \"ZDHCPID\": \"P383RB17\",\n \"ProductName\": \"A899RK58-Product-3\",\n \"Formulator\": \"MRY Demo Formulator 2025-0311\",\n \"ZDHCAID\": \"A899RK58\",\n \"CertificationStandard\": \"\",\n \"ProductStatus\": \"Draft\"\n },\n {\n \"ZDHCPID\": \"P798MC41\",\n \"ProductName\": \"A899RK58-Product-4\",\n \"Formulator\": \"MRY Demo Formulator 2025-0311\",\n \"ZDHCAID\": \"A899RK58\",\n \"CertificationStandard\": \"\",\n \"ProductStatus\": \"Draft\"\n },\n {\n \"ZDHCPID\": \"P140KR31\",\n \"ProductName\": \"A899RK58-Product-5\",\n \"Formulator\": \"MRY Demo Formulator 2025-0311\",\n \"ZDHCAID\": \"A899RK58\",\n \"CertificationStandard\": \"\",\n \"ProductStatus\": \"Draft\"\n },\n {\n \"ZDHCPID\": \"P938IQ10\",\n \"ProductName\": \"A899RK58-Product-6\",\n \"Formulator\": \"MRY Demo Formulator 2025-0311\",\n \"ZDHCAID\": \"A899RK58\",\n \"CertificationStandard\": \"\",\n \"ProductStatus\": \"Draft\"\n },\n {\n \"ZDHCPID\": \"P563BD97\",\n \"ProductName\": \"A899RK58-Product-7\",\n \"Formulator\": \"MRY Demo Formulator 2025-0311\",\n \"ZDHCAID\": \"A899RK58\",\n \"CertificationStandard\": \"\",\n \"ProductStatus\": \"Draft\"\n },\n {\n \"ZDHCPID\": \"P365HP61\",\n \"ProductName\": \"A899RK58-Product-8\",\n \"Formulator\": \"MRY Demo Formulator 2025-0311\",\n \"ZDHCAID\": \"A899RK58\",\n \"CertificationStandard\": \"\",\n \"ProductStatus\": \"Draft\"\n },\n {\n \"ZDHCPID\": \"P220SY26\",\n \"ProductName\": \"A899RK58-Product-9\",\n \"Formulator\": \"MRY Demo Formulator 2025-0311\",\n \"ZDHCAID\": \"A899RK58\",\n \"CertificationStandard\": \"\",\n \"ProductStatus\": \"Draft\"\n },\n {\n \"ZDHCPID\": \"P504SL73\",\n \"ProductName\": \"A899RK58-Product-10\",\n \"Formulator\": \"MRY Demo Formulator 2025-0311\",\n \"ZDHCAID\": \"A899RK58\",\n \"CertificationStandard\": \"\",\n \"ProductStatus\": \"Draft\"\n },\n {\n \"ZDHCPID\": \"P171FL41\",\n \"ProductName\": \"A899RK58-Product-11\",\n \"Formulator\": \"MRY Demo Formulator 2025-0311\",\n \"ZDHCAID\": \"A899RK58\",\n \"CertificationStandard\": \"\",\n \"ProductStatus\": \"Draft\"\n },\n {\n \"ZDHCPID\": \"P666KN48\",\n \"ProductName\": \"A899RK58-Product-12\",\n \"Formulator\": \"MRY Demo Formulator 2025-0311\",\n \"ZDHCAID\": \"A899RK58\",\n \"CertificationStandard\": \"\",\n \"ProductStatus\": \"Draft\"\n },\n {\n \"ZDHCPID\": \"P118DY30\",\n \"ProductName\": \"A899RK58-Product-13\",\n \"Formulator\": \"MRY Demo Formulator 2025-0311\",\n \"ZDHCAID\": \"A899RK58\",\n \"CertificationStandard\": \"\",\n \"ProductStatus\": \"Draft\"\n },\n {\n \"ZDHCPID\": \"P626DT47\",\n \"ProductName\": \"A899RK58-Product-14\",\n \"Formulator\": \"MRY Demo Formulator 2025-0311\",\n \"ZDHCAID\": \"A899RK58\",\n \"CertificationStandard\": \"\",\n \"ProductStatus\": \"Draft\"\n },\n {\n \"ZDHCPID\": \"P917HG62\",\n \"ProductName\": \"A899RK58-Product-15\",\n \"Formulator\": \"MRY Demo Formulator 2025-0311\",\n \"ZDHCAID\": \"A899RK58\",\n \"CertificationStandard\": \"\",\n \"ProductStatus\": \"Draft\"\n },\n {\n \"ZDHCPID\": \"P374FS94\",\n \"ProductName\": \"A899RK58-Product-16\",\n \"Formulator\": \"MRY Demo Formulator 2025-0311\",\n \"ZDHCAID\": \"A899RK58\",\n \"CertificationStandard\": \"\",\n \"ProductStatus\": \"Draft\"\n },\n {\n \"ZDHCPID\": \"P797KP19\",\n \"ProductName\": \"A899RK58-Product-17\",\n \"Formulator\": \"MRY Demo Formulator 2025-0311\",\n \"ZDHCAID\": \"A899RK58\",\n \"CertificationStandard\": \"\",\n \"ProductStatus\": \"Draft\"\n },\n {\n \"ZDHCPID\": \"P649PI60\",\n \"ProductName\": \"A899RK58-Product-18\",\n \"Formulator\": \"MRY Demo Formulator 2025-0311\",\n \"ZDHCAID\": \"A899RK58\",\n \"CertificationStandard\": \"\",\n \"ProductStatus\": \"Draft\"\n },\n {\n \"ZDHCPID\": \"P554PO59\",\n \"ProductName\": \"A899RK58-Product-19\",\n \"Formulator\": \"MRY Demo Formulator 2025-0311\",\n \"ZDHCAID\": \"A899RK58\",\n \"CertificationStandard\": \"\",\n \"ProductStatus\": \"Draft\"\n },\n {\n \"ZDHCPID\": \"P816AB90\",\n \"ProductName\": \"A899RK58-Product-20\",\n \"Formulator\": \"MRY Demo Formulator 2025-0311\",\n \"ZDHCAID\": \"A899RK58\",\n \"CertificationStandard\": \"\",\n \"ProductStatus\": \"Draft\"\n },\n {\n \"ZDHCPID\": \"P117EC62\",\n \"ProductName\": \"A899RK58-Product-21\",\n \"Formulator\": \"MRY Demo Formulator 2025-0311\",\n \"ZDHCAID\": \"A899RK58\",\n \"CertificationStandard\": \"\",\n \"ProductStatus\": \"Draft\"\n },\n {\n \"ZDHCPID\": \"P454AS44\",\n \"ProductName\": \"A899RK58-Product-22\",\n \"Formulator\": \"MRY Demo Formulator 2025-0311\",\n \"ZDHCAID\": \"A899RK58\",\n \"CertificationStandard\": \"\",\n \"ProductStatus\": \"Draft\"\n },\n {\n \"ZDHCPID\": \"P990AX97\",\n \"ProductName\": \"A899RK58-Product-23\",\n \"Formulator\": \"MRY Demo Formulator 2025-0311\",\n \"ZDHCAID\": \"A899RK58\",\n \"CertificationStandard\": \"\",\n \"ProductStatus\": \"Draft\"\n },\n {\n \"ZDHCPID\": \"P451BE51\",\n \"ProductName\": \"A899RK58-Product-24\",\n \"Formulator\": \"MRY Demo Formulator 2025-0311\",\n \"ZDHCAID\": \"A899RK58\",\n \"CertificationStandard\": \"\",\n \"ProductStatus\": \"Draft\"\n },\n {\n \"ZDHCPID\": \"P202RN51\",\n \"ProductName\": \"A899RK58-Product-25\",\n \"Formulator\": \"MRY Demo Formulator 2025-0311\",\n \"ZDHCAID\": \"A899RK58\",\n \"CertificationStandard\": \"\",\n \"ProductStatus\": \"Draft\"\n }\n ],\n \"Result\": {\n \"Success\": true,\n \"Message\": \"\"\n }\n}"},{"id":"b50cb377-b3ec-462c-8092-ac2eb804dfaa","name":"Success Retrieve Newly Created Products to Excel","originalRequest":{"method":"GET","header":[{"key":"accessToken","value":"{{token}}","type":"text"}],"url":{"raw":"https://beta.my-aip.com/TestAPI/rest/CertifierAPIBeta/CertifierProducts?ZDHC_AID=A899RK58&ReturnExcel=True","protocol":"https","host":["beta","my-aip","com"],"path":["TestAPI","rest","CertifierAPIBeta","CertifierProducts"],"query":[{"key":"ZDHC_AID","value":"A899RK58","description":"Required | String | Formulator's ZDHC AID"},{"key":"ProductStatus","value":"{ProductStatus}","description":"Optional | String |","disabled":true},{"key":"ReturnExcel","value":"True","description":"Optional | Boolean | Default is False"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 16 Mar 2025 15:27:31 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"6214"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=pE0hKXk/DRTqGsP26cbYQKlhD2puueUgRf9AqBscGD4k7JkRd0sr716RkfzkYJC9evVBLWxut6/a3JNy0zKqVNh5xAcwETIGjj845+5r8w6PLJex/EN/Y+d8Kt4r; Expires=Sun, 23 Mar 2025 15:27:31 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=pE0hKXk/DRTqGsP26cbYQKlhD2puueUgRf9AqBscGD4k7JkRd0sr716RkfzkYJC9evVBLWxut6/a3JNy0zKqVNh5xAcwETIGjj845+5r8w6PLJex/EN/Y+d8Kt4r; Expires=Sun, 23 Mar 2025 15:27:31 GMT; Path=/; SameSite=None; Secure"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000;includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"Excel\": \"UEsDBBQAAAAIAG97cFpJsbxgRQQAAJkWAAAYABwAeGwvd29ya3NoZWV0cy9zaGVldDEueG1sIKIYACigFAAAAAAAAAAAAAAAAAAAAAAAAAAAAI2YXY+jNhSG/wrivgPn8JFklWTVyXTUStvValO11wxxErQEI3Ay3fn1NUwWju3tkecKeIl5zOTlCV5//PdSBzfR9ZVsNiE8xGEgmlIequa0Ca/q+MsyDHpVNIeilo3YhN9FH37crl9l960/C6EC/fmm34RnpdoPUdSXZ3Ep+gfZikYnR9ldCqV3u1PUt50oDuOHLnWEcZxHl6JqwvcRPnQ+Y8jjsSrFkyyvF9Go90E6URdK0/fnqu3D7Xq8wt+VeO3JdqCKl72oRanEQU8zDIYJvEj5bQj/0If0vJVsP4mj2om63oS/6nPepLzsy6IWnwcEfRDimBzdD4N/Kr7L63iJTZjT9H72bUyacYAwiLbryOF7Hif4pQsO4lhca/VVvv4uqtNZ6SGy8MfRnaz/qQ7qvAlXD5DGOWbjcOMIT4UqtutOvgbdMLntuhw2hinoMYZ7ctvG6+imL17es0eagZntaIZm9kSzxMx+o1lqZs80y6Ys0swTOE7gSE7OLXCaLSxwmi0tcJqtLHCagXWnno0Qfo6eTOgJPdu6eY9GaN29XcLAJwx8wsEnHvDpBJ/Ss63/4KMRZhZ8ysCnDHzKwace8NkEn9Gz7W+NEdpfm4yBzxj4jIPPPODzCT6nZ1sMj0ZoQexyBj5n4HMOPveAX0zwC/q8sB80Rmg/aRYM/IKBX3DwCw/45QS/pHx2YY3QLuySgV8y8EsOfukBv5rgV5TPLqwR2oVdMfArBn7Fwa884CGe/RRTQruyZmp31kjtCRihPQMjdKZgpv83B+JYQ5Z2c83Urq6ROnMAbg7AzgF85jDrFqjiEueXgpE6vxU45wInXWCtCz7ahdm7QE2X2D02U7vIwKkXOPcCK1/wsS/M+gUqvMSus5nafQbOwMApGFgHg4+EYbYwUO8lTqeN1Ok0J2LgTAysisHHxTDLGKj+EqfTRup0mvMxcEIG1sjgo2SYnQzUgqnTaSN1Os1pGTgvAytm8DEzzGoGKsPU6bSROp3m7AycnoH1M/gIGmZDA3Vi6nTaSJ1Oc5IGztLAahp8PI2zp5E6MXVeyIzUeSXjPI2cp5H1NPp4GmdPo/FyanfaTO1OI+dp5DyNrKfRx9NIXoupEzO702ZqdxrZd2P25Zh/O/bxNM6eRurEzO60mdqdRs7TyHkaWU+jj6dx9jRSJ2Z2p83U7jRynkbO08h6Gn08jbOnkToxczptpE6nOU8j52lkPY0+nsbZ00idmDmdNlKn05ynkfM0sp5G1tMRWa5ri5P4s+hOVdMHtTiqYfVVy6W7r/wN20q249bK/AuDF6mUvPw8O4viIDRK/KBv51FKNe1E7xfdC3VtA9lVolHjyukmbGWnuqJSYdCTtcu2aEW3r97EuDx6rLpefdGf/3y9vAxjwnBM/SXvy5LxfffH2qXeP+uLvEl9lfqprcYjN9Gpqpz3S9lWoh/HGtZGp2Xl7X9QSwMEFAAAAAgAb3twWhT+k7R0AAAAjQAAACMAHAB4bC93b3Jrc2hlZXRzL19yZWxzL3NoZWV0MS54bWwucmVscyCiGAAooBQAAAAAAAAAAAAAAAAAAAAAAAAAAABNjEEOwiAQAL9C9m4XPRhjSvsHf7ChWyDShbBo9Pdy9DiZzMzr58jmzU1TEQfnyYJh8WVLEhy8+n66gdFOslEuwg6+rLAu84Mz9ZFoTFXNeIg6iL3XO6L6yAfpVCrLMHtpB/WBLWAl/6TAeLH2iu3/AQaXH1BLAwQUAAAACABve3BaH9kbh0kBAAA0AgAADwAcAHhsL3dvcmtib29rLnhtbCCiGAAooBQAAAAAAAAAAAAAAAAAAAAAAAAAAACNkMtuwjAQRfeV+g+W98UhCrRECUhVH+qmQi1lb+wJsfAjsh0ef99JAqjsurLnWnN8ZorF0WiyBx+UsyUdjxJKwAonld2W9Gf19vBESYjcSq6dhZKeINDF/P6uODi/2zi3IwiwoaR1jE3OWBA1GB5GrgGLL5Xzhkcs/ZaFxgOXoQaIRrM0SabMcGXpQMj9fxiuqpSAFydaAzYOEA+aR9QPtWoCRTdCikppWA9TEd40n9yg+1FTonmIr1JFkCXNsHQHuAl82zy3SnfFJJlQwgbeZdqlJ4iO4Jde7bk44cookVDxVscVWl8+xTzN0nR6BXTNawWH0Jd/iF1IuIhqDyu+KWlybWG3PUW/uTAfTmL7kb67Oyr02YfsdXyu8PIO5kvJ9HE2zrIOWbBzf89CZWVBdnsJ5/8wFVwLnLA7elaaTcazwadgF+H5L1BLAwQUAAAACABve3Ban0Qum+8AAADEAgAAGgAcAHhsL19yZWxzL3dvcmtib29rLnhtbC5yZWxzIKIYACigFAAAAAAAAAAAAAAAAAAAAAAAAAAAAK2STU7DMBCFr2LNnjhJK/5Utxsk1G3hApY9iaMmtuWZArk9pkikkQpikZX1njVvvhl7s/sYevGGibrgFVRFCQK9CbbzrYITNzf3IIi1t7oPHhWMSLDbbg7Ya84l5LpIImd4UuCY46OUZBwOmooQ0eebJqRBc5aplVGbo25R1mV5K9NlBswzxd4qSHtbgXgdI/4nOzRNZ/ApmNOAnq+0kOR0QvvCKQ9HOVinFlnBzC5yKgh5naZekoZzLU4UZ/ltVn9CrBZdCY89Xu7irH/v/4zDobP13UO1Xi/J8R7SkRwiTyg/1tfD5WPaipz9vu0nUEsDBBQAAAAIAG97cFpwrald9QEAAGoHAAAUABwAeGwvc2hhcmVkU3RyaW5ncy54bWwgohgAKKAUAAAAAAAAAAAAAAAAAAAAAAAAAAAAjZXbbptAEIZfZcW9A3uErWwiMHFtOXG3dqXWvUOwjpHM4rJL1b59SQ9pyySCS2bmn+MHzG+/1Rf0Vbe2aszCwzeBh7QpmrIyjwuvc6dZ5CHrclPml8bohfddW+82nlvrUK80duGdnbu+8X1bnHWd25vmqk3vOTVtnbv+sX307bXVeWnPWrv64pMgEH6dV8ZDRdMZt/BEX7Qz1ZdOL58NfYkqnrv4c7Zeqk029108959Mv8yqbcqucGiX13roW/Wlu0vumnboeUqWwGRL3brqVBW565eADj+nbcvXSvZ+11ngDWW0+kjJ0J5EUu63PJr9ls/wMOJhf0SZrhv0t29EAsJnAcUg+E+6gR35/0VlbX5yoENKaLpj4WiHYAZFI7pP8biSvrSVhyV7dYxnJQNKzILtno4rOVBKGm3e42BUKYCSC5pmcnxOEKGo4GslxrsdHi5WhASHIwG9AKWE3QbscB+CnUPiwCoUDvHqfsJZIIBKCLHdMTAHlEKMMI6yIx0/DIYcCSKyDxPYxRAkicP1WzHhxYQk0ZCtDhKkhFKIUijDrcLgaFAKWRJMqo2YsCYIE+dMveMTqkKaIiySVI5XJS/QhMO75YQNE0gT4yw5sPENE0iTlEHyacLLSiBNjOP0jo/jTyBN/Zd5v5si/Ycmv/9bxj8AUEsDBBQAAAAIAG97cFrS+FpBYAEAAAsDAAANABwAeGwvc3R5bGVzLnhtbCCiGAAooBQAAAAAAAAAAAAAAAAAAAAAAAAAAAClUk1rwzAM/SvG9zVtYWUbScouhcE2Cu1hVzexE4O/sJWS7NdPid20hcEOO1l6en5PspVve63ImfsgrSnoarGkhJvK1tI0Be1APDxREoCZmilreEEHHui2zAMMih9azoGggAkFbQHcS5aFquWahYV13GBFWK8ZYOqbLDjPWR3GS1pl6+Vyk2kmDS1zYQ0EUtnOAPaQADT5JmemEMGmsjI3TPMIvHrJ1IRlkTkdAe9JpWahNY1AmTsGwL3ZYUJSfBwcTmNwpqQzEf+gN54Nq/Xj7Y3pQOeT9TW+4u0QEZq4qVrmFVfqML7dl7jj9oKYTu80vNUFxXHHeS4hGqQwyqRk1L2Vi+L/12XOqWHvLfAK4lKgjpvzybcXyXz2nbq4s55RMn5cQT/HVcBf68XFtZMKpPltHBQFdsINu1NFVs0F6xQc52JBr/EHr2Wnn2fWXp4tJNY1fpdNC6tNdLzucfkDUEsDBBQAAAAIAG97cFpwho9vGwEAAAYCAAAQABwAZG9jUHJvcHMvYXBwLnhtbCCiGAAooBQAAAAAAAAAAAAAAAAAAAAAAAAAAACdkbFOwzAQhnck3iHy3jjtgFDlpIJWwMCAlLS7ZV8Si8S2bLdKno2BR+IVuCZK2ooNb/f/d5/v1/18fbNN1zbRCZxXRqdkGSckAi2MVLpKyb54WTySyAeuJW+MhpT04Mkmu79jH85YcEGBjxChfUrqEOyaUi9qaLmP0dbolMa1PGDpKmrKUgnYGXFsQQe6SpIHCl0ALUEu7AwkI3F9Cv+FSiPO+/lD0Vvk4b5RxJ6sbZTgAZNmr9A+my7OrQMufQ0QGL32hwFk5iCOToU+Sxi9Lgc/F7yBLf6TlbzxwOhFGPx3pT/93hZmxwNMPbfiyKm5A4n4mTMLg/+GIVxzntvWXFcgp76/xhT0MF40W67iBN8QbtLwePRyvewXUEsDBBQAAAAIAG97cFr5V7UL3gAAAHIBAAARABwAZG9jUHJvcHMvY29yZS54bWwgohgAKKAUAAAAAAAAAAAAAAAAAAAAAAAAAAAAbZDPSsNAEIfvgu8Q9p5MUkEkNO3NkwVBBa/L7Jguzf5hZzTts3nwkXwFN0GjYI/D75uPmd/n+8d6e3RD8UaJbfCdaqpaFeQxGOv7Tj093pY3qmDR3ugheOrUiVhtN5cXa4wthkT3KURKYomLbPLcYuzUXiS2AIx7cpqrTPgcvoTktOQx9RA1HnRPsKrra3Ak2mjRMAnLuBjVt9LgooyvaZgFBoEGcuSFoaka+GWFkuOzC3Pyh3RWTpHOoj/hQh/ZLuA4jtV4NaP5/gaed3cP86ul9VNXSGpqCP5VtPkCUEsDBBQAAAAIAG97cFopyyuV5QAAAE0CAAALABwAX3JlbHMvLnJlbHMgohgAKKAUAAAAAAAAAAAAAAAAAAAAAAAAAAAArZLNTsMwDIBfJfJ9dTckhNCyXXbZDaG9gEncH7WNo8SD7u0JF6DSmHbgGMf+/Nnydj9Po3nnlHsJFtZVDYaDE9+H1sJZm9UTmKwUPI0S2MKFM+x321ceSUtJ7vqYTWGEbKFTjc+I2XU8Ua4kcig/jaSJtDxTi5HcQC3jpq4fMf1mwJJpjt5COvoHMKdL5HvY0jS944O488RBr7RAnpWDZ7+KqdQn7css5kSpZbXgxb2UcEaKsSpoMHhdaXO/0t/j4sRKnpTQSeLbQl8ZN43W/7mkZcaPzjzih6ThTWT4lsHFGew+AVBLAwQUAAAACABve3BaQH0DjkAGAAArKAAAEwAcAHhsL3RoZW1lL3RoZW1lMS54bWwgohgAKKAUAAAAAAAAAAAAAAAAAAAAAAAAAAAA7VrNjxM3FL9X6v9gzR3yHbKIgDbZBFpYWO0GKo7OxMmY9YxHtrNLbhUcK1WqSqteKvXWQ9UWCaRe6F+zLVVLJf6FPk8+dsbjzGRRFha6Oawytn8/v/f8PuY5e+XaQ5+hAyIk5UHTKV0sOogELh/QYNR07va6FxoOkgoHA8x4QJrOhEjn2tWPP7qCLyuP+AQBPpCXcdPxlAovFwrShWEsL/KQBDA35MLHCh7FqDAQ+BB4fVYoF4v1go9p4KAA+0B7ZzikLkE9TekAPULzDToM/gRKRoPRsMvEnhvtHcc6swXRksF+afEYDciJbDOBDjBrOiDDgB/2yEPlIIalgommU4w+TuGYpZCkARKmclljjN3oYzDGKSI5ywajGPUXlKVudePSVkqmclKmLIZOp9PulFIyJBiw64J9Tc3iLNVuo9Qy5TBhC6YsedrFWrFqZ7LIVMlg2mi1WrUNK1MlzVTNYGoU69XNspWpmmaqZdmptdlu161MtTRTPYOpe2mjXrUz1eNMHqPBfgaP9umUDyZBABlydiOHqAFEDTM8DJweWsTmcbgOeaDy4tXHD7jowsKkCAwrGiA1CckQu4BsY78vKI6JES0jOLbGnHRlxqSWDUlX0FA1nU9DDPnoePHrFz+/fvEMvX7x9OjR86NHvx09fnz06NdMihs4GMUpXv341b/ff47+efbDqyff5CFlHPnnL1/88fvXeRAVh7z89ulfz5++/O7Lv396kgncFLgfB/aoTyS6TQ7RLvfBBpmbkr54U2zPwzSBxR5gMiEd5SUgtyeYZSNaJHkE9wQk5mzI9fGDhE57nhgrmgm56fkJyDbnrMVFjgFuakniBhgHozzRxDiO2MX4IFuytuFInXEIsZcOmiTIIwl1dhj4Fh6RgCik5/g+IZkE9ylNnNM2dQWXfKjQfYpamOaYs0f7yg6/QX048Um2+OBYCbtu30MtzrK33CIHSQyELmbZ2xCWOIzreKywn6MZ9lkccwsrL1uZvYlwEwcoFfjViDCOOgMiZTb6jpgk1LqJIUPnONk2m/hJjFB0PxtzC3Mex2zx/baH/TBHNxp4cdQnch8CB6MdrnJE5Mmo1s9wwjhYwbnuUaLeNGXdpSPP7ph6ZiyMipiuY7q40WC14sYoVLfz4rbe4rYJLwzZYW2WtHzEB1zItvA42CEQped17LyOndexZbqdhTqWn6dOWr2MQjXt8ebdW6yj83MbuiFlbE9NGLkljbInQd1BF6Zjw9OJiHLRcYYefE1qV7CjATsSOBpFgqvPqPL2PByCYCXH3GQkkwIthlHIJfTLjjG3XLLUwumVFQXzR6tqxn1SkhGrbT6YLqyYN08JfedbmzIXtNDLFano7denTOXSu1SmNCVdmzal2qraLDvEE2ozHTI9T78Dwhsg1jetpXp5qiTELmZkoH3X9P25k59R15ceHpCZ75dWNHCpcgru0liHt8S02ai8S23W4/xxdaorq7MkTt6C9xfzvT+qTrYyo5kDe/FhAToEC9TKNQe5OGw6Q+jC4Ksfwp5Sl2bMRkHTcZVIxY+9cJ3gIIxjWGZc4xCK1nXLj2BZlYyYQyHVFpbelDtaljI0C2w2K9eq+nxO22iFt6FLpVF6v3WZPtocnwyHxFV254/NmftPp6z1gY8VEXve4BD12VjsYrBTdRqrAyrhHbM8fxCQ96uzME7WoiXZy/yhwpblopWYhR6eVeRGRkqaEloiZaFD6kRsih+Pm7Y6PSNW3qoRs/L6uRHPjhFnuYUEpDJI28OF5ktgpHNH0+FCeRxqZOhRtyugabNqCtZAkPC0IRDTP/hrC5EDs97OZZrukN6ZQfeodukICQrVW3mCkB01s/wJNy6V7R1DlOJm26TzqMUk2lKhzUx9ckBYT+f9uj4zB3nzamZJ0EmGZU5sjBs5uD/q/u+73+rK3e+aWqyEItX19ovVzH4x9kq38S6VXnujUF71DMu1U24UQqw8pP/AixkVLiOm8LMbpx7fhZhEi9sXBAnnQmNWCBaDfbBVw6Kb3l5v8n613cduatPJel5n+JIm5n7Lmum0+61JnVNxv5rF+2zRv6rz6UFrgYnaYT9+V6tH0v9Cp1+k+g9Azi0yxGOmZGE+TB4qgdvzf+ABZj2zILn6H1BLAwQUAAAACABve3Bag6GfPkIBAACJBAAAEwAcAFtDb250ZW50X1R5cGVzXS54bWwgohgAKKAUAAAAAAAAAAAAAAAAAAAAAAAAAAAArZTPTgIxEMZfZdOr2RY8GGNYOKhXJdEXqO0s29B/aQeEZ/PgI/kKzhYhxhDAwGWb7cz3/b400359fI4mK2erJaRsgm/YkA9YBV4FbfysYQts61s2GY9e1xFyRa0+N6xDjHdCZNWBk5mHCJ4qbUhOIv2mmYhSzeUMxPVgcCNU8Agea+w92Hj0AK1cWKweV7S9wZKcVfebvh7VMBmjNUoilUWpir3CBDYfUC69/hOv/onGSVl6cmdivtoinukkktFQTWXCJ+nIT6yseA9pnjsAzKIsQ3448R5uaFujQAe1cCThOSaQupg5y3f+pwR5C2F+YX5ZuZPGHwuQO5lAv2Ci+cgXT/HL+2gQXFu4eIJiehBNymkKMQvinE2HfpI16DqSJSQ0p8JVSPB/+nb2e/WpSDpqpHsOm+/5g19sdkRRHpbxN1BLAQItABQAAAAIAG97cFpJsbxgRQQAAJkWAAAYAAAAAAAAAAAAAAAAAAAAAAB4bC93b3Jrc2hlZXRzL3NoZWV0MS54bWxQSwECLQAUAAAACABve3BaFP6TtHQAAACNAAAAIwAAAAAAAAAAAAAAAACXBAAAeGwvd29ya3NoZWV0cy9fcmVscy9zaGVldDEueG1sLnJlbHNQSwECLQAUAAAACABve3BaH9kbh0kBAAA0AgAADwAAAAAAAAAAAAAAAABoBQAAeGwvd29ya2Jvb2sueG1sUEsBAi0AFAAAAAgAb3twWp9ELpvvAAAAxAIAABoAAAAAAAAAAAAAAAAA+gYAAHhsL19yZWxzL3dvcmtib29rLnhtbC5yZWxzUEsBAi0AFAAAAAgAb3twWnCtqV31AQAAagcAABQAAAAAAAAAAAAAAAAAPQgAAHhsL3NoYXJlZFN0cmluZ3MueG1sUEsBAi0AFAAAAAgAb3twWtL4WkFgAQAACwMAAA0AAAAAAAAAAAAAAAAAgAoAAHhsL3N0eWxlcy54bWxQSwECLQAUAAAACABve3BacIaPbxsBAAAGAgAAEAAAAAAAAAAAAAAAAAAnDAAAZG9jUHJvcHMvYXBwLnhtbFBLAQItABQAAAAIAG97cFr5V7UL3gAAAHIBAAARAAAAAAAAAAAAAAAAAIwNAABkb2NQcm9wcy9jb3JlLnhtbFBLAQItABQAAAAIAG97cFopyyuV5QAAAE0CAAALAAAAAAAAAAAAAAAAALUOAABfcmVscy8ucmVsc1BLAQItABQAAAAIAG97cFpAfQOOQAYAACsoAAATAAAAAAAAAAAAAAAAAN8PAAB4bC90aGVtZS90aGVtZTEueG1sUEsBAi0AFAAAAAgAb3twWoOhnz5CAQAAiQQAABMAAAAAAAAAAAAAAAAAbBYAAFtDb250ZW50X1R5cGVzXS54bWxQSwUGAAAAAAsACwDRAgAA+xcAAAAA\",\n \"Result\": {\n \"Success\": true,\n \"Message\": \"\"\n }\n}"}],"_postman_id":"582fc686-09d7-4638-9de9-f55ec5509dff"},{"name":"CertToProductsApproval","id":"8abb6a20-d2b1-409e-beeb-2f63f2966e5f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accessToken","value":"{{token}}","type":"text"}],"url":"https://beta.my-aip.com/TestAPI/rest/CertifierAPIBeta/CertToProductsApproval?ZDHCPID={ZDHCPID}&CertStandardID={CertStandardID}&IsAccept={IsAccept}&IsDecline={IsDecline}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n

BETA Environment	PROD Environment
Available by Mar 2025	Not applicable, for BETA Only

When to use this API?

\n\n\n\n\n\n\n\n\n\n\n\n\n\n

This can help a Certifier in the following scenarios:
I want to mimic a Formulator's action in the UI to accept new certificate
I want to mimic a Formulator's action in the UI to decline new certificate

Pre-requisites:

You need:

a Formulator's ZDHC Product ID (PID)
\n
Certificate Standard ID that you wish to approve
\n

Notes:

Only NEW certificate needs to be accepted or declined

Limitations:

Accept or Decline product one at a time only
\n
The action is applied per Certificate Standard instead of a particular Certificate Number
\n

\n","urlObject":{"protocol":"https","path":["TestAPI","rest","CertifierAPIBeta","CertToProductsApproval"],"host":["beta","my-aip","com"],"query":[{"description":{"content":"

Required | String | Formulator's ZDHC Product ID

\n","type":"text/plain"},"key":"ZDHCPID","value":"{ZDHCPID}"},{"description":{"content":"

Required | Numeric | Certifier's Cert Standard ID

\n","type":"text/plain"},"key":"CertStandardID","value":"{CertStandardID}"},{"description":{"content":"

Required | Boolean | Default is False, True to Accept

\n","type":"text/plain"},"key":"IsAccept","value":"{IsAccept}"},{"description":{"content":"

Required | Boolean | Default is False, True to Decline

\n","type":"text/plain"},"key":"IsDecline","value":"{IsDecline}"}],"variable":[]}},"response":[{"id":"2fa28996-5e5e-432b-8e39-f7304965ba66","name":"Success Accept New Cert to a Product","originalRequest":{"method":"POST","header":[{"key":"accessToken","value":"{{token}}","type":"text"}],"url":{"raw":"https://beta.my-aip.com/TestAPI/rest/CertifierAPIBeta/CertToProductsApproval?ZDHCPID=P323BN47&CertStandardID=297&IsAccept=True&IsDecline=False","protocol":"https","host":["beta","my-aip","com"],"path":["TestAPI","rest","CertifierAPIBeta","CertToProductsApproval"],"query":[{"key":"ZDHCPID","value":"P323BN47","description":"Required | String | Formulator's ZDHC Product ID"},{"key":"CertStandardID","value":"297","description":"Required | Numeric | Certifier's Cert Standard ID"},{"key":"IsAccept","value":"True","description":"Required | Boolean | Default is False, True to Accept"},{"key":"IsDecline","value":"False","description":"Required | Boolean | Default is False, True to Decline"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 16 Mar 2025 16:06:27 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"60"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=rTp9d9Q3o9L+2xr8zB6S4lWeBvIYhVUAIIoTKx/inon0nUE5xWUYQcZFR4ud1afAKBdQHNExXy3dl9X8d9GxI2tJB3CB0RfD8O+nfAmK2lmWzmtmSZdJzUC7mJ3G; Expires=Sun, 23 Mar 2025 16:06:27 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=rTp9d9Q3o9L+2xr8zB6S4lWeBvIYhVUAIIoTKx/inon0nUE5xWUYQcZFR4ud1afAKBdQHNExXy3dl9X8d9GxI2tJB3CB0RfD8O+nfAmK2lmWzmtmSZdJzUC7mJ3G; Expires=Sun, 23 Mar 2025 16:06:27 GMT; Path=/; SameSite=None; Secure"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000;includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"Message\": \"\"\n}"}],"_postman_id":"8abb6a20-d2b1-409e-beeb-2f63f2966e5f"}],"id":"40b17da8-74a1-49f8-8846-1bd11553d35c","description":"

In Production, after Certifier POST a new Certificate Information, the Formulator needs to Accept or Decline it from their end.

To avoid delay on your testing we have added supporting APIs that will only be available in BETA so you can impersonate a Formulator's action. Through this supporting APIs you will be able to mimic the action of accept or decline.

Pre-requisite: You need the Formulator's ZDHC Account ID (AID)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Step	APIs
Mimic the Formulator by creating new products	POST/NewProducts
Mimic the Formulator by retrieving the list of products that was recently created	GET/CertifierProducts
As a Certifier, add your certificate to the products	Refer to How to Maintain Records
Mimic the Formulator by accepting or declining new certificate information to the product (Only NEW certificate needs to be accepted or declined)	POST/CertToProductsApproval
As a Certifier, continue to perform certificate information updates to the products	Refer to How to Maintain Records

","_postman_id":"40b17da8-74a1-49f8-8846-1bd11553d35c"}],"id":"0626b836-db11-4e31-a0ed-0870d9596b43","description":"

We are excited to announce the launch of API Version 1.0! This version marks the initial release of our API, designed to offer a robust and versatile platform for developers to integrate with our services. Here’s what you need to know about the new release:

\n\n\n\n\n\n\n\n\n\n\n\n\n

BETA Environment	PROD Environment
Available by Dec 2024 or Jan 2025	Target Release on April 01, 2025

New Features

1. Core Endpoints

Authentication: Secure access to API resources with our OAuth 2.0 implementation.
\n
Certificate Management: Create, update, and delete certificates with a set of RESTful endpoints.
\n
Data Retrieval: Access and query your data efficiently through our standardized query parameters.
\n

2. Enhanced Security

OAuth 2.0: Ensure secure access with our comprehensive authorization framework.

3. Comprehensive Documentation

Detailed Guides: Step-by-step tutorials and sample code to get you up and running quickly.

4. Error Handling

Standardized Error Codes: Clear and consistent error responses to help troubleshoot issues effectively.
\n
Error Messages: Descriptive messages to provide more context on errors.
\n

End Points

1. Environments

https://beta.my-aip.com/Gateway/rest/CertifierAPIv1/
\n
https://www.my-aip.com/Gateway/rest/CertifierAPIv1/
\n

2. Versioning

Versioning Strategy: Clearly defined versioning scheme to ensure compatibility and ease of updates.

Deprecations

None: As this is the initial release, there are no deprecated features or endpoints.

Known Issues

TBD, if any

How to Get Started

Obtain Your API Key: Connect to our admin support at gateway@zdhc.org. Provide the following:
- Organisation Name and ZDHC Account ID for your AuthenticationKey
- Indicate whether you wish to use an existing Account Admin user or
create a new one just for the API for your UserAccessKey.
\n
Follow the API Documentation: Use our comprehensive documentation to connect to the API and begin making requests.
\n
Need Assistance?: For support or inquiries, reach out to us at gateway@zdhc.org.
\n

We look forward to your feedback and are excited to see the innovative ways you'll use our new API. Happy coding!

\n","_postman_id":"0626b836-db11-4e31-a0ed-0870d9596b43"}],"id":"03a7acb3-eff4-4ef9-b9fd-cbf5f4577bc0","description":"

\n
This section allows you to work with the current APIs in the Production Environment. Watch out for the upcoming...
\n

✨ Launch this Q1 2025 for Version 1.0 🎉🎊

\n","_postman_id":"03a7acb3-eff4-4ef9-b9fd-cbf5f4577bc0"},{"name":"⌚Future Versions","item":[],"id":"f4ec1f9c-b643-4cac-80af-d68c1a432f0c","description":"

\n
This section allows you to work with upcoming versions in the BETA environment before the go-live.
\n

\n","_postman_id":"f4ec1f9c-b643-4cac-80af-d68c1a432f0c"},{"name":"⌛Past Versions","item":[],"id":"35ff1022-d244-420f-af95-262875f0dab2","description":"

\n
This section contains depracated versions and may no longer be accessible in Production. It serves as a historical document only.
\n

No past versions as of 2024 Dec 01.

\n","_postman_id":"35ff1022-d244-420f-af95-262875f0dab2"},{"name":"📒Release History","item":[],"id":"95926952-ce1f-4aa1-84ed-33cd1a9e526b","description":"

This contains the API version and release history in Production Environment:

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n

Version Number and Date	Release Notes
	Certifier API Initial Launch

","_postman_id":"95926952-ce1f-4aa1-84ed-33cd1a9e526b"},{"name":"📑Documentation History","item":[],"id":"32a2c2d0-ee68-49cf-ba4d-64a2e6571534","description":"

This contains list of updates in the API Documentation itself:

2025 Mar 16 - Updated Supporting APIs in BETA Section
\n
2025 Jan 23 -Added 'API Beta Only' in the Certifier API Project Process Flow
\n
2025 Jan 15 - Initial Published to public
\n

\n","_postman_id":"32a2c2d0-ee68-49cf-ba4d-64a2e6571534"},{"name":"🎥Demos and Tutorials","item":[],"id":"e64dce96-5ae4-4ea6-aadb-ecd293654021","description":"

This contain video recordings

","_postman_id":"e64dce96-5ae4-4ea6-aadb-ecd293654021"},{"name":"📝Notes","item":[],"id":"146aa11d-7809-4379-81e6-f94f60aa5e1c","description":"

Sources:

ZDHC Knowledge Base Articles
\n
Outsystems Swagger
\n
- version 1
\n
Images are designed by Freepik
\n
Some text are AI-generated
\n

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"ad5b8dad-87ca-4fed-9f48-bd30109a47ab","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"7b4a6ced-db2b-4ba8-95ea-ecc43cb88918","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"146aa11d-7809-4379-81e6-f94f60aa5e1c"}],"event":[{"listen":"prerequest","script":{"id":"77ea9063-86f7-4ef7-a478-7bc9bb3705bf","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"0d8c2724-40fb-4d7c-ad29-d8b6da8bd5c2","type":"text/javascript","packages":{},"exec":[""]}}]}

Revolutionize your certification process today! 🌟

OAuth authentication

Testing

Key Concept

Terminologies

Table of contents:

When to use this API?

Responses

When to use this API?

Responses

When to use this API?

Responses

Process Flow

When to use this API?

Responses

When to use this API?

When to use this API?

When to use this API?

New Features

1. Core Endpoints

2. Enhanced Security

3. Comprehensive Documentation

4. Error Handling

End Points

1. Environments

2. Versioning

Deprecations

Known Issues

How to Get Started

✨ Launch this Q1 2025 for Version 1.0 🎉🎊