Skip to main content
POST
Log in with PIN

Authorizations

X-Tenant-ID
string
header
required

Tenant slug (cloudpay, cloudpay-test) or UUID, for unauthenticated endpoints. Optional when the deployment sets DEFAULT_TENANT_ID (the platform tenant).

Body

application/json
msisdn
string
required

Kenyan mobile number in local or international format.

Example:

712345678

pin
string
required

4-6 digits; repeated (0000) and sequential (1234, 4321) PINs are refused.

Pattern: ^[0-9]{4,6}$
Example:

"4821"

device_id
string
required

Stable per-install identifier generated by the app.

Required string length: 8 - 128
otp
string

Required on a new device.

Pattern: ^[0-9]{6}$

Response

Logged in.

status
object
required
data
object