Peleza — Trust built on data
Dashboard
Updates
On this page

Changelog

Latest releases, improvements, and breaking changes for the Peleza API.

September 2026 — Credit Information + AML / PEP

  • Added Kenya credit information reports on the Go API: POST /api/v1/credit-info/individual/ke (billed as credit-info-individual) and POST /api/v1/credit-info/business/ke (billed as credit-info-business). Default provider is creditinfo; optional provider metropol is also supported. Requires consent: true. HTTP 200 and 404 are billed; 422 / 503 are not. Documented as a single Credit Reports page covering both individual and business. Docs samples match live CreditInfo CIR field shapes (general, scoring.cip_records, contracts, payment_calendar, extract with consent dates). Report-level general.subscriber is omitted from API responses.
  • Added sandbox AML / PEP screening: POST /api/v1/check/screen and GET /api/v1/check/screen/{token}.
  • Screen individuals or organisations for pep, sanctions, and adverse_media scopes. Returns a UUID screening_id for polling.
  • Sandbox fixtures cover clear, PEP hit, sanctions, adverse media, and processing outcomes. Live billing uses Merchant aml_pep_pricing. Docs samples use the production match object shape with fictional sample data (no upstream vendor labels on matches).

August 2026 — Go API on api.peleza.com

  • Kenya National ID consolidated to POST /api/v1/id/ke with required consent and scope (basic | full).
  • Other-country IDs on the Go API and sandbox: POST /api/v1/id/{ao,ug,za,zm,zw,gh,ng} with required consent: true. Ghana Card requires Personal ID GHA-#########-# (document numbers rejected). Billing: id-ao, id-ug, id-za, id-zm, zimbabwe-national-id, ghana-card / ghana-voter, id-ng / nigeria-nin-advance.
  • Legacy Go routes /api/v1/national-id and /api/v1/national-id-image removed — migrate to /id/ke.
  • Basic responses include serial_number; scope / status are not returned in data.
  • One api_request_logs row per client call with request and response details for support and audit.
  • Wallet debit transactions use uppercase references (e.g. APIK7M2Q9X4P1).
  • KES wallets with tenant VAT enabled debit subtotal + VAT; non-KES currencies skip VAT.
  • Added docs for GET /api/v1/oauth/validate and GET /api/v1/wallet/balance. Validate returns valid and expires_at only (no credential identifiers).
  • Kenya Passport on the Go API: POST /api/v1/passport/ke (billed as passport).
  • Maisha Number on the Go API: POST /api/v1/maisha-number (billed as maisha-number). Requires consent: true. Success payload includes serial_no when available. Also live on sandbox with test ID 1028845319.
  • Phone + ID on the Go API: POST /api/v1/phone-id/ke (combined phone and national ID verification; billed as phone-id).
  • Driving License on the Go API: POST /api/v1/dl/ke (billed as driving-license).
  • Motor Vehicle Records on the Go API: POST /api/v1/mvr/ke (billed as vehicle-plate). NTSA via Metropol is primary; CreditInfo is fallback only when Metropol never submitted. Success payload now includes year_of_manufacture, owner_type, flagged, inspection, and charges. HTTP 200 and 404 are billed; 503 is not.
  • KRA on the Go API: POST /api/v1/kra-pin-by-id, /kra-pin-by-pin.
  • Business / KYB on the Go API: POST /api/v1/business/ke with search_type pvt | bn | llp | bo (billed as company / business / limitted / business-ownership). Requires consent: true.

Breaking changes

Clients calling the Go API must use National ID with scope and consent. Do not call removed legacy national-id paths on the Go host.