post https://business-api.test.equal.in/ie/transaction/journey/execute
The businesses can use this API to get the mobile number verified for their users.
STEP 1
The businesses need to invoke the API with a mobile number to get the OTP.
The step for the step 1 needs to be INIT_MOBILE_OTP.
Journey Input Data
{
"mobile_number": "XXXXXXXXXX",
"step": "INIT_MOBILE_OTP"
}Journey Output Data
{
"status": "SUCCESS",
"message": "Success",
"status_code": "success",
"transaction_id": "c29d6a8f-14a6-4489-91da-77ed53152d77",
"journey_transaction_id": "EQ.GT.de538f8e-23ea-447a-b757-391482addb40#mobile_otp_pidg_v1#a03c63b060f84b818d584db745efbcc7",
"journey_id": "mobile_otp_pidg_v1",
"data": {}
}The OTP message would have the following format
676038 is the OTP to access your Equal Account. This OTP is confidential and is valid for 10 min. Powered by Equal.
STEP 2
The businesses need to invoke the API with a mobile number and OTP sent to the mobile number.
The step for the step 2 needs to be VERIFY_MOBILE_OTP.
Journey Input Data
{
"mobile_number": "XXXXXXXXXX",
"mobile_otp": "697395",
"step": "VERIFY_MOBILE_OTP"
}Journey Output Data
{
"status": "SUCCESS",
"message": "Success",
"status_code": "success",
"transaction_id": "c29d6a8f-14a6-4489-91da-77ed53152d77",
"journey_transaction_id": "EQ.GT.de538f8e-23ea-447a-b757-391482addb40#mobile_otp_pidg_v1#263d650fa1f84efdae642fad9ba7e7af",
"journey_id": "mobile_otp_pidg_v1",
"data": {}
}These journeys do not include any pre-configured Ownership or Fraud Checks. To add these checks, please contact your Account Manager.
Status Codes
| Scenario | Http Status Code | status | status_code | message |
|---|---|---|---|---|
| When request is successful and OTP is verified. | 200 | SUCCESS | success | Request successful |
| When mobile number provided is not valid | 200 | FAILURE | invalid_mobile_no | mobile_no is Invalid |
| Invalid Client Credentials | 401 | FAILURE | invalid_credentials | Invalid Client Credentials |
| Any unhandled error from Equal end | 500 | FAILURE | internal_server_error | Something went wrong, please try again. |
| Too many requests | 429 | No object will be sent, throttling happens at the gateway level. | ||
| Service Unavailable | 503 |
Status (Journey Status)
| Possible Values | Description |
|---|---|
| SUCCESS | Shows that the verification process was completed successfully. |
| FAILURE | Indicates that the verification process did not succeed. |
| IN_PROGRESS | Signifies that the verification process is currently underway and has not yet been completed. |
Decision
| Possible Values | Description |
|---|---|
| CLEAR | Indicates that the verification has been completed and the information is confirmed as accurate and legitimate. |
| MUST REVIEW | Signifies that further review is needed due to potential issues or inconsistencies in the verification results. |
| NEEDS REVIEW | Suggests that the verification has identified areas that require further investigation or clarification before a final determination can be made. |
Journey ID will be shared as part of Onboarding
| Key | Description |
|---|---|
| status | The current status of the transaction (e.g., SUCCESS, IN_PROGRESS). |
| message | A message providing additional information about the status (e.g., "Success"). |
| status_code | The code representing the status of the transaction (e.g., "success"). |
| transaction_id | A unique identifier for the transaction. |
| journey_transaction_id | A unique identifier for the journey transaction, which includes information about the journey and its version. |
| journey_id | The unique identifier of the journey associated with the transaction. |
| step | An optional field that could represent the step in the transaction process. |