User Management
This API is used to create a user - The endpoint for Create User V1 is /user/v1/create - The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
Timestamp at which given API request is sent.
This ID uniquely identifies a request if the same API is executed multiple times.
It is a unique token/key to authenticate the user each time an API is called. For corresponding sessions this token is used, not your actual username/password
{{authorization}}OK ! Successful operation."Create User" operation was successfully executed.
BAD REQUEST. The "Create User" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.
'INTERNAL SERVER ERROR. We track these errors automatically and try to set it right at the earliest. Try refreshing the page. If the problem persists contact us at [email protected].'
This API is used to create a user
- The endpoint for Create User V2 is
/user/v2/create - The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
Timestamp at which given API request is sent.
This ID uniquely identifies a request if the same API is executed multiple times.
To make use of any User API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.
{{authorization}}OK ! Successful operation."Create User" operation was successfully executed.
BAD REQUEST. The "Create User V2" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.
'INTERNAL SERVER ERROR. We track these errors automatically and try to set it right at the earliest. Try refreshing the page. If the problem persists contact us at [email protected].'
This API is used to create a user
- The endpoint for Create User V3 is
/user/v3/create - The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
Timestamp at which given API request is sent.
This ID uniquely identifies a request if the same API is executed multiple times.
To make use of any User API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.
{{authorization}}BAD REQUEST. The "Create User" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.
'INTERNAL SERVER ERROR. We track these errors automatically and try to set it right at the earliest. Try refreshing the page. If the problem persists contact us at [email protected].'
This API is used to create a user
- The endpoint for Create SsoUser V1 is
/user/v1/sso/create - The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
Timestamp at which given API request is sent.
This ID uniquely identifies a request if the same API is executed multiple times.
To make use of any User API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.
{{authorization}}BAD REQUEST. The "Create SsoUser" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.
'INTERNAL SERVER ERROR. We track these errors automatically and try to set it right at the earliest. Try refreshing the page. If the problem persists contact us at [email protected].'
This API is used to create a user
- The endpoint for User Signup is
/user/v1/signup - The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
Timestamp at which given API request is sent.
This ID uniquely identifies a request if the same API is executed multiple times.
To make use of any User API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.
{{authorization}}BAD REQUEST. The "Create User" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.
'INTERNAL SERVER ERROR. We track these errors automatically and try to set it right at the earliest. Try refreshing the page. If the problem persists contact us at [email protected].'
This API is used to create a user
- The endpoint for User Signup V2 is
/user/v2/signup - The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
Timestamp at which given API request is sent.
This ID uniquely identifies a request if the same API is executed multiple times.
To make use of any User API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.
{{authorization}}BAD REQUEST. The "Create SSU User" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.
'INTERNAL SERVER ERROR. We track these errors automatically and try to set it right at the earliest. Try refreshing the page. If the problem persists contact us at [email protected].'
This API is used to create MUA user.
- The endpoint for Create MUA User is
/user/v4/create - The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
Timestamp at which given API request is sent.
This ID uniquely identifies a request if the same API is executed multiple times.
To make use of any User API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.
{{authorization}}It is a unique token/key to authenticate the user each time an API is called. For corresponding sessions this token is used, not your actual username/password
{{user_token}}OK ! Successful operation."Create User" operation was successfully executed.
No content
BAD REQUEST. The "Create User V4" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.
Unauthorized
'INTERNAL SERVER ERROR. We track these errors automatically and try to set it right at the earliest. Try refreshing the page. If the problem persists contact us at [email protected].'
No content
This API is used to create MUA user.
- The endpoint for Create MUA User is
/user/v1/managed/create - The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
Timestamp at which given API request is sent.
This ID uniquely identifies a request if the same API is executed multiple times.
To make use of any User API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.
{{authorization}}It is a unique token/key to authenticate the user each time an API is called. For corresponding sessions this token is used, not your actual username/password
{{user_token}}OK ! Successful operation."Create MUA User" operation was successfully executed.
No content
BAD REQUEST. The "Create MUA user" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.
Unauthorized
'INTERNAL SERVER ERROR. We track these errors automatically and try to set it right at the earliest. Try refreshing the page. If the problem persists contact us at [email protected].'
No content
This API is used for searching a particular user
- The endpoint for Search User is
/user/v1/search - The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
Timestamp at which given API request is sent.
This ID uniquely identifies a request if the same API is executed multiple times.
To make use of any User API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.
{{authorization}}It is a unique token/key to authenticate the user each time an API is called. For corresponding sessions this token is used, not your actual username/password
{{user_token}}OK ! Successful operation."Search User" operation was successfully executed.
BAD REQUEST. The "User Search V1" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.
Unauthorized
'INTERNAL SERVER ERROR. We track these errors automatically and try to set it right at the earliest. Try refreshing the page. If the problem persists contact us at [email protected].'
This API is used for searching a particular user
- The endpoint for Search User V2 is
/user/v2/search - The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
Timestamp at which given API request is sent.
This ID uniquely identifies a request if the same API is executed multiple times.
To make use of any User API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.
{{authorization}}It is a unique token/key to authenticate the user each time an API is called. For corresponding sessions this token is used, not your actual username/password
{{user_token}}OK ! Successful operation."Search User V2" operation was successfully executed.
BAD REQUEST. The "User Search V2" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.
Unauthorized
'INTERNAL SERVER ERROR. We track these errors automatically and try to set it right at the earliest. Try refreshing the page. If the problem persists contact us at [email protected].'
This API is used for searching a particular user
- The endpoint for Search User V2 is
/user/v3/search - The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
Timestamp at which given API request is sent.
This ID uniquely identifies a request if the same API is executed multiple times.
To make use of any User API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.
{{authorization}}It is a unique token/key to authenticate the user each time an API is called. For corresponding sessions this token is used, not your actual username/password
{{user_token}}OK ! Successful operation."Search User V2" operation was successfully executed.
BAD REQUEST. The "User Search V2" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.
Unauthorized
'INTERNAL SERVER ERROR. We track these errors automatically and try to set it right at the earliest. Try refreshing the page. If the problem persists contact us at [email protected].'
This API is use for updating the user realted details
- The endpoint for Update User is
/user/v1/update - The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
Timestamp at which given API request is sent.
This ID uniquely identifies a request if the same API is executed multiple times.
Specify authorization key (format: Bearer api-key) received from administrator when performing given API request.
{{authorization}}Access token of registered user performing given API request.
{{user_token}}OK ! Successful operation."Update User" operation was successfully executed.
No content
BAD REQUEST. The "Update User" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.
Unauthorized
'INTERNAL SERVER ERROR. We track these errors automatically and try to set it right at the earliest. Try refreshing the page. If the problem persists contact us at [email protected].'
No content
This API is use for updating the user realted details
- The endpoint for Update User V2 is
/user/v2/update - The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
Timestamp at which given API request is sent.
This ID uniquely identifies a request if the same API is executed multiple times.
Specify authorization key (format: Bearer api-key) received from administrator when performing given API request.
{{authorization}}Access token of registered user performing given API request.
{{user_token}}OK ! Successful operation."Update User V2" operation was successfully executed.
No content
BAD REQUEST. The "Update User V2" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.
Unauthorized
'INTERNAL SERVER ERROR. We track these errors automatically and try to set it right at the earliest. Try refreshing the page. If the problem persists contact us at [email protected].'
No content
This API is use for updating the user realted details
- The endpoint for Update User V3 is
/user/v3/update - The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
Timestamp at which given API request is sent.
This ID uniquely identifies a request if the same API is executed multiple times.
Specify authorization key (format: Bearer api-key) received from administrator when performing given API request.
{{authorization}}Access token of registered user performing given API request.
{{user_token}}OK ! Successful operation."Update User V3" operation was successfully executed.
No content
BAD REQUEST. The "Update User V3" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.
Unauthorized
'INTERNAL SERVER ERROR. We track these errors automatically and try to set it right at the earliest. Try refreshing the page. If the problem persists contact us at [email protected].'
No content
This API is used for searching a specific user, the user search is based on the unique ID of the user
- The endpoint for Get User by User ID is
/user/v1/read/{User_ID} - The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
- User can pass an optional query parameter 'fields'. The value is a comma separated list of fields whose information is required in response. e.g. fields=completeness,missingFields,topic,organisations,roles
- 'completeness' is to return profile completeness percentage.
- 'missingFields' is to return fields that are missing to achieve 100% profile completeness.
- 'topic' is to return list of topics that are used for announcements.
- 'organisations' is to return organisation and location details.
- 'roles' is to return list of roles with name and ID details.
User-Id of the user
Timestamp at which given API request is sent.
This ID uniquely identifies a request if the same API is executed multiple times.
To make use of any User API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.
{{authorization}}It a unique token/key to authenticate the user each time an API is called. For corresponsing sessions, this token is exchanged, not the username/password of the user
{{user_token}}OK ! Successful operation."Get User by User ID" operation was successfully executed.
BAD REQUEST. The "Read User V1" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.
'INTERNAL SERVER ERROR. We track these errors automatically and try to set it right at the earliest. Try refreshing the page. If the problem persists contact us at [email protected].'
This API is used for searching a specific user, the user search is based on the unique ID of the user
- The endpoint for Get User by User ID v2 is
/user/v2/read/{User_ID} - The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
- User can pass an optional query parameter 'fields'. The value is a comma separated list of fields whose information is required in response. e.g. fields=completeness,missingFields,topic,organisations,roles
- 'completeness' is to return profile completeness percentage.
- 'missingFields' is to return fields that are missing to achieve 100% profile completeness.
- 'topic' is to return list of topics that are used for announcements.
- 'organisations' is to return organisation and location details.
- 'roles' is to return list of roles with name and ID details.
- Only necessary fields are returned in the response as per user profile configuration.
Please append a valid User Id To the Request URI and if user need any specific values like , profile completeness ,missingFields,topic Ex: ?Fields=completeness,missingFields,topic
Timestamp at which given API request is sent.
This ID uniquely identifies a request if the same API is executed multiple times.
Specify authorization key (format: Bearer api-key) received from administrator when performing given API request.
{{authorization}}Access token of registered user performing given API request.
{{user_token}}OK ! Successful operation."Get User by User ID v2" operation was successfully executed.
BAD REQUEST. The "Read User V2" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.
'INTERNAL SERVER ERROR. We track these errors automatically and try to set it right at the earliest. Try refreshing the page. If the problem persists contact us at [email protected].'
This API is used for reading a specific user, the user read is based on the unique ID of the user
- The endpoint for Get User by User ID v3 is
/user/v3/read/{User_ID} - The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
- User can pass an optional query parameter 'fields'. The value is a comma separated list of fields whose information is required in response. e.g. fields=completeness,missingFields,topic,organisations,roles,tokens
- 'completeness' is to return profile completeness percentage.
- 'missingFields' is to return fields that are missing to achieve 100% profile completeness.
- 'topic' is to return list of topics that are used for announcements.
- 'organisations' is to return organisation and location details.
- 'roles' is to return list of roles with name and ID details.
- MUA user detail can be retreived with their token details
Please append a valid User Id To the Request URI and if user need any specific values like , profile completeness ,missingFields,topic Ex: ?Fields=completeness,missingFields,topic
- When withTokens attribute is passed MUA user tokens will passsed in the response
true- User can pass an optional query parameter 'fields'. The value is a comma separated list of fields whose information is required in response. e.g. fields=completeness,missingFields,topic,organisations,roles
organisations,roles,locations,declarationsTimestamp at which given API request is sent.
This ID uniquely identifies a request if the same API is executed multiple times.
Specify authorization key (format: Bearer api-key) received from administrator when performing given API request.
{{authorization}}Access token of registered user performing given API request.
{{user_token}}OK ! Successful operation."Get User by User ID v3" operation was successfully executed.
BAD REQUEST. The "Read User V3" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.
'INTERNAL SERVER ERROR. We track these errors automatically and try to set it right at the earliest. Try refreshing the page. If the problem persists contact us at [email protected].'
This API is used for searching a specific user, the user search is based on the unique ID of the user
- The endpoint for Get User by User ID is
/user/v4/read/{User_ID} - The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
- User can pass an optional query parameter 'fields'. The value is a comma separated list of fields whose information is required in response. e.g. fields=completeness,missingFields,topic,organisations,roles,locations
- 'completeness' is to return profile completeness percentage.
- 'missingFields' is to return fields that are missing to achieve 100% profile completeness.
- 'topic' is to return list of topics that are used for announcements.
- 'organisations' is to return organisation and location details.
- 'roles' is to return list of roles with name and ID details.
- 'locations' is to return profileLocation
User-Id of the user
Timestamp at which given API request is sent.
This ID uniquely identifies a request if the same API is executed multiple times.
To make use of any User API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.
{{authorization}}It a unique token/key to authenticate the user each time an API is called. For corresponsing sessions, this token is exchanged, not the username/password of the user
{{user_token}}OK ! Successful operation."Get User by User ID V4" operation was successfully executed.
BAD REQUEST. The "Read User V4" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.
'INTERNAL SERVER ERROR. We track these errors automatically and try to set it right at the earliest. Try refreshing the page. If the problem persists contact us at [email protected].'
This API is used for searching a specific user, the user search is based on the unique ID of the user
- The endpoint for Get User by User ID is
/user/v5/read/{User_ID} - The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
- User can pass an optional query parameter 'fields'. The value is a comma separated list of fields whose information is required in response. e.g. fields=completeness,missingFields,topic,organisations,roles,locations
- 'completeness' is to return profile completeness percentage.
- 'missingFields' is to return fields that are missing to achieve 100% profile completeness.
- 'topic' is to return list of topics that are used for announcements.
- 'organisations' is to return organisation and location details.
- 'roles' is to return list of roles with name and ID details.
- 'locations' is to return profileLocation
User-Id of the user
Timestamp at which given API request is sent.
This ID uniquely identifies a request if the same API is executed multiple times.
To make use of any User API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.
{{authorization}}It a unique token/key to authenticate the user each time an API is called. For corresponsing sessions, this token is exchanged, not the username/password of the user
{{user_token}}OK ! Successful operation."Get User by User ID V4" operation was successfully executed.
BAD REQUEST. The "Read User V4" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.
'INTERNAL SERVER ERROR. We track these errors automatically and try to set it right at the earliest. Try refreshing the page. If the problem persists contact us at [email protected].'
This API is used for searching a specific user, the user search is based on the unique ID type of the user
- The endpoint for Get User by User ID is
/user/v1/get/{idType}/{id}
idType can only be either email, phone or loginId
id can only be values of email, phone or loginId
Timestamp at which given API request is sent.
This ID uniquely identifies a request if the same API is executed multiple times.
It is a unique token/key to authenticate the user each time an API is called.
{{authorization}}It is a unique token/key to authenticate the user each time an API is called.
OK ! Successful operation."Get User by ID Type" operation was successfully executed.
BAD REQUEST. The "Get User By Id Type" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.
Unauthorized
'INTERNAL SERVER ERROR. We track these errors automatically and try to set it right at the earliest. Try refreshing the page. If the problem persists contact us at [email protected].'
This API is used for searching a specific user, the user search is based on the unique ID type of the user
- The endpoint for Get User by User ID is
/user/v2/exists/{idType}/{id} - The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
idType can only be either email, phone or userName
id can only be values of email, phone or userName
Captha validation for APP is based on this value, for app this field is mandatory
Captcha is sent with the request, it is validated and then response is shared
someInvalidCaptchaTimestamp at which given API request is sent.
This ID uniquely identifies a request if the same API is executed multiple times.
Specify authorization key (format: Bearer api-key) received from administrator when performing given API request.
{{authorization}}It is a unique token/key to authenticate the user each time an API is called.
{{user_token}}OK ! Successful operation."Get User by ID Type" operation was successfully executed.
No content
BAD REQUEST. The "User Exists V2" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.
Client Error (418)
'INTERNAL SERVER ERROR. We track these errors automatically and try to set it right at the earliest. Try refreshing the page. If the problem persists contact us at [email protected].'
No content
This API is used for searching a specific user, the user search is based on the unique ID type of the user
- The endpoint for Get User by User ID is
/user/v1/exists/{idType}/{id} - The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
idType can only be either email, or phone
id can only be values of email or phone
Timestamp at which given API request is sent.
This ID uniquely identifies a request if the same API is executed multiple times.
Specify authorization key (format: Bearer api-key) received from administrator when performing given API request.
{{authorization}}It is a unique token/key to authenticate the user each time an API is called.
{{user_token}}OK ! Successful operation."will return true or false on the basis of user existence in system" operation was successfully executed.
BAD REQUEST. The "User Exists V1" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.
Unauthorized
'INTERNAL SERVER ERROR. We track these errors automatically and try to set it right at the earliest. Try refreshing the page. If the problem persists contact us at [email protected].'
This API is used to block a user
- The endpoint for Block User is
/user/v1/block - The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
Timestamp at which given API request is sent.
This ID uniquely identifies a request if the same API is executed multiple times.
To make use of any User API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.
{{authorization}}It is a unique token/key to authenticate the user each time an API is called. For corresponsing sessions, this token is exchanged, not the username/password of the user
{{user_token}}OK ! Successful operation."Blocking user" operation was successfully executed.
Bad Request
'INTERNAL SERVER ERROR. We track these errors automatically and try to set it right at the earliest. Try refreshing the page. If the problem persists contact us at [email protected].'
This API is used to unblock a user
- The endpoint for Unblock user is
/user/v1/unblock - The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
Timestamp at which given API request is sent.
This ID uniquely identifies a request if the same API is executed multiple times.
To make use of any User API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.
{{authorization}}It is a unique token/key to authenticate the user each time an API is called. For further sessions this token is exchanged, not the username/password of the user
{{user_token}}OK ! Successful operation."Unblocking User" operation was successfully executed.
Bad Request
'INTERNAL SERVER ERROR. We track these errors automatically and try to set it right at the earliest. Try refreshing the page. If the problem persists contact us at [email protected].'
This API is used for getting information about the currently authenticated user
- The endpoint for Get User by Login ID is
/user/v1/profile/read
'User can pass an optional query parameter 'fields'. The value is a comma separated list of fields whose information is required in response. e.g. fields=completeness,missingFields,topic,organisations,roles'
rolesTimestamp at which given API request is sent.
This ID uniquely identifies a request if the same API is executed multiple times.
Specify authorization key (format: Bearer api-key) received from administrator when performing given API request.
{{authorization}}OK ! Successful operation. The requested operation was successfully executed.
No content
BAD REQUEST. The "User By LoginId" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.
Resource not found. The "User Profile Read" operation failed ! The possible reason for failure is that requested resource not found. here resource is user.
'INTERNAL SERVER ERROR. We track these errors automatically and try to set it right at the earliest. Try refreshing the page. If the problem persists contact us at [email protected].'
No content
This api will get the MUA details with token details.
- User-Id of the managedby user.
- When withTokens attribute is passed MUA user tokens will passsed in the response
trueTimestamp at which given API request is sent.
This ID uniquely identifies a request if the same API is executed multiple times.
Specify authorization key (format: Bearer api-key) received from administrator when performing given API request.
{{authorization}}It is a unique token to authenticate the user each time an API is called
{{user_token}}OK ! Successful operation. The requested operation was successfully executed.
BAD REQUEST. The "Get MUA User Details" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.
'INTERNAL SERVER ERROR. We track these errors automatically and try to set it right at the earliest. Try refreshing the page. If the problem persists contact us at [email protected].'
Api will add or update custodian user self-declarations
Timestamp at which given API request is sent.
This ID uniquely identifies a request if the same API is executed multiple times.
Specify authorization key (format: Bearer api-key) received from administrator when performing given API request.
{{authorization}}It is a unique token to authenticate the user each time an API is called
{{user_token}}OK ! Successful operation. The requested operation was successfully executed.
BAD REQUEST. The "User Declarations" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.
'INTERNAL SERVER ERROR. We track these errors automatically and try to set it right at the earliest. Try refreshing the page. If the problem persists contact us at [email protected].'
This API is used to Migrated the custodian account with non-custodian account.
- The endpoint for User Migrations is
/user/v1/migration - It is mandatory to provide values for required parameters
Timestamp at which given API request is sent.
This ID uniquely identifies a request if the same API is executed multiple times.
Specify authorization key (format: Bearer api-key) received from administrator when performing given API request.
{{authorization}}It is a unique token/key to authenticate the user each time an API is called. For corresponsing sessions, this token is exchanged, not the username/password of the user. it is mandatory to pass the auth token of same user whom we want to migrate
{{user_token}}OK ! Successful operation. "User migration" operation was successfully executed.
BAD REQUEST. The "User Migrate" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.
'INTERNAL SERVER ERROR. We track these errors automatically and try to set it right at the earliest. Try refreshing the page. If the problem persists contact us at [email protected].'
This API is used to merge the custodian account with non-custodian account.
- The endpoint for User Account Merge is
/user/v1/account/merge - It is mandatory to provide values for required parameters
Timestamp at which given API request is sent.
This ID uniquely identifies a request if the same API is executed multiple times.
Specify authorization key (format: Bearer api-key) received from administrator when performing given API request.
{{authorization}}OK ! Successful operation. "USer Merge" operation was successfully executed.
BAD REQUEST. The "User Merge" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.
Unauthorized
'INTERNAL SERVER ERROR. We track these errors automatically and try to set it right at the earliest. Try refreshing the page. If the problem persists contact us at [email protected].'
This API is used to assign roles to a user. It can also be used to replace and remove already assigned user roles. If a user should not be assigned any role in the organization, pass the role paramater as an empty array.
- The endpoint for Assign Role to User is
/user/v1/role/assign - The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
Timestamp at which given API request is sent.
This ID uniquely identifies a request if the same API is executed multiple times.
To make use of any User API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received here.
{{authorization}}It is a unique token/key to authenticate the user each time an API is called.
{{user_token}}OK ! Successful operation. "assign role" operation was successfully executed.
BAD REQUEST. The "User Role Assign" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.
'INTERNAL SERVER ERROR. We track these errors automatically and try to set it right at the earliest. Try refreshing the page. If the problem persists contact us at [email protected].'
This API is used to assign roles to a user. It can also be used to replace and remove already assigned user roles. If a user should not be assigned any role in the organization, pass the role paramater as an empty array.
- The endpoint for Assign Role to User is
/user/v2/role/assign - The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
Timestamp at which given API request is sent.
This ID uniquely identifies a request if the same API is executed multiple times.
To make use of any User API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received here.
{{authorization}}It is a unique token/key to authenticate the user each time an API is called.
{{user_token}}OK ! Successful operation. "assign role" operation was successfully executed.
BAD REQUEST. The "User Role Assign" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.
'INTERNAL SERVER ERROR. We track these errors automatically and try to set it right at the earliest. Try refreshing the page. If the problem persists contact us at [email protected].'
This API is used to assign roles to a user. It can also be used to replace and remove already assigned user roles. If a user should not be assigned any role in the organization, pass the role paramater as an empty array.
- The endpoint for Accepting User T&C* is
/user/v1/tnc/accept - The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
Timestamp at which given API request is sent.
This ID uniquely identifies a request if the same API is executed multiple times.
Specify authorization key (format: Bearer api-key) received from administrator when performing given API request.
{{authorization}}Access token of registered user performing given API request.
{{user_token}}Managed User token of registered MUA user performing given API
{"{ mua_user_token }":null}OK ! Successful operation."User accept TnC" operation was successfully executed.
No content
BAD REQUEST. The "User Accept Tnc" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.
Unauthorized
'INTERNAL SERVER ERROR. We track these errors automatically and try to set it right at the earliest. Try refreshing the page. If the problem persists contact us at [email protected].'
No content
Last updated
Was this helpful?