LogoLogo
Back to All
  • TNG Identity user documentation
  • 📑INTRODUCTION
    • Introduction to TNG Identity
    • Why choose TNG Identity?
      • DID differentiators
    • How does TNG Identity work?
      • Data flows
      • Use cases and applications
    • Standards and regulations
    • Portal API
      • Overview
      • Getting Started
      • API Documentation
        • App
        • Auth
        • Mail
        • Organisation Profiles
        • User Profiles
        • PSP > Product Manager > Customer User Api Key
        • PSP > Product Manager > User Manager
  • 📄TNG Identity Issuers
    • What is an issuer?
    • How to become an issuer?
    • Operating an issuer
    • What do issuers do?
    • Issuer API
      • Overview
      • Getting Started
      • Examples
        • Issue an email credential
        • Revoke a claimed email credential
      • API Documentation
        • Info
        • Auth
        • Media
        • Credential Offer Claims
        • Credential Offer Collections
        • Credential Offers
        • Credential Templates
        • Claim
        • Agent
  • 📑TNG IDENTITY VERIFIER
    • What is a Verifier?
    • Operating a verifier
    • How to become a verifier?
    • Verifier API
      • Overview
      • Getting Started
      • Examples
        • Verify an email credential
      • API Documentation
        • Info
        • Auth
        • Verifiable Presentation
        • Agent
        • SIOP
        • Templates
  • 📄TNG IDENTITY WALLET
    • What is the wallet for?
    • How to receive a Verifiable Credential?
    • How to share a Verifiable Credential?
  • 📑Privacy and Security
    • Privacy and Security Measures: TNG Identity Services
    • Revocation and data deletion
  • 🗃️SELF-SOVEREIGN IDENTITY KNOWLEDGE
    • Self-Sovereign Identity
    • Actors
    • Decentralized vs Self-Sovereign Identity
    • Key Principles of Self-Sovereign Identity
    • Self-Sovereign Identity – Use Cases
    • Digital Trust
    • Some of the critical components of Self Sovereign Identity
      • Trust over IP
    • Some of the critical components of Decentralise ID
      • A Blockchain Tailored for Decentralized Identity
      • Decentralise Identifiers (DID)
      • Verifiable Credentials
      • Verifiable Presentations
  • 📑GLOSSARY
    • Glossary
  • 📄FAQs / HELP
    • Help & FAQs
      • What is a digital identity?
      • What is TNG Identity, and how does it work?
      • How is blockchain used in TNG Identity?
      • Compatible Blockchains for TNG Identity.
      • How can my business sign up for TNG Identity?
      • How is TNG Identity different to other identity solutions in the market?
      • Can TNG Identity communicate with other identity solutions?
      • What is TNG Identity doing with my data, and does it act as a data processor or controller?
      • What measures does TNG Identity take to protect user data?
      • What support is available for TNG Identity?
      • Can TNG Identity be integrated into our existing systems?
      • How can I get started with TNG Identity?
      • What countries is TNG Identity available in?
Powered by GitBook
On this page
  1. 📄TNG Identity Issuers
  2. Issuer API
  3. API Documentation

Credential Offer Collections

PreviousCredential Offer ClaimsNextCredential Offers

Copyright © nChain Licensing AG 2024

  • GETList Credential Offer Collections
  • POSTCreate Credential Offer Collection

List Credential Offer Collections

get

Returns an array of credential offer collections in the environment.


Claim-based access control: Issuer_Admin, Issuer_Auditor, Issuer_User

Authorizations
Query parameters
pagenumberOptional

Page number to retrieve.If you provide invalid value the default page number will applied Example: 1 Default Value: 1

limitnumberOptional

Number of records per page. Example: 20 Default Value: 20 Max Value: 100

  If provided value is greater than max value, max value will be applied.
filter.namestring[]Optional

Filter by name query param. Format: filter.name={$not}:OPERATION:VALUE Example: filter.name=$not:$like:John Doe&filter.name=like:John Available Operations$eq

Responses
200Success
application/json
Responseall of
and
401
Invalid authentication credentials.
403
User does not have a required claim to perform this operation.
get
GET /products/web/$IDENTITY_ENV_ID/issuer/api/private/credential-offer-collections HTTP/1.1
Host: identity.nchainplatform.com
X-API-KEY: YOUR_API_KEY
Accept: */*
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-06-20T05:37:40.139Z",
      "name": "text"
    }
  ],
  "meta": {
    "select": [
      "text"
    ],
    "filter": {
      "name": "text"
    }
  },
  "links": {
    "first": "text",
    "previous": "text",
    "current": "text",
    "next": "text",
    "last": "text"
  }
}

Create Credential Offer Collection

post

Creates a new credential offer collection in the environment.


Claim-based access control: Issuer_Admin, Issuer_User

Authorizations
Body
namestring · min: 1 · max: 50Required
Responses
201Success
application/json
400
Invalid request body
401
Invalid authentication credentials.
403
User does not have a required claim to perform this operation.
post
POST /products/web/$IDENTITY_ENV_ID/issuer/api/private/credential-offer-collections HTTP/1.1
Host: identity.nchainplatform.com
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-06-20T05:37:40.139Z",
  "name": "text"
}