Skip to main content

KycProof

idstring

Identifier of the request

Example: 2ebed93f-079d-4564-b649-b99153c1d08d
thidstring

Identifier of the test (same as the request)

Example: 2ebed93f-079d-4564-b649-b99153c1d08d
fromstring

Decentralized identifier of the verifier (DID)

Example: did:polygonid:polygon:mumbai:2qEbsGmh6KdVcTcZ1vTqYfAybihrk1xz81qaDoc47j
typstring

Content type

Example: application/iden3comm-plain-json
typestring

Type of Iden3 schema

Example: https://iden3-communication.io/authorization/1.0/request
body object
reasonstring

Purpose of presenting the zero-knowledge proof

Example: ProofOfValidKYC
messagestring

Message with additional information regarding the proof

Example: Validation of holding a valid KYC through a zero-knowledge proof
callbackUrlstring

URL where the proof is sent once generated from the Polygon ID App

Example: https://dev-bsapi.token-city.com/zkProof/proof-kyc-callback?sessionId=1bf35d4c-7ccf-4e8e-aac2-fce7d75c32df
scope object[]
  • Array [
    • idnumber

    Identifier of the query for the presentation of the zero-knowledge proof

    Example: 1654984164
    circuitIdstring

    Identifier of the circuit to be used to validate the zero-knowledge proof

    Example: credentialAtomicQuerySigV2
    query object
    allowedIssuersstring[]
    typestring

    Type of verified credential that the query will respond to

    Example: ProofOfValidKYC
    contextstring

    URL of the JSON-LD schema containing the context for generating the proof

    Example: https://raw.githubusercontent.com/TC/W3CSchemas/main/KYC_test/KYC.jsonld
    credentialSubject object

    Fields of the context schema to be validated using the defined operator

    field object

    Name of the field to be validated

    operatorstring

    Comparison operator for the data to be validated, must be one of these six: $eq=Equals, $lt=Less-than, $gt=Greater-than, $in=In, $nin=Not-in, $ne=Not-equal

    Example: $eq
  • ]
    • KycProof
    {
      "id": "2ebed93f-079d-4564-b649-b99153c1d08d",
      "thid": "2ebed93f-079d-4564-b649-b99153c1d08d",
      "from": "did:polygonid:polygon:mumbai:2qEbsGmh6KdVcTcZ1vTqYfAybihrk1xz81qaDoc47j",
      "typ": "application/iden3comm-plain-json",
      "type": "https://iden3-communication.io/authorization/1.0/request",
      "body": {
        "reason": "ProofOfValidKYC",
        "message": "Validation of holding a valid KYC through a zero-knowledge proof",
        "callbackUrl": "https://dev-bsapi.token-city.com/zkProof/proof-kyc-callback?sessionId=1bf35d4c-7ccf-4e8e-aac2-fce7d75c32df",
        "scope": [
          {
            "id": 1654984164,
            "circuitId": "credentialAtomicQuerySigV2",
            "query": {
              "allowedIssuers": [
                "did:polygonid:polygon:mumbai:2qEbsGmh6KdVcTcZ1vTqYfAybihrk1xz81qaDoc47j"
              ],
              "type": "ProofOfValidKYC",
              "context": "https://raw.githubusercontent.com/TC/W3CSchemas/main/KYC_test/KYC.jsonld",
              "credentialSubject": {
                "field": "kyc_validated"
              }
            }
          }
        ]
      }
    }