Get Upload Proof URL API enables API partners to capture and upload the necessary proof directly into the Telgoo5 system, bypassing storage on third-party systems.
It should be invoked whenever proof is required. If proof is not needed and this API is called, the link will prompt for mandatory eligibility proof.
This API must be called after creating a Lifeline customer.
The URL provided by the API will be valid for 30 seconds; if the customer does not click the URL within this time-frame, it will expire.
The system only allows proof capture. Below are the details of all fields and their nature.
API End Point URL: https://www.vcareapi.com:8080/customer
Request:
{
"action": "get_upload_proof_url",
"agent_id": "ewebsiteapi",
"source": "WEBSITE",
"enrollment_id": "ABC18779",
"return_url": https://www.telgoo5.com/
}
| action | This parameter must be set to a fixed value: get_upload_proof_url for this API. (Required*) |
| agent_id | This is the user login id which will be created in Telgoo5 for the API user. (Required*) |
| source | The source of the API call. (Required*) |
| enrollment_id | The enrollment ID of the customer. (Required*) |
| return_url | This is the url where user will be redirected after uploading the proof. (Required*) |
Response:
{
"msg": "Success",
"data": {
"upload_proof_url": "https://qa-uploadproof.telgoo5.com?id=MDQ1c1hJR2NMekUyWjJ4b2RUQTBTa2dweXZtWmZCdURYTWt5NlFjNUlHcjNqRW5rbXM5UVVCWmtVMEtJdTNDRg=="
}
"msg_code": "RESTAPI000"
}
The `upload_proof_url` in the response body is the URL to which the user will be redirected to capture and upload their documents. This URL is valid for only 30 seconds from when the user clicks on it to begin the document process.
- After clicking on the provided URL in the response, the customer will be redirected to the page below.
- On this page, customers can upload proof using their webcam or mobile camera. Proofs marked with an asterisk (*) are mandatory and must be uploaded by the customer.
- When they click on the capture button, they will be able to capture and upload the proof.
- The system will not allow the process to proceed without completing the mandatory fields.
- Proof successfully uploaded and submitted to CPUC.
- Upon clicking the OK button, the system redirects to the provided return URL.
- This link will be valid for 30 seconds.
- Captured proofs are displayed in the Review section.
- Both proofs are also submitted to CPUC.