Upload Proof

This API use for upload Proof. and should be called only after the customer is created successfully in Telgoo5. If you want to upload multiple proof you must be call multiple time with diffrent proof file. Please make sure you call the API only after when CreateCustomer API is successfull. To test the operation using the HTTP POST protocol, click the 'Invoke' button.

End Point https://www.vcareapi.com/vcareOssApi/UploadProof/
Field (Short Description) Value/Tag Name Format Field Example Type Notes Validation rules
VENDOR ID string Vcarecorporation Required A unique Vendor ID is associated with the MVNO/OSS partner. This is used for authorization purpose and can be obtained by contacting your account manager.
USER NAME string Vcarecorporation Required A unique User name is associated with the MVNO/OSS partner. This is used for authorization purpose and can be obtained by contacting your account manager.
PASSWORD string Vcarecorporation Required This is a random string which is generated by Vcare and is tied to the MVNO/OSS user name. This is specifically used for authentication purpose and can be obtained by contacting your account manager.
PIN string 123456789 Required This is generated by Vcare to provide an additional layer of security in the Interim API. This is used for authentication purpose and can be obtained by contacting your account manager.
REFERENCE NUMBER string 123456789 Required Reference number is required to be passed with each transaction.
ENROLLMENT ID string AN12345 Require The enrollment id is returned in the CheckServiceAvailability call and you are required to pass the same enrollment id for the enrollment you are attempting Alphanumeric
SIGNATUREFILENAME string base64encode Optional The enrollment you capture the customer signature eligibility proof. base64encode string
PROOF FILE string base64encode Optional The enrollment you capture the customer proof file eligibility proof. base64encode string
BILL PROOF string base64encode Optional The enrollment you capture the customer bill proof eligibility proof. base64encode string
ID PROOF string base64encode Optional The enrollment you capture the customer id proof eligibility proof. base64encode string
ADDITIONAL INFO string base64encode Optional The enrollment you capture the customer additional info eligibility proof. base64encode string
ADDRESS PROOF string base64encode Optional The enrollment you capture the customer address eligibility proof. base64encode string
IS BASE64CODE characters Y Require Upload proof file must be base64encode string value. Always tag value 'Y'. 'Y'
CUSTRESERT characters N Optional Customer resert upload signature. 'Y' or 'N'
AGENT ID string John Doe Required This is the Telgoo5 user id.For the Agent/Employee who is sending the API request.
AGENT PASSWORD string JohnDoe Conditional This is the password for the Agent Id mentioned above. This is configuration level field. If you have set the permissions for the Agent Id for the requirement of the password in API transactions then you will need to pass the Agent Password in all the XML API transaction, else if you have set the permissions to password not required then you don't need to pass the Agent Password in the XML API.
SOURCE string API Optional This is the source where the API. This could be API, TABLET, IVR, WEBSITE, POS, CUSTOMERPORTAL etc. API, TABLET, IVR, WEBSITE, POS, CUSTOMERPORTAL
Sample Request XML
<?xml version="1.0" encoding="utf-8"?>
<VCAREOSSAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<CREDENTIALS>
	<VENDORID></VENDORID>
	<USERNAME></USERNAME>
	<PASSWORD></PASSWORD>
	<PIN></PIN>
	<REFERENCENUMBER></REFERENCENUMBER>
</CREDENTIALS>
<VCAREOSS>
<UPLOADPROOF>
	<ENROLLMENTID></ENROLLMENTID>
	<SIGNATUREFILENAME></SIGNATUREFILENAME>
	<PROOFFILE></PROOFFILE>
	<BILLPROOF></BILLPROOF>
	<IDPROOF></IDPROOF>
	<ADDITIONALINFO></ADDITIONALINFO>
	<ADDRESSPROOF></ADDRESSPROOF>
	<ISBASE64CODE></ISBASE64CODE>
	<CUSTRESERT></CUSTRESERT>
	<AGENTID></AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<SOURCE></SOURCE>
</UPLOADPROOF>
</VCAREOSS>
</VCAREOSSAPI>
List of status code, description and resolution.
Status Code Description How to Resolve?
00 SUCCESS SUCCESS
13 Password is invalid. Provide a valid Password.
16 Vendor not found. Wrong credentials. Please enter valid vendor credentials.
59 Invalid Enrollment ID. Please provide valid Enrollment ID.
81 Enrollment ID should not be blank. Please provide Enrollment id. Enrollment id cannot be left blank.
751 Custom message. This is dynamic message.
782 These types of files are not allowed. Allowed only jpg, jpeg, and png. Enter a valid file. These types of files are not allowed. Allowed only jpg, jpeg, and png.
Sample Response XML
<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
     <credentials>
        <vendorId>Vcarecorporation</vendorId>
        <referenceNumber>111111111</referenceNumber>
    </credentials>
    <UploadProof>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
        <enrollmentid></enrollmentid>
    </UploadProof>
</VcareOssApi>
SUCCESS
Sample Fail Response: 1
<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<UploadProof>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</UploadProof>
</VcareOssApi>
Error Description: Password is invalid.
How to Resolve?: Provide a valid Password.
Sample Fail Response: 2
<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<UploadProof>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</UploadProof>
</VcareOssApi>
Error Description: Vendor not found. Wrong credentials.
How to Resolve?: Please enter valid vendor credentials.
Sample Fail Response: 3
<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<UploadProof>
	<statusCode>59</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Enrollment ID.</errorDescription>
</UploadProof>
</VcareOssApi>
Error Description: Invalid Enrollment ID.
How to Resolve?: Please provide valid Enrollment ID.
Sample Fail Response: 4
<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<UploadProof>
	<statusCode>81</statusCode>
	<description>FAIL</description>
	<errorDescription>Enrollment ID should not be blank.</errorDescription>
</UploadProof>
</VcareOssApi>
Error Description: Enrollment ID should not be blank.
How to Resolve?: Please provide Enrollment id. Enrollment id cannot be left blank.
Sample Fail Response: 5
<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<UploadProof>
	<statusCode>751</statusCode>
	<description>FAIL</description>
	<errorDescription>Custom message.</errorDescription>
</UploadProof>
</VcareOssApi>
Error Description: Custom message.
How to Resolve?: This is dynamic message.
Sample Fail Response: 6
<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<UploadProof>
	<statusCode>782</statusCode>
	<description>FAIL</description>
	<errorDescription>These types of files are not allowed. Allowed only jpg, jpeg, and png.</errorDescription>
</UploadProof>
</VcareOssApi>
Error Description: These types of files are not allowed. Allowed only jpg, jpeg, and png.
How to Resolve?: Enter a valid file. These types of files are not allowed. Allowed only jpg, jpeg, and png.

All the status codes are listed under the status code sections. Please click here to go to the status code.