Skip to main content

Security API

Manage two-factor authentication, security events, and KYC.

Two-Factor Authentication​

setup2FA​

const setup = await zenpays.security.setup2FA()
// { secret, qrCodeUrl, backupCodes }

verify2FA​

const result = await zenpays.security.verify2FA({ code: '123456' })

disable2FA​

await zenpays.security.disable2FA('123456')

is2FAEnabled​

const status = await zenpays.security.is2FAEnabled()
// { enabled: true, setupAt: '2024-01-01' }

Security Events​

listSecurityEvents​

const { data } = await zenpays.security.listSecurityEvents({
  type: 'login_failed',
  severity: 'critical',
})

getSecurityEvent​

const event = await zenpays.security.getSecurityEvent('evt_xxx')

KYC​

getKycStatus​

const status = await zenpays.security.getKycStatus()
// { status: 'approved', submittedDocuments: [...] }

uploadKycDocument​

const doc = await zenpays.security.uploadKycDocument({
  type: 'passport',
  file: fileBlob,
})

getKycDocument​

const doc = await zenpays.security.getKycDocument('doc_xxx')