Skip to content
CREDEBL Docs
Search
Ctrl
K
Cancel
GitHub
Twitter
Discord
YouTube
Select theme
Dark
Light
Auto
Intro
Intro to SSI
What is CREDEBL?
Architecture
User Guide
Getting started
Studio UI overview
CREDEBL APIs guide
API Reference
Credo Agent
Overview
Proofs
GetAllProofs
GetProofById
ProposeProof
proof-AcceptProposal
RequestProof
CreateRequest
proof-AcceptRequest
AcceptPresentation
ProofFormData
Polygon
CreateKeyPair
polygon-CreateSchema
EstimateTransaction
polygon-GetSchemaById
Out Of Band
GetAllOutOfBandRecords
GetOutOfBandRecordById
DeleteOutOfBandRecord
CreateInvitation
CreateLegacyInvitation
CreateLegacyConnectionlessInvitation
ReceiveInvitation
ReceiveInvitationFromUrl
AcceptInvitation
MultiTenancy
CreateTenant
tenant_CreateDid
tenant_GetDids
tenant_DidNymTransaction
tenant_EndorserTransaction
tenant_GetConnectionById
tenant_CreateInvitation
tenant_CreateLegacyInvitation
tenant_ReceiveInvitation
tenant_ReceiveInvitationFromUrl
tenant_GetAllOutOfBandRecords
tenant_GetAllConnections
tenant_GetInvitation
tenant_CreateSchema
CreatePolygonW3CSchema
GetPolygonW3CSchemaById
tenant_WriteSchemaAndCredDefOnLedger
tenant_GetSchemaById
tenant_CreateCredentialDefinition
tenant_GetCredentialDefinitionById
tenant_CreateOffer
tenant_CreateOfferOob
tenant_AcceptOffer
tenant_GetCredentialById
tenant_GetAllCredentials
tenant_GetAllProofs
tenant_ProofFormData
tenant_RequestProof
tenant_CreateRequest
tenant_proof_AcceptRequest
tenant_AcceptPresentation
tenant_GetProofById
tenant_DeleteTenantById
CreateDidWeb
CreateDidKey
tenant_GetQuestionAnswerRecords
tenant_SendQuestion
tenant_SendAnswer
tenant_GetQuestionAnswerRecordById
tenant_GetBasicMessages
tenant_SendMessage
EndorserTransaction
EndorserTransaction
DidNymTransaction
WriteSchemaAndCredDefOnLedger
Dids
GetDidRecordByDid
WriteDid
GetDids
Schemas
GetSchemaById
CreateSchema
Credential Definitions
GetCredentialDefinitionById
CreateCredentialDefinition
Credentials
GetAllCredentials
GetAllW3c
GetW3cById
GetCredentialById
ProposeCredential
credential_AcceptProposal
CreateOffer
CreateOfferOob
AcceptOffer
NegotiateOffer
credential-AcceptRequest
AcceptCredential
Connections
GetAllConnections
GetConnectionById
DeleteConnection
connection-AcceptRequest
AcceptResponse
GetInvitation
Basic Messages
GetBasicMessages
SendMessage
Agent
GetAgentInfo
DeleteWallet
Question Answer
GetQuestionAnswerRecords
SendQuestion
SendAnswer
GetQuestionAnswerRecordById
Credebl Platform API
Overview
agents
Get the agent health details
Get the ledger config details
Agent spinup
Shared Agent
Delete wallet
Create wallet
Create new did
AgentController_createSecp256k1KeyPair
Agent configure
schemas
Get all schemas from platform.
Get schema information from the ledger using its schema ID.
Credential definitions by schema Id
Schemas by org id.
Create and register various types of schemas.
credential-definitions
Get all credential-definitions from platform.
Get credential definition by credential definition Id
Get all credential definitions by schema Id
Fetch all credential definitions by organization Id
Sends a credential definition to ledger
ledgers
Get all ledgers from platform.
Get network url from platform.
auth
Verify user’s email
Send verification email
Register new user to platform
Authenticate the user for the access
Reset password
Forgot password
Reset password with token
Token from refresh token
users
Fetch login user details
Get all platform and ecosystem settings
Update platform and ecosystem settings
users activity
organization invitations
Check if user exist
Get user credentials by Id
accept/reject organization invitation
Share user certificate
Update user profile
verifications
Get verified proof details
Get proof presentation by proof Id
Get all proof presentations by orgId
Sends a proof request
Verify presentation
Sends a out-of-band proof request
Delete verification record
fido
Fetch fido user details
Generate registration option
Verify registration
Generate authentication option
Verify authentication
Update fido user device name
Delete fido user device
organizations
Get all public profile organizations
Fetch org-roles details
Fetch organization details
Get dashboard details
Get organization references count
Get all invitations
Create organization invitation
Get all organizations
Create a new Organization
Get an organization
Update Organization
Delete Organization
Fetch client credentials for an organization
Create credentials for an organization
Get organization users list
Fetch organization DIDs
Set primary DID
Authenticate client for credentials
Register client and map users
Update user roles
Delete organization invitation
connections
Get connections by connection Id
Fetch all connections by orgId
Create outbound out-of-band connection invitation
Delete connection record
Fetch all connections from agent by orgId
Get question-answer record
Receive Invitation URL
Receive Invitation
Send basic message
credentials
Get all issued credentials for a specific organization
Fetch credentials by credentialRecordId
Fetch all templates for bulk opeartion
Download csv template for bulk-issuance
Upload file for bulk issuance
Preview uploded file details
bulk issue credential
Get all file list uploaded for bulk operation
Get uploaded file details by file id
Retry bulk issue credential
Issuer create a credential offer
Creates a out-of-band credential offer and sends them via emails
Create out-of-band credential offer
Delete issuance record
ecosystem
Get all endorsement transactions
Get all ecosystem schemas
Get all organization ecosystems
Create a new ecosystem
Get ecosystem dashboard details
Get received ecosystem invitations
Get all sent invitations
Send ecosystem invitation
Get ecosystem members list
Request new schema
Request new credential-definition
Sign transaction
Submit transaction
Add multiple organizations of ecosystem owner in ecosystem
Accept or reject ecosystem invitation
Edit ecosystem
Decline Endorsement Request By Lead
Delete organization from ecosystem as a ecosystem member
Delete ecosystem pending invitations
utilities
Create a shorteningurl
Store an object and return a short url to it
webhooks
Register Webhook
Get the webhookurl details
notification
Register organization webhook endpoint for notification
Send notification for holder
geolocation
Retrieve a list of all countries
Retrieve a list of all states within a specified country
Retrieve a list of all cities within a specified state and country
cloud-wallet
Configure base wallet
Create cloud wallet
Accept proof request
Get proof presentation by Id
Get proof presentation
Receive inviation using URL
Accept credential offer
Get DID list from wallet
Create new did
Create connection invitation for cloud wallet
Get connection by connection Id
Get all wallet connections
Get credential list from cloud wallet
Get credential by credential record Id
Get basic message by connection id
send question
Developers Guide
Installation
Prerequisites
Prerequisites
Keycloak
NATS
REDIS
PostgreSQL
Platform
Installation
Using NPM
Using Docker
Environment Variables
References
Agent
Overview
Installation
Using NPM
Using Docker
Environment Variables
References
Studio
Installation
Using NPM
Using Docker
Environment Variables
References
Troubleshooting
Support
FAQ
License
GitHub
Twitter
Discord
YouTube
Select theme
Dark
Light
Auto
EndorserTransaction
POST
/transactions/endorse
Authorizations
apiKey
Request Body
required
Select media type
application/json
object
transaction
required
Any of:
string
object
string
Construct a type with a set of properties K of type T
object
endorserDid
required
string
Responses
200
Ok
Select media type
application/json
object
signedTransaction
required
