Peleza β€” Trust built on data
πŸ‡°πŸ‡ͺ KYC
On this page

Phone + ID

Combined phone and national ID verification in a single request.

Request

POST/api/v1/phone-id
{{baseUrl}}/api/v1/phone-id
HeaderTypeDescription
AuthorizationstringBearer YOUR_ACCESS_TOKEN from the OAuth client-credentials flow
Content-Typestringapplication/json

Body Parameters

ParameterTypeDescriptionRequired
phone_numberstringMSISDN to verifyrequired
national_idstringNational ID to verify together with the phonerequired
customer_numberstringOptional reference for your own tracking (max 255 characters)optional

Response

200 OKSample dataExample response
{
  "success": true,
  "response_code": 200,
  "message": "Phone and ID verified successfully",
  "data": {
    "phone_number": "0712845631",
    "id_number": "1028845320",
    "verification_status": "verified",
    "name": "James Otieno Kamau"
  },
  "request_id": "550e8400-e29b-41d4-a716-446655440000"
}

Response Fields

FieldTypeDescription
successbooleanWhether the request succeeded
response_codenumberApplication response code (typically mirrors HTTP)
messagestringHuman-readable status message
dataobjectPayload for the verified resource
request_idstringUUID for support and audit trails

Set {{baseUrl}} to https://api.peleza.com (production) or https://sandbox.peleza.com (sandbox). Authenticated calls need a Bearer token from POST /api/v1/oauth/token.