Quickstart — Up and Running with Vouch SDK in 5 Minutes

import Vouch from 'vouch-sdk';

const vouch = new Vouch(process.env.VOUCH_API_KEY!);

// With optional URL overrides
const vouch = new Vouch(process.env.VOUCH_API_KEY!, {
  apiUrl: 'https://staging.example.com/v1',       // override API base URL
  verifyUrl: 'https://your-custom-modal.example.com', // override KYC modal URL
});

async function verifyUser(userId: string) {
  try {
    const result = await vouch.identity.verify(userId);

    if (result.status === 'verified') {
      console.log('User verified:', result.data.id);
      // Grant access, update your database, etc.
    } else {
      console.warn('Verification incomplete:', result.status);
    }
  } catch (error) {
    console.error('Identity check failed:', error);
  }
}

verifyUser('user-12345');

async function checkFraudRisk(platformUserId: string, transactionAmount: number) {
  const assessment = await vouch.fraud.assess({
    platformUserId,
    transactionAmount,
  });

  switch (assessment.flag) {
    case 'GREEN':
      // Proceed with the transaction
      console.log('Low risk — proceeding:', assessment.score);
      break;

    case 'AMBER':
      // Require additional verification before proceeding
      console.warn('Elevated risk — requesting step-up auth:', assessment.triggeredSignals);
      break;

    case 'RED':
      // Block the transaction and alert your trust & safety team
      console.error('High risk — transaction blocked:', assessment.triggeredSignals);
      break;
  }
}

checkFraudRisk('user-12345', 2500);