POST /presentations/prove - Proves a presentation and returns it in the response body.
| Response | Description |
|---|
| 201 | Presentation successfully proved! |
| 400 | invalid input! |
| 500 | error! |
The /presentations/prove endpoint uses the following schema when receiving a POST:
{
"presentation": {
"type": "object",
"description": "A JSON-LD Verifiable Presentation without a proof.",
"properties": {
"@context": {
"type": "array",
"description": "The JSON-LD context of the presentation.",
"items": {
"type": "string"
}
},
"id": {
"type": "string",
"description": "The ID of the presentation."
},
"type": {
"type": "array",
"description": "The JSON-LD type of the presentation.",
"items": {
"type": "string"
}
},
"holder": {
"type": "object",
"description": "The holder - will be ignored if no proof is present since there is no proof of authority over the credentials",
"nullable": true
},
"verifiableCredential": {
"type": "array",
"description": "The Verifiable Credentials",
"items": {
"type": "object",
"description": "A JSON-LD Verifiable Credential with a proof.",
"allOf": [
{
"type": "object",
"description": "A JSON-LD Verifiable Credential without a proof.",
"properties": {
"@context": {
"type": "array",
"description": "The JSON-LD context of the credential.",
"items": {
"type": "string"
}
},
"id": {
"type": "string",
"description": "The ID of the credential."
},
"type": {
"type": "array",
"description": "The JSON-LD type of the credential.",
"items": {
"type": "string"
}
},
"issuer": {
"type": "object",
"description": "A JSON-LD Verifiable Credential Issuer.",
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
}
}
}
],
"example": {
"id": "did:key:z6MkjRagNiMu91DduvCvgEsqLZDVzrJzFrwahc4tXLt9DoHd"
}
},
"issuanceDate": {
"type": "string",
"description": "The issuanceDate"
},
"expirationDate": {
"type": "string",
"description": "The expirationDate"
},
"credentialSubject": {
"type": "object",
"description": "The subject"
}
},
"example": {
"@context": [
"https://www.w3.org/2018/credentials/v1",
"https://www.w3.org/2018/credentials/examples/v1"
],
"id": "http://example.gov/credentials/3732",
"type": [
"VerifiableCredential",
"UniversityDegreeCredential"
],
"issuer": "did:example:123",
"issuanceDate": "2020-03-16T22:37:26.544Z",
"credentialSubject": {
"id": "did:example:123",
"degree": {
"type": "BachelorDegree",
"name": "Bachelor of Science and Arts"
}
}
}
},
{
"type": "object",
"properties": {
"proof": {
"type": "object",
"description": "A JSON-LD Linked Data proof.",
"properties": {
"type": {
"type": "string",
"description": "Linked Data Signature Suite used to produce proof."
},
"created": {
"type": "string",
"description": "Date the proof was created."
},
"verificationMethod": {
"type": "string",
"description": "Verification Method used to verify proof."
},
"proofPurpose": {
"type": "string",
"description": "The purpose of the proof to be used with verificationMethod."
},
"jws": {
"type": "string",
"description": "Detached JSON Web Signature"
}
},
"example": {
"type": "Ed25519Signature2018",
"created": "2020-04-02T18:28:08Z",
"verificationMethod": "did:example:123#z6MksHh7qHWvybLg5QTPPdG2DgEjjduBDArV9EF9mRiRzMBN",
"proofPurpose": "assertionMethod",
"jws": "eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..YtqjEYnFENT7fNW-COD0HAACxeuQxPKAmp4nIl8jYAu__6IH2FpSxv81w-l5PvE1og50tS9tH8WyXMlXyo45CA"
}
}
}
}
],
"example": {
"@context": [
"https://www.w3.org/2018/credentials/v1",
"https://www.w3.org/2018/credentials/examples/v1"
],
"id": "http://example.gov/credentials/3732",
"type": [
"VerifiableCredential",
"UniversityDegreeCredential"
],
"issuer": "did:example:123",
"issuanceDate": "2020-03-16T22:37:26.544Z",
"credentialSubject": {
"id": "did:example:123",
"degree": {
"type": "BachelorDegree",
"name": "Bachelor of Science and Arts"
}
},
"proof": {
"type": "Ed25519Signature2018",
"created": "2020-04-02T18:28:08Z",
"verificationMethod": "did:example:123#z6MksHh7qHWvybLg5QTPPdG2DgEjjduBDArV9EF9mRiRzMBN",
"proofPurpose": "assertionMethod",
"jws": "eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..YtqjEYnFENT7fNW-COD0HAACxeuQxPKAmp4nIl8jYAu__6IH2FpSxv81w-l5PvE1og50tS9tH8WyXMlXyo45CA"
}
}
}
}
},
"example": {
"@context": [
"https://www.w3.org/2018/credentials/v1",
"https://www.w3.org/2018/credentials/examples/v1"
],
"holder": "did:example:123",
"type": "VerifiablePresentation",
"verifiableCredential": [
{
"@context": [
"https://www.w3.org/2018/credentials/v1",
"https://www.w3.org/2018/credentials/examples/v1"
]
},
{
"id": "http://example.gov/credentials/3732"
},
{
"type": [
"VerifiableCredential",
"UniversityDegreeCredential"
]
},
{
"issuer": "did:example:123"
},
{
"issuanceDate": "2020-03-16T22:37:26.544Z"
},
{
"credentialSubject": {
"id": "did:example:123",
"degree": {
"type": "BachelorDegree",
"name": "Bachelor of Science and Arts"
}
}
},
{
"proof": {
"type": "Ed25519Signature2018",
"created": "2020-04-02T18:28:08Z",
"verificationMethod": "did:example:123#z6MksHh7qHWvybLg5QTPPdG2DgEjjduBDArV9EF9mRiRzMBN",
"proofPurpose": "assertionMethod",
"jws": "eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..YtqjEYnFENT7fNW-COD0HAACxeuQxPKAmp4nIl8jYAu__6IH2FpSxv81w-l5PvE1og50tS9tH8WyXMlXyo45CA"
}
}
]
}
},
"options": {
"type": "object",
"additionalProperties": false,
"description": "Options for specifying how the LinkedDataProof is created.",
"properties": {
"type": {
"type": "string",
"description": "The type of the proof. Default is an appropriate proof type corresponding to the verification method."
},
"verificationMethod": {
"type": "string",
"description": "The URI of the verificationMethod used for the proof. Default assertionMethod URI."
},
"proofPurpose": {
"type": "string",
"description": "The purpose of the proof. Default 'assertionMethod'."
},
"created": {
"type": "string",
"description": "The date and time of the proof (with a maximum accuracy in seconds). Default current system time."
},
"challenge": {
"type": "string",
"description": "A challenge provided by the requesting party of the proof. For example 6e62f66e-67de-11eb-b490-ef3eeefa55f2"
},
"domain": {
"type": "string",
"description": "The intended domain of validity for the proof. For example website.example"
}
},
"example": {
"type": "Ed25519Signature2018",
"verificationMethod": "did:example:123#z6MksHh7qHWvybLg5QTPPdG2DgEjjduBDArV9EF9mRiRzMBN",
"proofPurpose": "assertionMethod",
"created": "2020-04-02T18:48:36Z",
"domain": "example.com",
"challenge": "d436f0c8-fbd9-4e48-bbb2-55fc5d0920a8"
}
}
}
