post https://business-api.test.equal.in/ie/transaction/journey/execute
Businesses can use this annotation feature to watermark user PDFs or images, authenticating the captured information and its intended use case with customizable text. The text's position, font size, and font color can be tailored to meet specific business requirements.
This annotation could be configured with the following journeys:
- PAN OCR
- Aadhaar OCR
- Voter ID OCR
- Driving Licence OCR
- E-Sign
- Any other document
The base64 format should be "data:application/jpg;base64,base64 string"
Journey Input Data
{
"doc_s3_url": "",
"doc_base64":"",
"watermark_text": [
{
"key": "key",
"value": "value1"
}
]
}Journey Output Data
{
"status": "DUMMY_STATUS",
"message": "DUMMY_MESSAGE",
"status_code": "DUMMY_STATUS_CODE",
"transaction_id": "DUMMY_TRANSACTION_ID",
"journey_transaction_id": "DUMMY_JOURNEY_TRANSACTION_ID",
"journey_id": "DUMMY_JOURNEY_ID",
"data": {
"insights": {
"user_document_annotation": [
{
"data": {
"watermarked_doc_s3_url": "DUMMY_WATERMARKED_DOC_URL",
"watermarked_doc_base64": "DUMMY_WATERMARKED_BASE64"
}
}
]
}
}
}Currently no journey included pre-configured watermarking. To add these watermarking, please contact your Account Manager.
Status Codes
| Scenario | Http Status Code | status | status_code | message |
|---|---|---|---|---|
| The watermarked document/ image is successfully shared. | 200 | SUCCESS | success | Request successful |
| Invalid image | 200 | FAILURE | invalid_input | Invalid Image, please upload a valid image |
| Invalid Client Credentials | 401 | FAILURE | invalid_credentials | Invalid Client Credentials |
| Both formats(Base 64 and URL) are entered | 400 | FAILURE | invalid_request | Enter only one Base 64 or URL |
| None of the inputs (Base 64 or URL) provided | 400 | FAILURE | invalid_request | One of the inputs Base 64 or URL is required |
| Unsupported media types | 400 | FAILURE | invalid_request | Invalid file type, only PNG, JPG, and JPEG files are allowed |
| Image too large | 400 | FAILURE | invalid_request | File size exceeds the maximum limit of 2MB |
| Invalid Base 64 | 400 | FAILURE | invalid_request | Invalid base64 content |
| Invalid URL | 400 | FAILURE | invalid_request | Invalid URL |
| 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., DUMMY_STATUS). |
| message | A message providing additional information about the status (e.g., "DUMMY_MESSAGE"). |
| status_code | The code representing the status of the transaction (e.g., "DUMMY_STATUS_CODE"). |
| transaction_id | A unique identifier for the transaction (e.g., "DUMMY_TRANSACTION_ID"). |
| journey_transaction_id | A unique identifier for the journey transaction (e.g., "DUMMY_JOURNEY_TRANSACTION_ID"). |
| journey_id | The unique identifier of the journey associated with the transaction (e.g., "DUMMY_JOURNEY_ID"). |
| doc_s3_url | The S3 URL pointing to the document. |
| doc_base64 | The base64 encoded version of the document. |
| watermark_text | An array containing the watermark text for the document. |
| key | The key associated with the watermark text. |
| value | The value corresponding to the watermark text key (e.g., "value1"). |
| insights | An object containing various insights related to the transaction. |
| user_document_annotation | An array containing annotation data related to the user’s document. |
| data | An object containing additional data within the user document annotation. |
| watermarked_doc_s3_url | The S3 URL pointing to the watermarked document. |
| watermarked_doc_base64 | The base64 encoded version of the watermarked document. |