post
https://business-api.test.equal.in/ie/transaction/journey/execute
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
This journey enables the businesses to match the Name obtained from one source to another base value, to check for the accuracy of the data.
Journey Input Data
{
"journey_id": "fuzzy_match_dev_test_v1",
"transaction_id": "3c90a844-af27-49bf-ab9c-b3b3fcf0ba87",
"input_data": {
"match_unit": "NAME",
"base_value": "kendrick lamar",
"target_value": "frank ocean",
"match_sensitivity":"",
"threshold": "20"
}
}Journey Output Data
{
"status": "SUCCESS",
"message": "Success",
"status_code": "success",
"transaction_id": "d06c203e-9101-42a9-ab9f-80c5cd49c2d1",
"journey_transaction_id": "EQ.GT.08b9bfda-dd07-43a6-882e-7a33f8d944b8#fuzzy_match_dev_test_v1#d885911cf3fc4299a24f785edbf040fc",
"journey_id": "fuzzy_match_dev_test_v1",
"data": {
"match_unit": "NAME",
"base_value": "kendrick lamar",
"target_value": "frank ocean",
"insights": null,
"match_result": "FAILED",
"keys": null,
"match_score": 32.0,
"result_reason": "fuzzy string match failed"
}
}Status Codes
| Scenario | Http Status Code | status | status_code | message |
|---|---|---|---|---|
| When the base value matched the target value | 200 | SUCCESS | success | success |
| When the base value doesnt match the target value | 200 | SUCCESS | success | success |
| 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