Retrieving Supplier Certification List Using the Trading Partner Profile Certification API

Prerequisites

Context

The Trading Partner Profile Certification API allows you to retrieve a supplier's list of certifications from their company profile.

SAP Business Network uses a three-level hierarchy to organize supplier certifications: classification, certification type, and certification name. The classification is the highest level and includes the following seven categories:

  • Supplier Diversity: Certifications related to businesses that are owned, controlled, and operated by individuals who are part of historically underrepresented groups, such as women, minorities, LGBTQ+, veterans, and individuals with disabilities.

  • Environmental: Certifications related to businesses that demonstrate environmentally responsible practices, such as reducing waste, conserving energy, and reducing pollution.

  • Energy: Certifications related to businesses that promote energy efficiency and renewable energy sources, such as solar or wind power.

  • Social Enterprise: Certifications related to businesses that have a social or environmental mission and are committed to creating a positive impact in their communities.

  • Quality: Certifications related to businesses that demonstrate a commitment to quality management systems and processes.

  • Security: Certifications related to businesses that demonstrate a commitment to information security and risk management.

  • Other: Certifications that do not fit into the above categories.

The second level of the hierarchy is the certification type. Each classification includes several certification types. For example, the Supplier Diversity classification includes six certification types: Small Business, Women-owned Business, Minority-owned Business, Veteran-owned Business, LGBT-Owned Business, and Disability-Owned Business. The certification type further specifies the kind of certification a business has earned.

The lowest level of the hierarchy is the certification name. Each certification type includes different certifications. For example, Small Disadvantaged Business (SDB), 8(a) Business Development Program, and HUBZone (Historically Underutilized Business Zone Program) all fall into the Small Business type of certifications. Certification names provide more detailed information about the specific certification a business has earned.

Procedure

  1. To obtain the list of certifications of a supplier, use the following endpoint: 
    GET {{runtime_url}}/v1/certifications?tradingPartnerId={org-an-id}
    runtime_url
    Replace it with the desired runtime URL from the Environment Details table on the SAP Ariba Developer Portal discovery page for this API.
    org-an-id
    Replace it with the target supplier's ANID
    If the query is successful, the response includes the following certification information.
     

    Response Field

    Description

    Certification details

    id

    The UUID of the certification.

    certificationName

    Name of the certification, for example, "ISO 14001 Certified (Environmental Management)"

    certificationTypeName

    Specific type of the certification, for example "Environmental ISO". The certification type is used to manage certifications. Each certification type includes multiple certification names.

    certificationClassificationName

    Broader classification of the certification, for example "Environmental". The certification classification is used to manage certification types. Each certification classification includes multiple certification types.

    versions

    Different instances of the certification that a supplier has achieved. If a supplier has successfully passed a certification multiple times, they can include multiple instances of the certification to demonstrate their ongoing commitment and consistent adherence to the standards outlined in the certification process.

    Certification instance details

    id

    The UUID of a certification instance.

    certificationNumber

    A unique identifier associated with the certification.

    issueDate

    Date when the certification was issued.

    expirationDate

    Date when the certification expires.

    publicationYear

    Year when the certification was issued.

    issuerName

    Agency issuing the certification.

    issuerLocationName

    Location of the issuing agency.

    hasAttachment

    Whether the supplier has uploaded an attachment for the certification version.

    additionalInformation

    Any additional information provided by the supplier.

    status

    Indicates whether the certification has been verified by a third party or SAP Business Network.

    Value:

    • FOR_VERIFICATION: The certification is waiting for verification.

    		 
    {
    "certifications": [
        {
            "id": "9100c561-728f-427f-8b1d-f720ff460a82",
            "certificationName": "ISO 14001 Certified (Environmental Management)",
            "certificationTypeName": "Environmental ISO",
            "certificationClassificationName": "Environmental",
            "versions": [
                {
                    "id": "e82a6af1-35c5-4e20-8716-cfb497f1ebd8",
                    "certificationNumber": "14001",
                    "issueDate": "2023-10-08T16:00:00Z",
                    "expirationDate": "2023-12-28T16:00:00Z",
                    "publicationYear": 2015,
                    "issuerName": "ISO Council",
                    "issuerLocationName": "United States",
                    "hasAttachment": true,
                    "additionalInformation": "Certificated on Oct 9",
                    "status": "FOR_VERIFICATION"
                }
            ]
        },
        {
            "id": "bc6fecbc-f167-4ae3-843b-22837833d2d3",
            "certificationName": "WBENC (Women's Business Enterprise National Council)",
            "certificationTypeName": "Women-Owned Business",
            "certificationClassificationName": "Supplier Diversity",
            "versions": [
                {
                    "id": "499ce989-4ad9-4f98-a41f-ae44b1b41b09",
                    "certificationNumber": "200002018",
                    "issueDate": "2023-11-30T16:00:00Z",
                    "expirationDate": "2023-12-14T16:00:00Z",
                    "issuerName": "Women's Business Enterprise National Council",
                    "issuerLocationName": "United States",
                    "hasAttachment": true,
                    "additionalInformation": "Certificated on Dec 1 2023",
                    "status": "FOR_VERIFICATION"
                },
                {
                    "id": "37dea46c-872a-4731-a0e8-a7f03572c8af",
                    "certificationNumber": "200002017",
                    "issueDate": "2023-10-01T16:00:00Z",
                    "expirationDate": "2023-11-29T16:00:00Z",
                    "issuerName": "Women's Business Enterprise National Council",
                    "issuerLocationName": "United States",
                    "hasAttachment": false,
                    "additionalInformation": "Certificated on Oct 2",
                    "status": "FOR_VERIFICATION"
                }
            ]
        }
    ]
}

    If the query is unsuccessful, the response will include an error message. Refer to Error Messages Returned by the Trading Partner Profile Certification API for a list of specific error messages related to this API.

  2. Parse or format the response data as needed.