Z-Connect

Minor Validate OTP

Documentations

Documentations for API

End Points

https://z-sandbox.jsbl.com/zconnect/api/OTP/ValidateOTP

Http Method

POST

Header

Name	Type	Values	Description

Request Parameters

Name	Description	Required	Parameter Type	Length	Sample Value

Sample Request

{
    "DeviceID": "",
    "Mobile": "03414041001",
    "OTPCode": "123456",
    "UserID": "",
    "FireBaseToken": "",
    "UDID": "",
    "CNIC": "3740581100001",
    "Client": "Android",
    "ApplicationVersion": "",
    "customerTypeId": "105",
    "IsUserBvsExempted": false
}

Response Parameters

Name	Description	Parameter Type	Length	Sample Value

Response Sample

{
    "responseCode": "00",
    "Message": "OTP verified successfully",
    "responseDescription": "OTP verified successfully",
    "OTPCode": "123456",
    "UserID": "105001",
    "Mobile": "03414041001",
    "AccessToken": "mock-access-token",
    "CoolingOffStatus": "N",
    "CoolingOffConfigHeader": "",
    "CoolingOffConfigText": ""
}

Response Code Details

{
    "responseCode": "00",
    "Message": "OTP verified successfully",
    "responseDescription": "OTP verified successfully",
    "OTPCode": "123456",
    "UserID": "105001",
    "Mobile": "03414041001",
    "AccessToken": "mock-access-token",
    "CoolingOffStatus": "N",
    "CoolingOffConfigHeader": "",
    "CoolingOffConfigText": ""
}

{
    "messages": "Bad Request - Invalid Access Token",
    "errorcode": "4001"
}

{
    "messages": "Bad Request - Invalid Request Payload",
    "errorcode": "4002"
}

{
    "messages": "Bad Request - Invalid Authorization Header",
    "errorcode": "4003"
}

{
    "messages": "Something Went Wrong",
    "errorcode": "4004"
}

{
    "messages": "Record Not Found",
    "errorcode": "4005"
}

{
    "messages": "Invalid Client Id\/Secret",
    "errorcode": "4006"
}

{
    "messages": "Bad Request - Invalid Access Token",
    "errorcode": "4007"
}

Try out yourself

Security

X-IBM-Client-Id(apiKey located in header)

X-IBM-Client-Secret(apiKey located in header)
1c48aa28-2614-486f-aa2c-cbc86cc7ab51

Header Parameter

Name	Values	Description
Content-Type	application/json	Content Type application/json is supported
Accept	application/json	Content Type application/json is supported
organizationId	xyz	You will make a call to the auth-blb api and give it your client ID. You should add the client secret and organisation ID it returns here.
clientId		Enter your verified Client Id
clientSecret		Enter Your Verified Client Secret