Users

CreateApiKey creates a new API Key

post

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/users/v1/api/create

priv_key is returned only once, in this response. It isn't stored and can't be retrieved again, only rotated via RotateApiKey

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Body

application/json

expiresAtstring · date-timeOptional

namestringRequired

scopesstring[]Required

Responses

200

A successful response.

application/json

apiKeystringRequired

privKeystringRequired

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

post/users/v1/api/create

HTTPcURLJavaScriptPython

POST /users/v1/api/create HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 72

{
  "expiresAt": "2026-08-10T18:57:28.848Z",
  "name": "text",
  "scopes": [
    "text"
  ]
}

{
  "apiKey": "text",
  "privKey": "text"
}

UpdateApiKey overwrite the Api key information (scopes)

patch

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/users/v1/api/{apiKeyId}

Full replace of scopes and expires_at. The key material itself is unchanged. Use RotateApiKey to replace credentials instead

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

apiKeyIdstringRequired

api_key represents the api key returned after successfully creation

Body

application/json

expiresAtstring · date-timeOptional

scopesstring[]Required

Responses

200

A successful response.

application/json

object · UpdateApiKeyResponse represents the response body from the UpdateApi endpointOptional

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

patch/users/v1/api/{apiKeyId}

HTTPcURLJavaScriptPython

PATCH /users/v1/api/{apiKeyId} HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "expiresAt": "2026-08-10T18:57:28.848Z",
  "scopes": [
    "text"
  ]
}

{}

DeleteApiKey deletes the provided api key id

delete

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/users/v1/api/{apiKeyId}/delete

Immediate and irreversible. Any client still using this key starts failing authentication right away

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

apiKeyIdstringRequired

api_key represents the api key returned after successfully creation

Responses

200

A successful response.

application/json

object · DeleteApiKeyResponse represents the response body from the DeleteApi endpointOptional

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

delete/users/v1/api/{apiKeyId}/delete

HTTPcURLJavaScriptPython

DELETE /users/v1/api/{apiKeyId}/delete HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{}

RotateApiKey takes the provided Api Key and rotates credentials (changes Api Key, Pub Key and Priv Key)

patch

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/users/v1/api/{apiKeyId}/rotate

The old api_key stops working immediately. Priv_key is only returned in this response, same as on creation

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

apiKeyIdstringRequired

api_key represents the provided api key

Responses

200

A successful response.

application/json

apiKeystringRequired

privKeystringRequired

pubKeystringRequired

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

patch/users/v1/api/{apiKeyId}/rotate

HTTPcURLJavaScriptPython

PATCH /users/v1/api/{apiKeyId}/rotate HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "apiKey": "text",
  "privKey": "text",
  "pubKey": "text"
}

GetApiKeyScopes returns the scopes associated to the provided api key id

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/users/v1/api/{apiKeyId}/scopes

Scopes an API key carries directly, distinct from the calling user's own role-based scopes (see GetUserRoles)

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

apiKeyIdstringRequired

api_key represents the provided api key

Responses

200

A successful response.

application/json

scopesstring[]Required

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/users/v1/api/{apiKeyId}/scopes

HTTPcURLJavaScriptPython

GET /users/v1/api/{apiKeyId}/scopes HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "scopes": [
    "text"
  ]
}

GetUserApiKeys returns all the user api keys

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/users/v1/api/{userId}/api-keys

Never includes priv_key. That's only ever returned once, at creation/rotation time

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

userIdstringRequired

user_id represents the user identifier

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/users/v1/api/{userId}/api-keys

HTTPcURLJavaScriptPython

GET /users/v1/api/{userId}/api-keys HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "apiKey": [
    {
      "apiKey": "text",
      "createdAt": "2026-08-10T18:57:28.848Z",
      "expiresAt": "2026-08-10T18:57:28.848Z",
      "id": "text",
      "lastUsedAt": "2026-08-10T18:57:28.848Z",
      "name": "text",
      "privKey": "text",
      "pubKey": "text",
      "revokedAt": "2026-08-10T18:57:28.848Z",
      "scopes": [
        "text"
      ]
    }
  ]
}

Me is the endpoint to get the current authenticated user

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/users/v1/users/me

Also returns the active account (with KYC and wallets) and the caller's roles, which GetUser doesn't include

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Responses

200

A successful response.

application/json

rolesstring[]Required

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/users/v1/users/me

HTTPcURLJavaScriptPython

