Auth - os-salahuddin/php8-cluster GitHub Wiki

Version

This API provides app version, maintenance status, and feature configuration

Get Version

This route provides the current app information for Android and iOS, a list of active features, Firebase channels, and checks whether the system is in maintenance mode.

URL

[GET] http://127.0.0.1:8282/api/v2/version

Sample Response

{
    "code": 200,
    "messages": [],
    "data": {
        "is_maintenance": false,
        "maintenance_message": "",
        "android": "34",
        "ios": "44",
        "active_features": {
            "add_money": true,
            "send_money": true,
            "regular_transfer": true,
            "instant_transfer": true,
            "credit_card_payment": true,
            "request_money": true,
            "make_payment": true,
            "ecom_payment": true
        },
        "firebase_channels": [
            "dev2-personal",
            "dev2-all",
            "dev2-all-branch-all-user",
            "dev2-promotional"
        ],
        "app_contents": {
            "mobile": {
                "left_menu": {
                    "account_settings": "show",
                    "limit": "show",
                    "refer_a_friend": "show",
                    "app_settings": "show",
                    "contact_us": "show",
                    "logout": "show"
                },
                "home": {
                    "wallet_service": {
                        "add": {
                            "status": "active",
                            "type": {
                                "credit_card": "active",
                                "bank": "active",
                                "voucher": "inactive"
                            }
                        },
                        "send": {
                            "status": "active",
                            "type": []
                        },
                        "request": {
                            "status": "active",
                            "type": []
                        },
                        "cash_out": {
                            "status": "active",
                            "type": {
                                "agent": "inactive",
                                "bank": "active",
                                "mfs": "inactive"
                            }
                        }
                    },
                    "other_service": {
                        "mobile_recharge": "active",
                        "pay_bill": "active",
                        "share_trip": "active",
                        "offers": "active"
                    },
                    "favourites": "show",
                    "promotional_banner": "show",
                    "recommended_merchant": "show"
                }
            },
            "web": [],
            "rules": {
                "idle_time": 300,
                "otp_expired_time": 300,
                "appStore_app_id": null,
                "playStore_app_id": null
            }
        }
    }
}

Sample Response Format

Parameter	Type	Description	Always Present
code	Int	HTTP code (e.g. 200)	Yes
message	Array	Result message	Yes
data.is_maintenance	Boolean	Indicates whether system is in maintenance mode	Yes
data.android	String	Current app version for android	Yes
data.ios	String	Current app version for ios	Yes
data.active_features	JSON	List of active features (e.g. add money, send money, instant transfer and so on)	Yes
data.app_contents	JSON	Provide info about mobile ui (e.g left menu, home, favourites, promotional banner and so on) and rules (e.g idle time, otp expired time, playstore app id)	Yes

SignUp

These API provides personal account signup in 4 steps:

Step-1: Input a valid mobile number to check if the number exist in our database.
Step-2: If the number does not exist, generate an OTP for verification.
Step-3: After OTP verification, store Firebase verification info.
Step-4: Final step: Accept T&C and set a PIN, which will be used for login and transactions.

Verify whether MSISDN already associated with a user

This api checks if the MSISDN belongs to a user or not.

URL

[POST] http://127.0.0.1:8282/api/v2/auth/signup/existence

Sample Request Format

The table below provides form data (application/x-www-form-urlencoded) request body.

Parameter	Type	Description	Always Present
`msisdn`	string	mobile number	Yes

Sample Response

200

{
    "code": 200,
    "messages": [
        "Sorry! The mobile number already in use."
    ],
    "data": {
        "status": "migrate",
        "kyc_status": 1
    }
}

200

{
    "code": 200,
    "messages": [],
    "data": {
        "otp_expired_time": 2,
        "status": "not_exist"
    }
}

422

{
    "code": 422,
    "messages": [
        "The mobile number format is invalid."
    ],
    "data": null,
    "error_title": null
}

Sample Response Format

