FINOCRED API Documentation

Authentication

All authenticated endpoints require a Bearer token in the Authorization header. Tokens are valid for 30 days.

POST /auth/register Register new user

Parameter	Type	Required	Description
name	string	Yes	Full name
email	string	Yes	Email address (unique)
phone	string	Yes	Phone with country code
password	string	Yes	Min 8 characters
password_confirmation	string	Yes	Must match password
role	enum	Yes	buyer \| seller \| investor \| financer
pan	string	No	PAN number (ABCDE1234F)
entity_name	string	No	Company/entity name
fcm_token	string	No	Firebase push token

{
  "status": "success",
  "message": "Registration successful. Account pending approval.",
  "data": {
    "user": { "id": 5, "name": "...", "role": "buyer", "status": "pending" },
    "token": "5|abc123...",
    "token_type": "Bearer",
    "expires_in": 2592000
  }
}

POST /auth/login Login and get token

Parameter	Type	Required	Description
email	string	Yes	Registered email
password	string	Yes	Account password
fcm_token	string	No	Update FCM token on login

POST /auth/logout Revoke current token AUTH

Revokes the current access token. No body required.

POST /auth/refresh Refresh token AUTH

Revokes old token and issues a new one valid for 30 days.

Profile

GET/auth/profileGet current user profile + KYC statusAUTH

{
  "status": "success",
  "data": {
    "id": 1, "name": "...", "email": "...", "phone": "...",
    "role": "buyer", "status": "active", "wallet_balance": 50000,
    "kyc_status": {
      "pan": { "status": "verified", "verified_at": "..." },
      "gst": { "status": "not_submitted" },
      "bank_account": { "status": "pending" }
    }
  }
}

PUT/auth/profileUpdate profile fieldsAUTH

Send any of: name, phone, entity_name, entity_type, entity_reg, industry, address, website

POST/auth/profile/photoUpload profile photoAUTH

Send multipart form with `photo` field (max 5MB, image)

POST/auth/change-passwordChange passwordAUTH

Param	Type
current_password	string	Yes
password	string	Yes
password_confirmation	string	Yes

Factoring Units

GET/factoring-unitsList FUs (filtered by role)AUTH

Buyers see their own. Investors see "Bidding" status.

Query Param	Description
status	Filter by status
min_amount	Min invoice total
max_amount	Max invoice total
sort	amount_asc \| amount_desc
per_page	Items per page (default 20)

GET/factoring-units/{id}Get FU details with bidsAUTH

Returns FU with buyer info, all bids, and line-item details.

POST/factoring-unitsCreate new FU (buyer/seller)AUTH

Param	Type
fu_seller	string	Yes
fu_invoice_no	string	Yes
fu_invoice_date	date	Yes
fu_due_date	date	Yes
fu_total	number	Yes
fu_invoice_total	number	Yes
fu_finance_amount	number	Yes
fu_tenure	string	Yes

GET/dashboardRole-based dashboard statsAUTH

Returns different stats based on user role (buyer/investor).

Bids

GET/bidsList my bids (filtered by role)AUTH

Query	Description
status	Pending \| Accepted \| Rejected

POST/bids/{fuId}Place bid (investor/financer)AUTH

Param	Type
bid_amount	number	Yes
bid_percentage	number	Yes
bid_tenure	string	Yes

PUT/bids/{bidId}/statusAccept/reject bid (buyer)AUTH

Param	Type
status	enum	Accepted \| Rejected
remark	string	Optional note

Payments & Wallet

POST/payments/create-orderCreate Razorpay orderAUTH

Param	Type		Desc
amount	number	Yes	₹100 - ₹1,00,00,000
type	enum	No	wallet_topup \| bid_deposit

POST/payments/verifyVerify & capture paymentAUTH

Param	Type
payment_id	integer	Yes
razorpay_payment_id	string	Yes
razorpay_order_id	string	Yes
razorpay_signature	string	Yes

GET/payments/historyPayment historyAUTH

Paginated list of all payments for current user.

GET/payments/walletGet wallet balanceAUTH

{ "status": "success", "data": { "balance": 50000.00, "currency": "INR" } }

KYC Verification

GET/kyc/statusGet all KYC statusesAUTH

Returns verification status for PAN, GST, Bank, Aadhaar, Address.

POST/kyc/verify-panVerify PAN numberAUTH

Param	Type
pan	string	10 chars, e.g. ABCDE1234F

POST/kyc/verify-gstVerify GST numberAUTH

Param	Type
gst	string	15 chars GSTIN

POST/kyc/verify-bankVerify bank accountAUTH

Param	Type
account_number	string	Bank account number
ifsc	string	11-char IFSC code

Notifications

GET/notificationsList notifications + unread countAUTH

Returns paginated notifications with unread_count in meta.

PUT/notifications/{id}/readMark single as readAUTH

POST/notifications/mark-all-readMark all as readAUTH

POST/notifications/fcm-tokenUpdate FCM push tokenAUTH

Param	Type
fcm_token	string	Yes

Error Responses

// 401 Unauthorized
{ "message": "Unauthenticated." }

// 403 Forbidden
{ "status": "error", "message": "Only investors/financers can bid." }

// 422 Validation Error
{ "message": "The email field is required.", "errors": { "email": ["The email field is required."] } }

// 500 Server Error
{ "status": "error", "message": "Internal server error." }