Help Center/ KooDrive/ API Reference（Carrier）/ API/ User registration and provisioning/ Registering a New User
Updated on 2026-04-16 GMT+08:00
View PDF
Share

Registering a New User

Function

Register a new user.

URI

POST /koodrive/ose/v1/user/register

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

x-hw-agentName

Yes

String

Definition:

Agent name.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

X-Traceid

No

String

Definition:

Service trace ID, which contains 58 bits.

Constraints:

N/A

Range:

The value contains 58 bits.

Default Value:

N/A
Table 2 Request body parameters

Parameter

Mandatory

Type

Description

firstname

Yes

String

Name.

surname

No

String

Family name.

phone

Yes

String

Mobile number.

email

No

String

Email address.

captchaToken

Yes

String

Token of the verification code.

password

Yes

String

Password.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

code

String

Error Codes

msg

String

Error description.

data

data object

User registration response.
Table 4 data

Parameter

Type

Description

userId

String

KooDrive user ID.

phone

String

Mobile number.

sessionInfo

SessionInfo object

Authentication information.
Table 5 SessionInfo

Parameter

Type

Description

accessToken

String

Access token.

expiresIn

Long

Validity period.

issuedAt

String

Generation time.

refreshToken

String

Refresh token.

Example Requests

POST /koodrive/ose/v1/user/register

{
  "firstname" : "mike",
  "surname" : "01",
  "phone" : "0027188460901",
  "email" : "",
  "captchaToken" : "dasdq234312313dasdsadsd",
  "password" : "01ASDAa1"
}

Example Responses

Status code: 200

User registration response

{
  "data" : {
    "userId" : "1893595880502717057",
    "phone" : "0027188460912",
    "sessionInfo" : {
      "accessToken" : "AT e7ccb8b9b650fb67898c033d0e4f2fe9ee9523fdda9e1cb8",
      "expiresIn" : 1800,
      "issuedAt" : "1772006219896",
      "refreshToken" : "a7ec09ec91fb295d72534a66d03eaf9ef87949ec66df73ca"
    }
  },
  "code" : 0,
  "msg" : "Success."
}

Status Codes

Status Code

Description

200

User registration response