Verify a phone number

​

Verify a phone number and retrieve the subscriber's details. Ghana requires a networkCode.

Headers
  • Idempotency-Key
    Type: string
    min length:  
    1
    max length:  
    255
    required

    Required for verification mutations. Use a unique printable ASCII key per logical request; retries with the same key return the original response.

Body·
required
application/json
  • phoneNumber
    Type: string
    min length:  
    10
    max length:  
    15     Pattern: ^\+?\d+$
    required

    Phone number in local or E.164 format. 10–15 digits, optional leading +.

  • country
    Type: stringenum

    ISO 3166-1 alpha-2 country code. Supported: NG, GH, UG, ZM, SN, CM, BJ, TG, TZ.

    values
    • NG
    • GH
    • UG
    • ZM
    • SN
    • CM
    • BJ
    • TG
    • TZ
  • mode
    Type: stringenum

    sync returns the verification result in the response. async returns pending and delivers the final result via your registered webhooks (configure under /webhooks).

    values
    • sync
    • async
  • networkCode
    Type: string
    min length:  
    2
    max length:  
    10

    Mobile network operator code. Required for Ghana (GH); accepted values: MTN, Vodafone, AirtelTigo.

Responses
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/verify/phone
curl https://api.lira.com/api/v1/verify/phone \
  --request POST \
  --header 'Idempotency-Key: verify-request-20260504-001' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: YOUR_SECRET_TOKEN' \
  --data '{
  "phoneNumber": "08012345678",
  "country": "NG",
  "networkCode": "MTN",
  "mode": "sync"
}'

{
  "id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
  "status": "success",
  "verificationType": "PHONE_NUMBER",
  "identifier": "08012345678",
  "country": "NG",
  "verifiedAt": "2026-04-22T10:15:30.000Z",
  "verified": true,
  "origin": "api",
  "phoneNumber": "08012345678",
  "firstName": "Jane",
  "lastName": "Doe",
  "middleName": "Adaeze",
  "fullName": "Jane Adaeze Doe",
  "dateOfBirth": "1990-03-15",
  "identity": {
    "idType": "NIN",
    "idValue": "12345678901"
  },
  "error": {
    "code": "PHONE_NOT_FOUND",
    "message": "Phone number not registered with any operator"
  }
}

Verification result