---
title: "API: getCertification"
slug: "api-getcertification"
updated: 2025-05-08T20:20:07Z
published: 2025-05-08T20:20:07Z
canonical: "support.smarteru.com/api-getcertification"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://support.smarteru.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API: getCertification

- Starting June 1, 2022, SmarterU will require all API calls to POST to HTTPS. Any POST to HTTP will result in the SU:01 error (i.e., No POST data detected.).
- If you are viewing the help in a language other than English, please change your language to English before copying and pasting any code. All API attributes and functions are in English.
- Tags are required unless specified.

## Description

The getCertification method retrieves a [certification's](/v1/docs/certifications) details.

## Who Has Access

The following users have access to the getCertification method:

- Users with the [Manage Learning Plans, Certifications, and Requirements](/v1/docs/account-permission-manage-learning-plans-certifications-and-requirements) account permission.
- [Administrators and owners](/v1/docs/user-profile-information#access-level).

## API Call XML Package

```markup
<SmarterU>
   <AccountAPI><![CDATA[]]></AccountAPI>
   <UserAPI><![CDATA[]]></UserAPI>
   <Method>getCertification</Method>
   <Parameters>
      <Certification>
         <Name><![CDATA[]]></Name>
            - OR -
         <ID><![CDATA[]]></ID>
      </Certification>
   </Parameters>
</SmarterU>
```

## Certification Tag Group

The Certification tag group is a container for the certification filters.

```markup
<Certification>
   <Name><![CDATA[]]></Name>
      - OR -
   <ID><![CDATA[]]></ID>
</Certification>
```

The Certification tag contains one of the following.

### Name

The [name of the certification](/v1/docs/certification-main#name) to get. This tag is mutually exclusive with the ID tag.

### ID

The certification's system-generated identifier. This tag is mutually exclusive with the [](https://help.smarteru.com/api-getcertification$certification_name)[Name tag](/v1/docs/api-getcertification#name).

This is not yet an ID that you can access through the SmarterU system. Please contact our [Success Desk](mailto:success@neovation.com) to request your IDs.

## API Response XML Package

The [API response XML package](/v1/docs/api-response-xml-package) will always include a Result, Info, and [Errors](/v1/docs/api-getcertification#error-codes) tag.

```markup
<SmarterU>
   <Result></Result>
   <Info>
      <Certification>
         <Name><![CDATA[]]></Name>
         <CertificationID><![CDATA[]]></CertificationID>
         <CreatedDate></CreatedDate>
         <ModifiedDate></ModifiedDate>
         <Description><![CDATA[]]></Description>
         <CertificationCompletionNotification><![CDATA[]]></CertificationCompletionNotification>

         <Roles>
            <Role>
               <ID></ID>
               <Name></Name>
            </Role>
         </Roles>

         <Requirements>
            <Requirement>
               <ID></ID>
               <Name><![CDATA[]]></Name>
               <MandateLevel></MandateLevel>
               <CompletionOverrideCount></CompletionOverrideCount>
               <OverrideEnabled></OverrideEnabled>
               <OverrideOption></OverrideOption>
               <StickyUntilDate></StickyUntilDate>
               <StickyWarningDate></StickyWarningDate>
               <SortOrder></SortOrder>
            </Requirement>
         </Requirements>
         <Status></Status>
      </Certification>
   </Info>

   <Errors>
      <Error>
         <ErrorID></ErrorID>
         <ErrorMessage></ErrorMessage>
      </Error>
   </Errors>
</SmarterU>
```

The certification is contained in a Certification tag and may contain the following.

### **Name**

The [certification's name](/v1/docs/certification-main#name).

### **CertificationID**

The certification's system-generated identifier.

### **CreatedDate**

The date that the certification was added.

### **ModifiedDate**

The date that the certification was last edited.

### **Description**

The [certification's description](/v1/docs/certification-main#description).

### CertificationCompletionNotification

Indicates whether an [email will be sent to a learner when they complete the certification](/v1/docs/certification-notifications#send-to-learner). Acceptable values are:

- *0* - The email notification is disabled.
- *1* - The email notification is enabled.

Indicates whether the certification's [](https://help.smarteru.com/certification-settings$setting_send_cert_completion_notification)[Send Certification Completion Notification setting](/v1/docs/certification-notifications#send-certification-completion-notification) is enabled (i.e., 0 = disabled; 1 = enabled).

### Roles

The Roles tag is a container for the [learning plans that include the certification](/v1/docs/assigning-certifications-to-a-learning-plan). Each learning plan is contained in a Role tag and contains the following.

| Tag | Description |
| --- | --- |
| **ID** | The [learning plan's user-defined identifier](/v1/docs/learning-plan-main#learning-plan-id). |
| **Name** | The [learning plan's name](https://support.smarteru.com/docs/learning-plan-main#name). |

### **Requirements**

The Requirements tag is a container for the [certification's requirements](/v1/docs/assigning-requirements-to-a-certification). Each requirement is contained in a Requirement tag and contains the following.

| Tag | Description |
| --- | --- |
| **ID** | The requirement's system-generated identifier. |
| **Name** | The [requirement's name](/v1/docs/requirement-main#name). |
| **MandateLevel** | The [requirement's mandate level](/v1/docs/assigning-requirements-to-a-certification#mandate-level). Acceptable values are: - *Mandatory* - The requirement is required for the certification. - *Recommended* - The requirement is not required, but recommended for the certification. If you select this option, you can specify the minimum number of courses, credentials, or tasks that need to be completed for the requirement. This is particularly helpful for managing electives as part of the certification process. - *Optional* - The requirement is optional for the certification. If you select this option, you can specify the minimum number of courses, credentials, or tasks that need to be completed for the requirement. This is particularly helpful for managing electives as part of the certification process. |
| **CompletionOverrideCount** | The [minimum number of requirement blocks](/v1/docs/assigning-requirements-to-a-certification#learner-must-complete-at-least-n-requirement-items) a learner must complete. |
| **OverrideEnabled** | Indicates whether the [requirement's expiration status is overridden](/v1/docs/assigning-requirements-to-a-certification#settings-override-expiration-status). Acceptable values are: - *0* - The expiration status is not overridden. - *1* - The expiration status is overriden. |
| **OverrideOption** | Indicates the [requirement's expiration override option](/v1/docs/assigning-requirements-to-a-certification#extend-expiration-date-options). Acceptable values are: - *Permanent* - The requirement's expiration status is overridden indefinitely. - *Sticky* - The requirement's expiration status is overridden for the specified period of time. You can use this option to either extend the length of time users' certifications have a Met status, or force a status change on a requirement that doesn't expire. |
| **StickyUntilDate** | The [date that the requirement will expire](/v1/docs/assigning-requirements-to-a-certification#extend-expiration-date-options). |
| **StickyWarningDate** | The [date that the requirement status will change to Warning](/v1/docs/assigning-requirements-to-a-certification#extend-expiration-date-options). |
| **SortOrder** | The position of this requirement in relation to other requirements assigned to the certification. |

### **Status**

The [certification's status](/v1/docs/certification-main#status).

### Example API Response XML Package

Below is an example of an API response XML package.

```markup
<SmarterU>
   <Result>Success</Result>
   <Info>
      <Certification>
         <Name><![CDATA[Forklift Operation]]></Name>
         <CertificationID><![CDATA[10222]]></CertificationID>
         <CreatedDate>2018-03-21 21:35:56.22</CreatedDate>
         <ModifiedDate>2018-05-29 17:17:29.787</ModifiedDate>
         <Description><![CDATA[Forklift operator certification]]></Description>
         <CertificationCompletionNotification><![CDATA[1]]></CertificationCompletionNotification>

         <Roles>
            <Role>
               <ID/>
               <Name>Forklift Operator</Name>
            </Role>

            <Role>
               <ID/>
               <Name>Manufacturing Floor Manager</Name>
            </Role>
         </Roles>

         <Requirements>
            <Requirement>
               <ID>14672</ID>
               <Name><![CDATA[Forklift Operator]]></Name>
               <MandateLevel>Mandatory</MandateLevel>
               <CompletionOverrideCount/>
               <OverrideEnabled>0</OverrideEnabled>
               <OverrideOption>None</OverrideOption>
               <StickyUntilDate/>
               <StickyWarningDate/>
               <SortOrder>1</SortOrder>
            </Requirement>
         </Requirements>
         <Status>Active</Status>
      </Certification>
   </Info>

   <Errors>
   </Errors>
</SmarterU>
```

## **Error Codes**

| Error Code | Message |
| --- | --- |
| GC:01 | The name provided is invalid. |
| GC:02 | The ID provided is invalid. |
| GC:03 | The required permissions are not met to call the getCertification method. |
| GC:04 | The requested Certification does not exist. |
| GC:05 | Certification name and ID not provided. You must provide a Name or ID. |

## Related

- [API: createCertification](/api-createcertification.md)
- [API: listCertifications](/api-listcertifications.md)
- [API: updateCertification](/api-updatecertification.md)
- [Assigning Requirements to a Certification](/assigning-requirements-to-a-certification.md)
- [Certifications](/certifications.md)
- [Learning Plans](/learning-plans.md)
- [Requirements](/requirements.md)