Backend SDK

npm install @dcid/server-sdk

import { DCIDServerSDK } from '@dcid/server-sdk';

const sdk = new DCIDServerSDK({
  apiKey: process.env.DCID_API_KEY, // Required
  environment: 'prod', // 'dev' or 'prod'
  timeout: 30000 // Optional
});

// Send OTP to user's email
const result = await sdk.auth.registerOTP({
  email: 'user@example.com'
});

// Or send to phone
const result = await sdk.auth.registerOTP({
  phone: '+1234567890'
});

const tokens = await sdk.auth.confirmOTP({
  email: 'user@example.com',
  otp: '123456'
});

// tokens.access_token - JWT access token
// tokens.refresh_token - JWT refresh token

const newTokens = await sdk.auth.refreshToken({
  refreshToken: tokens.refresh_token
});

const keyResult = await sdk.identity.encryption.generateKey({
  did: 'did:iden3:dcid:main:...',
  ownerEmail: 'user@example.com'
});

// keyResult.encryptedKey - HSM encrypted key

const credential = await sdk.identity.issuer.issueCredential({
  did: 'did:iden3:dcid:main:...',
  credentialName: 'KYCAgeCredential',
  values: {
    birthday: 25,
    documentType: 2
  },
  ownerEmail: 'user@example.com'
});

// For SIG: credential.qrCodeLink
// For MTP: credential.txId, credential.claimId

const stored = await sdk.identity.ipfs.storeCredential({
  did: 'did:iden3:dcid:main:...',
  credential: credentialData,
  credentialType: 'ProofOfAge'
});

// stored.cid - IPFS Content Identifier

const session = await sdk.identity.verification.verifySignIn({
  credentialName: 'ProofOfAgeCredential'
});

// session.proofRequestUrl - URL to fetch proof request
// session.iden3commUrl - Deep link for wallet apps
// session.sessionId - Session identifier

const verified = await sdk.identity.verification.verifyCallback({
  sessionId: session.sessionId,
  jwzToken: 'user-submitted-token'
});

// verified.from - User's DID
// verified.body.scope - Proof results

import {
  DCIDServerSDKError,
  AuthenticationError,
  NetworkError,
  ServerError
} from '@dcid/server-sdk';

try {
  await sdk.auth.registerOTP({ email });
} catch (error) {
  if (error instanceof AuthenticationError) {
    if (error.isApiKeyError) {
      console.error('Invalid API key');
    }
  } else if (error instanceof NetworkError) {
    console.error('Network error');
  } else if (error instanceof ServerError) {
    console.error('Server error');
  }
}