Authentication
16 endpoints in the Authentication module.
16 endpoints in the Authentication module.
Registration
Health
POST
/v2/api/auth/healthParameters
Headers
| app_key | YOUR_APP_KEY |
Example request
json
{}Example response200 OK
json
{
"access_token": "<access_token>",
"expires_in": 600,
"refresh_token": "<refresh_token>",
"refresh_expires_in": 7200,
"uid": 6,
"company_id": 1,
"user_context": {
"tz": "Europe/Brussels",
"lang": "en_US",
"uid": 6
}
}Otp
POST
/v2/api/auth/signup/otpExample request
json
{
"mobile": "+8562000000000",
"is_company": false,
"lang": "lo_LA"
}Example response200 OK
json
{
"access_token": "<access_token>",
"expires_in": 600,
"refresh_token": "<refresh_token>",
"refresh_expires_in": 7200,
"uid": 6,
"company_id": 1,
"user_context": {
"tz": "Europe/Brussels",
"lang": "en_US",
"uid": 6
}
}Cors path test
OPTIONS
/api/cors-path-testExample response200 OK
json
{
"access_token": "<access_token>",
"expires_in": 600,
"refresh_token": "<refresh_token>",
"refresh_expires_in": 7200,
"uid": 6,
"company_id": 1,
"user_context": {
"tz": "Europe/Brussels",
"lang": "en_US",
"uid": 6
}
}Otp verify
POST
/v2/api/auth/signup/otp-verifyParameters
Headers
| app_key | {{app-key}} |
Example request
json
{
"mobile": "+8562000000000",
"ref_number": "78a068fe-35aa-484c-919c-5a7fcd7a8705",
"otp": "********"
}Example response200 OK
json
{
"access_token": "<access_token>",
"expires_in": 600,
"refresh_token": "<refresh_token>",
"refresh_expires_in": 7200,
"uid": 6,
"company_id": 1,
"user_context": {
"tz": "Europe/Brussels",
"lang": "en_US",
"uid": 6
}
}User update
POST
/v2/api/auth/signup/user-update/:customer_numberParameters
Headers
| Access-Token | {{access_token}} |
| app_key | YOUR_APP_KEY |
Example request
json
{
"partner": {
"mobile": "+8562000000000",
"name": "Raja",
"email": "user@example.com",
"street": "123 Example Street"
},
"password": "********",
"confirm_password": "********",
"user_passcode": "********",
"confirm_user_passcode": "********"
}Example response200 OK
json
{
"access_token": "<access_token>",
"expires_in": 600,
"refresh_token": "<refresh_token>",
"refresh_expires_in": 7200,
"uid": 6,
"company_id": 1,
"user_context": {
"tz": "Europe/Brussels",
"lang": "en_US",
"uid": 6
}
}User update no pass
POST
/v2/api/auth/signup/user-update/:customer_numberParameters
Headers
| Access-Token | {{access_token}} |
| app_key | YOUR_APP_KEY |
Example request
json
{
"partner": {
"mobile": "+8562000000000",
"name": "Arun",
"email": "user@example.com"
}
}Example response200 OK
json
{
"access_token": "<access_token>",
"expires_in": 600,
"refresh_token": "<refresh_token>",
"refresh_expires_in": 7200,
"uid": 6,
"company_id": 1,
"user_context": {
"tz": "Europe/Brussels",
"lang": "en_US",
"uid": 6
}
}User update no pass test
POST
/v2/api/auth/signup/user-update/:customer_numberParameters
Headers
| Access-Token | {{access_token}} |
| app_key | YOUR_APP_KEY |
Example request
json
{
"partner": {
"mobile": "+8562000000000",
"name": "Raja",
"sur_name": "Selvaraj",
"gender": "male",
"dob": "1990-01-01",
"age": 18,
"marital_status": "single",
"occupation_id_ext_ref_id": 123,
"state_id": 1737,
"city_id": 1662,
"village_id": 45806,
"country_id": "125",
"email": "user@example.com"
}
}Example response200 OK
json
{
"access_token": "<access_token>",
"expires_in": 600,
"refresh_token": "<refresh_token>",
"refresh_expires_in": 7200,
"uid": 6,
"company_id": 1,
"user_context": {
"tz": "Europe/Brussels",
"lang": "en_US",
"uid": 6
}
}User update no pass test anypay
POST
/v2/api/auth/signup/user-update/:customer_numberParameters
Headers
| Access-Token | {{access_token}} |
| app_key | YOUR_APP_KEY |
Example request
json
{
"partner": {
"mobile": "+8562000000000",
"name": "Raja",
"sur_name": "Selvaraj",
"gender": "male",
"dob": "1990-01-01",
"age": 18,
"marital_status": "single",
"occupation_id_ext_ref_id": 123,
"state_id": 1433,
"city_id": 2431,
"village_id": 26263,
"country_id": "Lao",
"email": "user@example.com"
}
}Example response200 OK
json
{
"access_token": "<access_token>",
"expires_in": 600,
"refresh_token": "<refresh_token>",
"refresh_expires_in": 7200,
"uid": 6,
"company_id": 1,
"user_context": {
"tz": "Europe/Brussels",
"lang": "en_US",
"uid": 6
}
}User update password
POST
/v2/api/auth/signup/user-update/:customer_numberParameters
Headers
| Access-Token | {{access_token}} |
| app_key | YOUR_APP_KEY |
Example request
json
{
"password": "********",
"confirm_password": "********"
}Example response200 OK
json
{
"access_token": "<access_token>",
"expires_in": 600,
"refresh_token": "<refresh_token>",
"refresh_expires_in": 7200,
"uid": 6,
"company_id": 1,
"user_context": {
"tz": "Europe/Brussels",
"lang": "en_US",
"uid": 6
}
}User update user passcode
POST
/v2/api/auth/signup/user-update/:customer_numberParameters
Headers
| Access-Token | {{access_token}} |
| app_key | YOUR_APP_KEY |
Example request
json
{
"user_passcode": "********",
"confirm_user_passcode": "********"
}Example response200 OK
json
{
"access_token": "<access_token>",
"expires_in": 600,
"refresh_token": "<refresh_token>",
"refresh_expires_in": 7200,
"uid": 6,
"company_id": 1,
"user_context": {
"tz": "Europe/Brussels",
"lang": "en_US",
"uid": 6
}
}Get tokens admin
POST
/api/auth/get_tokensParameters
Headers
| app_key | {{app-key}} |
Example request
json
{
"username": "user@example.com",
"password": "********"
}Example response200 OK
json
{
"access_token": "<access_token>",
"expires_in": 600,
"refresh_token": "<refresh_token>",
"refresh_expires_in": 7200,
"uid": 6,
"company_id": 1,
"user_context": {
"tz": "Europe/Brussels",
"lang": "en_US",
"uid": 6
}
}Get tokens user
POST
/api/auth/get_tokensParameters
Headers
| app_key | YOUR_APP_KEY |
Example request
json
{
"username": "user@example.com",
"password": "********"
}Example response200 OK
json
{
"access_token": "<access_token>",
"expires_in": 600,
"refresh_token": "<refresh_token>",
"refresh_expires_in": 7200,
"uid": 6,
"company_id": 1,
"user_context": {
"tz": "Europe/Brussels",
"lang": "en_US",
"uid": 6
}
}Get tokens admin email
POST
/api/auth/get_tokensParameters
Headers
| app_key | {{app-key}} |
Example request
json
{
"email": "user@example.com",
"password": "********"
}Example response200 OK
json
{
"access_token": "<access_token>",
"expires_in": 600,
"refresh_token": "<refresh_token>",
"refresh_expires_in": 7200,
"uid": 6,
"company_id": 1,
"user_context": {
"tz": "Europe/Brussels",
"lang": "en_US",
"uid": 6
}
}Get tokens admin mobile
POST
/api/auth/get_tokensParameters
Headers
| app_key | {{app-key}} |
Example request
json
{
"mobile": "+8562000000000",
"password": "********"
}Example response200 OK
json
{
"access_token": "<access_token>",
"expires_in": 600,
"refresh_token": "<refresh_token>",
"refresh_expires_in": 7200,
"uid": 6,
"company_id": 1,
"user_context": {
"tz": "Europe/Brussels",
"lang": "en_US",
"uid": 6
}
}Get tokens user online
POST
/api/auth/get_tokensParameters
Headers
| app_key | YOUR_APP_KEY |
Example request
json
{
"username": "CU00000000",
"password": "********"
}Example response200 OK
json
{
"access_token": "<access_token>",
"expires_in": 600,
"refresh_token": "<refresh_token>",
"refresh_expires_in": 7200,
"uid": 6,
"company_id": 1,
"user_context": {
"tz": "Europe/Brussels",
"lang": "en_US",
"uid": 6
}
}Get tokens user passcode
POST
/api/auth/get_tokensParameters
Headers
| app_key | YOUR_APP_KEY |
Example request
json
{
"username": "user@example.com",
"user_passcode": "********"
}Example response200 OK
json
{
"access_token": "<access_token>",
"expires_in": 600,
"refresh_token": "<refresh_token>",
"refresh_expires_in": 7200,
"uid": 6,
"company_id": 1,
"user_context": {
"tz": "Europe/Brussels",
"lang": "en_US",
"uid": 6
}
}