Other proof endpoints

These endpoints are not used in the most common verification scenarios.

Send a presentation to the proof request

Sends presentation to proof request

post

https://api-testnet.truvera.iohttps://api.truvera.io

/proof-requests/{id}/send-presentation

Sends a presentation to the request

Path parameters

idstring · uuidRequired

Proof request UUID

Body

application/json

objectOptional

Responses

200

Proof request accepted

application/json

idstring · uuidRequired

The unique identifier for the proof request.

Example: 37275574-7ea4-438d-b8ef-f8fc61dbf09e

namestringOptional

Proof request name

Example: Proof request

cedarVerificationPolicystringOptional

Optional Cedar policy to run on verification

noncestringOptional

Nonce or challenge for the presentation to match

Example: 1234567890

errorstringOptional

response_urlstring · uriRequired

The URL to send the proof presentation response.

Example: http://api-testnet.truvera.io/proof-requests/37275574-7ea4-438d-b8ef-f8fc61dbf09e/send-presentation

qrstringOptional

QR code deep link for mobile wallet scanning

Example: http://creds-testnet.truvera.io/proof/37275574-7ea4-438d-b8ef-f8fc61dbf09e

didstring · min: 32Optional

A DID

Example: did:cheqd:testnet:ac2b9027-ec1a-4ee2-aad1-1e316e7d6f59

verifiedbooleanOptional

Indicates whether the proof request has been verified.

Example: false

expiredbooleanOptional

Indicates whether the proof request has expired

Example: false

presentationobjectOptional

createdstring · date-timeRequired

The timestamp when the proof request was created.

Example: 2024-09-26T12:38:10.871Z

updatedstring · date-timeOptional

The timestamp when the proof request was last updated.

Example: 2024-09-26T12:38:10.871Z

typestringOptional

The type of the request.

Example: proof-request

typesstring[]Optional

An array of types indicating the formats or methods that can be used for the proof.

Example: jsonld

verifierNamestringOptional

The name of the verifier.

Example: Truvera

verifierLogostringOptional

The logo of the verifier.

Example: https://logo.truvera.io/verifier

400

Invalid parameters

application/json

404

Proof request was not found.

application/json

post

/proof-requests/{id}/send-presentation

HTTPcURLJavaScriptPython

