User Status Check API

Request Method :: POST

Base URL: Will be shared later.

URL: {BaseUrl}/ppcard/mw/user/user_status_check

Description:This API is used to retrieve the current KYC or account status of a user based on their unique identifier (e.g., mobile number, device ID).

Headers

Content-Type: application/JSON

header_secrets: These values must be generated each time while consuming the API (refer to the generation process mentioned in the note above).

client_id: To be shared during integration by ISU Team

Request Body Parameters

Parameters	Parameter description with validations	Data type	Mandatory/Optional
mobileNumber	10-digit Mobile number, no spaces are allowed.	Numeric String	Mandatory
latLong	Comma separated by Latitude and Longitude.	String	Mandatory
deviceId	Unique Identifier of the Device.Required when the channel is ANDROID. String, no spaces are allowed, Length minimum- 1 and maximum -255	String	Optional.Mandatory if Channel is ANDROID
channel	Channel. Must be ANDROID or WEB, alphabetic only, Length minimum- 3 and maximum -10	String	Mandatory

Sample Request Body

{ "mobileNumber": "8322589965", "latLong": "20.3406087,85.8159733", "deviceId": "123456789e2", "channel": "WEB" }

Response Body Parameters

Parameters	Description	Data type
statusCode	Status Code(0/1)	String
statusDesc	Status Description of Status	String
status	SUCCESS/FAILED	String
data	Object containing user details and card details
userDetails	Object containing user details	Object
status	SUCCESS/FAILED	String
statusCode	Status Code(0/1)	Numeric
statusDesc	Description of Status	String
cardDetails	Object containing card details of the user	Object
accessStatus	Access Status It can be: 1 - GIFT card initiated 2 - GPR	String
kycStatus	KYC Status	String
card	Card Details Containing Card Reference Number and the Card Type.	Array of Objects
cardRefNo	Card Reference Number.	String
cardType	Card Type	String
cardStatus	Card Status	String
cardStatusCode	Code for Card Status.	Numeric

Sample Response Body

SUCCESS:

{ "data": { "cardDetails": { "accessStatus": [ 2 ], "card": [ { "cardRefNo": "1500001950", "cardType": "GPR", "cardStatus": "INPROGRESS", "cardStatusCode": 0 } ], "kycStatus": [] }, "userDetails": { "status": "INPROGRESS", "statusCode": 0, "statusDesc": "Customer onboarded. OTP verification pending" } }, "status": "SUCCESS", "statusCode": 0, "statusDesc": "Customer status fetched successfully" }

FAILED:

If card is not mapped to the customer.

{ "data": {}, "status": "FAILED", "statusCode": 1, "statusDesc": "Failed to fetch user status !!" }

Detailed Status Codes

Status	Response Type	Description
0	SUCCESS	Customer status fetched successfully
1	FAILED	Failed to fetch user status !!