Agent
This endpoint facilitates the retrieval of a DID document id.
GET /products/web/$IDENTITY_ENV_ID/issuer/api/public/did HTTP/1.1
Host: identity.nchainplatform.com
Accept: */*
did:bsv:1234
Returns all the information needed to see the status of the services running
GET /products/web/$IDENTITY_ENV_ID/issuer/api/public/getStatus HTTP/1.1
Host: identity.nchainplatform.com
Accept: */*
{
"state": "starting",
"did": {
"did": "did:bsv:1234",
"ready": true,
"controller": "https://did.identity.controller.nchainplatform.com/",
"resolver": "https://did.identity.resolver.nchainplatform.com/"
},
"started": "2011-10-05T14:48:00.000Z",
"timestamp": "2011-10-05T14:48:00.000Z",
"version": {
"version": "v1.1.0",
"commit": "4bfccdd063f6d21d34beba1c48eb6e82170d99f0",
"development": true,
"buildTime": "2011-10-05T14:48:00.000Z"
}
}
Endpoint facilitates the retrieval of a list of credentials that can be issued based
on the provided correlationId
. This endpoint expects the correlationId
to be passed as
a path parameter. Upon receiving a request, the server searches for JSON files located in the/dev/oid4vci_metadata
directory, matching the correlationId
with the correlationId
property in the JSON files.
It also returns metadata, which has fields credential_issuer
(tells web address where issuer is located) and credential_endpoint
(tells web address endpoint where credential can be claimed). It also returns display
object and credential_supplier_config
object.display
field name
will be displayed in wallet app as Authority Name when accepting a credential. Object credential_supplier_config
returns
all templates and mappings for the credential supplier.
Defines a organisation which is defined as a correlationId. Must be a value the Issuer is working with!
nchain
GET /products/web/$IDENTITY_ENV_ID/issuer/api/public/{correlationId}/.well-known/openid-credential-issuer HTTP/1.1
Host: identity.nchainplatform.com
Accept: */*
{
"credential_issuer": "https://{server-url/ip}/public/{correlation-id}",
"credential_endpoint": "https://{server-url/ip}/public/{correlation-id}/credentials",
"token_endpoint": "https://{server-url/ip}/public/{correlation-id}/token",
"display": {
"name": "Organisation Issuer",
"description": "Organisation Issuer"
},
"credential_configurations_supported": {
"ANY_ADDITIONAL_PROPERTY": {
"display": [
{
"name": "Email Credential",
"description": "Email Credential for Organisation",
"background_image": {
"url": "https://cloudfront.example.com/some-path/1/emailCredential"
}
}
],
"order": [
"name-of-claim"
],
"format": "jwt_vc_json",
"cryptographic_binding_methods_supported": [
"did:bsv"
],
"credential_signing_alg_values_supported": [
"ES256K"
],
"credential_definition": {
"type": [
"UniqueCredential",
"VerifiableCredential"
],
"credentialSubject": {
"name-of-claim": {
"value_type": "string",
"mandatory": true,
"format": "email",
"display": [
{
"name-of-claim-display-value": "Email"
}
]
}
}
}
}
},
"credential_supplier_config": {
"templates_base_dir": "templates/org-id",
"template_mappings": [
{
"type": [
"UniqueCredential",
"VerifiableCredential"
],
"credentialSubject": {
"name-of-claim": {
"value_type": "string",
"mandatory": true,
"format": "email",
"display": [
{
"name-of-claim-display-value": "Email"
}
]
}
}
}
]
}
}