Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Accredible Credentials API

Issue, retrieve, update, delete, search, and verify digital credentials.

Accredible Credentials API is one of 10 APIs that Accredible publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Credentials. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 11 operations across 9 paths, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against 2 base URLs: https://api.accredible.com/v1, https://sandbox.api.accredible.com/v1.

11 operations 9 paths 5 schemas 1 DELETE4 GET5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.accredible.com/v1
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

Accredible Credentials API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (tokenAuth). By default, every request must be authenticated.

  • tokenAuth — API key sent in the Authorization header using the scheme Token token=YOURAPIKEY.

Paths & Operations 11

Across 9 paths, the API surfaces 11 operations — 1 DELETE, 4 GET, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Credentials 11

Issue, retrieve, update, delete, search, and verify digital credentials.

POST
/credentials
Create a credential
createCredential body → 200401
POST
/credentials/bulk_create
Bulk create credentials
bulkCreateCredentials body → 200401
GET
/credentials/{id}
View a credential
getCredential 1 param → 200401404
PUT
/credentials/{id}
Update a credential
updateCredential 1 param body → 200401
DELETE
/credentials/{id}
Delete a credential
deleteCredential 1 param → 200401
POST
/credentials/search
Search for credentials
searchCredentials body → 200401
GET
/all_credentialsdeprecated
View many credentials (deprecated)
listAllCredentials 5 params → 200401
POST
/credentials/generate_pdf
Generate PDFs for credentials
generateCredentialPdfs body → 200401
POST
/credentials/generate_single_pdf/{id}
Generate PDF for a single credential
generateSingleCredentialPdf 1 param → 200401
GET
/credentials/blockchain_data/{encoded_id}
Verify blockchain credential
getBlockchainCredential 1 param → 200404
GET
/issuer/credential_redirect
Redirect to a credential
credentialRedirect 2 params → 302

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are CredentialInput (11 properties), Recipient (3 properties), Error (2 properties), CredentialEnvelope (1 property). Each schema is shown below with its type and property counts.

Credential
CredentialInput
object
11 properties 1 required
CredentialEnvelope
object
1 property
Error
object
2 properties
Recipient
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

accredible-credentials-api-openapi.yml Raw ↑

Other APIs Accredible publishes across the network.

Accredible Analytics API
Accredible Departments API
Accredible Designs API
Accredible Evidence Items API
Accredible Groups API
Accredible Issuer API
Accredible References API
Accredible SSO API
Accredible Team Members API