Help Center/ Blockchain Service/ Developer Guide/ Blockchain Middleware APIs/ Distributed Identity (OBT)/ Verifiable Credential (VC) Management/ Applying for Verifiable Credentials
Updated on 2022-12-06 GMT+08:00
View PDF

Applying for Verifiable Credentials

Function

This API is used to apply for verifiable credentials. The applicant must provide relevant data according to the fields claimed in the service.

URI

POST /v1/identity/apply-vc

Request Parameters

Table 1 Request body parameters

Parameter

Mandatory

Type

Description

orgID

Yes

String

Organization ID.

channelID

Yes

String

Channel ID.

cryptoMethod

Yes

String

Encryption method, which is fixed at SW.

cert

Yes

String

User certificate. Add an explicit line break (\n) at the end of each line.

sk

Yes

String

User private key. Add an explicit line break (\n) at the end of each line.

timestamp

Yes

String

Timestamp.

applyer

Yes

String

Applicant identifier.

serviceID

Yes

String

Service identifier. Service ID declared by the service provider in the DID.

data

No

String

data

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

orderIndex

String

Order index.

Status code: 500

Table 3 Response body parameters

Parameter

Type

Description

errorCode

String

Error code.

Minimum: 8

Maximum: 36

errorMsg

String

Error description.

Minimum: 2

Maximum: 512

Example Requests

{
  "orgID" : "4f1439758ebb41f7411b5f684b67713c08b89198",
  "channelID" : "mychannel",
  "cryptoMethod" : "SW",
  "cert" : "-----BEGIN CERTIFICATE-----\n...\n...\n-----END CERTIFICATE-----",
  "sk" : "------BEGIN PRIVATE KEY-----\n...\n...\n-----END PRIVATE KEY-----",
  "timestamp" : "2020-10-27T17:28:16+08:00",
  "applyer" : "did:example:ebfeb1f712ebc6f1c276e12ec21",
  "serviceID" : "did:example:ebfeb1f712ebc6f1c276e12ec21#service1",
  "data" : "abcdefg"
}

Example Responses

Status code: 200

VCOrderResponeParams Information

{
  "orderIndex" : "string"
}

Status code: 500

Error response.

{
  "errorCode" : "stringst",
  "errorMsg" : "string"
}

Status Codes

Status Code

Description

200

VCOrderResponeParams Information

500

Error response.

Error Codes

See Error Codes.