In this step, the Client will be able to create an account with a login and verify the ownership of the information (telephone number) he has provided through OTP.
1 - As on any other application, the Client will have to create an account.
post
Authorizations
OAuth2clientCredentialsRequired
Token URL:
Body
phoneNumberstringOptional
emailstringOptional
passwordstringOptional
rolesstring[]Optional
Responses
200
OK
*/*
post
/v1/user/sign-up
200
OK
OAuth: client_auth
2 - The client will then be able to login using his e-mail and password:
Client can login to the application
POST
Path Parameters
Name
Type
Description
"username":*
"string"
Client ads his username
"password"*
"string"
Client ads the password he chose in the previous step.
OAuth: client_auth
3 - The client then need to respond to an OTP challenge, i.e he will receive a text message which includes a 4 digit number that he will need to pasted into the Mobile App:
post
Authorizations
OAuth2clientCredentialsRequired
Token URL:
Body
sessionIdstringOptional
usernamestringOptional
challengeTypestringOptional
codestringOptional
Responses
200
OK
*/*
post
/v1/user/otp
200
OK
Responding to the OTP challenge correctly, will allow the user to receive an access token to access features (deposit, withdraw, convert).
OAuth: user_auth
If this is not the case, it will be possible to refresh the OPT token using:
post
Authorizations
OAuth2clientCredentialsRequired
Token URL:
Body
usernamestringOptional
refreshTokenstringOptional
Responses
200
OK
*/*
post
/v1/user/refresh
200
OK
4 - If the User loses his password, it is possible to generate a new one using:
put
Authorizations
OAuth2clientCredentialsRequired
Token URL:
Body
sessionIdstringOptional
usernamestringOptional
challengeTypestringOptional
passwordstringOptional
passwordConfirmstringOptional
Responses
200
OK
*/*
put
/v1/user/change-password
200
OK
To validate the change of the password, the User will receive a new OTP challenge in the form as describe in point 3 above.
You can add this OTP challenge using:
get
Authorizations
OAuth2clientCredentialsRequired
Token URL:
Query parameters
emailstringRequired
Responses
200
OK
*/*
get
/v1/user/forget-password
200
OK
5 - Once the KYC process as been completed and validated for a retail client (as described in step 2 below), the account will be validated and it will be possible to generate a Portfolio Id using: