E-Sign Journey - Get Signer URL

📘
The base64 format should be data:application/pdf;base64,<base64 string>

STEP 1

The businesses need to invoke this API with the file to be signed and the signers details to obtain the signers URLs.

Journey Input Data

{
  "doc_id": "",
  "doc_base64": "",
  "doc_s3_url": "",
  "signer_details": [
    {
      "name": "",
      "email": "",
      "phone": "",
      "aadhaar_no_last_4_digits": ""
    },
    {
      "name": "",
      "email": "",
      "phone": "",
      "aadhaar_no_last_4_digits": ""
    }
  ]
}

Journey Output Data

{
  "status": "IN_PROGRESS",
  "message": "Success",
  "status_code": "success",
  "transaction_id": "aa91da24-52a9-44a0-a630-dec582f74066",
  "journey_transaction_id": "EQ.GT.bb5f6076-e00c-4f5a-acbd-72430bfc4691#pan_digital_v1#c263f8d05f244ddea32043579fcf9dc5",
  "journey_id": "",
  "data": {
    "keys": {
      "e_sign": [
        {
          "signers_url": [
            {
              "name": "",
              "signer_url": ""
            },
            {
              "name": "",
              "signer_url": ""
            }
          ]
        }
      ]
    }
  }
}

📘
This journey does not include any pre-configured Ownership or Fraud Checks. To configure these checks, please contact your Account Manager.

Status Codes

Scenario	HttpStatus	status	status_code	message
When the document is successfully e-signed by all the signers.	200	SUCCESS	success	Request successful
When the mobile number/ email id entered is invalid.	400	FAILURE	invalid_input	Mobile Number/ Email ID is invalid
When the doc_type is incorrect	400	FAILURE	invalid_input	Enter a valid doc_type.
When one of the parameters signer details is missing from the request.	400	FAILURE	invalid_request	Invalid Request
Any unhandled error from Equal's 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
Invalid Client Credentials	401	FAILURE	invalid_credentials	Invalid Client Credentials

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., IN_PROGRESS, SUCCESS).
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. It may be empty in some cases.
signer_details	An array of objects containing the details of each signer involved in the transaction.
name	The name of the signer.
email	The email address of the signer.
phone	The phone number of the signer.
aadhaar_no_last_4_digits	The last four digits of the signer's Aadhaar number, if applicable.
e_sign	An array containing signer information for electronic signature verification.
signers_url	An array of objects containing the name and URL of each signer.
name	The name of the signer.
signer_url	The URL of the signer’s electronic signature platform.