POST /proof-requests/{id}/send-presentation HTTP/1.1
Host: api-testnet.truvera.io
Content-Type: application/json
Accept: */*
Content-Length: 6816

{
  "description": "Verifiable Presentation that has been signed",
  "type": "object",
  "properties": {
    "@context": {
      "description": "JSON-LD context array of strings or single string",
      "example": "https://docknetwork.github.io/vc-schemas/basic-credential.json-ld",
      "oneOf": [
        {
          "type": "array",
          "items": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "object"
              }
            ]
          }
        },
        {
          "type": "string"
        }
      ]
    },
    "id": {
      "type": "string",
      "format": "uri"
    },
    "type": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "verifiableCredential": {
      "oneOf": [
        {
          "type": "object",
          "description": "Verifiable (signed) Credential returned by API. The current set of properties is almost complete",
          "properties": {
            "@context": {
              "description": "JSON-LD context array of strings or single string",
              "example": "https://docknetwork.github.io/vc-schemas/basic-credential.json-ld",
              "oneOf": [
                {
                  "type": "array",
                  "items": {
                    "oneOf": [
                      {
                        "type": "string"
                      },
                      {
                        "type": "object"
                      }
                    ]
                  }
                },
                {
                  "type": "string"
                }
              ]
            },
            "id": {
              "type": "string"
            },
            "type": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "credentialSubject": {
              "oneOf": [
                {
                  "type": "object"
                },
                {
                  "type": "array",
                  "items": {
                    "type": "object"
                  }
                }
              ]
            },
            "issuer": {
              "oneOf": [
                {
                  "type": "string",
                  "description": "DID as fully qualified, typically. `did:cheqd:`",
                  "minimum": 32,
                  "example": "did:cheqd:testnet:ac2b9027-ec1a-4ee2-aad1-1e316e7d6f59"
                },
                {
                  "type": "object"
                }
              ]
            },
            "issuanceDate": {
              "type": "string",
              "format": "date-time"
            },
            "expirationDate": {
              "type": "string",
              "format": "date-time"
            },
            "credentialStatus": {
              "description": "Revocation registry id or user supplied status object",
              "oneOf": [
                {
                  "type": "object"
                },
                {
                  "type": "string"
                }
              ]
            },
            "proof": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "type": {
                      "description": "Type of signature (NOTE: EcdsaSecp256k1Signature2019, Sr25519Signature2020 are deprecated)",
                      "type": "string",
                      "enum": [
                        "Ed25519Signature2018",
                        "Ed25519Signature2020",
                        "Bls12381BBS+SignatureDock2022",
                        "Bls12381BBS+SignatureProofDock2022",
                        "Bls12381BBDT16MACDock2024",
                        "Bls12381BBSSignatureDock2023",
                        "Bls12381BBSVerificationKeyDock2023",
                        "BJJSignature2021",
                        "EcdsaSecp256k1Signature2019",
                        "Sr25519Signature2020"
                      ]
                    },
                    "proofPurpose": {
                      "description": "Purpose of credential",
                      "type": "string",
                      "enum": [
                        "assertionMethod",
                        "authentication"
                      ]
                    },
                    "verificationMethod": {
                      "type": "string"
                    },
                    "created": {
                      "type": "string",
                      "format": "date-time"
                    },
                    "proofValue": {
                      "type": "string"
                    }
                  }
                },
                {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "type": {
                        "description": "Type of signature (NOTE: EcdsaSecp256k1Signature2019, Sr25519Signature2020 are deprecated)",
                        "type": "string",
                        "enum": [
                          "Ed25519Signature2018",
                          "Ed25519Signature2020",
                          "Bls12381BBS+SignatureDock2022",
                          "Bls12381BBS+SignatureProofDock2022",
                          "Bls12381BBDT16MACDock2024",
                          "Bls12381BBSSignatureDock2023",
                          "Bls12381BBSVerificationKeyDock2023",
                          "BJJSignature2021",
                          "EcdsaSecp256k1Signature2019",
                          "Sr25519Signature2020"
                        ]
                      },
                      "proofPurpose": {
                        "description": "Purpose of credential",
                        "type": "string",
                        "enum": [
                          "assertionMethod",
                          "authentication"
                        ]
                      },
                      "verificationMethod": {
                        "type": "string"
                      },
                      "created": {
                        "type": "string",
                        "format": "date-time"
                      },
                      "proofValue": {
                        "type": "string"
                      }
                    }
                  }
                }
              ]
            }
          }
        },
        {
          "type": "array",
          "items": {
            "type": "object",
            "description": "Verifiable (signed) Credential returned by API. The current set of properties is almost complete",
            "properties": {
              "@context": {
                "description": "JSON-LD context array of strings or single string",
                "example": "https://docknetwork.github.io/vc-schemas/basic-credential.json-ld",
                "oneOf": [
                  {
                    "type": "array",
                    "items": {
                      "oneOf": [
                        {
                          "type": "string"
                        },
                        {
                          "type": "object"
                        }
                      ]
                    }
                  },
                  {
                    "type": "string"
                  }
                ]
              },
              "id": {
                "type": "string"
              },
              "type": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "credentialSubject": {
                "oneOf": [
                  {
                    "type": "object"
                  },
                  {
                    "type": "array",
                    "items": {
                      "type": "object"
                    }
                  }
                ]
              },
              "issuer": {
                "oneOf": [
                  {
                    "type": "string",
                    "description": "DID as fully qualified, typically. `did:cheqd:`",
                    "minimum": 32,
                    "example": "did:cheqd:testnet:ac2b9027-ec1a-4ee2-aad1-1e316e7d6f59"
                  },
                  {
                    "type": "object"
                  }
                ]
              },
              "issuanceDate": {
                "type": "string",
                "format": "date-time"
              },
              "expirationDate": {
                "type": "string",
                "format": "date-time"
              },
              "credentialStatus": {
                "description": "Revocation registry id or user supplied status object",
                "oneOf": [
                  {
                    "type": "object"
                  },
                  {
                    "type": "string"
                  }
                ]
              },
              "proof": {
                "oneOf": [
                  {
                    "type": "object",
                    "properties": {
                      "type": {
                        "description": "Type of signature (NOTE: EcdsaSecp256k1Signature2019, Sr25519Signature2020 are deprecated)",
                        "type": "string",
                        "enum": [
                          "Ed25519Signature2018",
                          "Ed25519Signature2020",
                          "Bls12381BBS+SignatureDock2022",
                          "Bls12381BBS+SignatureProofDock2022",
                          "Bls12381BBDT16MACDock2024",
                          "Bls12381BBSSignatureDock2023",
                          "Bls12381BBSVerificationKeyDock2023",
                          "BJJSignature2021",
                          "EcdsaSecp256k1Signature2019",
                          "Sr25519Signature2020"
                        ]
                      },
                      "proofPurpose": {
                        "description": "Purpose of credential",
                        "type": "string",
                        "enum": [
                          "assertionMethod",
                          "authentication"
                        ]
                      },
                      "verificationMethod": {
                        "type": "string"
                      },
                      "created": {
                        "type": "string",
                        "format": "date-time"
                      },
                      "proofValue": {
                        "type": "string"
                      }
                    }
                  },
                  {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "type": {
                          "description": "Type of signature (NOTE: EcdsaSecp256k1Signature2019, Sr25519Signature2020 are deprecated)",
                          "type": "string",
                          "enum": [
                            "Ed25519Signature2018",
                            "Ed25519Signature2020",
                            "Bls12381BBS+SignatureDock2022",
                            "Bls12381BBS+SignatureProofDock2022",
                            "Bls12381BBDT16MACDock2024",
                            "Bls12381BBSSignatureDock2023",
                            "Bls12381BBSVerificationKeyDock2023",
                            "BJJSignature2021",
                            "EcdsaSecp256k1Signature2019",
                            "Sr25519Signature2020"
                          ]
                        },
                        "proofPurpose": {
                          "description": "Purpose of credential",
                          "type": "string",
                          "enum": [
                            "assertionMethod",
                            "authentication"
                          ]
                        },
                        "verificationMethod": {
                          "type": "string"
                        },
                        "created": {
                          "type": "string",
                          "format": "date-time"
                        },
                        "proofValue": {
                          "type": "string"
                        }
                      }
                    }
                  }
                ]
              }
            }
          }
        }
      ]
    },
    "proof": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "type": {
              "description": "Type of signature (NOTE: EcdsaSecp256k1Signature2019, Sr25519Signature2020 are deprecated)",
              "type": "string",
              "enum": [
                "Ed25519Signature2018",
                "Ed25519Signature2020",
                "Bls12381BBS+SignatureDock2022",
                "Bls12381BBS+SignatureProofDock2022",
                "Bls12381BBDT16MACDock2024",
                "Bls12381BBSSignatureDock2023",
                "Bls12381BBSVerificationKeyDock2023",
                "BJJSignature2021",
                "EcdsaSecp256k1Signature2019",
                "Sr25519Signature2020"
              ]
            },
            "proofPurpose": {
              "description": "Purpose of credential",
              "type": "string",
              "enum": [
                "assertionMethod",
                "authentication"
              ]
            },
            "verificationMethod": {
              "type": "string"
            },
            "created": {
              "type": "string",
              "format": "date-time"
            },
            "proofValue": {
              "type": "string"
            }
          }
        },
        {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "description": "Type of signature (NOTE: EcdsaSecp256k1Signature2019, Sr25519Signature2020 are deprecated)",
                "type": "string",
                "enum": [
                  "Ed25519Signature2018",
                  "Ed25519Signature2020",
                  "Bls12381BBS+SignatureDock2022",
                  "Bls12381BBS+SignatureProofDock2022",
                  "Bls12381BBDT16MACDock2024",
                  "Bls12381BBSSignatureDock2023",
                  "Bls12381BBSVerificationKeyDock2023",
                  "BJJSignature2021",
                  "EcdsaSecp256k1Signature2019",
                  "Sr25519Signature2020"
                ]
              },
              "proofPurpose": {
                "description": "Purpose of credential",
                "type": "string",
                "enum": [
                  "assertionMethod",
                  "authentication"
                ]
              },
              "verificationMethod": {
                "type": "string"
              },
              "created": {
                "type": "string",
                "format": "date-time"
              },
              "proofValue": {
                "type": "string"
              }
            }
          }
        }
      ]
    }
  }
}

{
  "id": "37275574-7ea4-438d-b8ef-f8fc61dbf09e",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {
      "name": "favouriteDrink",
      "names": [
        "age"
      ]
    }
  },
  "name": "Proof request",
  "cedarVerificationPolicy": "text",
  "nonce": "1234567890",
  "error": "text",
  "response_url": "http://api-testnet.truvera.io/proof-requests/37275574-7ea4-438d-b8ef-f8fc61dbf09e/send-presentation",
  "qr": "http://creds-testnet.truvera.io/proof/37275574-7ea4-438d-b8ef-f8fc61dbf09e",
  "did": "did:cheqd:testnet:ac2b9027-ec1a-4ee2-aad1-1e316e7d6f59",
  "verified": false,
  "expired": false,
  "presentation": {},
  "created": "2024-09-26T12:38:10.871Z",
  "updated": "2024-09-26T12:38:10.871Z",
  "request": {
    "name": "test request",
    "purpose": "my purpose",
    "input_descriptors": null
  },
  "type": "proof-request",
  "types": [
    "jsonld"
  ],
  "verifierName": "Truvera",
  "verifierLogo": "https://logo.truvera.io/verifier"
}

Get the proof request PEX definition

Get the proof request PEX definition

get

https://api-testnet.truvera.iohttps://api.truvera.io

/proof-requests/{id}/pex

Get the proof request PEX definition

Path parameters

idstring · uuidRequired

OpenID issuer UUID

Responses

200

The proof request PEX definition

application/json

objectOptional

400

Application error

application/json

404

Not Found

application/json

get

/proof-requests/{id}/pex

HTTPcURLJavaScriptPython

GET /proof-requests/{id}/pex HTTP/1.1
Host: api-testnet.truvera.io
Accept: */*

{}