Accredible Evidence Items API
Supplemental work samples attached to a credential.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/accredible:accredible-evidence-items-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Accredible Credential Evidence Items API
version: 25.08.0
description: 'The Accredible Credential API allows you to create and interact with badges and certificates called Accredible Credentials. There are 3 main objects in Accredible: Credentials, Groups and Designs. ### Getting Started with the API - Video Walkthrough
# Objects Overview
## Credentials
Credentials are the core object in the API. They collect all of the data related to a course, training activity or achievement and the recipient/participant information. You should create a credential for each achievement completion that a recipient has. For example if John Doe finishes the Programming 101 course we should create one credential to represent that. If John Doe achieves something else then he would need a new credential. ## Groups
Groups represent an achievement such as a course or qualification. They contain information about the achievement and have multiple Credentials attached to them. For example you should create a group for the Introduction to Programming course. You''d provide the Course Name, Course Description and Course URL. In the future you can pass the name or ID of this group when creating a credential so that the credential is passed all the information relating to the achievement. ## Designs
Designs provide a visual specification for how a Credential should be rendered. Designs can be used across multiple Groups. For example if we have three courses: Intro to Basic Programming, Intro to Advanced Programming and Intro to DevOps each of these may have the same design for their Credentials. When creating or updating their corresponding Groups you would attach the desired design accordingly. ## Departments
Departments, if enabled for your account allow you to manage multiple, independent organization groups. Each Department is entirely separate with its own Designs, Groups, Branding, etc. You cannot share data between Departments except Billing and Administrators. ## Attributes
Attributes, are used to merge information with your badge or certificate designs and email templates. Attributes act as placeholders for information and can be added to certificate designs and email templates. ## Skills Frameworks
Skills Frameworks are structured taxonomies of skills — Accredible-maintained ones such as O*NET, ESCO and NACE, plus any your organization uploads itself. Tagging a Group against a framework version replaces the Group''s free-text `learning_outcomes` with skills that carry a stable identifier and a known position in a recognized taxonomy. For example, instead of listing `"Reading Books"` on your Introduction to Programming group, you can attach the O*NET skill `Reading Comprehension` together with the trail it sits on — Worker Requirements → Basic Skills → Content. Frameworks are read-only over the API: you discover the frameworks enabled for a department, search their skills, then select those skills when creating or updating a Group. Uploading and managing frameworks is done in the Accredible Dashboard. # API Keys
API keys are used as Authorization tokens in the header in all authenticated API endpoints. These Keys are managed in the Accredible Dashboard. There are two types of API Keys, those that are account wide and work on all assets and those that are related to a specific department. API keys scoped to a specific department can only access the resources (Credentials, Groups, Designs etc.) belonging to that department. # Single sign-on options
Single sign-on in addition to the student authentication provided by Accredible, you can also use single sign-on to authenticate your student into Accredible and they can directly sign-in. SSO is also available via our Integrations and via SAML 2.0. # Rate Limiting
We allow up to 2000 requests every 5 minutes from a single IP address, but some higher security endpoints have stricter rate limiting. Requests are counted in 30 second periods.'
servers:
- url: https://api.accredible.com/
description: Production environment - US
- url: https://eu.api.accredible.com/
description: Production environment - EU
- url: https://sandbox.api.accredible.com/
description: Sandbox environment - Testing environment
tags:
- name: Evidence Items
description: Resources related to EvidenceItems. EvidenceItems provide more information about how the recipient met the achievement. Typically this would include work samples for a course.
paths:
/v1/credentials/{credential_id}/evidence_items:
post:
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
evidence_item:
type: object
properties:
id:
type: number
description:
type: string
link_url:
type: string
preview_image_url:
type: string
type:
type: string
supplemental:
type: boolean
string_object: {}
position:
type: number
example:
evidence_item:
id: 1234
description: updated description
link_url: https://s3.amazonaws.com/accredible_api_evidence_items/files/44/original/1410743692307_Hours_Tracking.pdf
preview_image_url: https://www.example.com/1234/reportcard.png
type: url
supplemental: false
string_object: null
position: 1
summary: Create a New Evidence Item
operationId: CreateANewEvidenceItem
tags:
- Evidence Items
parameters:
- name: credential_id
in: path
description: Global ID of the credential in the form of an integer or string for the particular Credential requested.
required: true
schema:
type: string
requestBody:
content:
application/json:
example:
evidence_item:
description: Example file
file: https://s3.amazonaws.com/accredible_api_evidence_items/files/44/original/1410743692307_Hours_Tracking.pdf
category: file
schema:
type: object
properties:
evidence_item:
type: object
properties:
description:
type: string
description: Title text for the evidence item. This is displayed on a Credential.
category:
type: string
enum:
- file
- url
- video
- grade
- transcript
description: Type of Evidence Item added, must be one of [file, url, video, grade, transcript]. The type dictates how the item is displayed on the certificate.
url:
type: string
description: If the category is url or video, this should be the URL of Evidence Item.
file:
type: string
description: If the category is file, this should be the file's URL.
string_object:
type: string
description: If the category is grade or transcript then use it. For grade it will be just string 83.
preview:
type: string
description: By default if you add a URL category EvidenceItem, we take a screenshot to set the preview of this URL on Credential. You can overwrite this default behaviour by setting this preview field to be the URL of the desired image.
position:
type: number
description: The numeric position of the evidence item on the credential. 0 is displayed first in the list.
custom_insight:
type: string
description: The insights which will appear below Evidence Item, if not given it will be generated automatically based on data.
required:
- description
- category
security:
- ApiKeyAuth: []
x-code-samples:
- lang: cURL
label: cURL
source: "curl -X POST \\\n \"https://api.accredible.com/v1/credentials/12345/evidence_items\" \\\n -H \"Authorization: Token token=YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"evidence_item\": {\n \"description\": \"Example file\",\n \"file\": \"https://s3.amazonaws.com/accredible_api_evidence_items/files/44/original/1410743692307_Hours_Tracking.pdf\",\n \"category\": \"file\"\n }\n}'"
x-operation-id-source: normalized
x-operation-id-original: Create a New Evidence Item
/v1/credentials/{credential_id}/evidence_items/{evidence_item_id}:
get:
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
evidence_item:
type: object
properties:
id:
type: number
description:
type: string
link_url:
type: string
preview_image_url:
type: string
type:
type: string
supplemental:
type: boolean
string_object: {}
position:
type: number
example:
evidence_item:
id: 1234
description: updated description
link_url: https://s3.amazonaws.com/accredible_api_evidence_items/files/44/original/1410743692307_Hours_Tracking.pdf
preview_image_url: https://www.example.com/1234/reportcard.png
type: url
supplemental: false
string_object: null
position: 1
summary: View an Evidence Item
operationId: ViewAnEvidenceItem
tags:
- Evidence Items
parameters:
- name: credential_id
in: path
description: ID of the Credential in the form of an integer or string for the particular Credential requested.
required: true
schema:
type: string
- name: evidence_item_id
in: path
description: ID of the EvidenceItem in the form of an integer.
required: true
schema:
type: number
security:
- ApiKeyAuth: []
x-code-samples:
- lang: cURL
label: cURL
source: "curl -X GET \\\n \"https://api.accredible.com/v1/credentials/12345/evidence_items/1234\" \\\n -H \"Authorization: Token token=YOUR_API_KEY\""
x-operation-id-source: normalized
x-operation-id-original: View an Evidence Item
put:
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
evidence_item:
type: object
properties:
id:
type: number
description:
type: string
link_url:
type: string
preview_image_url:
type: string
type:
type: string
supplemental:
type: boolean
string_object: {}
position:
type: number
example:
evidence_item:
id: 1234
description: updated description
link_url: https://s3.amazonaws.com/accredible_api_evidence_items/files/44/original/1410743692307_Hours_Tracking.pdf
preview_image_url: https://www.example.com/1234/reportcard.png
type: url
supplemental: false
string_object: null
position: 1
summary: Update an Evidence Item
operationId: UpdateAnEvidenceItem
tags:
- Evidence Items
parameters:
- name: credential_id
in: path
description: ID of the Credential in the form of a string or integer for the particular Credential requested.
required: true
schema:
type: string
- name: evidence_item_id
in: path
description: ID of the Evidence Item in the form of an integer.
required: true
schema:
type: number
requestBody:
content:
application/json:
example:
evidence_item:
description: updated description
schema:
type: object
properties:
evidence_item:
type: object
properties:
description:
type: string
description: Title text for the evidence item. This is displayed on a Credential.
category:
type: string
enum:
- file
- url
- video
- grade
- transcript
description: Type of Evidence Item added, must be one of [file, url, video, grade, transcript]. The type dictates how the item is displayed on the Credential.
url:
type: string
description: If the category is url or video, this should be the URL of Evidence Item.
file:
type: string
description: If the category is file, this should be the file's URL.
string_object:
type: string
description: If the category is grade or transcript then use it. For grade it will be just string 83.
preview:
type: string
description: By default if you add a URL category EvidenceItem, we take a screenshot to set the preview of this URL on Credentials. You can overwrite this default behaviour by setting this preview field to be the URL of the desired image.
position:
type: number
description: The numeric position of the evidence item on the credential. 0 is displayed first in the list.
custom_insight:
type: string
description: The insights which will appear below Evidence Item, if not given it will be generated automatically based on data.
required:
- description
- category
security:
- ApiKeyAuth: []
x-code-samples:
- lang: cURL
label: cURL
source: "curl -X PUT \\\n \"https://api.accredible.com/v1/credentials/12345/evidence_items/1234\" \\\n -H \"Authorization: Token token=YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"evidence_item\": {\n \"description\": \"updated description\"\n }\n}'"
x-operation-id-source: normalized
x-operation-id-original: Update an Evidence Item
delete:
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
evidence_item:
type: object
properties:
id:
type: number
description:
type: string
example:
evidence_item:
id: 1234
description: Report card including all grades
summary: Delete an Evidence Item
operationId: DeleteAnEvidenceItem
tags:
- Evidence Items
parameters:
- name: credential_id
in: path
description: ID of the Credential in the form of a string or integer for the particular Credential requested.
required: true
schema:
type: string
- name: evidence_item_id
in: path
description: ID of the EvidenceItem in the form of an integer.
required: true
schema:
type: number
security:
- ApiKeyAuth: []
x-code-samples:
- lang: cURL
label: cURL
source: "curl -X DELETE \\\n \"https://api.accredible.com/v1/credentials/12345/evidence_items/1234\" \\\n -H \"Authorization: Token token=YOUR_API_KEY\""
x-operation-id-source: normalized
x-operation-id-original: Delete an Evidence Item
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: Authorization
description: 'Use the format: Token token=YOUR_API_KEY'
x-provenance:
method: harvested
publisher: Accredible
source: https://docs.api.accredible.com/openapi.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)