humanity protocol
  • Introduction
    • Overview
    • How Humanity Protocol Works
    • Palm Scanner
  • Getting Started
    • Network Configuration
    • Important Links
  • Testnet Info
    • Onboarding Tutorial
    • Testnet Rewards
    • Testnet FAQ
  • Build on Humanity
    • API
      • Issue Credentials (VCs)
      • Verify Credentials (VCs)
      • Revoke Credentials (VCs)
      • List Client Credentials (VCs)
    • Contracts
      • VC contract
      • Rewards contract
    • Contract Integrations Guide
    • Examples
      • Fairdrops
      • Social Media VCs
  • Glossary
  • Community/Support
Powered by GitBook
On this page
  1. Build on Humanity
  2. API

Issue Credentials (VCs)

PreviousAPINextVerify Credentials (VCs)

Last updated 3 months ago

Issue a Verifiable Credential

post

Issues a signed Verifiable Credential with specified claims for a subject.

Authorizations
Body
subject_addressstringRequired

The address of the credential subject

Example: 0x0fa4adf7830a048c285e981ba5d57c51604c917f
Responses
200
Successfully issued credential
application/json
400
Invalid request
application/json
401
Unauthorized
application/json
post
POST /credentials/issue HTTP/1.1
Host: issuer.humanity.org
X-API-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 122

{
  "claims": {
    "kyc": "passed",
    "age": 22,
    "custom_claim": "value"
  },
  "subject_address": "0x0fa4adf7830a048c285e981ba5d57c51604c917f"
}
{
  "message": "Credential issued successfully",
  "credential": {
    "@context": [
      "https://www.w3.org/ns/credentials/v2"
    ],
    "type": [
      "VerifiableCredential"
    ],
    "issuer": "did:key:zUC72jLAC7CFjxk9FDM4fBwx5fYDdesDSn3dT8i38ZEcq6iGdBRGFcBUGczVjbHQbEHvY9rhSBpAuvjjqrze9o7cxtpbJ7Vbi4eDdjyGFMCaexgpeRABVX1uDUoxrkeQjN14k2C",
    "validFrom": "2025-02-24T14:47:27.457Z",
    "validUntil": "",
    "credentialSubject": {
      "id": "did:ethr:0x0fa4adf7830a048c285e981ba5d57c51604c917f",
      "kyc": "passed",
      "age": 22,
      "custom_claim": "value"
    },
    "id": "urn:uuid:a90c4593-376a-4dd1-b68b-06994b4d0256",
    "credentialStatus": {
      "type": "T3RevocationRegistry",
      "chain_id": "1942999413",
      "revocation_registry_contract_address": "0xB7676D6881f3642b27dF77a4f2e2060F4CBa2594",
      "did_registry_contract_address": "0x9ec4D6B69926e80316Bf9c1E0A2b2Ae4b8bde707"
    },
    "proof": {
      "type": "DataIntegrityProof",
      "cryptosuite": "bbs-2023",
      "created": "2025-02-24T14:47:28.019Z",
      "verificationMethod": "did:key:zUC72jLAC7CFjxk9FDM4fBwx5fYDdesDSn3dT8i38ZEcq6iGdBRGFcBUGczVjbHQbEHvY9rhSBpAuvjjqrze9o7cxtpbJ7Vbi4eDdjyGFMCaexgpeRABVX1uDUoxrkeQjN14k2C",
      "proofPurpose": "assertionMethod",
      "proofValue": "2V0ChVhwtJwduH92wZUvifETQz16LDdRPI2jUr7fO7yYO7loNXJiAp1cAb0IyAGrepZXd2k_YUHlKfzccE4m7waZyoLEkBLFiK2g54Q2i-CdtYBgDdkUDsoULSBMcH1MwGHwdjfXpldFNFrHFx_IAvLVniyeMVhAGyUImnA5UiL0kAfNmVbNd_oy8s6aeF-4e5b13uJ-RyEoMmJQRJU_Rh2oGUF37CyZeu5ynVDj6-FTjdN5tjpdI1hghTmtt-ysKbIxRPmJgCUDX1gMWH_XKd3fwgY5NXXNlwIDTo8qcnQ5Wsa_Hl6u4UuQE_srwQGxP8M3k9_M1zFrw39muVsXXuaFQM2hTTOoSUehu9biK4SnJqdgkYj606DpWCDjqVcBP56jimKaOniUAxoDNqHx-WmuJ39ESp37WVdGi4ZJL0Bjb250ZXh0Qy9pZEcvaXNzdWVyRS90eXBlSi92YWxpZEZyb21LL3ZhbGlkVW50aWw"
    }
  }
}