Active KYC Services

Returns the KYC services that are currently active for your account. Each item includes the billing endpoint slug and the public API call (method + path) so you can map catalog services to the routes documented elsewhere. Inactive or unavailable services are not listed. Auth required; not billed. Optional filters: category, country, q.

Request

GET/api/v1/kyc/services

{{baseUrl}}/api/v1/kyc/services

Header

Header	Type	Description
Authorization	string	`Bearer YOUR_ACCESS_TOKEN` from the OAuth client-credentials flow
Content-Type	string	application/json

Query Parameters

Parameter	Type	Description	Required
category	string	Filter by category — "individual" or "business"	optional
country	string	ISO 3166-1 alpha-2 country code — e.g. KE, UG, GH	optional
q	string	Case-insensitive search against title, endpoint, category, and api.path	optional

Filter by country (country=KE)

Expected response for Filter by country (country=KE):

200 OKSample dataExpected response

{
  "success": true,
  "response_code": 200,
  "message": "KYC services retrieved successfully",
  "data": {
    "services": [
      {
        "title": "Maisha Number",
        "endpoint": "maisha-number",
        "category": "individual",
        "country_codes": ["KE"],
        "status": "active",
        "api": {
          "method": "POST",
          "path": "/api/v1/maisha-number"
        }
      }
    ]
  },
  "request_id": "550e8400-e29b-41d4-a716-446655440000"
}

Filter by category (category=business)

Expected response for Filter by category (category=business):

200 OKSample dataExpected response

{
  "success": true,
  "response_code": 200,
  "message": "KYC services retrieved successfully",
  "data": {
    "services": [
      {
        "title": "Company Search",
        "endpoint": "company",
        "category": "business",
        "country_codes": ["KE"],
        "status": "active",
        "api": {
          "method": "POST",
          "path": "/api/v1/business/ke",
          "notes": "Send search_type=pvt."
        }
      }
    ]
  },
  "request_id": "550e8400-e29b-41d4-a716-446655440000"
}

Response Fields

Field	Type	Description
success	boolean	Whether the request succeeded
response_code	number	Application response code (typically mirrors HTTP)
message	string	Human-readable status message
data	object	Payload for the verified resource
request_id	string	UUID for support and audit trails
data.services	array	Active KYC services available to your account
data.services[].title	string	Service name
data.services[].endpoint	string	Billing slug (wallet / pricing) — not always the same as the URL path
data.services[].category	string	"individual" or "business"
data.services[].country_codes	array	Countries where this service is currently available
data.services[].status	string	"active" — only active services are returned
data.services[].api	object	Public API call for this service when one exists on the Peleza API
data.services[].api.method	string	HTTP method — usually POST
data.services[].api.path	string	API path to call (may include {country} or {searchId} placeholders)
data.services[].api.notes	string	Optional request hints (scope, search_type, related poll URLs)

Error codes

Standard Peleza HTTP / response_code values (same across all API calls). Validation message text is endpoint-specific. Full reference: Error Codes.

Code	When
200	Active services retrieved successfully
401	Missing or invalid Bearer token
500	Failed to retrieve active services

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.