Parameter	Type	Description	Always Present
code	Int	HTTP code (e.g. 200)	Yes
message	Array	Result message	Yes
data.otp_expired_time	Int	otp expired time	No
data.status	string	status text	No
error_title	string	Validation error tag (i.e E_PIN_ERROR for otp doesn't matched)	No

OTP Verify

This route verifies otp for a mobile number

URL

[POST] http://127.0.0.1:8282/api/v2/auth/signup/verify-otp

Sample Request Format

The table below provides form data (application/x-www-form-urlencoded) request body.

Parameter	Type	Description	Always Present
`mobile_number`	string	mobile number	Yes
`otp`	string	Sent otp	Yes

Sample Response

200

{
    "code": 200,
    "messages": [
        "Congratulations! Mobile number verification has been passed."
    ],
    "data": null
}

200

{
    "code": 200,
    "messages": [],
    "data": {
        "otp_expired_time": 2,
        "status": "not_exist"
    }
}

422

{
    "code": 422,
    "messages": [
        "The mobile number format is invalid."
    ],
    "data": null,
    "error_title": null
}

422

{
    "code": 422,
    "messages": [
        "The otp must be 6 digits."
    ],
    "data": null,
    "error_title": null
}

422

{
    "code": 422,
    "messages": [
        "Sorry! Incorrect OTP."
    ],
    "data": null
}

Sample Response Format

Parameter	Type	Description	Always Present
code	Int	HTTP code (e.g. 200)	Yes
message	Array	Result message	Yes
data.otp_expired_time	Int	otp expired time	No
data.status	string	status text	No
error_title	string	Validation error tag (i.e E_PIN_ERROR for otp doesn't matched)	No

Store Firebase Mobile Number Verification Information

This route stores the user information in firebase

URL

[POST] http://127.0.0.1:8282/api/v2/auth/signup/firebase-auth-info

Sample Request Format

The table below provides form data (application/x-www-form-urlencoded) request body.

Parameter	Type	Description	Always Present
`mobile_number`	string	mobile number	Yes
`uid`	string	user uid	Yes

Sample Response

200

{
    "code": 200,
    "messages": [
        "Thank you for the information."
    ],
    "data": null
}

422

{
    "code": 422,
    "messages": [
        "The mobile number format is invalid."
    ],
    "data": null,
    "error_title": null
}

Sample Response Format

Parameter	Type	Description	Always Present
code	Int	HTTP code (e.g. 200)	Yes
message	Array	Result message	Yes

Accept T&C + Completion

This route confirm whether user accepted T&C and finish signup process, after signup finished, system store data in password history, pin history, set default account type, set self referral code, assign default level and user id attribute.

URL

[POST] http://127.0.0.1:8282/api/v2/auth/signup/completion

Sample Request Format

The table below provides form data (application/x-www-form-urlencoded) request body.

Parameter	Type	Description	Always Present
`mobile_number`	String	mobile number	Yes
`accept`	String	Whether user accepted or not	Yes
`otp`	String	Sent otp	Yes
`pin`	String	user pin	Yes
`confirm_pin`	String	confirmation pin	Yes

Sample Response

200

{
    "code": 200,
    "messages": [
        "Congratulations! Welcome to ST Pay."
    ],
    "data": null
}

422

{
    "code": 422,
    "messages": [
        "The mobile number has already been taken."
    ],
    "data": null,
    "error_title": null
}

422

{
    "code": 422,
    "messages": [
        "Registration process failed."
    ],
    "data": null,
    "error_title": null
}

422

{
    "code": 422,
    "messages": [
        "The accept field is required."
    ],
    "data": null,
    "error_title": null
}

Sample Response Format

Parameter	Type	Description	Always Present
code	Int	HTTP code (e.g. 200)	Yes
message	Array	Result message	Yes
data.token	string	User access token	No
data.kyc_status	Boolean	Is kyc verified	No
data.invoice_token	string	Invoice token	No

Signin

This api is used for sign in, sign in with otp(new device) and sign in pin set verify otp.

Sign In Without OTP

URL

[POST] http://127.0.0.1:8282/api/v2/auth/signin

Sample request

{
    "mobile_number" : "+88017xxxxxxxx",
    "pin": "1235",
    "device_id": "A156FE5F-0A64-4D92-B671-D80A29BCB008"
}

Sample Request Format

Parameter	Type	Description	Always Present
`mobile_number`	string	mobile number	Yes
`pin`	string	mobile number	Yes
`device_id`	string	mobile number	Yes

Sample Response

200

{
    "code": 200,
    "messages": [
        "Congratulations! Welcome to ST Pay."
    ],
    "data": {
        "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxIiwianRpIjoiYzkzNGZlNzNkZmJmOGQ0YWE5YWMzZWI3OGY1MmNhMTVhMzEyYmE0NDhkNjY0MGM2M2RhODA5NmU3NWNjOWQzZDQ5MDc0YmRlNzQ5ZTA1OTciLCJpYXQiOjE3Mzk3MDU2MzguODAxNDkzLCJuYmYiOjE3Mzk3MDU2MzguODAxNDk1LCJleHAiOjE3NzEyNDE2MzguNzk5OTE3LCJzdWIiOiIxMDAwMDE2NTAiLCJzY29wZXMiOltdfQ.WwfMkSPk3GGnOlQv6h3GhABZZjmSnktxSjig6_McsT2JncWsdxeLshYrcz9j9Ifp9-eWducC4GXradj8Jdwm_jlp3wpxb0-CIbtnbVzCJny3LDSktme_hax0GB2oLH8GvwgVBqIZS16KXXP7pxVrIxF3Zx2IifMxGiTKFaqd9Y81yFPkXlxv0taD6cSiGP_SR1k9wxer9YUo3176_0sd7Rqa2KR1LPbOx_tY73-X5Okq4He4xmSRQBw1mcSFqyPkJL3p_AyCOknTY8WANHKRuCfjdZAMw-WubLKBoeW4bcqX57iplGImODaLOz1ZgMQMGch6xlTH1lfVFnzmmGufiDoHb7tFVELCec0zyUxNiif-Sgv5YGjYzkEzrecSwObRl4YQCVr_oZbaBpWlITxVxoX-U3SDYo0OakT69ct5Qs9RB-BF3tmT7HFK0QkbjSlCUB6SSKpTK8yPhu09woV1NBOJeGBEsK1GzNM6PKJ5wlzdWY2ZYwIwJmR6V8SiIQ58Hgilinyc0SvY7CXoczmEhCUo5IiIhwJjK3OAB9C8POsProykcuEKbdSj3qg7OEZ69juEwgx_DLjQxoQdFJpRiQik1hOglQbYPnxn7OQpDMwZ1xaRC4CBgAWxSucNN3Gwd9K0hNWewgq57jXXInzwtMh54nm-cDz1kE18VEdaS0Q",
        "status": "old_device",
        "kyc_status": 1,
        "invoice_token": ""
    }
}

503

{
    "code": 503,
    "messages": [
        "STPay is currently down for scheduled upgrade"
    ],
    "data": null
}

422

{
    "code": 422,
    "messages": [
        "Sorry! This user does not have any ST Pay account. Please sign up to continue the journey"
    ],
    "data": {
        "signup": true,
        "token": null,
        "kyc_status": -1,
        "invoice_token": null
    }
}

Sample Response Format

Parameter	Type	Description	Always Present
code	Int	HTTP code (e.g. 200)	Yes
message	Array	Result message	Yes
data.signup	Int	otp expired time	No
data.token	string	authentication token	No
data.kyc_status	string	is KYC verified	No
data.invoice_token	string	invoice token	No

Sign In With OTP

URL

[POST] http://127.0.0.1:8282/api/v2/auth/signin/verify-otp

Sample request

{
    "device_id": "A156FE5F-0A64-4D92-B671-D80A29BCB008",
    "mobile_number": "+88017xxxxxxxx",
    "otp": "123456",
    "pin": "1235"
}

Sample Request Format

Parameter	Type	Description	Always Present
`device_id`	string	mobile number	Yes
`mobile_number`	string	mobile number	Yes
`otp`	string	otp	Yes
`pin`	string	user pin	Yes

Sample Response

200

{
    "code": 200,
    "messages": [
        "Congratulations! Welcome to ST Pay."
    ],
    "data": {
        "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxIiwianRpIjoiYzkzNGZlNzNkZmJmOGQ0YWE5YWMzZWI3OGY1MmNhMTVhMzEyYmE0NDhkNjY0MGM2M2RhODA5NmU3NWNjOWQzZDQ5MDc0YmRlNzQ5ZTA1OTciLCJpYXQiOjE3Mzk3MDU2MzguODAxNDkzLCJuYmYiOjE3Mzk3MDU2MzguODAxNDk1LCJleHAiOjE3NzEyNDE2MzguNzk5OTE3LCJzdWIiOiIxMDAwMDE2NTAiLCJzY29wZXMiOltdfQ.WwfMkSPk3GGnOlQv6h3GhABZZjmSnktxSjig6_McsT2JncWsdxeLshYrcz9j9Ifp9-eWducC4GXradj8Jdwm_jlp3wpxb0-CIbtnbVzCJny3LDSktme_hax0GB2oLH8GvwgVBqIZS16KXXP7pxVrIxF3Zx2IifMxGiTKFaqd9Y81yFPkXlxv0taD6cSiGP_SR1k9wxer9YUo3176_0sd7Rqa2KR1LPbOx_tY73-X5Okq4He4xmSRQBw1mcSFqyPkJL3p_AyCOknTY8WANHKRuCfjdZAMw-WubLKBoeW4bcqX57iplGImODaLOz1ZgMQMGch6xlTH1lfVFnzmmGufiDoHb7tFVELCec0zyUxNiif-Sgv5YGjYzkEzrecSwObRl4YQCVr_oZbaBpWlITxVxoX-U3SDYo0OakT69ct5Qs9RB-BF3tmT7HFK0QkbjSlCUB6SSKpTK8yPhu09woV1NBOJeGBEsK1GzNM6PKJ5wlzdWY2ZYwIwJmR6V8SiIQ58Hgilinyc0SvY7CXoczmEhCUo5IiIhwJjK3OAB9C8POsProykcuEKbdSj3qg7OEZ69juEwgx_DLjQxoQdFJpRiQik1hOglQbYPnxn7OQpDMwZ1xaRC4CBgAWxSucNN3Gwd9K0hNWewgq57jXXInzwtMh54nm-cDz1kE18VEdaS0Q",
        "status": "old_device",
        "kyc_status": 1,
        "invoice_token": ""
    }
}

503

{
    "code": 503,
    "messages": [
        "STPay is currently down for scheduled upgrade"
    ],
    "data": null
}

401

{
    "code": 401,
    "messages": [
        "Sorry! Incorrect PIN"
    ],
    "data": {
        "signup": true,
        "token": null,
        "kyc_status": -1,
        "invoice_token": null
    }
}

422

{
    "code": 422,
    "messages": [
        "Sorry! The verification code has been expired."
    ],
    "data": null
}

422

{
    "code": 422,
    "messages": [
        "Sorry! This user does not have any ST Pay account. Please sign up to continue the journey"
    ],
    "data": null
}

Sample Response Format

Parameter	Type	Description	Always Present
code	Int	HTTP code (e.g. 200)	Yes
message	Array	Result message	Yes
data.signup	Int	otp expired time	No
data.token	string	authentication token	No
data.kyc_status	string	is KYC verified	No
data.invoice_token	string	invoice token	No

Set Pin Verify OTP

URL

[POST] http://127.0.0.1:8282/api/v2/auth/signin/set-pin-verify-otp

Sample request

{
    "mobile_number": "+88017xxxxxxxx",
    "otp": "123456"
}

Sample Request Format

Parameter	Type	Description	Always Present
`mobile_number`	string	mobile number	Yes
`otp`	string	otp	Yes
`pin`	string	user pin	Yes

Sample Response

200

{
    "code": 200,
    "messages": [
        "Congratulations! Mobile number verification has been passed."
    ],
    "data": null
}

422

{
    "code": 422,
    "messages": [
        "Sorry! The verification code has been expired."
    ],
    "data": null
}

422

{
    "code": 422,
    "messages": [
        "Sorry! This user does not have any ST Pay account. Please sign up to continue the journey"
    ],
    "data": null
}

422

{
    "code": 422,
    "messages": [
        "Sorry! Sorry! Incorrect OTP."
    ],
    "data": null
}

Sample Response Format

Parameter	Type	Description	Always Present
code	Int	HTTP code (e.g. 200)	Yes
message	Array	Result message	Yes
data	Mixed	Response data (null or object)	No

Set Pin with OTP

URL

[POST] http://127.0.0.1:8282/api/v2/auth/signin/set-pin

Sample request

{
    "mobile_number": "+88017xxxxxxxx",
    "otp": "123456",
    "pin": "1235",
    "confirm_pin": "1235"
}

Sample Request Format

Parameter	Type	Description	Always Present
`mobile_number`	string	mobile number	Yes
`otp`	string	otp	Yes
`pin`	string	user pin	Yes
`confirm_pin`	string	confirmation pin	Yes

Sample Response

200

{
    "code": 200,
    "messages": [
        "Congratulations! PIN has been set successfully."
    ],
    "data": null
}

422

{
    "code": 422,
    "messages": [
        "Sorry! The verification code has been expired."
    ],
    "data": null
}

422

{
    "code": 422,
    "messages": [
        "Security PIN setup process failed"
    ],
    "data": null
}

422

{
    "code": 422,
    "messages": [
        "Sorry! Sorry! Incorrect OTP."
    ],
    "data": null
}

Sample Response Format

Parameter	Type	Description	Always Present
code	Int	HTTP code (e.g. 200)	Yes
message	Array	Result message	Yes
data	Mixed	Response data (null or object)	No

Reset Pin

This api is responsible to reset pin.

Request reset pin

URL

[POST] http://127.0.0.1:8282/api/v2/auth/reset-pin/request

Sample request

{
    "mobile_number": "+88017xxxxxxxx"
}

Sample Request Format

Parameter	Type	Description	Always Present
`mobile_number`	string	mobile number	Yes

Sample Response

200

{
    "code": 200,
    "messages": [
        "Congratulations! Mobile number verification has been passed."
    ],
    "data": {
        "otp_expired_time": 2
    }
}

422

{
    "code": 422,
    "messages": [
        "Sorry! This user does not have any ST Pay account. Please sign up to continue the journey"
    ],
    "data": null
}

422

{
    "code": 422,
    "messages": [
        "Sorry! The verification code has been expired."
    ],
    "data": null
}

Sample Response Format

Parameter	Type	Description	Always Present
code	Int	HTTP code (e.g. 200)	Yes
message	Array	Result message	Yes
data.otp_expired_time	Int	OTP expired time	No

Verify OTP

URL

[POST] http://127.0.0.1:8282/api/v2/auth/reset-pin/verify-otp

Sample request

{
    "mobile_number": "+88017xxxxxxxx",
    "otp": "123456"
}

Sample Request Format

Parameter	Type	Description	Always Present
`mobile_number`	string	mobile number	Yes
`otp`	string	mobile number	Yes

Sample Response

200

{
    "code": 200,
    "messages": [
        "A verification code has been sent to your mobile number."
    ],
    "data": {
        "status": "nid_found",
        "token":"$2y$10$dwmf07d4nGVUfteVWzka9.L3RxgCJeI5j8fnElrq45tF/6qNwIyIu"      
    }
}

422

{
    "code": 422,
    "messages": [
        "Sorry! This user profile not found."
    ],
    "data": null
}

Sample Response Format

Parameter	Type	Description	Always Present
code	Int	HTTP code (e.g. 200)	Yes
message	Array	Result message	Yes
data.status	String	status text (i.e nid_found)	No
data.token	String	temporary token	No

NID upload during reset pin (If not exists)

URL

[POST] http://127.0.0.1:8282/api/v2/auth/reset-pin/upload-verification-document

Sample Request Format

The table below provides form data (application/x-www-form-urlencoded) request body.

Parameter	Type	Description	Always Present
`token`	string	token	Yes
`document_type_id`	Int	document type id	Yes
`document_copy`	File	NID front	Yes
`document_copy_2`	File	NID back	Yes
`nid_no`	string	nid no	Yes
`date_of_birth`	string	date of birth	Yes

Sample Response

200

{
    "code": 200,
    "messages": [
        "Thank you for uploading your verification document information."
    ],
    "data": null
}

200

{
    "code": 200,
    "messages": [
        "Sorry! User already added one verification document of this type"
    ],
    "data": null
}

404

{
    "code": 404,
    "messages": [
        "Sorry! This user does not have any ST Pay account. Please sign up to continue the journey"
    ],
    "data": null
}

403

{
    "code": 403,
    "messages": [
        "Sorry! Incorrect PIN"
    ],
    "data": null
}

422

{
    "code": 422,
    "messages": [
        "The document copy field is required.",
        "The document copy 2 field is required."
    ],
    "data": null,
    "error_title": null
}

Sample Response Format

Parameter	Type	Description	Always Present
code	Int	HTTP code (e.g. 200)	Yes
message	Array	Result message	Yes
data	Mixed	Response data (null or object)	No

Selfie Verification

URL

[POST] http://127.0.0.1:8282/api/v2/auth/reset-pin/verify-selfie

Sample Request Format

The table below provides form data (application/x-www-form-urlencoded) request body.

Parameter	Type	Description	Always Present
`mobile_number`	string	mobile number	Yes
`token`	String	document type id	Yes
`selfie`	File	Selfie	Yes

Sample Response

200

{
    "code": 200,
    "messages": [
        "Congratulations! Selfie verification completed."
    ],
    "data": {
        "status": "selfie_verified"
    }
}

404

{
    "code": 404,
    "messages": [
        "Sorry! This user does not have any ST Pay account. Please sign up to continue the journey"
    ],
    "data": null
}

403

{
    "code": 403,
    "messages": [
        "Sorry! Incorrect PIN"
    ],
    "data": null
}

422

{
    "code": 422,
    "messages": [
        "Sorry! Image upload failed. Please try again"
    ],
    "data": null
}

Sample Response Format

Parameter	Type	Description	Always Present
code	Int	HTTP code (e.g. 200)	Yes
message	Array	Result message	Yes
data.status	String	Selfie verify status	No

Reset Pin

URL

[POST] http://127.0.0.1:8282/api/v2/auth/reset-pin/reset

Sample request

{
    "mobile_number": "+88017xxxxxxxx",
    "token": "$2y$10$dwmf07d4nGVUfteVWzka9.L3RxgCJeI5j8fnElrq45tF/6qNwIyIu",
    "pin": "1235",
    "confirm_pin": "1235"
}

Sample Request Format

Parameter	Type	Description	Always Present
`mobile_number`	string	mobile number	Yes
`token`	String	token	Yes
`pin`	String	Pin	Yes
`confirm_pin`	String	confirm pin	Yes

Sample Response

200

{
    "code": 200,
    "messages": [
        "Congratulations! PIN has been updated successfully."
    ],
    "data": null
}

404

{
    "code": 404,
    "messages": [
        "Sorry! This user does not have any ST Pay account. Please sign up to continue the journey"
    ],
    "data": null
}

404

{
    "code": 404,
    "messages": [
        "Sorry! This user profile not found."
    ],
    "data": null
}

422

{
    "code": 422,
    "messages": [
        "Sorry! Incorrect PIN"
    ],
    "data": null
}

Sample Response Format

Parameter	Type	Description	Always Present
code	Int	HTTP code (e.g. 200)	Yes
message	Array	Result message	Yes
data	Mixed	Object or null	Yes

Firebase

Token Update

URL

[POST] http://127.0.0.1:8282/api/v1/private/user/firebase-token-update

Sample request

{
  "fcm_key": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9",
  "push_cur_version": "1",
  "push_handset_model": "iPhone 14 Pro",
  "push_imei": "A156FE5F-0A64-4D92-B671-D80A29BCB008",
  "push_os": "ios",
  "push_platform": "firebase",
  "push_os_version": "v18.1"
}

Sample Request Format

Parameter	Type	Description	Always Present
`fcm_key`	string	FCM key for push notifications	Yes
`push_cur_version`	string	Current version of the push notification system	Yes
`push_handset_model`	string	Model of handset/device	Yes
`push_imei`	string	IMEI number of the device	Yes
`push_os`	string	OS (e.g., Android, iOS)	Yes
`push_platform`	string	Platform type (e.g., mobile, web)	Yes
`push_os_version`	string	OS Version	Yes

Sample Response

200

{
    "code": 200,
    "messages": [],
    "data": null
}

401

{
    "code": 401,
    "messages": [
        "Authentication failed"
    ],
    "data": null
}

Sample Response Format

Parameter	Type	Description	Always Present
code	Int	HTTP code (e.g. 200)	Yes
message	Array	Result message	Yes
data	Mixed	Object or null	Yes

KYC

Photo Upload

URL

[POST] http://127.0.0.1:8282/api/v1/private/kyc/upload-photo

Sample Request Format

Parameter	Type	Description	Always Present
`photo`	File	kyc photo	Yes

Sample Response

200

{
    "code": 200,
    "messages": [
         "Thank you for uploading your photo."
    ],
    "data": null
}

200

{
    "code": 200,
    "messages": [
         "Thank you for registering with ST Pay. Your account is currently undergoing KYC verification which typically takes 1 to 3 working days to complete. We appreciate your patience during this process."
    ],
    "data": null
}

422

{
    "code": 401,
    "messages": [
        "Authentication failed"
    ],
    "data": null
}

422

{
    "code": 422,
    "messages": [
        "Sorry! Please upload another selfie."
    ],
    "data": null
}

Sample Response Format

Parameter	Type	Description	Always Present
code	Int	HTTP code (e.g. 200)	Yes
message	Array	Result message	Yes
data	Mixed	Object or null	Yes

Terms and Conditions

This api provides Terms and conditions data.

General

URL

[POST] http://127.0.0.1:8282/api/v1/terms-and-conditions/general

Sample Response

200

{
    "code": 200,
    "messages": [
        "Success"
    ],
    "data": {
        "text": "https://stpay.net/terms-condition"
    }
}

Sample Response Format

Parameter	Type	Description	Always Present
code	Int	HTTP code (e.g. 200)	Yes
message	Array	Result message	Yes
data.text	String	T&C text for general	Yes

konnect

URL

[POST] http://127.0.0.1:8282/api/v1/terms-and-conditions/konnect

Sample Response

200

{
    "code": 200,
    "messages": [
        "Success"
    ],
    "data": {
        "text": "https://stpay.net/terms-condition?content=konnect"
    }
}

Sample Response Format

Parameter	Type	Description	Always Present
code	Int	HTTP code (e.g. 200)	Yes
message	Array	Result message	Yes
data.text	String	T&C text for Konnect	Yes

Biometric

URL

[POST] http://127.0.0.1:8282/api/v1/terms-and-conditions/biometric

Sample Response

200

{
    "code": 200,
    "messages": [
        "Success"
    ],
    "data": {
        "text": "https://stpay.net/terms-condition?content=biometric"
    }
}

Sample Response Format

Parameter	Type	Description	Always Present
code	Int	HTTP code (e.g. 200)	Yes
message	Array	Result message	Yes
data.text	String	T&C text for biometric	Yes