Auth
- POSTAnonymous user
- POSTLogin with phone
- POSTLogin with email
- POSTLogin with whatsapp
- POSTLogin with password
- POSTVerify OTP
- POSTRegister with phone
- POSTRegister with email
- POSTRegister with whatsapp
- POSTRegister with password
- GETRetrieve a user
- PUTUpdate a user
- GETRetrieve a profile image
- PUTUpdate profile image
- POSTAdd profile image
- DELDelete profile image
- PUTDeactivate account
- POSTRefresh access token
- POSTChange password
- POSTForgot password
- POSTReset password
- GETRetrieve user notification preferences
- PUTUpdate user notification preferences
- POSTCreate user notification preferences
- POSTGenerate OTP
- POSTLogout user
- POSTCheck email/phone verification status
Catalog
Carts
- POSTCreate cart
- GETRetrieve cart detail
- DELDelete cart
- GETRetrieve cart using user id
- DELDelete cart using user id
- POSTAdd/delete cart item
- POSTUpdate cart address
- POSTApply coupon
- DELRemove coupon
- POSTRedeem loyalty points
- DELRemove loyalty points
- POSTUse credit balance
- DELRemove credit balance
- POSTRedeem gift card
- DELRemove gift card
- GETRetrieve wishlist
- POSTAdd product to wishlist
- DELDelete product from wishlist
Coupons & promotions
Customers
KYC
Orders
Shipping
Analytics
Campaigns
KYC
Update document detail
KYC
Update document detail
Update document detail
PUT
/
customers
/
{id}
/
documents
/
{document_id}
curl --request PUT \
--url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/customers/{id}/documents/{document_id} \
--header 'Content-Type: multipart/form-data' \
--form 'document_number=<string>' \
--form 'kyc_document_id=<string>' \
--form 'note=<string>' \
--form 'modified_reason=<string>'
{
"message": "<string>",
"success": true,
"content": {
"document": {
"id": "<string>",
"document_number": "<string>",
"note": "<string>",
"status": "submitted",
"title": "<string>",
"file_url": "<string>",
"verification_type": "automatic",
"is_verified": true,
"verified_at": "2023-11-07T05:31:56Z",
"created_by": "customer",
"created_at": "2023-11-07T05:31:56Z",
"modified_by": "customer",
"modified_at": "2023-11-07T05:31:56Z",
"modified_reason": "<string>",
"expires_at": "2023-11-07T05:31:56Z"
}
}
}
Body
multipart/form-data
file attachment will be required or optional as per store setting.
Response
200
application/json
OK
Available options:
submitted
, approved
, rejected
, expired
Available options:
automatic
, manual
Available options:
customer
, admin
Available options:
customer
, admin
curl --request PUT \
--url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/customers/{id}/documents/{document_id} \
--header 'Content-Type: multipart/form-data' \
--form 'document_number=<string>' \
--form 'kyc_document_id=<string>' \
--form 'note=<string>' \
--form 'modified_reason=<string>'
{
"message": "<string>",
"success": true,
"content": {
"document": {
"id": "<string>",
"document_number": "<string>",
"note": "<string>",
"status": "submitted",
"title": "<string>",
"file_url": "<string>",
"verification_type": "automatic",
"is_verified": true,
"verified_at": "2023-11-07T05:31:56Z",
"created_by": "customer",
"created_at": "2023-11-07T05:31:56Z",
"modified_by": "customer",
"modified_at": "2023-11-07T05:31:56Z",
"modified_reason": "<string>",
"expires_at": "2023-11-07T05:31:56Z"
}
}
}