sove-identity-sdk

The official JavaScript SDK for Sove — identity and compliance infrastructure for Africa.

Install

npm install sove-identity-sdk

Quick Start

import SoveSDK from 'sove-identity-sdk';

const sove = new SoveSDK({ apiKey: 'YOUR_API_KEY' });

// Verify a user
const result = await sove.verifyUser({
  eNumber: 'ENT-000001',
  country: 'NG',
  idType: 'BVN',
  idNumber: '22222222222'
});

console.log('Verified:', result.status);
console.log('Credential ID:', result.credentialId);

Methods

verifyUser(options)

Verify a user's identity. Issues a portable credential on successful verification.

| Field | Required | Description | |-------|----------|-------------| | eNumber | Yes | Unique identity number e.g. ENT-000001 | | country | Yes | ISO country code: NG, ZA, KE, GH, UG, ZM | | idType | Yes | BVN, NIN, NATIONAL_ID, PASSPORT, DRIVERS_LICENSE | | idNumber | Yes | The ID document number | | selfieBase64 | No | Base64 encoded selfie image (optional in beta) | | idImageBase64 | No | Base64 encoded ID image (optional) |

presentIdentity(eNumber)

Check if a user is already verified without re-doing KYC. This is the verify once, carry forever endpoint.

getCredential(credentialId)

Get the status of an issued credential by ID.

recoverIdentity({ eNumber, newDID })

Recover a user's identity to a new device after device loss. Preserves their eNumber.

recordTransaction(options)

Record a transaction for Travel Rule / ARC compliance. Required for crypto transfers above R5,000 ZAR.

health()

Check API health and status.

Supported Countries

| Country | Code | Supported ID Types | |---------|------|--------------------| | Nigeria | NG | BVN, NIN, PASSPORT, DRIVERS_LICENSE | | South Africa | ZA | NATIONAL_ID, PASSPORT | | Kenya | KE | NATIONAL_ID, PASSPORT | | Ghana | GH | DRIVERS_LICENSE | | Uganda | UG | NATIONAL_ID | | Zambia | ZM | NATIONAL_ID |

Beta Programme

During beta, selfieBase64 is optional and each account is limited to 5 verifications. Apply for access at sove.africa.

Support

[email protected]