Skip to main content
PUT
Update User PIN By ID

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

User ID.

Body

application/json

Request payload for updating or setting a user's 6-digit PIN.

new_pin
string
required

New 6-digit PIN to set.

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

"654321"

confirm_new_pin
string
required

Must match new_pin.

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

"654321"

current_pin
string

Existing 6-digit PIN. Required if a PIN is already set for the user.

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

"123456"

Response

PIN updated successfully

id
string<uuid>

User ID.

email
string<email>

User email.

phone_number
string

Phone in E.164 format.

first_name
string

Given name.

last_name
string

Family name.

role
enum<string>

Assigned role. Admin can only be assigned via PUT /api/v1/auth/user/id/{id}/role by an existing admin.

Available options:
customer,
vendor,
subvendor,
user,
admin
kyc_status
string

Current KYC status.