GET /users/v1/users/me HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "account": {
    "accountName": "text",
    "accountType": "text",
    "countries": [
      "text"
    ],
    "createdAt": "2026-08-10T18:57:28.848Z",
    "deletedAt": "2026-08-10T18:57:28.848Z",
    "id": "text",
    "kycInfo": {
      "level": 1,
      "provider": "text",
      "requestedAt": "2026-08-10T18:57:28.848Z",
      "status": "text",
      "verifiedAt": "2026-08-10T18:57:28.848Z"
    },
    "privyId": "text",
    "updatedAt": "2026-08-10T18:57:28.848Z",
    "userId": "text",
    "wallets": [
      {
        "address": "text",
        "chainType": "text",
        "id": "text"
      }
    ]
  },
  "roles": [
    "text"
  ],
  "user": {
    "admin": true,
    "createdAt": "2026-08-10T18:57:28.848Z",
    "deletedAt": "2026-08-10T18:57:28.848Z",
    "displayName": "text",
    "email": "text",
    "emailVerified": true,
    "id": "text",
    "isMfaEnabled": true,
    "language": "text",
    "lockReason": "text",
    "locked": true,
    "passwordChangedAt": "2026-08-10T18:57:28.848Z",
    "superAdmin": true,
    "updatedAt": "2026-08-10T18:57:28.848Z"
  }
}

UpdateMyProfile is the endpoint for a user to update their own profile (display_name, language).

patch

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/users/v1/users/me/change_profile

Self-service only. No user_id in the request, it always acts on the caller.

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Body

application/json

displayNamestringRequired

languagestringRequired

Responses

200

A successful response.

application/json

object · UpdateMyProfileResponse is the body response for the user self-update profile endpointOptional

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

patch/users/v1/users/me/change_profile

HTTPcURLJavaScriptPython

PATCH /users/v1/users/me/change_profile HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "displayName": "text",
  "language": "text"
}

{}

GetUser returns a single user

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/users/v1/users/{userId}

Lookup by user_id. For the caller's own profile use Me instead

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

userIdstringRequired

user_id represents the user identifier

Responses

200

A successful response.

application/json

accountsstring[]Required

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/users/v1/users/{userId}

HTTPcURLJavaScriptPython

GET /users/v1/users/{userId} HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "accounts": [
    "text"
  ],
  "user": {
    "admin": true,
    "createdAt": "2026-08-10T18:57:28.848Z",
    "deletedAt": "2026-08-10T18:57:28.848Z",
    "displayName": "text",
    "email": "text",
    "emailVerified": true,
    "id": "text",
    "isMfaEnabled": true,
    "language": "text",
    "lockReason": "text",
    "locked": true,
    "passwordChangedAt": "2026-08-10T18:57:28.848Z",
    "superAdmin": true,
    "updatedAt": "2026-08-10T18:57:28.848Z"
  }
}

UpdateLanguage is the endpoint to update the user language

patch

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/users/v1/users/{userId}/language

Callable on any user. For a user updating their own language use UpdateMyProfile instead

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

userIdstringRequired

user_id represents the user identifier

Body

application/json

languagestringRequired

Responses

200

A successful response.

application/json

object · UpdateLanguageResponse is the body response for the update language endpointOptional

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

patch/users/v1/users/{userId}/language

HTTPcURLJavaScriptPython

PATCH /users/v1/users/{userId}/language HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "language": "text"
}

{}

GetUserRoles is the endpoint to get the user roles and scopes

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/users/v1/users/{userId}/roles

scopes is the flattened, deduplicated union of every role's scopes This is what actually determines the user's permissions

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

userIdstringRequired

user_id represents the user identifier

Responses

200

A successful response.

application/json

scopesstring[]Required

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/users/v1/users/{userId}/roles

HTTPcURLJavaScriptPython

GET /users/v1/users/{userId}/roles HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "roles": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "scopes": [
    "text"
  ]
}

GetUserSettings returns the settings for a user

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/users/v1/users/{userId}/settings

Currently just max_allowance. Update via PatchUserSettings

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

userIdstringRequired

user_id is the user identifier

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/users/v1/users/{userId}/settings

HTTPcURLJavaScriptPython

GET /users/v1/users/{userId}/settings HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "settings": {
    "id": "text",
    "maxAllowance": true,
    "userId": "text"
  }
}

PatchUserSettings partially updates the settings for a user. Any setting not set in the body will be left unchanged.

patch

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/users/v1/users/{userId}/settings

max_allowance is optional in the request specifically so it can be omitted to leave the current value untouched

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

userIdstringRequired

user_id is the user identifier

Body

application/json

maxAllowancebooleanOptional

Responses

200

A successful response.

application/json

object · PatchUserSettingsResponse is the response for the patch user settings endpointOptional

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

patch/users/v1/users/{userId}/settings

HTTPcURLJavaScriptPython

PATCH /users/v1/users/{userId}/settings HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "maxAllowance": true
}

{}

GetMfaMethods returns the Mfa method registered for the user (if any)

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/users/v1/{userId}/mfa/methods

Only non-sensitive info per method (type, label, verified/primary flags). Never secrets like the TOTP seed

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

userIdstringRequired

user_id represents the user identifier

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/users/v1/{userId}/mfa/methods

HTTPcURLJavaScriptPython

GET /users/v1/{userId}/mfa/methods HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "methods": [
    {
      "isPrimary": true,
      "isVerified": true,
      "label": "text",
      "lastUsedAt": "2026-08-10T18:57:28.848Z",
      "mfaId": "text",
      "mfaType": "text"
    }
  ]
}