Polygon ID · Schema

CreateCredentialRequest

IdentityVerifiable CredentialsZero-Knowledge ProofsSelf-Sovereign IdentityDecentralized IdentityBlockchainWeb3KYC

Properties

Name Type Description
credentialSchema string
claimID string
type string
credentialSubject object
expiration integer
version integer
revNonce integer
subjectPosition string
merklizedRootPosition string
refreshService object
displayMethod object
proofs array
credentialStatusType string
encryptionKey object
View JSON Schema on GitHub

JSON Schema

create-credential-request.json Raw ↑ 
{
  "type": "object",
  "required": [
    "credentialSchema",
    "type",
    "credentialSubject"
  ],
  "properties": {
    "credentialSchema": {
      "type": "string",
      "x-omitempty": false
    },
    "claimID": {
      "type": "string",
      "x-go-type": "uuid.UUID",
      "x-omitempty": false
    },
    "type": {
      "type": "string",
      "x-omitempty": false
    },
    "credentialSubject": {
      "type": "object",
      "x-omitempty": false
    },
    "expiration": {
      "type": "integer",
      "format": "int64"
    },
    "version": {
      "type": "integer",
      "format": "uint32"
    },
    "revNonce": {
      "type": "integer",
      "format": "uint64"
    },
    "subjectPosition": {
      "type": "string"
    },
    "merklizedRootPosition": {
      "type": "string"
    },
    "refreshService": {
      "$ref": "#/components/schemas/RefreshService"
    },
    "displayMethod": {
      "$ref": "#/components/schemas/DisplayMethod"
    },
    "proofs": {
      "type": "array",
      "items": {
        "type": "string",
        "x-omitempty": false,
        "example": "BJJSignature2021",
        "enum": [
          "BJJSignature2021",
          "Iden3SparseMerkleTreeProof"
        ]
      }
    },
    "credentialStatusType": {
      "type": "string",
      "x-omitempty": true,
      "example": "Iden3ReverseSparseMerkleTreeProof",
      "enum": [
        "Iden3commRevocationStatusV1.0",
        "Iden3ReverseSparseMerkleTreeProof",
        "Iden3OnchainSparseMerkleTreeProof2023"
      ]
    },
    "encryptionKey": {
      "type": "object",
      "x-omitempty": true,
      "example": {
        "EncryptionKey": {
          "summary": "Encryption Key",
          "value": {
            "alg": "ECDH-ES+A256KW",
            "crv": "P-256",
            "kid": "tu-kid",
            "kty": "EC",
            "use": "enc",
            "x": "8UfTxPvmMFAPuqwtxaRWrWmihC_7uYF2rEnxa4lLQ_s",
            "y": "M4PFcNXKyyRJ3zNPg19FlB6O0Tlbqs8euRcflpbDtcE"
          }
        }
      }
    }
  },
  "example": {
    "credentialSchema": "https://raw.githubusercontent.com/iden3/claim-schema-vocab/main/schemas/json/KYCAgeCredential-v3.json",
    "type": "KYCAgeCredential",
    "credentialSubject": {
      "id": "fill with did",
      "birthday": 19960424,
      "documentType": 2
    },
    "expiration": 1903357766
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "CreateCredentialRequest"
}