Class PhoneVerificationService

Index

Constructors

Methods

getServiceInfo verify

Constructors

constructor

new PhoneVerificationService(http: HttpClient): PhoneVerificationService
Parameters
- http: HttpClient
Returns PhoneVerificationService
- Defined in src/services/phone-verification.ts:11

Methods

getServiceInfo

getServiceInfo(
options?: RequestOptions,
): Promise<APIResponseEnvelope<Record<string, unknown>>>
Get service info and quota limits for phone verification API.
Parameters
- Optionaloptions: RequestOptions
Returns Promise<APIResponseEnvelope<Record<string, unknown>>>
- Defined in src/services/phone-verification.ts:48

verify

verify(
params: VerifyPhoneParams,
options?: RequestOptions,
): Promise<VerifyPhoneResponse>
Verify Uganda phone number and retrieve registered subscriber KYC details.
Parameters
- params: VerifyPhoneParams
- Optionaloptions: RequestOptions
Returns Promise<VerifyPhoneResponse>
Example
```
const subscriber = await marzpay.phoneVerification.verify({
  phone_number: '+256777123456'
});
```
- Defined in src/services/phone-verification.ts:23