Get KYC

This endpoint allows you to verify that the users informations. This is an important step before processing payments to ensure the recipient can receive the transaction.

Overview

User verification is crucial for successful payment processing. This endpoint validates:

Phone number format
Country code validity
Network operator compatibility
Number reachability

Supported Countries:

Country	Country Code	Operators
CAMEROUN (CM)	+237	MTN, ORANGE

Request

Method: POST

URL: {{base_url}}clients/verify_wallet

Headers:

SECRETKEY: Your API secret key
Content-Type: application/json

Parameters: -countryCode (required): The user country code

accountNumber (required): The user mobile phone

cURL Request

curl -X POST \
  https://sandbox.peexit.com/api/v1/clients/verify_wallet \
  -H 'SECRETKEY: ########-####-####-####-############' \
  -H 'Content-Type: application/json' \
  -d '{
    "countryCode": "cm",
    "accountNumber": "677777777"
  }'

Request Body

Request payload

{
  "countryCode": "cm",
  "accountNumber": "677777777"
}

Response

Status 200 - Success

The verification response includes detailed information about the phone number:

valid: Boolean indicating if the number is valid
accountStatus: The account status (ex: active)
accountType: Number in local format
accountTitle: The account type (ex: mobile_wallet)

Success Response

{
  "valid": true,
  "accountTitle": "JOHN DOE",
  "accountStatus": "ACTIVE",
  "accountType": "MOBILE_WALLET"
}

Error Handling

Status 401 - Unauthorized

This means you're not authorized to make requests on the server. This could happen if:

You have not provided a correct secret key
Your secret key is wrong or expired

Error Response

{
  "error": "Unauthorized", 
  "message": "Invalid or missing secret key"
}

Phone Number Format

Accepted Formats

International format: +237677777777
Missing country code: 677777777

Invalid Formats

With spaces: +237 677 777 777
With dashes: +237-677-777-777
Missing country code: 677777777
Wrong country code: +1677777777
Letters in number: +237abcdefgh

Use Cases

user verification is typically used for:

Pre-payment Validation - Verify recipient before creating payment
Form Validation - Real-time validation in user interfaces
Compliance - Ensure regulatory compliance for payments

Next Steps

After verifying a phone number, you can proceed with:

Create Payment Request Bank Payment Request